Class CmsGalleriesTab
- 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.CmsGalleriesTab
-
- 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 CmsGalleriesTab extends A_CmsListTab
Provides the widget for the galleries(folder) tab.It displays the available gallery folders in the given order.
- Since:
- 8.0.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description protected class
CmsGalleriesTab.ListItemGenerator
A class which generates list items incrementally to fill the galleries tab.protected class
CmsGalleriesTab.MoreItemsCommand
Command for adding more list items to the list of publish items.protected class
CmsGalleriesTab.TreeItemGenerator
A class which generates tree items incrementally to fill the galleries tab.-
Nested classes/interfaces inherited from class org.opencms.ade.galleries.client.ui.A_CmsListTab
A_CmsListTab.A_SelectionHandler, A_CmsListTab.SelectHandler
-
-
Field Summary
Fields Modifier and Type Field Description protected static int
LOAD_BATCH_SIZE
The batch size for adding new elements to the tab.protected java.util.Iterator<CmsTreeItem>
m_itemIterator
An iterator which produces new list items which should be added to the tab.protected java.util.List<java.lang.String>
m_selectedGalleries
List of selected galleries.-
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
-
-
Constructor Summary
Constructors Constructor Description CmsGalleriesTab(CmsGalleriesTabHandler tabHandler)
Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
addChildren(CmsTreeItem parent, java.util.List<org.opencms.ade.galleries.shared.CmsGalleryTreeEntry> children, java.util.List<java.lang.String> selectedGalleries)
Adds children to the gallery tree and select the galleries.protected CmsTreeItem
createTreeItem(org.opencms.ade.galleries.shared.CmsGalleryFolderBean galleryInfo, java.util.List<java.lang.String> selectedGalleries, boolean forTree)
Creates a tree item widget used in list and tree view of this tab.void
fillContent(java.util.List<org.opencms.ade.galleries.shared.CmsGalleryFolderBean> galleryInfos, java.util.List<java.lang.String> selectedGalleries)
Fill the content of the galleries tab panel.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 CmsGalleriesTabHandler
getTabHandler()
Returns the tab handler.protected boolean
hasQuickFilter()
Returns if this tab has quick filter enabled.boolean
isLoading()
Returns the value of the "loading" flag, which indicates whether new elements are currently being added into the galleries tab.protected void
loadMoreItems()
Adds more gallery list items to display in the tab, if available.void
onSelection()
Will be triggered when a tab is selected.void
setLoading(boolean loading)
Sets the "loading" flag.void
uncheckGalleries(java.util.List<java.lang.String> galleries)
De-selects the galleries in the galleries list.void
updateListContent(java.util.List<org.opencms.ade.galleries.shared.CmsGalleryFolderBean> galleries, java.util.List<java.lang.String> selectedGalleries)
Update the galleries list.void
updateTreeContent(java.util.List<org.opencms.ade.galleries.shared.CmsGalleryTreeEntry> galleryTreeEntries, java.util.List<java.lang.String> selectedGalleries)
Update the galleries tree.-
Methods inherited from class org.opencms.ade.galleries.client.ui.A_CmsListTab
addWidgetToFrontOfList, addWidgetToList, addWidgetToOptions, cancelQuickFilterTimer, checkQuickSearchStatus, clearList, createCustomUploadButton, createNewExternalLinkButton, createOptimizeButton, createScrollList, 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, 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
-
-
-
-
Field Detail
-
LOAD_BATCH_SIZE
protected static final int LOAD_BATCH_SIZE
The batch size for adding new elements to the tab.- See Also:
- Constant Field Values
-
m_itemIterator
protected java.util.Iterator<CmsTreeItem> m_itemIterator
An iterator which produces new list items which should be added to the tab.
-
m_selectedGalleries
protected java.util.List<java.lang.String> m_selectedGalleries
List of selected galleries.
-
-
Constructor Detail
-
CmsGalleriesTab
public CmsGalleriesTab(CmsGalleriesTabHandler tabHandler)
Constructor.- Parameters:
tabHandler
- the tab handler
-
-
Method Detail
-
fillContent
public void fillContent(java.util.List<org.opencms.ade.galleries.shared.CmsGalleryFolderBean> galleryInfos, java.util.List<java.lang.String> selectedGalleries)
Fill the content of the galleries tab panel.- Parameters:
galleryInfos
- the gallery info beansselectedGalleries
- the list of galleries to select
-
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 classA_CmsTab
- Parameters:
searchObj
- the current search object- Returns:
- the parameter panel
- See Also:
A_CmsTab.getParamPanels(org.opencms.ade.galleries.shared.CmsGallerySearchBean)
-
isLoading
public boolean isLoading()
Returns the value of the "loading" flag, which indicates whether new elements are currently being added into the galleries tab.- Returns:
- the "loading" flag
-
onSelection
public void onSelection()
Description copied from class:A_CmsTab
Will be triggered when a tab is selected.- Overrides:
onSelection
in classA_CmsTab
- See Also:
A_CmsTab.onSelection()
-
setLoading
public void setLoading(boolean loading)
Sets the "loading" flag.- Parameters:
loading
- the new value of the loading flag
-
uncheckGalleries
public void uncheckGalleries(java.util.List<java.lang.String> galleries)
De-selects the galleries in the galleries list.- Parameters:
galleries
- the galleries to deselect
-
updateListContent
public void updateListContent(java.util.List<org.opencms.ade.galleries.shared.CmsGalleryFolderBean> galleries, java.util.List<java.lang.String> selectedGalleries)
Update the galleries list.- Parameters:
galleries
- the new gallery listselectedGalleries
- the list of galleries to select
-
updateTreeContent
public void updateTreeContent(java.util.List<org.opencms.ade.galleries.shared.CmsGalleryTreeEntry> galleryTreeEntries, java.util.List<java.lang.String> selectedGalleries)
Update the galleries tree.- Parameters:
galleryTreeEntries
- the new gallery tree listselectedGalleries
- the list of galleries to select
-
addChildren
protected void addChildren(CmsTreeItem parent, java.util.List<org.opencms.ade.galleries.shared.CmsGalleryTreeEntry> children, java.util.List<java.lang.String> selectedGalleries)
Adds children to the gallery tree and select the galleries.- Parameters:
parent
- the parent itemchildren
- the list of childrenselectedGalleries
- the list of galleries to select
-
createTreeItem
protected CmsTreeItem createTreeItem(org.opencms.ade.galleries.shared.CmsGalleryFolderBean galleryInfo, java.util.List<java.lang.String> selectedGalleries, boolean forTree)
Creates a tree item widget used in list and tree view of this tab.- Parameters:
galleryInfo
- the gallery folder beanselectedGalleries
- the selected galleriesforTree
-true
if the item is used within tree view- Returns:
- the tree item
-
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 classA_CmsListTab
- Returns:
- list of sort order value/text pairs
- See Also:
A_CmsListTab.getSortList()
-
getTabHandler
protected CmsGalleriesTabHandler getTabHandler()
Description copied from class:A_CmsTab
Returns the tab handler.- Specified by:
getTabHandler
in classA_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 classA_CmsListTab
- Returns:
true
if this tab has quick filter enabled- See Also:
A_CmsListTab.hasQuickFilter()
-
loadMoreItems
protected void loadMoreItems()
Adds more gallery list items to display in the tab, if available.
-
-