org.opencms.gwt.client.ui.tree

类 CmsTreeItem

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

所有已实现的接口:

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

直接已知子类:

CmsLazyTreeItem, CmsLazyTreeItem.LoadingItem

public class CmsTreeItem
extends CmsListItem

List tree item implementation.

Implemented as:

 <li class='listTreeItem listTreeItem*state*'>
   <span class='listTreeItemImage'></span>
   <div class='listTreeItemContent'>...*content*</div>
   <ul class='listTreeItemChildren'>
      *children*
   </ul>
 </li>
 

Where state can be opened, closed or leaf.

从以下版本开始:

8.0.0

嵌套类概要

从类继承的嵌套类/接口 org.opencms.gwt.client.ui.CmsListItem

CmsListItem.MoveHandle

从类继承的嵌套类/接口 com.google.gwt.user.client.ui.UIObject

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

字段概要

字段

限定符和类型	字段和说明
static int	ANIMATION_DURATION The duration of the animations.
protected CmsList<CmsTreeItem>	m_children The children list.
protected CmsToggleButton	m_opener The element showing the open/close icon.

从类继承的字段 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

从类继承的字段 com.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

构造器概要

构造器

限定符	构造器和说明
protected	CmsTreeItem(boolean showOpeners) Default constructor.
	CmsTreeItem(boolean showOpeners, CmsCheckBox checkbox, com.google.gwt.user.client.ui.Widget mainWidget) Creates a new list tree item containing a main widget and a check box.
	CmsTreeItem(boolean showOpeners, com.google.gwt.user.client.ui.Widget mainWidget) Creates a new list tree item containing a main widget.
	CmsTreeItem(boolean showOpeners, com.google.gwt.user.client.ui.Widget mainWidget, java.lang.String icon) Creates a new tree item with a 24px wide icon.

方法概要

方法

限定符和类型	方法和说明
void	add(com.google.gwt.user.client.ui.Widget w) Unsupported operation.
void	addChild(CmsTreeItem item) Adds a child list item.
protected void	adopt(CmsTreeItem item) Adopts the given item.
void	clear()
void	clearChildren() Removes all children.
void	closeAllEmptyChildren() Closes all empty child entries.
protected CmsToggleButton	createOpener() Creates the button for opening/closing this item.
protected void	executeOpen(boolean fireEvents) Executes the open call.
protected void	fireClose() Fires the close event.
protected void	fireOpen() Fires the open event on the tree.
CmsTreeItem	getChild(int index) Returns the child tree item at the given position.
CmsTreeItem	getChild(java.lang.String itemId) Returns the tree item with the given id.
int	getChildCount() Helper method which gets the number of children.
CmsList<? extends I_CmsListItem>	getChildren() Returns the children of this list item.
com.google.gwt.dom.client.Element	getDragHelper(I_CmsDropTarget target) Creates the drag helper element and attaches it into the DOM.
int	getItemPosition(CmsTreeItem item) Returns the given item position.
protected static CmsTreeItem	getLastOpenedItem(CmsTreeItem item, int stopLevel, boolean requiresDropEnabled) Returns the last opened item of a tree fragment.
protected com.google.gwt.user.client.ui.Image	getMinusImage() The '-' image.
CmsTreeItem	getParentItem() Returns the parent item.
I_CmsDropTarget	getParentTarget() Returns the parent drop target or null if there is none.
java.lang.String	getPath() Returns the path of IDs for the this item.
protected static int	getPathLevel(java.lang.String path) Method determining the path level by counting the number of '/'.
protected com.google.gwt.user.client.ui.Image	getPlusImage() The '+' image.
CmsTree<CmsTreeItem>	getTree() Gets the tree to which this tree item belongs, or null if it does not belong to a tree.
void	hideOpeners() Hides the open/close icons for this tree item and its descendants.
void	insertChild(CmsTreeItem item, int position) Inserts the given item at the given position.
protected int	insertPlaceholderAsLastChild(com.google.gwt.dom.client.Element placeholder) Inserts the placeholder element as last child of the children list.
boolean	isDropEnabled() Checks if dropping is enabled.
boolean	isOpen() Checks if the item is open or closed.
protected void	onChangeChildren() Helper method which is called when the list of children changes.
void	onDragCancel() Executed on drag cancel.
CmsTreeItem	removeChild(CmsTreeItem item) Removes an item from the list.
CmsTreeItem	removeChild(int index) Removes the item identified by the given index from the list.
CmsTreeItem	removeChild(java.lang.String itemId) Removes an item from the list.
void	removeOpener() Removes the opener widget.
int	repositionPlaceholder(int x, int y, com.google.gwt.dom.client.Element placeholder, CmsDNDHandler.Orientation orientation) Positions the drag and drop placeholder as a sibling or descendant of this element.
void	setDropEnabled(boolean enabled) Enables/disables dropping.
void	setLeafStyle(boolean isLeaf) Sets the tree item style to leaf, hiding the list opener.
void	setOpen(boolean open) Opens or closes this tree item (i.e. shows or hides its descendants).
void	setOpen(boolean open, boolean fireEvents) Opens or closes this tree item (i.e. shows or hides its descendants).
void	setParentItem(CmsTreeItem parentItem) Sets the parent item.
void	setTree(CmsTree<CmsTreeItem> tree) Sets the tree to which this tree item belongs.
void	showOpeners() Shows the open/close icons for this tree item and its descendants.

从类继承的方法 org.opencms.gwt.client.ui.CmsListItem

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

从类继承的方法 com.google.gwt.user.client.ui.Composite

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

从类继承的方法 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

从类继承的方法 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, unsinkEvents

从类继承的方法 java.lang.Object

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

从接口继承的方法 org.opencms.gwt.client.dnd.I_CmsDraggable

getElement

字段详细资料

ANIMATION_DURATION

public static final int ANIMATION_DURATION

The duration of the animations.

另请参阅:

常量字段值

m_children

protected CmsList<CmsTreeItem> m_children

The children list.

m_opener

protected CmsToggleButton m_opener

The element showing the open/close icon.

构造器详细资料

CmsTreeItem

public CmsTreeItem(boolean showOpeners,
           CmsCheckBox checkbox,
           com.google.gwt.user.client.ui.Widget mainWidget)

Creates a new list tree item containing a main widget and a check box.

参数:

showOpeners - if true, show open/close icons

checkbox - the check box

mainWidget - the main widget

CmsTreeItem

public CmsTreeItem(boolean showOpeners,
           com.google.gwt.user.client.ui.Widget mainWidget)

Creates a new list tree item containing a main widget.

参数:

showOpeners - if true, show open/close icons

mainWidget - the main widget

CmsTreeItem

public CmsTreeItem(boolean showOpeners,
           com.google.gwt.user.client.ui.Widget mainWidget,
           java.lang.String icon)

Creates a new tree item with a 24px wide icon.

参数:

showOpeners - if true, show open/close icons

mainWidget - the main widget

icon - the icon style name

CmsTreeItem

protected CmsTreeItem(boolean showOpeners)

Default constructor.

参数:

showOpeners - if true, the opener icons should be shown

方法详细资料

getLastOpenedItem

protected static CmsTreeItem getLastOpenedItem(CmsTreeItem item,
                            int stopLevel,
                            boolean requiresDropEnabled)

Returns the last opened item of a tree fragment.

参数:

item - the tree item

stopLevel - the level to stop at, set -1 to go to the very last opened item

requiresDropEnabled - true if it is required the returned element to be drop enabled

返回:

the last visible item of a tree fragment

getPathLevel

protected static int getPathLevel(java.lang.String path)

Method determining the path level by counting the number of '/'.

Example: '/xxx/xxx/' has a path-level of 2.

参数:

path - the path to test

返回:

the path level

add

public void add(com.google.gwt.user.client.ui.Widget w)

Unsupported operation.

指定者:

add 在接口中 I_CmsListItem

覆盖:

add 在类中 CmsListItem

参数:

w - the widget to add

另请参阅:

CmsListItem.add(com.google.gwt.user.client.ui.Widget)

addChild

public void addChild(CmsTreeItem item)

Adds a child list item.

参数:

item - the child to add

另请参阅:

CmsList.addItem(org.opencms.gwt.client.ui.I_CmsListItem)

clear

public void clear()

另请参阅:

HasWidgets.clear()

clearChildren

public void clearChildren()

Removes all children.

另请参阅:

CmsList.clearList()

closeAllEmptyChildren

public void closeAllEmptyChildren()

Closes all empty child entries.

getChild

public CmsTreeItem getChild(int index)

Returns the child tree item at the given position.

参数:

index - the position

返回:

the tree item

另请参阅:

CmsList.getItem(int)

getChild

public CmsTreeItem getChild(java.lang.String itemId)

Returns the tree item with the given id.

参数:

itemId - the id of the item to retrieve

返回:

the tree item

另请参阅:

CmsList.getItem(String)

getChildCount

public int getChildCount()

Helper method which gets the number of children.

返回:

the number of children

另请参阅:

ComplexPanel.getWidgetCount()

getChildren

public CmsList<? extends I_CmsListItem> getChildren()

Returns the children of this list item.

返回:

the children list

getDragHelper

public com.google.gwt.dom.client.Element getDragHelper(I_CmsDropTarget target)

从接口复制的说明: I_CmsDraggable

Creates the drag helper element and attaches it into the DOM.

指定者:

getDragHelper 在接口中 I_CmsDraggable

覆盖:

getDragHelper 在类中 CmsListItem

参数:

target - the drop target

返回:

the drag helper element

另请参阅:

I_CmsDraggable.getDragHelper(I_CmsDropTarget)

getItemPosition

public int getItemPosition(CmsTreeItem item)

Returns the given item position.

参数:

item - the item to get the position for

返回:

the item position

getParentItem

public CmsTreeItem getParentItem()

Returns the parent item.

返回:

the parent item

getParentTarget

public I_CmsDropTarget getParentTarget()

从接口复制的说明: I_CmsDraggable

Returns the parent drop target or null if there is none.

指定者:

getParentTarget 在接口中 I_CmsDraggable

覆盖:

getParentTarget 在类中 CmsListItem

返回:

the parent drop target

另请参阅:

CmsListItem.getParentTarget()

getPath

public java.lang.String getPath()

Returns the path of IDs for the this item.

返回:

a path of IDs separated by slash

getTree

public CmsTree<CmsTreeItem> getTree()

Gets the tree to which this tree item belongs, or null if it does not belong to a tree.

返回:

a tree or null

hideOpeners

public void hideOpeners()

Hides the open/close icons for this tree item and its descendants.

insertChild

public void insertChild(CmsTreeItem item,
               int position)

Inserts the given item at the given position.

参数:

item - the item to insert

position - the position

另请参阅:

CmsList.insertItem(org.opencms.gwt.client.ui.I_CmsListItem, int)

isDropEnabled

public boolean isDropEnabled()

Checks if dropping is enabled.

返回:

true if dropping is enabled

isOpen

public boolean isOpen()

Checks if the item is open or closed.

返回:

true if open

onDragCancel

public void onDragCancel()

从接口复制的说明: I_CmsDraggable

Executed on drag cancel.

指定者:

onDragCancel 在接口中 I_CmsDraggable

覆盖:

onDragCancel 在类中 CmsListItem

另请参阅:

I_CmsDraggable.onDragCancel()

removeChild

public CmsTreeItem removeChild(CmsTreeItem item)

Removes an item from the list.

参数:

item - the item to remove

返回:

the removed item

另请参阅:

CmsList.removeItem(org.opencms.gwt.client.ui.I_CmsListItem)

removeChild

public CmsTreeItem removeChild(int index)

Removes the item identified by the given index from the list.

参数:

index - the index of the item to remove

返回:

the removed item

另请参阅:

ComplexPanel.remove(int)

removeChild

public CmsTreeItem removeChild(java.lang.String itemId)

Removes an item from the list.

参数:

itemId - the id of the item to remove

返回:

the removed item

另请参阅:

CmsList.removeItem(String)

removeOpener

public void removeOpener()

Removes the opener widget.

repositionPlaceholder

public int repositionPlaceholder(int x,
                        int y,
                        com.google.gwt.dom.client.Element placeholder,
                        CmsDNDHandler.Orientation orientation)

Positions the drag and drop placeholder as a sibling or descendant of this element.

参数:

x - the cursor client x position

y - the cursor client y position

placeholder - the placeholder

orientation - the drag and drop orientation

返回:

the placeholder index

setDropEnabled

public void setDropEnabled(boolean enabled)

Enables/disables dropping.

参数:

enabled - true to enable, or false to disable

setLeafStyle

public void setLeafStyle(boolean isLeaf)

Sets the tree item style to leaf, hiding the list opener.

参数:

isLeaf - true to set to leaf style

setOpen

public void setOpen(boolean open)

Opens or closes this tree item (i.e. shows or hides its descendants).

参数:

open - if true, open the tree item, else close it

setOpen

public void setOpen(boolean open,
           boolean fireEvents)

Opens or closes this tree item (i.e. shows or hides its descendants).

参数:

open - if true, open the tree item, else close it

fireEvents - true if the open/close events should be fired

setParentItem

public void setParentItem(CmsTreeItem parentItem)

Sets the parent item.

参数:

parentItem - the parent item to set

setTree

public void setTree(CmsTree<CmsTreeItem> tree)

Sets the tree to which this tree item belongs.

This is automatically called when this tree item or one of its ancestors is inserted into a tree.

参数:

tree - the tree into which the item has been inserted

showOpeners

public void showOpeners()

Shows the open/close icons for this tree item and its descendants.

adopt

protected void adopt(CmsTreeItem item)

Adopts the given item.

参数:

item - the item to adopt

createOpener

protected CmsToggleButton createOpener()

Creates the button for opening/closing this item.

返回:

a button

executeOpen

protected void executeOpen(boolean fireEvents)

Executes the open call.

参数:

fireEvents - if true, open/close events will be fired

fireClose

protected void fireClose()

Fires the close event.

fireOpen

protected void fireOpen()

Fires the open event on the tree.

getMinusImage

protected com.google.gwt.user.client.ui.Image getMinusImage()

The '-' image.

返回:

the minus image

getPlusImage

protected com.google.gwt.user.client.ui.Image getPlusImage()

The '+' image.

返回:

the plus image

insertPlaceholderAsLastChild

protected int insertPlaceholderAsLastChild(com.google.gwt.dom.client.Element placeholder)

Inserts the placeholder element as last child of the children list. Setting it's path as the current placeholder path and returning the new index.

参数:

placeholder - the placeholder element

返回:

the new index

onChangeChildren

protected void onChangeChildren()

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