Package org.opencms.ade.galleries.client

Class CmsGalleryControllerHandler

java.lang.Object
org.opencms.ade.galleries.client.CmsGalleryControllerHandler
All Implemented Interfaces:
com.google.gwt.event.logical.shared.ValueChangeHandler<org.opencms.ade.galleries.shared.CmsGallerySearchBean>, com.google.gwt.event.shared.EventHandler
public class CmsGalleryControllerHandler extends Object implements com.google.gwt.event.logical.shared.ValueChangeHandler<org.opencms.ade.galleries.shared.CmsGallerySearchBean>
Gallery dialog controller handler.

Delegates the actions of the gallery controller to the gallery dialog.

Since:
8.0.0

  • Field Details

  • Constructor Details

  • Method Details

    • hasResultsTab

      public boolean hasResultsTab()
      Returns true if a results tab exists.

      Returns:
      true if a results tab exists

    • hideShowPreviewButton

      public void hideShowPreviewButton(boolean hide)
      Hides or shows the show-preview-button.

      Parameters:
      hide - true to hide the button

    • onCategoriesTabSelection

      public void onCategoriesTabSelection()
      Will be triggered when the categories tab is selected.

    • onClearCategories

      public void onClearCategories(List<String> categories)
      Deletes the html content of the categories parameter and removes the style.

      Parameters:
      categories - the categories to remove from selection

    • onClearFolders

      public void onClearFolders(Collection<String> folders)
      The method which is executed when all folders are cleared from the search object.

      Parameters:
      folders - the folders which have been cleared

    • onClearFullTextSearch

      public void onClearFullTextSearch()
      clears the search tab input.

    • onClearGalleries

      public void onClearGalleries(List<String> galleries)
      Deletes the html content of the galleries parameter and removes the style.

      Parameters:
      galleries - the galleries to remove from selection

    • onClearTypes

      public void onClearTypes(List<String> types)
      Deletes the html content of the types parameter and removes the style.

      Parameters:
      types - the types to be removed from selection

    • onGalleriesTabSelection

      public void onGalleriesTabSelection()
      Will be triggered when the galleries tab is selected.

    • onInitialSearch

      public void onInitialSearch(org.opencms.ade.galleries.shared.CmsGallerySearchBean searchObj, org.opencms.ade.galleries.shared.CmsGalleryDataBean dialogBean, CmsGalleryController controller, boolean isFirstTime)
      Will be triggered when the initial search is performed.

      Parameters:
      searchObj - the current search object
      dialogBean - the current dialog data bean
      controller - the dialog controller
      isFirstTime - true if this method is called the first time for the gallery dialog instance

    • onReceiveSitemapPreloadData

      public void onReceiveSitemapPreloadData(org.opencms.ade.galleries.shared.CmsSitemapEntryBean sitemapPreloadData)
      This method is called when preloaded sitemap tree state data is loaded.

      Parameters:
      sitemapPreloadData - the sitemap preload data

    • onReceiveVfsPreloadData

      public void onReceiveVfsPreloadData(org.opencms.ade.galleries.shared.CmsVfsEntryBean vfsPreloadData, Set<String> folders)
      This method is called when preloaded VFS tree state data is loaded.

      Parameters:
      vfsPreloadData - the preload data
      folders - the set of selected folders

    • onRemoveQuery

      public void onRemoveQuery()
      Called when the query is removed.

    • onRemoveScope

      public void onRemoveScope()
      Called when the search scope is removed.

    • onRemoveSearchParam

      public void onRemoveSearchParam(CmsSearchTab.ParamType type)
      Removes a parameter from the search tab.

      Parameters:
      type - the parameter type

    • onResultTabSelection

      public void onResultTabSelection(org.opencms.ade.galleries.shared.CmsGallerySearchBean searchObj)
      Will be triggered when the results tab is selected.

      Parameters:
      searchObj - the current search object

    • onTypesTabSelection

      public void onTypesTabSelection()
      Will be triggered when the types tab is selected.

    • onUpdateCategoriesList

      public void onUpdateCategoriesList(List<org.opencms.gwt.shared.CmsCategoryBean> categoriesList, List<String> selectedCategories)
      Will be triggered when categories list is sorted.

      Parameters:
      categoriesList - the updated categories list
      selectedCategories - the selected categories

    • onUpdateCategoriesTree

      public void onUpdateCategoriesTree(List<org.opencms.gwt.shared.CmsCategoryTreeEntry> categoryTreeEntry, List<String> selectedCategories)
      Will be triggered when the tree is selected.

      Parameters:
      categoryTreeEntry - the category root entry
      selectedCategories - the selected categories

    • onUpdateGalleries

      public void onUpdateGalleries(List<org.opencms.ade.galleries.shared.CmsGalleryFolderBean> galleries, List<String> selectedGalleries, boolean grouped)
      Will be triggered when the sort parameters of the galleries list are changed.

      Parameters:
      galleries - the updated galleries list
      selectedGalleries - the list of galleries to select
      grouped - true if the gallery list should be shown as groups

    • onUpdateGalleryTree

      public void onUpdateGalleryTree(List<org.opencms.ade.galleries.shared.CmsGalleryTreeEntry> galleryTreeEntries, List<String> selectedGalleries)
      Updates the gallery tree.

      Parameters:
      galleryTreeEntries - the gallery tree entries
      selectedGalleries - the selected galleries

    • onUpdateTypes

      public void onUpdateTypes(List<org.opencms.ade.galleries.shared.CmsResourceTypeBean> types, List<String> selectedTypes)
      Will be triggered when the sort parameters of the types list are changed.

      Parameters:
      types - the updated types list
      selectedTypes - the list of types to select

    • onValueChange

      public void onValueChange(com.google.gwt.event.logical.shared.ValueChangeEvent<org.opencms.ade.galleries.shared.CmsGallerySearchBean> event)
      Specified by:
      onValueChange in interface com.google.gwt.event.logical.shared.ValueChangeHandler<org.opencms.ade.galleries.shared.CmsGallerySearchBean>
      See Also:
      • ValueChangeHandler.onValueChange(com.google.gwt.event.logical.shared.ValueChangeEvent)

    • selectResultTab

      public void selectResultTab()
      Selects the result tab.

    • setCategoriesTabContent

      public void setCategoriesTabContent(List<org.opencms.gwt.shared.CmsCategoryTreeEntry> categoryRoot, List<String> selected)
      Sets the list content of the category tab.

      Parameters:
      categoryRoot - the root category tree entry
      selected - the selected categories

    • setGalleriesTabContent

      public void setGalleriesTabContent(List<org.opencms.ade.galleries.shared.CmsGalleryFolderBean> galleryInfos, List<String> selectedGalleries, boolean useGroups)
      Sets the list content of the galleries tab.

      Parameters:
      galleryInfos - the gallery info beans
      selectedGalleries - the selected galleries
      useGroups - true if the gallery list should be shown as groups

    • setTypesTabContent

      public void setTypesTabContent(List<org.opencms.ade.galleries.shared.CmsResourceTypeBean> typeInfos, List<String> selectedTypes)
      Sets the list content of the types tab.

      Parameters:
      typeInfos - the type info beans
      selectedTypes - the selected types

    • showFirstTab

      public void showFirstTab()
      Shows the first available tab.

    • updateGalleryData

      public void updateGalleryData(org.opencms.ade.galleries.shared.CmsGallerySearchBean searchObj, org.opencms.ade.galleries.shared.CmsGalleryDataBean dialogBean, CmsGalleryController controller)
      Updates the gallery data.

      Parameters:
      searchObj - the current search object
      dialogBean - the gallery data
      controller - he gallery controller