Package org.opencms.ade.galleries.client

Class A_CmsTabHandler

java.lang.Object

org.opencms.ade.galleries.client.A_CmsTabHandler

All Implemented Interfaces:

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

Direct Known Subclasses:

CmsCategoriesTabHandler, CmsGalleriesTabHandler, CmsResultsTabHandler, CmsSearchTabHandler, CmsSitemapTabHandler, CmsTypesTabHandler, CmsVfsTabHandler

public abstract class A_CmsTabHandler
extends java.lang.Object
implements com.google.gwt.event.logical.shared.CloseHandler<com.google.gwt.user.client.ui.PopupPanel>

The abstract class for the tab handler.

This class receives event information from the gallery dialog and delegates it to the gallery controller.

Since:

8.0.0

Field Summary

Fields

Modifier and Type	Field	Description
protected CmsGalleryController	m_controller	The gallery controller.

Constructor Summary

Constructors

Constructor	Description
A_CmsTabHandler(CmsGalleryController controller)	Constructor.

Method Summary

Modifier and Type	Method	Description
com.google.gwt.event.shared.HandlerRegistration	addSearchChangeHandler(com.google.gwt.event.logical.shared.ValueChangeHandler<org.opencms.ade.galleries.shared.CmsGallerySearchBean> handler)	Adds a change handler for the gallery search bean.
abstract void	clearParams()	Clears the search parameters of this tab.
org.opencms.ade.galleries.shared.CmsGalleryFolderBean	getGalleryInfo(java.lang.String galleryPath)	Returns the gallery folder info to the given path.
org.opencms.ade.galleries.shared.CmsResourceTypeBean	getTypeInfo(java.lang.String typeName)	Returns the resource type info for the given resource type name.
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	onDeselection()	Will be triggered when the tab is deselected.
abstract void	onSelection()	Will be triggered when the tab is selected.
abstract void	onSort(java.lang.String sortParams, java.lang.String filter)	Sorts the list, if present.
abstract void	removeParam(java.lang.String paramKey)	Removes the search parameter with the given key from the search object.
void	selectResource(java.lang.String resourcePath, org.opencms.util.CmsUUID structureId, java.lang.String title, java.lang.String resourceType)	Selects the given resource and sets its path into the xml-content field or editor link.
void	selectResultTab()	Selects the result tab.
void	setSearchQuery(java.lang.String searchQuery)	Delegates the clear input action (click on the clear button) to the controller.
void	updateIndex()	Updates the gallery index and triggers a new search afterwards.
void	updateSize()	Updates the tab size.

Methods inherited from class java.lang.Object

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

Field Detail

m_controller

protected CmsGalleryController m_controller

The gallery controller.

Constructor Detail

A_CmsTabHandler

public A_CmsTabHandler(CmsGalleryController controller)

Constructor.

Parameters:

controller - the controller

Method Detail

addSearchChangeHandler

public com.google.gwt.event.shared.HandlerRegistration addSearchChangeHandler(com.google.gwt.event.logical.shared.ValueChangeHandler<org.opencms.ade.galleries.shared.CmsGallerySearchBean> handler)

Adds a change handler for the gallery search bean.

Parameters:

handler - the handler

Returns:

the handler registration

clearParams

public abstract void clearParams()

Clears the search parameters of this tab.

getGalleryInfo

public org.opencms.ade.galleries.shared.CmsGalleryFolderBean getGalleryInfo(java.lang.String galleryPath)

Returns the gallery folder info to the given path.

Parameters:

galleryPath - the gallery folder path

Returns:

the gallery folder info

getTypeInfo

public org.opencms.ade.galleries.shared.CmsResourceTypeBean getTypeInfo(java.lang.String typeName)

Returns the resource type info for the given resource type name.

Parameters:

typeName - the resource type name

Returns:

the type info

onClose

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

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>

Parameters:

event - the close event

onDeselection

public void onDeselection()

Will be triggered when the tab is deselected.

onSelection

public abstract void onSelection()

Will be triggered when the tab is selected.

onSort

public abstract void onSort(java.lang.String sortParams,
                            java.lang.String filter)

Sorts the list, if present.

Parameters:

sortParams - the sort parameters

filter - the filter phrase

removeParam

public abstract void removeParam(java.lang.String paramKey)

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

Parameters:

paramKey - the parameter key

selectResource

public void selectResource(java.lang.String resourcePath,
                           org.opencms.util.CmsUUID structureId,
                           java.lang.String title,
                           java.lang.String resourceType)

Selects the given resource and sets its path into the xml-content field or editor link.

Parameters:

resourcePath - the item resource path

structureId - the structure id

title - the resource title

resourceType - the item resource type

selectResultTab

public void selectResultTab()

Selects the result tab.

setSearchQuery

public void setSearchQuery(java.lang.String searchQuery)

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

Parameters:

searchQuery - the search query

updateIndex

public void updateIndex()

Updates the gallery index and triggers a new search afterwards.

updateSize

public void updateSize()

Updates the tab size.