Class 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.
    • 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, boolean useGroups)
      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, boolean grouped)
      Fill the content of the galleries tab panel.
      protected java.lang.String getGroupName​(org.opencms.ade.galleries.shared.CmsGalleryGroup group)
      Gets the label to display for a group.
      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, boolean useGroups)
      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 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 Detail

      • m_groupLabels

        protected java.util.Map<org.opencms.ade.galleries.shared.CmsGalleryGroup,​java.lang.String> m_groupLabels
        The labels to display for groups.
      • m_itemIterator

        protected java.util.Iterator<CmsTreeItem> m_itemIterator
        An iterator which produces new list items which should be added to the tab.

      • m_lastGroup

        protected org.opencms.ade.galleries.shared.CmsGalleryGroup m_lastGroup
        The group of the gallery folder list item that was last rendered.
      • m_selectedGalleries

        protected java.util.List<java.lang.String> m_selectedGalleries
        List of selected galleries.
    • Method Detail

      • fillContent

        public void fillContent​(java.util.List<org.opencms.ade.galleries.shared.CmsGalleryFolderBean> galleryInfos,
                                java.util.List<java.lang.String> selectedGalleries,
                                boolean grouped)
        Fill the content of the galleries tab panel.

        Parameters:
        galleryInfos - the gallery info beans
        selectedGalleries - the list of galleries to select
        grouped - true if the items should be broken into groups
      • 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
      • 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,
                                      boolean useGroups)
        Update the galleries list.

        Parameters:
        galleries - the new gallery list
        selectedGalleries - the list of galleries to select
        useGroups - true if the galleries should be broken into groups (this assumes the galleries have already been sorted correctly)
      • 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 list
        selectedGalleries - 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 item
        children - the list of children
        selectedGalleries - 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,
                                             boolean useGroups)
        Creates a tree item widget used in list and tree view of this tab.

        Parameters:
        galleryInfo - the gallery folder bean
        selectedGalleries - the selected galleries
        forTree - true if the item is used within tree view
        useGroups - true if the gallery tree items should be broken into groups
        Returns:
        the tree item
      • getGroupName

        protected java.lang.String getGroupName​(org.opencms.ade.galleries.shared.CmsGalleryGroup group)
        Gets the label to display for a group.
        Parameters:
        group - the gallery group
        Returns:
        the label to display for the gallery group
      • loadMoreItems

        protected void loadMoreItems()
        Adds more gallery list items to display in the tab, if available.