org.opencms.ade.sitemap.client

类 CmsSitemapView

java.lang.Object

org.opencms.gwt.client.A_CmsEntryPoint

org.opencms.ade.sitemap.client.CmsSitemapView

所有已实现的接口:

com.google.gwt.core.client.EntryPoint, com.google.gwt.event.shared.EventHandler, I_CmsSitemapChangeHandler, I_CmsSitemapLoadHandler

public final class CmsSitemapView
extends A_CmsEntryPoint
implements I_CmsSitemapChangeHandler, I_CmsSitemapLoadHandler

Sitemap editor.

从以下版本开始:

8.0.0

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	CmsSitemapView.EditorMode The sitemap editor modes.
protected class	CmsSitemapView.TreeOpenHandler The sitemap tree open handler.

字段概要

字段

限定符和类型	字段和说明
protected CmsLazyTree<CmsSitemapTreeItem>	m_tree The displayed sitemap tree.

构造器概要

构造器

构造器和说明
CmsSitemapView()

方法概要

方法

限定符和类型	方法和说明
CmsSitemapTreeItem	create(CmsClientSitemapEntry entry) Creates a new tree item from the given sitemap entry.
CmsSitemapTreeItem	createSitemapItem(CmsClientSitemapEntry entry) Creates a sitemap tree item from a client sitemap entry.
void	ensureVisible(CmsSitemapTreeItem item) Ensures the given item is visible in the viewport.
CmsSitemapController	getController() Returns the controller.
CmsSitemapView.EditorMode	getEditorMode() Returns the editor mode.
java.lang.String	getIconForEntry(CmsClientSitemapEntry entry) Returns the icon class for the given entry depending on the editor mode.
static CmsSitemapView	getInstance() Returns the instance.
CmsPair<java.util.List<CmsClientSitemapEntry>,java.util.List<CmsClientSitemapEntry>>	getOpenAndClosedDescendants(java.lang.String path) Gets the list of descendants of a path and splits it into two lists, one containing the sitemap entries whose children have already been loaded, and those whose children haven't been loaded.
protected CmsSitemapTreeItem	getRootItem() Gets the sitemap tree item widget which represents the root of the current sitemap.
CmsSitemapToolbar	getToolbar() Gets the sitemap toolbar.
CmsLazyTree<CmsSitemapTreeItem>	getTree() Returns the tree.
CmsSitemapTreeItem	getTreeItem(CmsUUID entryId) Returns the tree entry with the given path.
CmsSitemapTreeItem	getTreeItem(java.lang.String path) Returns the tree entry with the given path.
void	highlightPath(java.lang.String sitePath) Highlights the sitemap entry with the given path.
boolean	isNavigationMode() Returns if the current sitemap editor mode is navigation.
void	onChange(CmsSitemapChangeEvent changeEvent) Will be triggered when something has changed.
void	onLoad(CmsSitemapLoadEvent event) Will be triggered when an entry loads its children.
void	onModuleLoad()
void	removeDeleted(CmsClientSitemapEntry entry) Removes deleted entry widget reference.
void	setEditorMode(CmsSitemapView.EditorMode editorMode) Sets the editor mode.
void	updateDetailPageView(CmsClientSitemapEntry entry) Updates the detail page view for a given changed entry.
void	updateEntriesById(java.util.Collection<CmsUUID> ids) Updates the entries whose id is in the given list of ids.

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

enableRemoteExceptionHandler

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

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

字段详细资料

m_tree

protected CmsLazyTree<CmsSitemapTreeItem> m_tree

The displayed sitemap tree.

构造器详细资料

CmsSitemapView

public CmsSitemapView()

方法详细资料

getInstance

public static CmsSitemapView getInstance()

Returns the instance.

返回:

the instance

create

public CmsSitemapTreeItem create(CmsClientSitemapEntry entry)

Creates a new tree item from the given sitemap entry.

参数:

entry - the sitemap entry

返回:

the new created (still orphan) tree item

createSitemapItem

public CmsSitemapTreeItem createSitemapItem(CmsClientSitemapEntry entry)

Creates a sitemap tree item from a client sitemap entry.

参数:

entry - the entry from which the sitemap tree item should be created

返回:

the new sitemap tree item

ensureVisible

public void ensureVisible(CmsSitemapTreeItem item)

Ensures the given item is visible in the viewport.

参数:

item - the item to see

getController

public CmsSitemapController getController()

Returns the controller.

返回:

the controller

getEditorMode

public CmsSitemapView.EditorMode getEditorMode()

Returns the editor mode.

返回:

the editor mode

getIconForEntry

public java.lang.String getIconForEntry(CmsClientSitemapEntry entry)

Returns the icon class for the given entry depending on the editor mode.

参数:

entry - the entry to get the icon for

返回:

the icon CSS class

getOpenAndClosedDescendants

public CmsPair<java.util.List<CmsClientSitemapEntry>,java.util.List<CmsClientSitemapEntry>> getOpenAndClosedDescendants(java.lang.String path)

Gets the list of descendants of a path and splits it into two lists, one containing the sitemap entries whose children have already been loaded, and those whose children haven't been loaded.

参数:

path - the path for which the open and closed descendants should be returned

返回:

a pair whose first and second components are lists of open and closed descendant entries of the path, respectively

getToolbar

public CmsSitemapToolbar getToolbar()

Gets the sitemap toolbar.

返回:

the sitemap toolbar

getTree

public CmsLazyTree<CmsSitemapTreeItem> getTree()

Returns the tree.

返回:

the tree

getTreeItem

public CmsSitemapTreeItem getTreeItem(CmsUUID entryId)

Returns the tree entry with the given path.

参数:

entryId - the id of the sitemap entry

返回:

the tree entry with the given path, or null if not found

getTreeItem

public CmsSitemapTreeItem getTreeItem(java.lang.String path)

Returns the tree entry with the given path.

参数:

path - the path to look for

返回:

the tree entry with the given path, or null if not found

highlightPath

public void highlightPath(java.lang.String sitePath)

Highlights the sitemap entry with the given path.

参数:

sitePath - the sitemap path of the entry to highlight

isNavigationMode

public boolean isNavigationMode()

Returns if the current sitemap editor mode is navigation.

返回:

true if the current sitemap editor mode is navigation

onChange

public void onChange(CmsSitemapChangeEvent changeEvent)

从接口复制的说明: I_CmsSitemapChangeHandler

Will be triggered when something has changed.

指定者:

onChange 在接口中 I_CmsSitemapChangeHandler

参数:

changeEvent - the specific change event

另请参阅:

I_CmsSitemapChangeHandler.onChange(org.opencms.ade.sitemap.client.control.CmsSitemapChangeEvent)

onLoad

public void onLoad(CmsSitemapLoadEvent event)

从接口复制的说明: I_CmsSitemapLoadHandler

Will be triggered when an entry loads its children.

指定者:

onLoad 在接口中 I_CmsSitemapLoadHandler

参数:

event - the event

另请参阅:

I_CmsSitemapLoadHandler.onLoad(org.opencms.ade.sitemap.client.control.CmsSitemapLoadEvent)

onModuleLoad

public void onModuleLoad()

指定者:

onModuleLoad 在接口中 com.google.gwt.core.client.EntryPoint

覆盖:

onModuleLoad 在类中 A_CmsEntryPoint

另请参阅:

EntryPoint.onModuleLoad()

removeDeleted

public void removeDeleted(CmsClientSitemapEntry entry)

Removes deleted entry widget reference.

参数:

entry - the entry being deleted

setEditorMode

public void setEditorMode(CmsSitemapView.EditorMode editorMode)

Sets the editor mode.

参数:

editorMode - the editor mode to set

updateDetailPageView

public void updateDetailPageView(CmsClientSitemapEntry entry)

Updates the detail page view for a given changed entry.

参数:

entry - the entry which was changed

updateEntriesById

public void updateEntriesById(java.util.Collection<CmsUUID> ids)

Updates the entries whose id is in the given list of ids.

参数:

ids - a list of sitemap entry ids

getRootItem

protected CmsSitemapTreeItem getRootItem()

Gets the sitemap tree item widget which represents the root of the current sitemap.

返回:

the root sitemap tree item widget