Class CmsSearchTab
- 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.CmsSearchTab
-
- 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
public class CmsSearchTab extends A_CmsTab
Provides the widget for the full text search tab.- Since:
- 8.0.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
CmsSearchTab.ParamType
The parameter types of this tab.
-
Field Summary
Fields Modifier and Type Field Description protected CmsPushButton
m_clearButton
The button to clear the tab input.protected java.lang.String
m_currentLocale
The current locale.protected CmsDateBox
m_dateCreatedEndDateBox
The date box for the created until date.protected com.google.gwt.user.client.ui.Label
m_dateCreatedEndLabel
The label for the created until date.protected CmsDateBox
m_dateCreatedStartDateBox
The date box for the created since date.protected com.google.gwt.user.client.ui.Label
m_dateCreatedStartLabel
The label for the created since date.protected CmsDateBox
m_dateModifiedEndDateBox
The date box for the modified until date.protected com.google.gwt.user.client.ui.Label
m_dateModifiedEndLabel
The label for the modified until date.protected CmsDateBox
m_dateModifiedStartDateBox
The date box for the modified since date.protected com.google.gwt.user.client.ui.Label
m_dateModifiedStartLabel
The label for the modified since date.protected CmsCheckBox
m_includeExpiredCheckBox
The include expired resources check-box.protected com.google.gwt.dom.client.DivElement
m_includeExpiredRow
The include expired resources form row.protected com.google.gwt.user.client.ui.Label
m_localeLabel
The label for the language selection.protected com.google.gwt.user.client.ui.HTMLPanel
m_localeRow
The row for the language selection.protected CmsSelectBox
m_localeSelection
The select box for the language selection.-
Fields inherited from class org.opencms.ade.galleries.client.ui.A_CmsTab
m_tabTextAccessor
-
-
Constructor Summary
Constructors Constructor Description CmsSearchTab(CmsSearchTabHandler tabHandler, I_CmsAutoHider autoHideParent, java.lang.String currentLocale, java.util.Map<java.lang.String,java.lang.String> availableLocales, boolean defaultIncludeExpired)
Constructor for the search tab.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
clearInput()
Clears the search tab input.protected void
clearInput(com.google.gwt.event.dom.client.ClickEvent event)
Clears the search tab input.void
enableExpiredResourcesSearch(boolean enable)
Enables the include expired resources form input.void
fillParams(org.opencms.ade.galleries.shared.CmsGallerySearchBean search)
Sets the form fields to the values from the stored gallery search.java.util.List<CmsSearchParamPanel>
getParamPanels(org.opencms.ade.galleries.shared.CmsGallerySearchBean searchObj)
Returns the search parameters to display within the result tab.int
getRequiredHeight()
Returns the height required by this tab.CmsSearchTabHandler
getTabHandler()
Returns the tab handler.protected void
onDateCreatedEndChange(com.google.gwt.event.logical.shared.ValueChangeEvent<java.util.Date> event)
Handles changes of date created range end box.protected void
onDateCreatedStartChange(com.google.gwt.event.logical.shared.ValueChangeEvent<java.util.Date> event)
Handles changes of date created range start box.protected void
onDateModifiedEndChange(com.google.gwt.event.logical.shared.ValueChangeEvent<java.util.Date> event)
Handles changes of date modified range end box.protected void
onDateModifiedStartChange(com.google.gwt.event.logical.shared.ValueChangeEvent<java.util.Date> event)
Handles changes of date modified range start box.protected void
onIncludeExpiredChange(com.google.gwt.event.logical.shared.ValueChangeEvent<java.lang.Boolean> event)
Handles changes of the include expired check box.protected void
onLocaleChange(com.google.gwt.event.logical.shared.ValueChangeEvent<java.lang.String> event)
Handles the change event of the locale select box.void
removeParameter(CmsSearchTab.ParamType type)
Removes the given parameter type.-
Methods inherited from class org.opencms.ade.galleries.client.ui.A_CmsTab
clearParams, getTabId, isSelected, onDeselection, onResize, 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
-
-
-
-
Field Detail
-
m_clearButton
@UiField protected CmsPushButton m_clearButton
The button to clear the tab input.
-
m_currentLocale
protected java.lang.String m_currentLocale
The current locale.
-
m_dateCreatedEndDateBox
@UiField protected CmsDateBox m_dateCreatedEndDateBox
The date box for the created until date.
-
m_dateCreatedEndLabel
@UiField protected com.google.gwt.user.client.ui.Label m_dateCreatedEndLabel
The label for the created until date.
-
m_dateCreatedStartDateBox
@UiField protected CmsDateBox m_dateCreatedStartDateBox
The date box for the created since date.
-
m_dateCreatedStartLabel
@UiField protected com.google.gwt.user.client.ui.Label m_dateCreatedStartLabel
The label for the created since date.
-
m_dateModifiedEndDateBox
@UiField protected CmsDateBox m_dateModifiedEndDateBox
The date box for the modified until date.
-
m_dateModifiedEndLabel
@UiField protected com.google.gwt.user.client.ui.Label m_dateModifiedEndLabel
The label for the modified until date.
-
m_dateModifiedStartDateBox
@UiField protected CmsDateBox m_dateModifiedStartDateBox
The date box for the modified since date.
-
m_dateModifiedStartLabel
@UiField protected com.google.gwt.user.client.ui.Label m_dateModifiedStartLabel
The label for the modified since date.
-
m_includeExpiredCheckBox
@UiField protected CmsCheckBox m_includeExpiredCheckBox
The include expired resources check-box.
-
m_includeExpiredRow
@UiField protected com.google.gwt.dom.client.DivElement m_includeExpiredRow
The include expired resources form row.
-
m_localeLabel
@UiField protected com.google.gwt.user.client.ui.Label m_localeLabel
The label for the language selection.
-
m_localeRow
@UiField protected com.google.gwt.user.client.ui.HTMLPanel m_localeRow
The row for the language selection.
-
m_localeSelection
@UiField protected CmsSelectBox m_localeSelection
The select box for the language selection.
-
-
Constructor Detail
-
CmsSearchTab
public CmsSearchTab(CmsSearchTabHandler tabHandler, I_CmsAutoHider autoHideParent, java.lang.String currentLocale, java.util.Map<java.lang.String,java.lang.String> availableLocales, boolean defaultIncludeExpired)
Constructor for the search tab.- Parameters:
tabHandler
- the tab handlerautoHideParent
- the auto-hide parent to this dialog if presentcurrentLocale
- the current content localeavailableLocales
- the available localesdefaultIncludeExpired
- true if 'show expired' should be enabled by default
-
-
Method Detail
-
clearInput
public void clearInput()
Clears the search tab input.
-
enableExpiredResourcesSearch
public void enableExpiredResourcesSearch(boolean enable)
Enables the include expired resources form input.- Parameters:
enable
-true
to enable the include expired resources form input
-
fillParams
public void fillParams(org.opencms.ade.galleries.shared.CmsGallerySearchBean search)
Sets the form fields to the values from the stored gallery search.- Parameters:
search
- a previously stored gallery search
-
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)
-
getRequiredHeight
public int getRequiredHeight()
Description copied from class:A_CmsTab
Returns the height required by this tab.- Specified by:
getRequiredHeight
in classA_CmsTab
- Returns:
- the height
- See Also:
A_CmsTab.getRequiredHeight()
-
getTabHandler
public CmsSearchTabHandler 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()
-
removeParameter
public void removeParameter(CmsSearchTab.ParamType type)
Removes the given parameter type.- Parameters:
type
- the parameter type
-
clearInput
@UiHandler("m_clearButton") protected void clearInput(com.google.gwt.event.dom.client.ClickEvent event)
Clears the search tab input.- Parameters:
event
- the click event
-
onDateCreatedEndChange
@UiHandler("m_dateCreatedEndDateBox") protected void onDateCreatedEndChange(com.google.gwt.event.logical.shared.ValueChangeEvent<java.util.Date> event)
Handles changes of date created range end box.- Parameters:
event
- the change event
-
onDateCreatedStartChange
@UiHandler("m_dateCreatedStartDateBox") protected void onDateCreatedStartChange(com.google.gwt.event.logical.shared.ValueChangeEvent<java.util.Date> event)
Handles changes of date created range start box.- Parameters:
event
- the change event
-
onDateModifiedEndChange
@UiHandler("m_dateModifiedEndDateBox") protected void onDateModifiedEndChange(com.google.gwt.event.logical.shared.ValueChangeEvent<java.util.Date> event)
Handles changes of date modified range end box.- Parameters:
event
- the change event
-
onDateModifiedStartChange
@UiHandler("m_dateModifiedStartDateBox") protected void onDateModifiedStartChange(com.google.gwt.event.logical.shared.ValueChangeEvent<java.util.Date> event)
Handles changes of date modified range start box.- Parameters:
event
- the change event
-
onIncludeExpiredChange
@UiHandler("m_includeExpiredCheckBox") protected void onIncludeExpiredChange(com.google.gwt.event.logical.shared.ValueChangeEvent<java.lang.Boolean> event)
Handles changes of the include expired check box.- Parameters:
event
- the change event
-
onLocaleChange
@UiHandler("m_localeSelection") protected void onLocaleChange(com.google.gwt.event.logical.shared.ValueChangeEvent<java.lang.String> event)
Handles the change event of the locale select box.- Parameters:
event
- the change event
-
-