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

Class A_CmsTab

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
All Implemented Interfaces:
com.google.gwt.event.logical.shared.HasAttachHandlers, 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
Direct Known Subclasses:
A_CmsListTab, CmsSearchTab
public abstract class A_CmsTab extends com.google.gwt.user.client.ui.Composite
A tab for the gallery dialog.

Since:
8.0.0

  • Nested Class Summary

    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 com.google.gwt.user.client.ui.HasText
    m_tabTextAccessor
    The tab text accessor.

    Fields inherited from class com.google.gwt.user.client.ui.UIObject

    DEBUG_ID_PREFIX

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    A_CmsTab(String tabId)
    Constructor.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    clearParams()
    Clears the selected search parameters on this tab.
    abstract List<CmsSearchParamPanel>
    getParamPanels(org.opencms.ade.galleries.shared.CmsGallerySearchBean searchObj)
    Returns the search parameters to display within the result tab.
    abstract int
    getRequiredHeight()
    Returns the height required by this tab.
    protected abstract A_CmsTabHandler
    getTabHandler()
    Returns the tab handler.
    String
    getTabId()
    Returns the tab id.
    boolean
    isSelected()
    Returns if the tab is currently selected.
    void
    onDeselection()
    Will be triggered when a tab is deselected.
    void
    onResize()
    Adjust content when outer dimensions are changed.
    void
    onSelection()
    Will be triggered when a tab is selected.
    void
    removeParam(String paramKey)
    Removes the parameter with the given key from the tab.
    void
    setTabTextAccessor(com.google.gwt.user.client.ui.HasText tabText)
    Sets the tab text accessor for this tab.

    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_tabTextAccessor

      protected com.google.gwt.user.client.ui.HasText m_tabTextAccessor
      The tab text accessor.

  • Constructor Details

    • A_CmsTab

      protected A_CmsTab(String tabId)
      Constructor.

      Parameters:
      tabId - the tab id

  • Method Details

    • clearParams

      public void clearParams()
      Clears the selected search parameters on this tab.

    • getParamPanels

      public abstract List<CmsSearchParamPanel> getParamPanels(org.opencms.ade.galleries.shared.CmsGallerySearchBean searchObj)
      Returns the search parameters to display within the result tab.

      Parameters:
      searchObj - the current search object
      Returns:
      the parameter panel

    • getRequiredHeight

      public abstract int getRequiredHeight()
      Returns the height required by this tab.

      Returns:
      the height

    • getTabId

      public String getTabId()
      Returns the tab id.

      Returns:
      the tab id

    • isSelected

      public boolean isSelected()
      Returns if the tab is currently selected.

      Returns:
      true if the tab is currently selected

    • onDeselection

      public void onDeselection()
      Will be triggered when a tab is deselected.

    • onResize

      public void onResize()
      Adjust content when outer dimensions are changed.

    • onSelection

      public void onSelection()
      Will be triggered when a tab is selected.

    • removeParam

      public void removeParam(String paramKey)
      Removes the parameter with the given key from the tab.

      Parameters:
      paramKey - the parameter key

    • setTabTextAccessor

      public void setTabTextAccessor(com.google.gwt.user.client.ui.HasText tabText)
      Sets the tab text accessor for this tab.

      Parameters:
      tabText - the tab text accessor

    • getTabHandler

      protected abstract A_CmsTabHandler getTabHandler()
      Returns the tab handler.

      Returns:
      the tab handler