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

Class CmsVfsTab

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.CmsVfsTab

All Implemented Interfaces:

com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.logical.shared.ValueChangeHandler<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 CmsVfsTab
extends A_CmsListTab

The tab widget for selecting folders from the VFS tree.

Since:

8.0.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

Modifier and Type	Field	Description
protected CmsVfsTabHandler	m_tabHandler	The tab handler.

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
CmsVfsTab(CmsVfsTabHandler tabHandler, boolean includeFiles)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	checkFolders(Set<String> folders)	Checks the check boxes for the selected folders.
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.CmsVfsEntryBean vfsEntry)	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.
protected A_CmsSelectBox<?>	createSelectBox(LinkedHashMap<String,String> options)	Creates the sort select box.
void	fillInitially(List<org.opencms.ade.galleries.shared.CmsVfsEntryBean> entries)	Sets the initial folders in the VFS tab.
void	fillInitially(List<org.opencms.ade.galleries.shared.CmsVfsEntryBean> entries, String selectedSiteRoot)	Sets the initial folders in the VFS tab.
List<CmsSearchParamPanel>	getParamPanels(org.opencms.ade.galleries.shared.CmsGallerySearchBean searchObj)	Returns the search parameters to display within the result tab.
protected LinkedHashMap<String,String>	getSortList()	Returns a list with sort values for this tab.
protected CmsVfsTabHandler	getTabHandler()	Returns the tab handler.
protected boolean	hasQuickFilter()	Returns if this tab has quick filter enabled.
protected boolean	isIncludeFiles()	Returns if files are included.
boolean	isInitialized()	Checks if the tab is initialized.
void	onReceiveVfsPreloadData(org.opencms.ade.galleries.shared.CmsVfsEntryBean vfsPreloadData)	This method is called when the VFS tree preload data is received.
void	uncheckFolders(Collection<String> folders)	Un-checks the check boxes for each folder passed in the folders parameter.

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, onLoad, 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

Field Details

m_tabHandler

protected CmsVfsTabHandler m_tabHandler

The tab handler.

Constructor Details

CmsVfsTab

public CmsVfsTab(CmsVfsTabHandler tabHandler,
 boolean includeFiles)

Constructor.

Parameters:

tabHandler - the tab handler

includeFiles - the include files flag

Method Details

checkFolders

public void checkFolders(Set<String> folders)

Checks the check boxes for the selected folders.

Parameters:

folders - the folders for which to check the check boxes

fillInitially

public void fillInitially(List<org.opencms.ade.galleries.shared.CmsVfsEntryBean> entries)

Sets the initial folders in the VFS tab.

Parameters:

entries - the root folders to display

fillInitially

public void fillInitially(List<org.opencms.ade.galleries.shared.CmsVfsEntryBean> entries,
 String selectedSiteRoot)

Sets the initial folders in the VFS tab.

Parameters:

entries - the root folders to display

selectedSiteRoot - site root that should be selected in the select box

getParamPanels

public 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)

isInitialized

public boolean isInitialized()

Checks if the tab is initialized.

Returns:

true if the tab is initialized

onReceiveVfsPreloadData

public void onReceiveVfsPreloadData(org.opencms.ade.galleries.shared.CmsVfsEntryBean vfsPreloadData)

This method is called when the VFS tree preload data is received.

Parameters:

vfsPreloadData - the VFS tree preload data

uncheckFolders

public void uncheckFolders(Collection<String> folders)

Un-checks the check boxes for each folder passed in the folders parameter.

Parameters:

folders - the folders for which the check boxes should be unchecked

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.CmsVfsEntryBean vfsEntry)

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

Parameters:

vfsEntry - 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()

createSelectBox

protected A_CmsSelectBox<?> createSelectBox(LinkedHashMap<String,String> options)

Description copied from class: A_CmsListTab

Creates the sort select box.

Overrides:

createSelectBox in class A_CmsListTab

Parameters:

options - the options for the select box

Returns:

the sort select box

See Also:

• A_CmsListTab.createSelectBox(java.util.LinkedHashMap)

getSortList

protected LinkedHashMap<String,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 CmsVfsTabHandler 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()

hasQuickFilter

protected 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()

isIncludeFiles

protected boolean isIncludeFiles()

Returns if files are included.

Returns:

true if files are included