Package org.opencms.gwt.client.ui.tree

Class CmsTree<I extends CmsTreeItem>

  • Type Parameters:
    I - the specific tree item implementation
    All Implemented Interfaces:
    com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.logical.shared.HasCloseHandlers<I>, com.google.gwt.event.logical.shared.HasOpenHandlers<I>, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.HasAnimation, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.HasWidgets, com.google.gwt.user.client.ui.HasWidgets.ForIsWidget, com.google.gwt.user.client.ui.IndexedPanel, com.google.gwt.user.client.ui.IndexedPanel.ForIsWidget, com.google.gwt.user.client.ui.IsWidget, java.lang.Iterable<com.google.gwt.user.client.ui.Widget>, I_CmsDropTarget, I_CmsTruncable
    Direct Known Subclasses:
    CmsLazyTree
    public class CmsTree<I extends CmsTreeItem>
extends CmsList<I>
implements com.google.gwt.event.logical.shared.HasOpenHandlers<I>, com.google.gwt.event.logical.shared.HasCloseHandlers<I>, com.google.gwt.user.client.ui.HasAnimation
    A tree of list items.

    Since:
    8.0.0

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

        com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled

      • Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.HasWidgets

        com.google.gwt.user.client.ui.HasWidgets.ForIsWidget

      • Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.IndexedPanel

        com.google.gwt.user.client.ui.IndexedPanel.ForIsWidget

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected com.google.gwt.event.shared.SimpleEventBus m_eventBus
      The event bus for the tree.

      • Fields inherited from class com.google.gwt.user.client.ui.UIObject

        DEBUG_ID_PREFIX

    • Constructor Summary

      Constructors 
      Constructor Description
      CmsTree()
      Constructor.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.google.gwt.event.shared.HandlerRegistration addCloseHandler​(com.google.gwt.event.logical.shared.CloseHandler<I> handler)  
      com.google.gwt.event.shared.HandlerRegistration addOpenHandler​(com.google.gwt.event.logical.shared.OpenHandler<I> handler)  
      void cancelOpenTimer()
      Cancels the open timer if present.
      void closeAllEmpty()
      Closes all empty entries.
      void fireClose​(I item)
      Fires the close event for an item.
      void fireEvent​(com.google.gwt.event.shared.GwtEvent<?> event)  
      void fireOpen​(I item)
      Fires an open event for a tree item.
      java.lang.String getPlaceholderPath()
      Returns the placeholder path.
      boolean isAnimationEnabled()  
      boolean isRootDropEnabled()
      Returns if dropping on root level is enabled or not.
      protected void registerItem​(I item)
      Registers the given item on this list.
      protected void removeOpenTimer()
      Sets the timer reference to null.
      void removePlaceholder()
      Removes the placeholder.
      void repositionPlaceholder​(int x, int y, CmsDNDHandler.Orientation orientation)
      Repositions the placeholder.
      void setAnimationEnabled​(boolean enable)  
      void setDropEnabled​(boolean enabled)
      Here the meaning is enabling dropping on the root level.
      void setOpenTimer​(CmsTreeItem item)
      Sets a timer to set a tree item open.
      protected void setPlaceholder​(com.google.gwt.dom.client.Element placeholder)
      Sets the current drag'n drop place holder.
      protected void setPlaceholderPath​(java.lang.String path)
      Sets the placeholder path.
      void setRootDropEnabled​(boolean rootDropEnabled)
      Sets the drop on root enabled.

      • Methods inherited from class com.google.gwt.user.client.ui.ComplexPanel

        add, add, adjustIndex, checkIndexBoundsForAccess, checkIndexBoundsForInsertion, getChildren, getWidget, getWidgetCount, getWidgetIndex, getWidgetIndex, insert, insert, iterator, remove

      • Methods inherited from class com.google.gwt.user.client.ui.Panel

        add, adopt, clear, doAttachChildren, doDetachChildren, orphan, remove

      • Methods inherited from class com.google.gwt.user.client.ui.Widget

        addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, onAttach, onBrowserEvent, onDetach, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents, unsinkEvents

      • Methods inherited from class com.google.gwt.user.client.ui.UIObject

        addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, getTitle, isVisible, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, setWidth, sinkBitlessEvent, toString

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

      • Methods inherited from interface java.lang.Iterable

        forEach, spliterator