org.opencms.gwt.client.ui.input

类 CmsMultiCheckBox

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.CmsMultiCheckBox

所有已实现的接口:

com.google.gwt.event.dom.client.HasFocusHandlers, com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.logical.shared.HasValueChangeHandlers<java.lang.String>, 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 CmsMultiCheckBox
extends com.google.gwt.user.client.ui.Composite
implements I_CmsFormWidget, I_CmsHasInit, com.google.gwt.event.logical.shared.HasValueChangeHandlers<java.lang.String>, com.google.gwt.event.dom.client.HasFocusHandlers

A form widget consisting of a group of checkboxes.

从以下版本开始:

8.0.0

嵌套类概要

从类继承的嵌套类/接口 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

字段概要

字段

限定符和类型	字段和说明
protected java.util.List<CmsCheckBox>	m_checkboxes The list of checkboxes.
protected CmsErrorWidget	m_error Error display for this widget.
protected java.util.Map<java.lang.String,java.lang.String>	m_items The select options of the multi check box.
protected com.google.gwt.user.client.ui.Panel	m_panel Panel which contains all the components of the widget.
static java.lang.String	WIDGET_TYPE The type string for this widget.

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

DEBUG_ID_PREFIX

构造器概要

构造器

构造器和说明
CmsMultiCheckBox(java.util.List<CmsPair<java.lang.String,java.lang.String>> items) Constructs a new checkbox group from a list of string pairs.
CmsMultiCheckBox(java.util.Map<java.lang.String,java.lang.String> items) Constructs a new checkbox group from a map from strings to strings.

方法概要

方法

限定符和类型	方法和说明
com.google.gwt.event.shared.HandlerRegistration	addFocusHandler(com.google.gwt.event.dom.client.FocusHandler handler)
com.google.gwt.event.shared.HandlerRegistration	addValueChangeHandler(com.google.gwt.event.logical.shared.ValueChangeHandler<java.lang.String> handler)
protected void	fireValueChanged(java.lang.String newValue) Fires the value change event for the widget.
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.
java.util.List<CmsCheckBox>	getCheckboxes() Returns a list of all checkboxes.
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.
java.util.Set<java.lang.String>	getSelected() Returns the set of values of the selected checkboxes.
protected void	init(java.util.Map<java.lang.String,java.lang.String> items) Initializes the widget given a map of select options.
static void	initClass() Initializes this class.
boolean	isEnabled() Returns true if this widget is enabled.
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	setFormValue(java.lang.Object value) Sets the value of the widget.
void	setFormValueAsString(java.lang.String formValue) Sets the current value of the widget as a string.
void	setTextWeak(boolean weak) Enables or disables italics display in the checkbox labels.

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

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

从接口继承的方法 com.google.gwt.event.shared.HasHandlers

fireEvent

字段详细资料

WIDGET_TYPE

public static final java.lang.String WIDGET_TYPE

The type string for this widget.

另请参阅:

常量字段值

m_checkboxes

protected java.util.List<CmsCheckBox> m_checkboxes

The list of checkboxes.

m_error

protected CmsErrorWidget m_error

Error display for this widget.

m_items

protected java.util.Map<java.lang.String,java.lang.String> m_items

The select options of the multi check box.

m_panel

protected com.google.gwt.user.client.ui.Panel m_panel

Panel which contains all the components of the widget.

构造器详细资料

CmsMultiCheckBox

public CmsMultiCheckBox(java.util.List<CmsPair<java.lang.String,java.lang.String>> items)

Constructs a new checkbox group from a list of string pairs.

The first string of every pair is the value of the checkbox, the second string is the label.

参数:

items - a list of pairs of strings.

CmsMultiCheckBox

public CmsMultiCheckBox(java.util.Map<java.lang.String,java.lang.String> items)

Constructs a new checkbox group from a map from strings to strings.

The keys of the map are used as the selection values of the checkboxes, while the value for a given key in the map is used as the label for the checkbox which is displayed to the user.

参数:

items - the map of checkbox options

方法详细资料

initClass

public static void initClass()

Initializes this class.

addValueChangeHandler

public com.google.gwt.event.shared.HandlerRegistration addValueChangeHandler(com.google.gwt.event.logical.shared.ValueChangeHandler<java.lang.String> handler)

指定者:

addValueChangeHandler 在接口中 com.google.gwt.event.logical.shared.HasValueChangeHandlers<java.lang.String>

另请参阅:

HasValueChangeHandlers.addValueChangeHandler(com.google.gwt.event.logical.shared.ValueChangeHandler)

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

getCheckboxes

public java.util.List<CmsCheckBox> getCheckboxes()

Returns a list of all checkboxes.

返回:

a list of checkboxes

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

getSelected

public java.util.Set<java.lang.String> getSelected()

Returns the set of values of the selected checkboxes.

返回:

a set of strings

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)

setFormValue

public void setFormValue(java.lang.Object value)

Sets the value of the widget.

参数:

value - the new value

setFormValueAsString

public void setFormValueAsString(java.lang.String formValue)

从接口复制的说明: I_CmsFormWidget

Sets the current value of the widget as a string.

指定者:

setFormValueAsString 在接口中 I_CmsFormWidget

参数:

formValue - the new value of the widget

另请参阅:

I_CmsFormWidget.setFormValueAsString(java.lang.String)

setTextWeak

public void setTextWeak(boolean weak)

Enables or disables italics display in the checkbox labels.

参数:

weak - true if italics display should be enabled

fireValueChanged

protected void fireValueChanged(java.lang.String newValue)

Fires the value change event for the widget.

参数:

newValue - the new value

init

protected void init(java.util.Map<java.lang.String,java.lang.String> items)

Initializes the widget given a map of select options.

The keys of the map are the values of the select options, while the values of the map are the labels which should be used for the checkboxes.

参数:

items - the map of select options

addFocusHandler

public com.google.gwt.event.shared.HandlerRegistration addFocusHandler(com.google.gwt.event.dom.client.FocusHandler handler)

指定者:

addFocusHandler 在接口中 com.google.gwt.event.dom.client.HasFocusHandlers

另请参阅:

HasFocusHandlers.addFocusHandler(com.google.gwt.event.dom.client.FocusHandler)