org.opencms.ade.galleries.client.ui

类 A_CmsListTab

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

所有已实现的接口:

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

直接已知子类:

CmsCategoriesTab, CmsGalleriesTab, CmsResultsTab, CmsSitemapTab, CmsTypesTab, CmsVfsTab

public abstract class A_CmsListTab
extends A_CmsTab
implements com.google.gwt.event.logical.shared.ValueChangeHandler<java.lang.String>

Provides a widget for the content of a tab.

从以下版本开始:

8.0.

嵌套类概要

嵌套类

限定符和类型	类和说明
protected class	A_CmsListTab.A_SelectionHandler Selection handler to handle check box click events and double clicks on the list items.
protected class	A_CmsListTab.SelectHandler Special click handler to use with select button.

从类继承的嵌套类/接口 com.google.gwt.user.client.ui.UIObject

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

字段概要

字段

限定符和类型	字段和说明
protected static I_CmsLayoutBundle.I_CmsGalleryDialogCss	DIALOG_CSS The css bundle used for this widget.
protected com.google.gwt.user.client.ui.HasText	m_infoLabel A label for displaying additional information about the tab.
protected CmsScrollPanel	m_list The borded panel to hold the scrollable list.
protected com.google.gwt.user.client.ui.FlowPanel	m_options The option panel.
protected CmsTextBox	m_quickSearch The quick search box.
protected CmsList<? extends I_CmsListItem>	m_scrollList The scrollable list panel.
protected CmsPushButton	m_searchButton The quick search button.
protected CmsSelectBox	m_sortSelectBox The select box to change the sort order.
protected com.google.gwt.user.client.ui.FlowPanel	m_tab The option panel.

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

m_tabTextAccessor

从类继承的字段 com.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

构造器概要

构造器

构造器和说明
A_CmsListTab(I_CmsGalleryProviderConstants.GalleryTabId tabId) The default constructor with drag handler.
A_CmsListTab(java.lang.String tabId) Sets up a list tab with a given tab id.

方法概要

方法

限定符和类型	方法和说明
protected void	addWidgetToFrontOfList(com.google.gwt.user.client.ui.Widget listItem) Adds a widget to the front of the list.
protected void	addWidgetToList(com.google.gwt.user.client.ui.Widget listItem) Add a list item widget to the list panel.
protected void	addWidgetToOptions(com.google.gwt.user.client.ui.Widget widget) Add a widget to the option panel.
protected void	cancelQuickFilterTimer() Cancels the quick filter timer.
protected void	checkQuickSearchStatus() Checks the quick search input and enables/disables the search button accordingly.
protected void	clearList() Clears the list panel.
protected CmsList<? extends I_CmsListItem>	createScrollList() Creates the list which should contain the list items of the tab.
protected CmsPushButton	createSelectButton(A_CmsListTab.A_SelectionHandler selectionHandler) Creates a select button.
protected CmsPushButton	createSelectResourceButton(java.lang.String resourcePath, CmsUUID structureId, java.lang.String title, java.lang.String resourceType) Creates a button widget to select the specified resource.
protected CmsUploadButton	createUploadButtonForTarget(java.lang.String target, boolean isRootPath) Creates an upload button for the given target.
CmsScrollPanel	getList() Returns the list.
protected abstract java.util.LinkedHashMap<java.lang.String,java.lang.String>	getSortList() Returns a list with sort values for this tab.
protected boolean	hasQuickFilter() Returns if this tab has quick filter enabled.
protected boolean	hasQuickSearch() Returns if the tab has the quick search box.
protected void	init() Call after all handlers have been set.
void	onContentChange() Call on content change to update the layout.
void	onValueChange(com.google.gwt.event.logical.shared.ValueChangeEvent<java.lang.String> event) Will be triggered if the value in the select box changes.
protected void	quickSearch() Sets the search query an selects the result tab.
protected void	scheduleQuickFilterTimer() Schedules the quick filter action.
protected CmsTreeItem	searchTreeItem(CmsList<? extends I_CmsListItem> list, java.lang.String categoryPath) Searches in the categories tree or list the item and returns it.
void	setSortSelectBoxValue(java.lang.String value, boolean fireEvents) Sets the value selected in the sort select box, if possible.

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

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

从类继承的方法 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, toString, unsinkEvents

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

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

字段详细资料

DIALOG_CSS

protected static final I_CmsLayoutBundle.I_CmsGalleryDialogCss DIALOG_CSS

The css bundle used for this widget.

m_infoLabel

protected com.google.gwt.user.client.ui.HasText m_infoLabel

A label for displaying additional information about the tab.

m_list

@UiField
protected CmsScrollPanel m_list

The borded panel to hold the scrollable list.

m_options

@UiField
protected com.google.gwt.user.client.ui.FlowPanel m_options

The option panel.

m_quickSearch

protected CmsTextBox m_quickSearch

The quick search box.

m_scrollList

protected CmsList<? extends I_CmsListItem> m_scrollList

The scrollable list panel.

m_searchButton

protected CmsPushButton m_searchButton

The quick search button.

m_sortSelectBox

protected CmsSelectBox m_sortSelectBox

The select box to change the sort order.

m_tab

@UiField
protected com.google.gwt.user.client.ui.FlowPanel m_tab

The option panel.

构造器详细资料

A_CmsListTab

public A_CmsListTab(I_CmsGalleryProviderConstants.GalleryTabId tabId)

The default constructor with drag handler.

参数:

tabId - the tab id

A_CmsListTab

public A_CmsListTab(java.lang.String tabId)

Sets up a list tab with a given tab id.

参数:

tabId - the tab id

方法详细资料

getList

public CmsScrollPanel getList()

Returns the list.

返回:

the list

onContentChange

public void onContentChange()

Call on content change to update the layout.

onValueChange

public void onValueChange(com.google.gwt.event.logical.shared.ValueChangeEvent<java.lang.String> event)

Will be triggered if the value in the select box changes.

指定者:

onValueChange 在接口中 com.google.gwt.event.logical.shared.ValueChangeHandler<java.lang.String>

另请参阅:

ValueChangeHandler.onValueChange(com.google.gwt.event.logical.shared.ValueChangeEvent)

setSortSelectBoxValue

public void setSortSelectBoxValue(java.lang.String value,
                         boolean fireEvents)

Sets the value selected in the sort select box, if possible.

参数:

value - the new value for the sort select box

fireEvents - if true, the change event of the select box is fired

addWidgetToFrontOfList

protected void addWidgetToFrontOfList(com.google.gwt.user.client.ui.Widget listItem)

Adds a widget to the front of the list.

参数:

listItem - the list item to add

addWidgetToList

protected void addWidgetToList(com.google.gwt.user.client.ui.Widget listItem)

Add a list item widget to the list panel.

参数:

listItem - the list item to add

addWidgetToOptions

protected void addWidgetToOptions(com.google.gwt.user.client.ui.Widget widget)

Add a widget to the option panel.

The option panel should contain drop down boxes or other list options.

参数:

widget - the widget to add

cancelQuickFilterTimer

protected void cancelQuickFilterTimer()

Cancels the quick filter timer.

checkQuickSearchStatus

protected void checkQuickSearchStatus()

Checks the quick search input and enables/disables the search button accordingly.

clearList

protected void clearList()

Clears the list panel.

createScrollList

protected CmsList<? extends I_CmsListItem> createScrollList()

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

返回:

the newly created list widget

createSelectButton

protected CmsPushButton createSelectButton(A_CmsListTab.A_SelectionHandler selectionHandler)

Creates a select button.

参数:

selectionHandler - the selction handler

返回:

the select button

createSelectResourceButton

protected CmsPushButton createSelectResourceButton(java.lang.String resourcePath,
                                       CmsUUID structureId,
                                       java.lang.String title,
                                       java.lang.String resourceType)

Creates a button widget to select the specified resource.

参数:

resourcePath - the item resource path

structureId - the structure id

title - the resource title

resourceType - the item resource type

返回:

the initialized select resource button

createUploadButtonForTarget

protected CmsUploadButton createUploadButtonForTarget(java.lang.String target,
                                          boolean isRootPath)

Creates an upload button for the given target.

参数:

target - the upload target folder

isRootPath - true if target is a root path

返回:

the upload button

getSortList

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

Returns a list with sort values for this tab.

返回:

list of sort order value/text pairs

hasQuickFilter

protected boolean hasQuickFilter()

Returns if this tab has quick filter enabled.

返回:

true if this tab has quick filter enabled

hasQuickSearch

protected boolean hasQuickSearch()

Returns if the tab has the quick search box.

返回:

true if the tab has the quick search box

init

protected void init()

Call after all handlers have been set.

quickSearch

protected void quickSearch()

Sets the search query an selects the result tab.

scheduleQuickFilterTimer

protected void scheduleQuickFilterTimer()

Schedules the quick filter action.

searchTreeItem

protected CmsTreeItem searchTreeItem(CmsList<? extends I_CmsListItem> list,
                         java.lang.String categoryPath)

Searches in the categories tree or list the item and returns it.

参数:

list - the list of items to start from

categoryPath - the category id to search

返回:

the category item widget