Package org.zkoss.zul.ext

Interface Openable<E>

All Known Implementing Classes:
AbstractTreeModel, DefaultTreeModel
public interface Openable<E>
Indicate an openable collection.

Since 6.0.0, TreeOpenableModel was introduced to handle the open state of TreeModel for better performance. Thus, for handling tree's open states, please use TreeOpenableModel instead.

Author:
jimmyshiau
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    addOpenObject(E obj)
    Add the specified object into the collection of opened objects.
    void
    clearOpen()
    Clear all open status.
    Set<E>
    getOpenObjects()
    Returns the objects that are opened.
    boolean
    isObjectOpened(Object obj)
    Returns whether the specified object be opened.
    boolean
    isOpenEmpty()
    Returns true if the open is currently empty.
    boolean
    removeOpenObject(Object obj)
    Remove the specified object from selection.
    void
    setOpenObjects(Collection<? extends E> opens)
    Replace the current set of opened objects with the given set.

  • Method Details

    • getOpenObjects

      Set<E> getOpenObjects()
      Returns the objects that are opened. It is readonly. Don't modify it directly
      Since:
      6.0.0

    • setOpenObjects

      void setOpenObjects(Collection<? extends E> opens)
      Replace the current set of opened objects with the given set.
      Since:
      6.0.0

    • isObjectOpened

      boolean isObjectOpened(Object obj)
      Returns whether the specified object be opened.
      Parameters:
      obj -

    • isOpenEmpty

      boolean isOpenEmpty()
      Returns true if the open is currently empty.
      Since:
      6.0.0

    • addOpenObject

      boolean addOpenObject(E obj)
      Add the specified object into the collection of opened objects.
      Parameters:
      obj - the object to be as selection.
      Returns:
      true if it is added successfully; false if obj is not part of the data, or was already opened.
      Since:
      6.0.0

    • removeOpenObject

      boolean removeOpenObject(Object obj)
      Remove the specified object from selection.
      Parameters:
      obj - the object to be remove from selection.
      Returns:
      whether it is removed successfully
      Since:
      6.0.0

    • clearOpen

      void clearOpen()
      Clear all open status.

      Notice that this method is designed to be called by a component (such as Tree). If it is called by an application, the component's open status won't be changed.