Package org.opencms.ade.galleries.client

Class CmsResultsTabHandler

java.lang.Object

org.opencms.ade.galleries.client.A_CmsTabHandler

org.opencms.ade.galleries.client.CmsResultsTabHandler

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 CmsResultsTabHandler
extends A_CmsTabHandler

The results tab handler.

This class receives event information from the results tab and delegates it to the gallery 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
CmsResultsTabHandler(CmsGalleryController controller)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	clearParams()	Clears the search parameters of this tab.
void	deleteResource(java.lang.String resourcePath)	Deletes the given resource.
java.lang.String	getResultViewType()	Returns the result view type.
boolean	hasPreview(java.lang.String resourceType)	Returns if a preview is available for the given resource type.
boolean	hasSelectResource()	Returns if resource entries in the search result are selectable.
boolean	isLoading()	Returns if a load results request is currently running.
void	onClose(com.google.gwt.event.logical.shared.CloseEvent<com.google.gwt.user.client.ui.PopupPanel> event)	Execute when the upload dialog is closed.
void	onScrollToBottom()	Will be triggered when the bottom of the result list is reached by scrolling.
void	onSelection()	Will be triggered when the tab is selected.
void	onSort(java.lang.String sortParams, java.lang.String filter)	Sorts the list, if present.
void	openPreview(java.lang.String resourcePath, java.lang.String resourceType)	Will be triggered when the result item is clicked.
void	removeParam(java.lang.String paramKey)	Removes the search parameter with the given key from the search object.
void	setResultViewType(java.lang.String resultViewType)	Stores the result view type.
void	setScope(org.opencms.ade.galleries.shared.CmsGallerySearchScope scope)	Sets the search scope.
void	updateResult()	Updates the result tab.

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

addSearchChangeHandler, getGalleryInfo, getTypeInfo, 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 Detail

CmsResultsTabHandler

public CmsResultsTabHandler(CmsGalleryController controller)

Constructor.

Parameters:

controller - the gallery controller

Method Detail

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()

deleteResource

public void deleteResource(java.lang.String resourcePath)

Deletes the given resource.

Parameters:

resourcePath - the resource path of the resource to delete

getResultViewType

public java.lang.String getResultViewType()

Returns the result view type.

Returns:

the result view type

hasPreview

public boolean hasPreview(java.lang.String resourceType)

Returns if a preview is available for the given resource type.

Parameters:

resourceType - the requested resource type

Returns:

true if a preview is available for the given resource type

hasSelectResource

public boolean hasSelectResource()

Returns if resource entries in the search result are selectable.

Returns:

if resource entries in the search result are selectable

isLoading

public boolean isLoading()

Returns if a load results request is currently running.

Returns:

true if a load results request is currently running

onClose

public void onClose(com.google.gwt.event.logical.shared.CloseEvent<com.google.gwt.user.client.ui.PopupPanel> event)

Description copied from class: A_CmsTabHandler

Execute when the upload dialog is closed.

Specified by:

onClose in interface com.google.gwt.event.logical.shared.CloseHandler<com.google.gwt.user.client.ui.PopupPanel>

Overrides:

onClose in class A_CmsTabHandler

Parameters:

event - the close event

See Also:

A_CmsTabHandler.onClose(com.google.gwt.event.logical.shared.CloseEvent)

onScrollToBottom

public void onScrollToBottom()

Will be triggered when the bottom of the result list is reached by scrolling.

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(java.lang.String sortParams,
                   java.lang.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)

openPreview

public void openPreview(java.lang.String resourcePath,
                        java.lang.String resourceType)

Will be triggered when the result item is clicked.

Parameters:

resourcePath - the resource path of the result

resourceType - the resource type

removeParam

public void removeParam(java.lang.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)

setResultViewType

public void setResultViewType(java.lang.String resultViewType)

Stores the result view type.

Parameters:

resultViewType - the result view type

setScope

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

Sets the search scope.

Parameters:

scope - the search scope

updateResult

public void updateResult()

Updates the result tab.