org.opencms.ade.sitemap.client

类 CmsSitemapTreeItem

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

org.opencms.ade.sitemap.client.CmsSitemapTreeItem

所有已实现的接口:

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

public class CmsSitemapTreeItem
extends CmsLazyTreeItem

Sitemap entry tree item implementation.

从以下版本开始:

8.0.0

另请参阅:

CmsLazyTreeItem, CmsClientSitemapEntry

嵌套类概要

嵌套类

限定符和类型	类和说明
protected class	CmsSitemapTreeItem.DetailPageLabelTitleGenerator Label generator for the detail page info label.

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

CmsLazyTreeItem.LoadingItem, CmsLazyTreeItem.LoadState

从类继承的嵌套类/接口 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

字段概要

字段

限定符和类型	字段和说明
protected CmsUUID	m_entryId The current sitemap entry id.

从类继承的字段 org.opencms.gwt.client.ui.tree.CmsTreeItem

ANIMATION_DURATION, m_children, m_opener

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

构造器概要

构造器

构造器和说明
CmsSitemapTreeItem(CmsClientSitemapEntry entry) Default constructor.

方法概要

方法

限定符和类型	方法和说明
protected static void	addInfo(java.util.List<CmsAdditionalInfoBean> infos, java.lang.String label, java.lang.String value) Helper method to add an additional info bean to a list.
protected com.google.gwt.user.client.ui.Widget	addMarker(java.lang.String text) Helper method for adding the marker widget.
java.lang.String	getDisplayedUrl(java.lang.String sitePath) Given the path of a sitemap entry, this method returns the URL which should be displayed to the user.
com.google.gwt.dom.client.Element	getDragHelper(I_CmsDropTarget target) Creates the drag helper element and attaches it into the DOM.
CmsUUID	getEntryId() Returns the entry id.
static CmsSitemapTreeItem	getItemById(CmsUUID id) Looks up a sitemap tree item by entry id.
I_CmsDragHandle	getMoveHandle() Returns the move handle.
protected java.lang.String	getName(java.lang.String sitePath) Return the name of this item, which can differ from the entry name for root nodes.
java.lang.String	getPath() Returns the path of IDs for the this item.
CmsClientSitemapEntry	getSitemapEntry() Returns the sitemap entry.
java.lang.String	getSitePath() Returns the site path.
void	highlight(boolean highlightOn) Turns the highlighting for this item on or off.
void	highlightTemporarily(int duration, CmsListItemWidget.Background background) Temporarily highlights an item.
boolean	isDropEnabled() Checks if dropping is enabled.
protected void	onChangeChildren() Helper method which is called when the list of children changes.
void	onDragCancel() Executed on drag cancel.
void	onDrop(I_CmsDropTarget target) Executed on drop.
void	onStartDrag(I_CmsDropTarget target) Executed on drag start.
protected void	removeInvalidChildren() Helper method to remove invalid children that don't have a corresponding CmsSitemapClientEntry.
void	resetEntry() Resets entry appearance.
void	setBackgroundColor(CmsListItemWidget.Background background) Sets the background color of the list item widget.
void	setStateIcon(CmsListInfoBean.StateIcon icon) Sets the icon.
java.lang.String	toString()
void	updateDetailPageStatus() Updates the detail page description.
void	updateEditorMode() Updates the sitemap editor mode.
void	updateEntry(CmsClientSitemapEntry entry) Refreshes the displayed data from the given sitemap entry.
void	updateInNavigation(CmsClientSitemapEntry entry) Updates the in navigation properties of the displayed entry.
void	updateSitePath() Updates the site path using the current site entry's data.
void	updateSitePath(java.lang.String sitePath) Updates the recursively the site path.

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

getLoadingImage, getLoadState, isLoaded, onFinishLoading, onStartLoading

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

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

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

addCheckBox, addDecoration, addDecorationWidget, addMainWidget, cloneForPlaceholder, getCheckBox, getData, getDecorationWidgets, getId, getListItemWidget, getMainWidget, getParentList, getPlaceholder, initContent, initContent, initContent, initMoveHandle, initMoveHandle, 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, unsinkEvents

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

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

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

getElement

字段详细资料

m_entryId

protected CmsUUID m_entryId

The current sitemap entry id.

构造器详细资料

CmsSitemapTreeItem

public CmsSitemapTreeItem(CmsClientSitemapEntry entry)

Default constructor.

参数:

entry - the sitemap entry

方法详细资料

getItemById

public static CmsSitemapTreeItem getItemById(CmsUUID id)

Looks up a sitemap tree item by entry id.

参数:

id - the sitemap entry id

返回:

the corresponding sitemap tree item, or null if there is none

addInfo

protected static void addInfo(java.util.List<CmsAdditionalInfoBean> infos,
           java.lang.String label,
           java.lang.String value)

Helper method to add an additional info bean to a list.

参数:

infos - the list of additional info beans

label - the label for the new bean

value - the value for the new bean

getDisplayedUrl

public java.lang.String getDisplayedUrl(java.lang.String sitePath)

Given the path of a sitemap entry, this method returns the URL which should be displayed to the user.

参数:

sitePath - the site path of a sitemap entry

返回:

the URL which should be displayed to the user

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 在类中 CmsTreeItem

参数:

target - the drop target

返回:

the drag helper element

另请参阅:

I_CmsDraggable.getDragHelper(I_CmsDropTarget)

getEntryId

public CmsUUID getEntryId()

Returns the entry id.

返回:

the entry id

getMoveHandle

public I_CmsDragHandle getMoveHandle()

从类复制的说明: CmsListItem

Returns the move handle.

覆盖:

getMoveHandle 在类中 CmsListItem

返回:

the move handle

另请参阅:

CmsListItem.getMoveHandle()

getPath

public java.lang.String getPath()

从类复制的说明: CmsTreeItem

Returns the path of IDs for the this item.

覆盖:

getPath 在类中 CmsTreeItem

返回:

a path of IDs separated by slash

另请参阅:

CmsTreeItem.getPath()

getSitemapEntry

public CmsClientSitemapEntry getSitemapEntry()

Returns the sitemap entry.

返回:

the sitemap entry

getSitePath

public java.lang.String getSitePath()

Returns the site path.

返回:

the site path

highlight

public void highlight(boolean highlightOn)

Turns the highlighting for this item on or off.

参数:

highlightOn - if true, the highlighting is turned on, else off

highlightTemporarily

public void highlightTemporarily(int duration,
                        CmsListItemWidget.Background background)

Temporarily highlights an item.

参数:

duration - the duration for which

background - the background to color to set when finished

isDropEnabled

public boolean isDropEnabled()

从类复制的说明: CmsTreeItem

Checks if dropping is enabled.

覆盖:

isDropEnabled 在类中 CmsTreeItem

返回:

true if dropping is enabled

另请参阅:

CmsTreeItem.isDropEnabled()

onDragCancel

public void onDragCancel()

从接口复制的说明: I_CmsDraggable

Executed on drag cancel.

指定者:

onDragCancel 在接口中 I_CmsDraggable

覆盖:

onDragCancel 在类中 CmsTreeItem

另请参阅:

I_CmsDraggable.onDragCancel()

onDrop

public void onDrop(I_CmsDropTarget target)

从接口复制的说明: I_CmsDraggable

Executed on drop.

指定者:

onDrop 在接口中 I_CmsDraggable

覆盖:

onDrop 在类中 CmsListItem

参数:

target - the drop target

另请参阅:

I_CmsDraggable.onDrop(org.opencms.gwt.client.dnd.I_CmsDropTarget)

onStartDrag

public void onStartDrag(I_CmsDropTarget target)

从接口复制的说明: I_CmsDraggable

Executed on drag start.

指定者:

onStartDrag 在接口中 I_CmsDraggable

覆盖:

onStartDrag 在类中 CmsListItem

参数:

target - the current drop target

另请参阅:

CmsListItem.onStartDrag(org.opencms.gwt.client.dnd.I_CmsDropTarget)

resetEntry

public void resetEntry()

Resets entry appearance.

setBackgroundColor

public void setBackgroundColor(CmsListItemWidget.Background background)

Sets the background color of the list item widget.

If the background is null, the widget will be shown with its default style.

参数:

background - the background color to set

setStateIcon

public void setStateIcon(CmsListInfoBean.StateIcon icon)

Sets the icon.

参数:

icon - the icon to set

toString

public java.lang.String toString()

覆盖:

toString 在类中 com.google.gwt.user.client.ui.UIObject

另请参阅:

UIObject.toString()

updateDetailPageStatus

public void updateDetailPageStatus()

Updates the detail page description.

updateEditorMode

public void updateEditorMode()

Updates the sitemap editor mode.

updateEntry

public void updateEntry(CmsClientSitemapEntry entry)

Refreshes the displayed data from the given sitemap entry.

参数:

entry - the sitemap entry to update

updateInNavigation

public void updateInNavigation(CmsClientSitemapEntry entry)

Updates the in navigation properties of the displayed entry.

参数:

entry - the sitemap entry

updateSitePath

public void updateSitePath()

Updates the site path using the current site entry's data.

updateSitePath

public void updateSitePath(java.lang.String sitePath)

Updates the recursively the site path.

参数:

sitePath - the new site path to set

addMarker

protected com.google.gwt.user.client.ui.Widget addMarker(java.lang.String text)

Helper method for adding the marker widget.

参数:

text - the text for the marker widget

返回:

the new marker widget

getName

protected java.lang.String getName(java.lang.String sitePath)

Return the name of this item, which can differ from the entry name for root nodes.

参数:

sitePath - the sitemap entry's site path

返回:

the name

onChangeChildren

protected void onChangeChildren()

从类复制的说明: CmsTreeItem

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

覆盖:

onChangeChildren 在类中 CmsLazyTreeItem

另请参阅:

CmsLazyTreeItem.onChangeChildren()

removeInvalidChildren

protected void removeInvalidChildren()

Helper method to remove invalid children that don't have a corresponding CmsSitemapClientEntry.