org.opencms.ade.galleries.client

类 CmsSitemapTabHandler

java.lang.Object

org.opencms.ade.galleries.client.A_CmsTabHandler

org.opencms.ade.galleries.client.CmsSitemapTabHandler

所有已实现的接口:

com.google.gwt.event.logical.shared.CloseHandler<com.google.gwt.user.client.ui.PopupPanel>, com.google.gwt.event.shared.EventHandler

public class CmsSitemapTabHandler
extends A_CmsTabHandler

Handler class for the sitemap tree tab.

从以下版本开始:

8.5.0

字段概要

从类继承的字段 org.opencms.ade.galleries.client.A_CmsTabHandler

m_controller

构造器概要

构造器

构造器和说明
CmsSitemapTabHandler(CmsGalleryController controller) Creates a new sitemap tab handler.

方法概要

方法

限定符和类型	方法和说明
void	clearParams() Clears the search parameters of this tab.
java.lang.String	getDefaultSelectedSiteRoot() Gets the selected site root.
java.lang.String	getSelectPath(CmsSitemapEntryBean sitemapEntry) Gets the path which is used when the sitemap entry is selected.
java.util.LinkedHashMap<java.lang.String,java.lang.String>	getSortList() Gets the select options for the sort list.
void	getSubEntries(java.lang.String rootPath, boolean isRoot, I_CmsSimpleCallback<java.util.List<CmsSitemapEntryBean>> callback) Loads the sub entries for the given path.
protected CmsSitemapTab	getTab() Returns the sitemap tab.
boolean	hasSelectResource() Returns if this tab should offer select resource buttons.
void	initializeSitemapTab() Initializes the sitemap tab's content.
void	onChangeTreeState(java.util.Set<CmsUUID> openItemIds) This method is called when the tree open state changes.
void	onSelection() Will be triggered when the tab is selected.
void	onSort(java.lang.String sortParams, java.lang.String filter) Sorts the list, if present.
void	removeParam(java.lang.String paramKey) Removes the search parameter with the given key from the search object.
protected void	setSiteRoot(java.lang.String siteRoot) Setter for the site root attribute.

从类继承的方法 org.opencms.ade.galleries.client.A_CmsTabHandler

addSearchChangeHandler, onClose, onDeselection, selectResource, selectResultTab, setSearchQuery, updateIndex

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

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

构造器详细资料

CmsSitemapTabHandler

public CmsSitemapTabHandler(CmsGalleryController controller)

Creates a new sitemap tab handler.

参数:

controller - the gallery controller

方法详细资料

clearParams

public void clearParams()

从类复制的说明: A_CmsTabHandler

Clears the search parameters of this tab.

指定者:

clearParams 在类中 A_CmsTabHandler

另请参阅:

A_CmsTabHandler.clearParams()

getDefaultSelectedSiteRoot

public java.lang.String getDefaultSelectedSiteRoot()

Gets the selected site root.

返回:

the selected site root

getSelectPath

public java.lang.String getSelectPath(CmsSitemapEntryBean sitemapEntry)

Gets the path which is used when the sitemap entry is selected.

参数:

sitemapEntry - the sitemap entry

返回:

the path to use when the entry is selected

getSortList

public java.util.LinkedHashMap<java.lang.String,java.lang.String> getSortList()

Gets the select options for the sort list.

返回:

the select options for the sort list

getSubEntries

public void getSubEntries(java.lang.String rootPath,
                 boolean isRoot,
                 I_CmsSimpleCallback<java.util.List<CmsSitemapEntryBean>> callback)

Loads the sub entries for the given path.

参数:

rootPath - the root path

isRoot - true if the requested entry is the root entry

callback - the callback to execute with the result

hasSelectResource

public boolean hasSelectResource()

Returns if this tab should offer select resource buttons.

返回:

true if this tab should offer select resource buttons

initializeSitemapTab

public void initializeSitemapTab()

Initializes the sitemap tab's content.

onChangeTreeState

public void onChangeTreeState(java.util.Set<CmsUUID> openItemIds)

This method is called when the tree open state changes.

参数:

openItemIds - the structure ids of open entries

onSelection

public void onSelection()

从类复制的说明: A_CmsTabHandler

Will be triggered when the tab is selected.

指定者:

onSelection 在类中 A_CmsTabHandler

另请参阅:

A_CmsTabHandler.onSelection()

onSort

public void onSort(java.lang.String sortParams,
          java.lang.String filter)

从类复制的说明: A_CmsTabHandler

Sorts the list, if present.

指定者:

onSort 在类中 A_CmsTabHandler

参数:

sortParams - the sort parameters

filter - the filter phrase

另请参阅:

A_CmsTabHandler.onSort(java.lang.String, java.lang.String)

removeParam

public void removeParam(java.lang.String paramKey)

从类复制的说明: A_CmsTabHandler

Removes the search parameter with the given key from the search object.

指定者:

removeParam 在类中 A_CmsTabHandler

参数:

paramKey - the parameter key

另请参阅:

A_CmsTabHandler.removeParam(java.lang.String)

getTab

protected CmsSitemapTab getTab()

Returns the sitemap tab.

返回:

the sitemap tab

setSiteRoot

protected void setSiteRoot(java.lang.String siteRoot)

Setter for the site root attribute.

参数:

siteRoot - the new value for the site root attribute