Package org.opencms.ade.galleries.client.ui

Class CmsSitemapTab

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.ade.galleries.client.ui.A_CmsTab

org.opencms.ade.galleries.client.ui.A_CmsListTab

org.opencms.ade.galleries.client.ui.CmsSitemapTab

All Implemented Interfaces:

com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.logical.shared.ValueChangeHandler<java.lang.String>, com.google.gwt.event.shared.EventHandler, 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_CmsTruncable

public class CmsSitemapTab
extends A_CmsListTab

The tab widget for selecting sitemap entries.

Since:

8.5.0

Nested Class Summary

Nested classes/interfaces inherited from class org.opencms.ade.galleries.client.ui.A_CmsListTab

A_CmsListTab.A_SelectionHandler, A_CmsListTab.SelectHandler

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

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

Field Summary

Fields inherited from class org.opencms.ade.galleries.client.ui.A_CmsListTab

DIALOG_CSS, m_infoLabel, m_list, m_options, m_quickSearch, m_scrollList, m_searchButton, m_sortSelectBox, m_tab

Fields inherited from class org.opencms.ade.galleries.client.ui.A_CmsTab

m_tabTextAccessor

Fields inherited from class com.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor	Description
CmsSitemapTab(CmsSitemapTabHandler handler)	Constructor.

Method Summary

Modifier and Type	Method	Description
protected void	clear()	Clears the contents of the tab and resets the mapping from tree items to VFS beans.
protected CmsLazyTreeItem	createItem(org.opencms.ade.galleries.shared.CmsSitemapEntryBean sitemapEntry)	Helper method for creating a VFS tree item widget from a VFS entry bean.
protected CmsList<? extends I_CmsListItem>	createScrollList()	Creates the list which should contain the list items of the tab.
void	fill(java.util.List<org.opencms.ade.galleries.shared.CmsSitemapEntryBean> entries)	Sets the initial folders in the VFS tab.
void	fillDefault(java.util.List<org.opencms.ade.galleries.shared.CmsSitemapEntryBean> entries)	Default way to fill the sitemap tab.
void	fillWithPreloadInfo(java.util.List<org.opencms.ade.galleries.shared.CmsSitemapEntryBean> entries)	Fills the sitemap tab with preloaded data.
java.util.List<CmsSearchParamPanel>	getParamPanels(org.opencms.ade.galleries.shared.CmsGallerySearchBean searchObj)	Returns the search parameters to display within the result tab.
protected java.util.LinkedHashMap<java.lang.String,java.lang.String>	getSortList()	Returns a list with sort values for this tab.
protected CmsSitemapTabHandler	getTabHandler()	Returns the tab handler.
boolean	hasQuickFilter()	Returns if this tab has quick filter enabled.
boolean	isInitialized()	Returns if the tab content has been initialized.
void	onLoad()
void	onReceiveSitemapPreloadData(org.opencms.ade.galleries.shared.CmsSitemapEntryBean sitemapPreloadData)	Method which is called when the sitemap preload data is received.

Methods inherited from class org.opencms.ade.galleries.client.ui.A_CmsListTab

addWidgetToFrontOfList, addWidgetToList, addWidgetToOptions, cancelQuickFilterTimer, checkQuickSearchStatus, clearList, createCustomUploadButton, createNewExternalLinkButton, createOptimizeButton, createSelectButton, createSelectResourceButton, createUploadButtonForTarget, getList, getRequiredHeight, hasQuickSearch, init, onContentChange, onResize, onValueChange, quickSearch, scheduleQuickFilterTimer, searchTreeItem, setSortSelectBoxValue, truncate

Methods inherited from class org.opencms.ade.galleries.client.ui.A_CmsTab

clearParams, getTabId, isSelected, onDeselection, onSelection, removeParam, setTabTextAccessor

Methods inherited from class com.google.gwt.user.client.ui.Composite

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

Methods inherited from class com.google.gwt.user.client.ui.Widget

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getHandlerCount, getLayoutData, getParent, isOrWasAttached, onUnload, removeFromParent, setLayoutData, sinkEvents, unsinkEvents

Methods inherited from class 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

Methods inherited from class java.lang.Object

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

Constructor Detail

CmsSitemapTab

public CmsSitemapTab(CmsSitemapTabHandler handler)

Constructor.

Parameters:

handler - the tab handler

Method Detail

fill

public void fill(java.util.List<org.opencms.ade.galleries.shared.CmsSitemapEntryBean> entries)

Sets the initial folders in the VFS tab.

Parameters:

entries - the root folders to display

fillDefault

public void fillDefault(java.util.List<org.opencms.ade.galleries.shared.CmsSitemapEntryBean> entries)

Default way to fill the sitemap tab.

Parameters:

entries - the entries to fill the tab with

fillWithPreloadInfo

public void fillWithPreloadInfo(java.util.List<org.opencms.ade.galleries.shared.CmsSitemapEntryBean> entries)

Fills the sitemap tab with preloaded data.

Parameters:

entries - the preloaded sitemap entries

getParamPanels

public java.util.List<CmsSearchParamPanel> getParamPanels(org.opencms.ade.galleries.shared.CmsGallerySearchBean searchObj)

Description copied from class: A_CmsTab

Returns the search parameters to display within the result tab.

Specified by:

getParamPanels in class A_CmsTab

Parameters:

searchObj - the current search object

Returns:

the parameter panel

See Also:

A_CmsTab.getParamPanels(org.opencms.ade.galleries.shared.CmsGallerySearchBean)

hasQuickFilter

public boolean hasQuickFilter()

Description copied from class: A_CmsListTab

Returns if this tab has quick filter enabled.

Overrides:

hasQuickFilter in class A_CmsListTab

Returns:

true if this tab has quick filter enabled

See Also:

A_CmsListTab.hasQuickFilter()

isInitialized

public boolean isInitialized()

Returns if the tab content has been initialized.

Returns:

true if the tab content has been initialized

onLoad

public void onLoad()

Overrides:

onLoad in class com.google.gwt.user.client.ui.Widget

See Also:

Widget.onLoad()

onReceiveSitemapPreloadData

public void onReceiveSitemapPreloadData(org.opencms.ade.galleries.shared.CmsSitemapEntryBean sitemapPreloadData)

Method which is called when the sitemap preload data is received.

Parameters:

sitemapPreloadData - the sitemap tree's preloaded root entry

clear

protected void clear()

Clears the contents of the tab and resets the mapping from tree items to VFS beans.

createItem

protected CmsLazyTreeItem createItem(org.opencms.ade.galleries.shared.CmsSitemapEntryBean sitemapEntry)

Helper method for creating a VFS tree item widget from a VFS entry bean.

Parameters:

sitemapEntry - the VFS entry bean

Returns:

the tree item widget

createScrollList

protected CmsList<? extends I_CmsListItem> createScrollList()

Description copied from class: A_CmsListTab

Creates the list which should contain the list items of the tab.

Overrides:

createScrollList in class A_CmsListTab

Returns:

the newly created list widget

See Also:

A_CmsListTab.createScrollList()

getSortList

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

Description copied from class: A_CmsListTab

Returns a list with sort values for this tab.

Specified by:

getSortList in class A_CmsListTab

Returns:

list of sort order value/text pairs

See Also:

A_CmsListTab.getSortList()

getTabHandler

protected CmsSitemapTabHandler getTabHandler()

Description copied from class: A_CmsTab

Returns the tab handler.

Specified by:

getTabHandler in class A_CmsTab

Returns:

the tab handler

See Also:

A_CmsTab.getTabHandler()