Package org.opencms.gwt.client.ui.input

Class CmsCategoryField

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.gwt.client.ui.input.CmsCategoryField

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, I_CmsHasInit, I_CmsHasResizeOnShow, I_CmsFormWidget

public class CmsCategoryField
extends com.google.gwt.user.client.ui.Composite
implements I_CmsFormWidget, I_CmsHasInit, I_CmsHasResizeOnShow

Basic category widget for forms.

Since:

8.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	CmsCategoryField.A_SelectionHandler	Selection handler to handle check box click events and double clicks on the list items.

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

Nested classes/interfaces inherited from interface org.opencms.gwt.client.ui.input.I_CmsFormWidget

I_CmsFormWidget.FieldType

Field Summary

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

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor	Description
CmsCategoryField()	Category field widgets for ADE forms.

Method Summary

Modifier and Type	Method	Description
void	buildCategoryTree(java.util.List<org.opencms.gwt.shared.CmsCategoryTreeEntry> treeEntries, java.util.Collection<java.lang.String> selectedCategories)	Builds and shows the category tree.
java.util.List<java.lang.String>	getAllSitePath()	Returns the site path of all shown categories.
java.lang.String	getApparentValue()	Returns the "apparent value", i.e.
I_CmsFormWidget.FieldType	getFieldType()	Returns the type of data this widget produces.
java.lang.Object	getFormValue()	Gets the selected/entered value from the widget.
java.lang.String	getFormValueAsString()	Gets the current value of the widget as a string.
CmsScrollPanel	getScrollPanel()	Returns the scroll panel of this widget.
java.lang.String	getSingelSitePath()	Returns the site path of the last category.
int	getValuesSet()	Returns the count of values set to show.
static void	initClass()	Initializes this class.
boolean	isEnabled()	Returns true if this widget is enabled.
static boolean	isParentCategoryOfSelected(java.lang.String category, java.util.Collection<java.lang.String> selection)	Checks if the given category is a parent category of any element of the given selection.
protected void	onAttach()
void	reset()	Resets the widget to its default state.
void	resizeOnShow()	Adjusts widget's size once it's visible.
void	setAutoHideParent(I_CmsAutoHider autoHideParent)	Call this when auto hiding parents are shown.
void	setEnabled(boolean enabled)	Enables or disables the widget.
void	setErrorMessage(java.lang.String errorMessage)	Sets the error message for this widget.
void	setFormValueAsString(java.lang.String value)	Sets the current value of the widget as a string.
void	setHeight(int height)	Sets the height of this category field.
void	setParentSelection(boolean value)	Sets if the parent category should be selected with the child or not.
void	setSelected(java.lang.Object value)	Sets the value of the widget.
void	setSelectedAsString(java.lang.String newValue)	Set the selected categories.

Methods inherited from class com.google.gwt.user.client.ui.Composite

claimElement, getWidget, initializeClaimedElement, initWidget, isAttached, 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

Constructor Detail

CmsCategoryField

public CmsCategoryField()

Category field widgets for ADE forms.

Method Detail

initClass

public static void initClass()

Initializes this class.

isParentCategoryOfSelected

public static boolean isParentCategoryOfSelected(java.lang.String category,
                                                 java.util.Collection<java.lang.String> selection)

Checks if the given category is a parent category of any element of the given selection.

The selection might contain either category paths or site paths of categories.

Parameters:

category - a category path

selection - a set containing either category paths or category site paths

Returns:

true if the category is a parent category of any element of the given selection

buildCategoryTree

public void buildCategoryTree(java.util.List<org.opencms.gwt.shared.CmsCategoryTreeEntry> treeEntries,
                              java.util.Collection<java.lang.String> selectedCategories)

Builds and shows the category tree.

Parameters:

treeEntries - List of category entries

selectedCategories - a list of all selected categories

getAllSitePath

public java.util.List<java.lang.String> getAllSitePath()

Returns the site path of all shown categories.

Returns:

the site path of all shown categories

getApparentValue

public java.lang.String getApparentValue()

Description copied from interface: I_CmsFormWidget

Returns the "apparent value", i.e. either the real value if available, or else the ghost value if available, or null otherwise.

Specified by:

getApparentValue in interface I_CmsFormWidget

Returns:

the apparent value

See Also:

I_CmsFormWidget.getApparentValue()

getFieldType

public I_CmsFormWidget.FieldType getFieldType()

Description copied from interface: I_CmsFormWidget

Returns the type of data this widget produces.

Specified by:

getFieldType in interface I_CmsFormWidget

Returns:

the data type

See Also:

I_CmsFormWidget.getFieldType()

getFormValue

public java.lang.Object getFormValue()

Description copied from interface: I_CmsFormWidget

Gets the selected/entered value from the widget.

Specified by:

getFormValue in interface I_CmsFormWidget

Returns:

the value

See Also:

I_CmsFormWidget.getFormValue()

getFormValueAsString

public java.lang.String getFormValueAsString()

Description copied from interface: I_CmsFormWidget

Gets the current value of the widget as a string.

Specified by:

getFormValueAsString in interface I_CmsFormWidget

Returns:

the current value of the widget

See Also:

I_CmsFormWidget.getFormValueAsString()

getScrollPanel

public CmsScrollPanel getScrollPanel()

Returns the scroll panel of this widget.

Returns:

the scroll panel

getSingelSitePath

public java.lang.String getSingelSitePath()

Returns the site path of the last category.

Returns:

the site path of the last category

getValuesSet

public int getValuesSet()

Returns the count of values set to show.

Returns:

the count of values set to show

isEnabled

public boolean isEnabled()

Description copied from interface: I_CmsFormWidget

Returns true if this widget is enabled.

Specified by:

isEnabled in interface I_CmsFormWidget

Returns:

true if this widget is enabled

See Also:

I_CmsFormWidget.isEnabled()

reset

public void reset()

Description copied from interface: I_CmsFormWidget

Resets the widget to its default state.

Specified by:

reset in interface I_CmsFormWidget

See Also:

I_CmsFormWidget.reset()

resizeOnShow

public void resizeOnShow()

Description copied from interface: I_CmsHasResizeOnShow

Adjusts widget's size once it's visible.

Specified by:

resizeOnShow in interface I_CmsHasResizeOnShow

See Also:

I_CmsHasResizeOnShow.resizeOnShow()

setAutoHideParent

public void setAutoHideParent(I_CmsAutoHider autoHideParent)

Description copied from interface: I_CmsFormWidget

Call this when auto hiding parents are shown.

Specified by:

setAutoHideParent in interface I_CmsFormWidget

Parameters:

autoHideParent - the auto hide parent

See Also:

I_CmsFormWidget.setAutoHideParent(org.opencms.gwt.client.ui.I_CmsAutoHider)

setEnabled

public void setEnabled(boolean enabled)

Description copied from interface: I_CmsFormWidget

Enables or disables the widget.

Specified by:

setEnabled in interface I_CmsFormWidget

Parameters:

enabled - if true, the widget will be enabled, else disabled

See Also:

I_CmsFormWidget.setEnabled(boolean)

setErrorMessage

public void setErrorMessage(java.lang.String errorMessage)

Description copied from interface: I_CmsFormWidget

Sets the error message for this widget.

If the error message is null, no error message will be displayed.

Specified by:

setErrorMessage in interface I_CmsFormWidget

Parameters:

errorMessage - an error message or null

See Also:

I_CmsFormWidget.setErrorMessage(java.lang.String)

setFormValueAsString

public void setFormValueAsString(java.lang.String value)

Description copied from interface: I_CmsFormWidget

Sets the current value of the widget as a string.

Specified by:

setFormValueAsString in interface I_CmsFormWidget

Parameters:

value - the new value of the widget

See Also:

I_CmsFormWidget.setFormValueAsString(java.lang.String)

setHeight

public void setHeight(int height)

Sets the height of this category field.

Parameters:

height - the height of this category field

setParentSelection

public void setParentSelection(boolean value)

Sets if the parent category should be selected with the child or not.

Parameters:

value - if the parent categories should be selected or not

setSelected

public void setSelected(java.lang.Object value)

Sets the value of the widget.

Parameters:

value - the new value

setSelectedAsString

public void setSelectedAsString(java.lang.String newValue)

Set the selected categories.

Parameters:

newValue - String of selected categories separated by '|'

onAttach

protected void onAttach()

Overrides:

onAttach in class com.google.gwt.user.client.ui.Composite

See Also:

Composite.onAttach()