Package org.opencms.ade.galleries.client

Class CmsSearchTabHandler

java.lang.Object

org.opencms.ade.galleries.client.A_CmsTabHandler

org.opencms.ade.galleries.client.CmsSearchTabHandler

All Implemented Interfaces:

com.google.gwt.event.logical.shared.CloseHandler<com.google.gwt.user.client.ui.PopupPanel>, com.google.gwt.event.shared.EventHandler

public class CmsSearchTabHandler
extends A_CmsTabHandler

The full text search tab handler.

This class receives events information from the full text search tab and delegates them to the gallery search controller.

Since:

8.0.0

Field Summary

Fields inherited from class org.opencms.ade.galleries.client.A_CmsTabHandler

m_controller

Constructor Summary

Constructors

Constructor	Description
CmsSearchTabHandler(CmsGalleryController controller)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	clearInput()	Delegates the clear input action (click on the clear button) to the controller.
void	clearParams()	Clears the search parameters of this tab.
void	onSelection()	Will be triggered when the tab is selected.
void	onSort(String sortParams, String filter)	Sorts the list, if present.
void	removeParam(String paramKey)	Removes the search parameter with the given key from the search object.
void	setDateCreatedEnd(long createdEnd)	Delegates the value for the created until date to the controller.
void	setDateCreatedStart(long createdStart)	Delegates the value for the created since date to the controller.
void	setDateModifiedEnd(long modifiedEnd)	Delegates the value for the modified until date to the controller.
void	setDateModifiedStart(long modifiedStart)	Delegates the value for the modified since date to the controller.
void	setIncludeExpired(boolean includeExpired, boolean fireEvent)	Sets if the search should include expired or unreleased resources.
void	setLocale(String locale)	Delegates the locale value to the controller.
void	setScope(org.opencms.ade.galleries.shared.CmsGallerySearchScope scope)	Sets the search scope.

Methods inherited from class org.opencms.ade.galleries.client.A_CmsTabHandler

addSearchChangeHandler, getGalleryInfo, getTypeInfo, onClose, onDeselection, selectResource, selectResultTab, setSearchQuery, updateIndex, updateSize

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

CmsSearchTabHandler

public CmsSearchTabHandler(CmsGalleryController controller)

Constructor.

Parameters:

controller - the gallery controller

Method Details

clearInput

public void clearInput()

Delegates the clear input action (click on the clear button) to the controller.

clearParams

public void clearParams()

Description copied from class: A_CmsTabHandler

Clears the search parameters of this tab.

Specified by:

clearParams in class A_CmsTabHandler

See Also:

• A_CmsTabHandler.clearParams()

onSelection

public void onSelection()

Description copied from class: A_CmsTabHandler

Will be triggered when the tab is selected.

Specified by:

onSelection in class A_CmsTabHandler

See Also:

• A_CmsTabHandler.onSelection()

onSort

public void onSort(String sortParams,
 String filter)

Description copied from class: A_CmsTabHandler

Sorts the list, if present.

Specified by:

onSort in class A_CmsTabHandler

Parameters:

sortParams - the sort parameters

filter - the filter phrase

See Also:

• A_CmsTabHandler.onSort(java.lang.String, java.lang.String)

removeParam

public void removeParam(String paramKey)

Description copied from class: A_CmsTabHandler

Removes the search parameter with the given key from the search object.

Specified by:

removeParam in class A_CmsTabHandler

Parameters:

paramKey - the parameter key

See Also:

• A_CmsTabHandler.removeParam(java.lang.String)

setDateCreatedEnd

public void setDateCreatedEnd(long createdEnd)

Delegates the value for the created until date to the controller.

Parameters:

createdEnd - the created until date as long

setDateCreatedStart

public void setDateCreatedStart(long createdStart)

Delegates the value for the created since date to the controller.

Parameters:

createdStart - the created since date as long

setDateModifiedEnd

public void setDateModifiedEnd(long modifiedEnd)

Delegates the value for the modified until date to the controller.

Parameters:

modifiedEnd - the modified until date as long

setDateModifiedStart

public void setDateModifiedStart(long modifiedStart)

Delegates the value for the modified since date to the controller.

Parameters:

modifiedStart - the modified since date as long

setIncludeExpired

public void setIncludeExpired(boolean includeExpired,
 boolean fireEvent)

Sets if the search should include expired or unreleased resources.

Parameters:

includeExpired - if the search should include expired or unreleased resources

fireEvent - true if a change event should be fired

setLocale

public void setLocale(String locale)

Delegates the locale value to the controller.

Parameters:

locale - the locale

setScope

public void setScope(org.opencms.ade.galleries.shared.CmsGallerySearchScope scope)

Sets the search scope.

Parameters:

scope - the search scope