org.opencms.gwt.client.ui.input

类 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

所有已实现的接口:

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_CmsFormWidget

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

Basic category widget for forms.

从以下版本开始:

8.0.0

嵌套类概要

嵌套类

限定符和类型	类和说明
protected class	CmsCategoryField.A_SelectionHandler Selection handler to handle check box click events and double clicks on the list items.

从类继承的嵌套类/接口 com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled

从接口继承的嵌套类/接口 org.opencms.gwt.client.ui.input.I_CmsFormWidget

I_CmsFormWidget.FieldType

字段概要

从类继承的字段 com.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

构造器概要

构造器

构造器和说明
CmsCategoryField() Category field widgets for ADE forms.

方法概要

方法

限定符和类型	方法和说明
void	buildCategoryTree(java.util.List<CmsCategoryTreeEntry> treeEntries, java.util.List<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. either the real value if available, or else the ghost value if available, or null otherwise.
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.
protected void	onAttach()
void	reset() Resets the widget to its default state.
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.

从类继承的方法 com.google.gwt.user.client.ui.Composite

claimElement, getWidget, initializeClaimedElement, initWidget, isAttached, onBrowserEvent, onDetach, render, render, resolvePotentialElement, setWidget

从类继承的方法 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

从类继承的方法 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, unsinkEvents

从类继承的方法 java.lang.Object

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

构造器详细资料

CmsCategoryField

public CmsCategoryField()

Category field widgets for ADE forms.

方法详细资料

initClass

public static void initClass()

Initializes this class.

buildCategoryTree

public void buildCategoryTree(java.util.List<CmsCategoryTreeEntry> treeEntries,
                     java.util.List<java.lang.String> selectedCategories)

Builds and shows the category tree.

参数:

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.

返回:

the site path of all shown categories

getApparentValue

public java.lang.String getApparentValue()

从接口复制的说明: I_CmsFormWidget

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

指定者:

getApparentValue 在接口中 I_CmsFormWidget

返回:

the apparent value

另请参阅:

I_CmsFormWidget.getApparentValue()

getFieldType

public I_CmsFormWidget.FieldType getFieldType()

从接口复制的说明: I_CmsFormWidget

Returns the type of data this widget produces.

指定者:

getFieldType 在接口中 I_CmsFormWidget

返回:

the data type

另请参阅:

I_CmsFormWidget.getFieldType()

getFormValue

public java.lang.Object getFormValue()

从接口复制的说明: I_CmsFormWidget

Gets the selected/entered value from the widget.

指定者:

getFormValue 在接口中 I_CmsFormWidget

返回:

the value

另请参阅:

I_CmsFormWidget.getFormValue()

getFormValueAsString

public java.lang.String getFormValueAsString()

从接口复制的说明: I_CmsFormWidget

Gets the current value of the widget as a string.

指定者:

getFormValueAsString 在接口中 I_CmsFormWidget

返回:

the current value of the widget

另请参阅:

I_CmsFormWidget.getFormValueAsString()

getScrollPanel

public CmsScrollPanel getScrollPanel()

Returns the scroll panel of this widget.

返回:

the scroll panel

getSingelSitePath

public java.lang.String getSingelSitePath()

Returns the site path of the last category.

返回:

the site path of the last category

getValuesSet

public int getValuesSet()

Returns the count of values set to show.

返回:

the count of values set to show

isEnabled

public boolean isEnabled()

从接口复制的说明: I_CmsFormWidget

Returns true if this widget is enabled.

指定者:

isEnabled 在接口中 I_CmsFormWidget

返回:

true if this widget is enabled

另请参阅:

I_CmsFormWidget.isEnabled()

reset

public void reset()

从接口复制的说明: I_CmsFormWidget

Resets the widget to its default state.

指定者:

reset 在接口中 I_CmsFormWidget

另请参阅:

I_CmsFormWidget.reset()

setAutoHideParent

public void setAutoHideParent(I_CmsAutoHider autoHideParent)

从接口复制的说明: I_CmsFormWidget

Call this when auto hiding parents are shown.

指定者:

setAutoHideParent 在接口中 I_CmsFormWidget

参数:

autoHideParent - the auto hide parent

另请参阅:

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

setEnabled

public void setEnabled(boolean enabled)

从接口复制的说明: I_CmsFormWidget

Enables or disables the widget.

指定者:

setEnabled 在接口中 I_CmsFormWidget

参数:

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

另请参阅:

I_CmsFormWidget.setEnabled(boolean)

setErrorMessage

public void setErrorMessage(java.lang.String errorMessage)

从接口复制的说明: I_CmsFormWidget

Sets the error message for this widget.

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

指定者:

setErrorMessage 在接口中 I_CmsFormWidget

参数:

errorMessage - an error message or null

另请参阅:

I_CmsFormWidget.setErrorMessage(java.lang.String)

setFormValueAsString

public void setFormValueAsString(java.lang.String value)

从接口复制的说明: I_CmsFormWidget

Sets the current value of the widget as a string.

指定者:

setFormValueAsString 在接口中 I_CmsFormWidget

参数:

value - the new value of the widget

另请参阅:

I_CmsFormWidget.setFormValueAsString(java.lang.String)

setHeight

public void setHeight(int height)

Sets the height of this category field.

参数:

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.

参数:

value - if the parent categories should be selected or not

setSelected

public void setSelected(java.lang.Object value)

Sets the value of the widget.

参数:

value - the new value

setSelectedAsString

public void setSelectedAsString(java.lang.String newValue)

Set the selected categories.

参数:

newValue - String of selected categories separated by '|'

onAttach

protected void onAttach()

覆盖:

onAttach 在类中 com.google.gwt.user.client.ui.Composite

另请参阅:

Composite.onAttach()