Package org.opencms.ade.galleries.client

Class CmsSitemapTabHandler

java.lang.Object

org.opencms.ade.galleries.client.A_CmsTabHandler

org.opencms.ade.galleries.client.CmsSitemapTabHandler

All Implemented Interfaces:

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.

Since:

8.5.0

Field Summary

Fields inherited from class org.opencms.ade.galleries.client.A_CmsTabHandler

m_controller

Constructor Summary

Constructors

Constructor	Description
CmsSitemapTabHandler(CmsGalleryController controller)	Creates a new sitemap tab handler.

Method Summary

Modifier and Type	Method	Description
void	clearParams()	Clears the search parameters of this tab.
String	getDefaultSelectedSiteRoot()	Gets the selected site root.
String	getSelectPath(org.opencms.ade.galleries.shared.CmsSitemapEntryBean sitemapEntry)	Gets the path which is used when the sitemap entry is selected.
LinkedHashMap<String,String>	getSortList()	Gets the select options for the sort list.
void	getSubEntries(String rootPath, boolean isRoot, I_CmsSimpleCallback<List<org.opencms.ade.galleries.shared.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(Set<org.opencms.util.CmsUUID> openItemIds)	This method is called when the tree open state changes.
void	onSelection()	Will be triggered when the tab is selected.
void	onSort(String sortParams, String filter)	Sorts the list, if present.
void	removeParam(String paramKey)	Removes the search parameter with the given key from the search object.
protected void	setSiteRoot(String siteRoot)	Setter for the site root attribute.

Methods inherited from class org.opencms.ade.galleries.client.A_CmsTabHandler

addSearchChangeHandler, getGalleryInfo, getTypeInfo, onClose, onDeselection, selectResource, selectResultTab, setSearchQuery, updateIndex, updateSize

Methods inherited from class java.lang.Object

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

Constructor Details

CmsSitemapTabHandler

public CmsSitemapTabHandler(CmsGalleryController controller)

Creates a new sitemap tab handler.

Parameters:

controller - the gallery controller

Method Details

clearParams

public void clearParams()

Description copied from class: A_CmsTabHandler

Clears the search parameters of this tab.

Specified by:

clearParams in class A_CmsTabHandler

See Also:

• A_CmsTabHandler.clearParams()

getDefaultSelectedSiteRoot

public String getDefaultSelectedSiteRoot()

Gets the selected site root.

Returns:

the selected site root

getSelectPath

public String getSelectPath(org.opencms.ade.galleries.shared.CmsSitemapEntryBean sitemapEntry)

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

Parameters:

sitemapEntry - the sitemap entry

Returns:

the path to use when the entry is selected

getSortList

public LinkedHashMap<String,String> getSortList()

Gets the select options for the sort list.

Returns:

the select options for the sort list

getSubEntries

public void getSubEntries(String rootPath,
 boolean isRoot,
 I_CmsSimpleCallback<List<org.opencms.ade.galleries.shared.CmsSitemapEntryBean>> callback)

Loads the sub entries for the given path.

Parameters:

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.

Returns:

true if this tab should offer select resource buttons

initializeSitemapTab

public void initializeSitemapTab()

Initializes the sitemap tab's content.

onChangeTreeState

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

This method is called when the tree open state changes.

Parameters:

openItemIds - the structure ids of open entries

onSelection

public void onSelection()

Description copied from class: A_CmsTabHandler

Will be triggered when the tab is selected.

Specified by:

onSelection in class A_CmsTabHandler

See Also:

• A_CmsTabHandler.onSelection()

onSort

public void onSort(String sortParams,
 String filter)

Description copied from class: A_CmsTabHandler

Sorts the list, if present.

Specified by:

onSort in class A_CmsTabHandler

Parameters:

sortParams - the sort parameters

filter - the filter phrase

See Also:

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

removeParam

public void removeParam(String paramKey)

Description copied from class: A_CmsTabHandler

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

Specified by:

removeParam in class A_CmsTabHandler

Parameters:

paramKey - the parameter key

See Also:

• A_CmsTabHandler.removeParam(java.lang.String)

getTab

protected CmsSitemapTab getTab()

Returns the sitemap tab.

Returns:

the sitemap tab

setSiteRoot

protected void setSiteRoot(String siteRoot)

Setter for the site root attribute.

Parameters:

siteRoot - the new value for the site root attribute