Package org.opencms.gwt.client.ui.tree
Class CmsTree<I extends CmsTreeItem>
- java.lang.Object
-
- com.google.gwt.user.client.ui.UIObject
-
- com.google.gwt.user.client.ui.Widget
-
- com.google.gwt.user.client.ui.Panel
-
- com.google.gwt.user.client.ui.ComplexPanel
-
- org.opencms.gwt.client.ui.CmsList<I>
-
- org.opencms.gwt.client.ui.tree.CmsTree<I>
-
- 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
-
-
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 org.opencms.gwt.client.ui.CmsList
m_dndHandler, m_placeholder, m_placeholderIndex
-
-
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 tonull
.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 org.opencms.gwt.client.ui.CmsList
add, addItem, changeId, checkPosition, clearList, getDnDHandler, getItem, getItem, getItemPosition, getPlaceholderIndex, insert, insertItem, insertPlaceholder, isDNDTakeAll, isDropEnabled, onDrop, remove, removeItem, removeItem, setDNDHandler, setDNDTakeAll, truncate
-
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 org.opencms.gwt.client.dnd.I_CmsDropTarget
getElement
-
-
-
-
Field Detail
-
m_eventBus
protected com.google.gwt.event.shared.SimpleEventBus m_eventBus
The event bus for the tree.
-
-
Constructor Detail
-
CmsTree
public CmsTree()
Constructor.
-
-
Method Detail
-
addCloseHandler
public com.google.gwt.event.shared.HandlerRegistration addCloseHandler(com.google.gwt.event.logical.shared.CloseHandler<I> handler)
- Specified by:
addCloseHandler
in interfacecom.google.gwt.event.logical.shared.HasCloseHandlers<I extends CmsTreeItem>
- See Also:
HasCloseHandlers.addCloseHandler(com.google.gwt.event.logical.shared.CloseHandler)
-
addOpenHandler
public com.google.gwt.event.shared.HandlerRegistration addOpenHandler(com.google.gwt.event.logical.shared.OpenHandler<I> handler)
- Specified by:
addOpenHandler
in interfacecom.google.gwt.event.logical.shared.HasOpenHandlers<I extends CmsTreeItem>
- See Also:
HasOpenHandlers.addOpenHandler(com.google.gwt.event.logical.shared.OpenHandler)
-
cancelOpenTimer
public void cancelOpenTimer()
Cancels the open timer if present.
-
closeAllEmpty
public void closeAllEmpty()
Closes all empty entries.
-
fireClose
public void fireClose(I item)
Fires the close event for an item.- Parameters:
item
- the item for which to fire the close event
-
fireEvent
public void fireEvent(com.google.gwt.event.shared.GwtEvent<?> event)
- Specified by:
fireEvent
in interfacecom.google.gwt.event.shared.HasHandlers
- Overrides:
fireEvent
in classcom.google.gwt.user.client.ui.Widget
- See Also:
Widget.fireEvent(com.google.gwt.event.shared.GwtEvent)
-
fireOpen
public void fireOpen(I item)
Fires an open event for a tree item.- Parameters:
item
- the tree item for which the open event should be fired
-
getPlaceholderPath
public java.lang.String getPlaceholderPath()
Returns the placeholder path.- Returns:
- the path
-
isAnimationEnabled
public boolean isAnimationEnabled()
- Specified by:
isAnimationEnabled
in interfacecom.google.gwt.user.client.ui.HasAnimation
- See Also:
HasAnimation.isAnimationEnabled()
-
isRootDropEnabled
public boolean isRootDropEnabled()
Returns if dropping on root level is enabled or not.- Returns:
true
if dropping on root level is enabled
-
removePlaceholder
public void removePlaceholder()
Description copied from interface:I_CmsDropTarget
Removes the placeholder.- Specified by:
removePlaceholder
in interfaceI_CmsDropTarget
- Overrides:
removePlaceholder
in classCmsList<I extends CmsTreeItem>
- See Also:
CmsList.removePlaceholder()
-
repositionPlaceholder
public void repositionPlaceholder(int x, int y, CmsDNDHandler.Orientation orientation)
Description copied from interface:I_CmsDropTarget
Repositions the placeholder.- Specified by:
repositionPlaceholder
in interfaceI_CmsDropTarget
- Overrides:
repositionPlaceholder
in classCmsList<I extends CmsTreeItem>
- Parameters:
x
- the cursor client x positiony
- the cursor client y positionorientation
- the drag and drop orientation- See Also:
CmsList.repositionPlaceholder(int, int, Orientation)
-
setAnimationEnabled
public void setAnimationEnabled(boolean enable)
- Specified by:
setAnimationEnabled
in interfacecom.google.gwt.user.client.ui.HasAnimation
- See Also:
HasAnimation.setAnimationEnabled(boolean)
-
setDropEnabled
public void setDropEnabled(boolean enabled)
Here the meaning is enabling dropping on the root level.Use
CmsTreeItem.setDropEnabled(boolean)
for dropping on tree items.- Overrides:
setDropEnabled
in classCmsList<I extends CmsTreeItem>
- Parameters:
enabled
-true
to enable, orfalse
to disable- See Also:
CmsList.setDropEnabled(boolean)
-
setOpenTimer
public void setOpenTimer(CmsTreeItem item)
Sets a timer to set a tree item open.- Parameters:
item
- the item to open
-
setRootDropEnabled
public void setRootDropEnabled(boolean rootDropEnabled)
Sets the drop on root enabled.- Parameters:
rootDropEnabled
-true
to enable dropping on root level
-
registerItem
protected void registerItem(I item)
Description copied from class:CmsList
Registers the given item on this list.- Overrides:
registerItem
in classCmsList<I extends CmsTreeItem>
- Parameters:
item
- the item to register- See Also:
CmsList.registerItem(org.opencms.gwt.client.ui.I_CmsListItem)
-
removeOpenTimer
protected void removeOpenTimer()
Sets the timer reference tonull
.
-
setPlaceholder
protected void setPlaceholder(com.google.gwt.dom.client.Element placeholder)
Description copied from class:CmsList
Sets the current drag'n drop place holder.- Overrides:
setPlaceholder
in classCmsList<I extends CmsTreeItem>
- Parameters:
placeholder
- the element to set as place holder- See Also:
CmsList.setPlaceholder(com.google.gwt.dom.client.Element)
-
setPlaceholderPath
protected void setPlaceholderPath(java.lang.String path)
Sets the placeholder path.- Parameters:
path
- the path
-
-