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

Class CmsLazyTreeItem

java.lang.Object

com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.Widget

com.google.gwt.user.client.ui.Composite

org.opencms.gwt.client.ui.CmsListItem

org.opencms.gwt.client.ui.tree.CmsTreeItem

org.opencms.gwt.client.ui.tree.CmsLazyTreeItem

All Implemented Interfaces:

com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.IsRenderable, com.google.gwt.user.client.ui.IsWidget, I_CmsDraggable, I_CmsListItem, I_CmsTruncable

Direct Known Subclasses:

CmsSitemapTreeItem

public class CmsLazyTreeItem
extends CmsTreeItem

Tree item for lazily loaded list trees.

Since:

8.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	CmsLazyTreeItem.LoadingItem	Helper tree item which displays a "loading" message.
static class	CmsLazyTreeItem.LoadState	Enum for indicating the load state of a tree item.

Nested classes/interfaces inherited from class org.opencms.gwt.client.ui.CmsListItem

CmsListItem.MoveHandle

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 inherited from class org.opencms.gwt.client.ui.tree.CmsTreeItem

ANIMATION_DURATION, m_children, m_opener

Fields inherited from class org.opencms.gwt.client.ui.CmsListItem

m_checkbox, m_decoratedPanel, m_decorationWidgets, m_decorationWidth, m_id, m_listItemWidget, m_mainWidget, m_panel, m_placeholder, m_provisionalParent, MOVE_HANDLE_MARKER_CLASS

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

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor	Description
CmsLazyTreeItem(com.google.gwt.user.client.ui.Widget widget, boolean useLoadItem)	Constructs a new lazy tree item with a main widget.
CmsLazyTreeItem(CmsCheckBox checkbox, com.google.gwt.user.client.ui.Widget widget, boolean useLoadItem)	Constructs a new lazy tree item with a main widget and a check box.

Method Summary

Modifier and Type	Method	Description
CmsLazyTreeItem.LoadState	getLoadState()	Gets the load state of the tree item.
boolean	isLoaded()	Returns if tree item children have been loaded.
protected void	onChangeChildren()	Helper method which is called when the list of children changes.
void	onFinishLoading()	This method should be called when the item's children have finished loading.
void	onStartLoading()	This method is called when the tree item's children start being loaded.

Methods inherited from class org.opencms.gwt.client.ui.tree.CmsTreeItem

add, addChild, adopt, clear, clearChildren, closeAllEmptyChildren, createOpener, executeOpen, fireClose, fireOpen, getChild, getChild, getChildCount, getChildren, getDragHelper, getItemPosition, getLastOpenedItem, getParentItem, getParentTarget, getPath, getPathLevel, getTree, hideOpeners, insertChild, insertPlaceholderAsLastChild, isDropEnabled, isOpen, onDragCancel, removeChild, removeChild, removeChild, removeOpener, repositionPlaceholder, setDropEnabled, setLeafStyle, setOpen, setOpen, setParentItem, setTree, showOpeners, visit

Methods inherited from class org.opencms.gwt.client.ui.CmsListItem

addCheckBox, addDecoration, addDecorationWidget, addMainWidget, cloneForPlaceholder, getCheckBox, getCursorOffsetDelta, getData, getDecorationWidgets, getDndHelperClass, getDndParentClass, getId, getListItemWidget, getMainWidget, getMoveHandle, getParentList, getPlaceholder, initContent, initContent, initContent, initMoveHandle, initMoveHandle, moveHandleLeft, onDrop, onStartDrag, removeDecorationWidget, setData, setDndHelperClass, setDndParentClass, setId, setSmallView, truncate

Methods inherited from class com.google.gwt.user.client.ui.Composite

claimElement, getWidget, initializeClaimedElement, initWidget, isAttached, onAttach, onBrowserEvent, onDetach, render, render, resolvePotentialElement, setWidget

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

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getHandlerCount, getLayoutData, getParent, isOrWasAttached, 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, 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_CmsDraggable

getElement

Constructor Detail

CmsLazyTreeItem

public CmsLazyTreeItem(CmsCheckBox checkbox,
                       com.google.gwt.user.client.ui.Widget widget,
                       boolean useLoadItem)

Constructs a new lazy tree item with a main widget and a check box.

Parameters:

checkbox - the check box

widget - the main widget

useLoadItem - true to show a load item while children are being loaded

CmsLazyTreeItem

public CmsLazyTreeItem(com.google.gwt.user.client.ui.Widget widget,
                       boolean useLoadItem)

Constructs a new lazy tree item with a main widget.

Parameters:

widget - the main widget

useLoadItem - true to show a load item while children are being loaded

Method Detail

getLoadState

public CmsLazyTreeItem.LoadState getLoadState()

Gets the load state of the tree item.

Returns:

a load state

isLoaded

public boolean isLoaded()

Returns if tree item children have been loaded.

Returns:

true if tree item children have been loaded

onFinishLoading

public void onFinishLoading()

This method should be called when the item's children have finished loading.

onStartLoading

public void onStartLoading()

This method is called when the tree item's children start being loaded.

onChangeChildren

protected void onChangeChildren()

Description copied from class: CmsTreeItem

Helper method which is called when the list of children changes.

Overrides:

onChangeChildren in class CmsTreeItem

See Also:

CmsTreeItem.onChangeChildren()