org.opencms.gwt.client.ui.input

类 CmsCheckBox

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

所有已实现的接口:

com.google.gwt.event.dom.client.HasClickHandlers, com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.logical.shared.HasValueChangeHandlers<java.lang.Boolean>, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.HasHorizontalAlignment, 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 CmsCheckBox
extends com.google.gwt.user.client.ui.Composite
implements com.google.gwt.event.dom.client.HasClickHandlers, I_CmsFormWidget, I_CmsHasInit, com.google.gwt.user.client.ui.HasHorizontalAlignment, com.google.gwt.event.logical.shared.HasValueChangeHandlers<java.lang.Boolean>

This class represents a labeled checkbox which is not represented as an INPUT element in the DOM, but is displayed as an image.

It can be checked/unchecked and enabled/disabled, which means 4 combinations in total. So you need to supply 4 images, one for each of the combinations.

从以下版本开始:

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

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

com.google.gwt.user.client.ui.HasHorizontalAlignment.AutoHorizontalAlignmentConstant, com.google.gwt.user.client.ui.HasHorizontalAlignment.HorizontalAlignmentConstant

字段概要

字段

限定符和类型	字段和说明
static java.lang.String	WIDGET_TYPE Type string for this widget.

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

DEBUG_ID_PREFIX

从接口继承的字段 com.google.gwt.user.client.ui.HasHorizontalAlignment

ALIGN_CENTER, ALIGN_DEFAULT, ALIGN_JUSTIFY, ALIGN_LEFT, ALIGN_LOCALE_END, ALIGN_LOCALE_START, ALIGN_RIGHT

构造器概要

构造器

构造器和说明
CmsCheckBox() Default constructor which creates a checkbox without a label.
CmsCheckBox(java.lang.String labelText) Public constructor for a checkbox.

方法概要

方法

限定符和类型	方法和说明
com.google.gwt.event.shared.HandlerRegistration	addClickHandler(com.google.gwt.event.dom.client.ClickHandler handler) Adds a click handler to the checkbox.
com.google.gwt.event.shared.HandlerRegistration	addValueChangeHandler(com.google.gwt.event.logical.shared.ValueChangeHandler<java.lang.Boolean> handler)
void	disable(java.lang.String disabledReason) Disables the checkbox and changes the checkbox title attribute to the disabled reason.
void	enable() Enables the checkbox, switching the checkbox title attribute from the disabled reason to the original title.
protected void	fireValueChangedEvent() Helper method for firing a 'value changed' event.
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.
CmsToggleButton	getButton() Gets the toggle button used internally.
I_CmsFormWidget.FieldType	getFieldType() Returns the type of data this widget produces.
java.lang.Boolean	getFormValue() Gets the selected/entered value from the widget.
java.lang.String	getFormValueAsString() Gets the current value of the widget as a string.
com.google.gwt.user.client.ui.HasHorizontalAlignment.HorizontalAlignmentConstant	getHorizontalAlignment() This is the alignment of the text in reference to the checkbox, possible values are left or right.
java.lang.String	getInternalValue() Returns the internal value of this Checkbox.
java.lang.String	getText() Returns the text.
static void	initClass() Initializes this class.
boolean	isChecked() Returns true if the checkbox is checked.
boolean	isEnabled() Returns true if the checkbox 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	setChecked(boolean checked) Checks or unchecks the checkbox.
void	setEnabled(boolean enabled) Enables or disables the checkbox.
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 value) Sets the current value of the widget as a string.
void	setHorizontalAlignment(com.google.gwt.user.client.ui.HasHorizontalAlignment.HorizontalAlignmentConstant align) This is the alignment of the text in reference to the checkbox, possible values are left or right.
void	setInternalValue(java.lang.String value) Sets the internal value of this Checkbox.
void	setText(java.lang.String text) Sets the text.

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

Type string for this widget.

另请参阅:

常量字段值

构造器详细资料

CmsCheckBox

public CmsCheckBox()

Default constructor which creates a checkbox without a label.

CmsCheckBox

public CmsCheckBox(java.lang.String labelText)

Public constructor for a checkbox.

The label text passed will be displayed to the right of the checkbox. If it is null, no label is displayed.

参数:

labelText - the label text

方法详细资料

initClass

public static void initClass()

Initializes this class.

addClickHandler

public com.google.gwt.event.shared.HandlerRegistration addClickHandler(com.google.gwt.event.dom.client.ClickHandler handler)

Adds a click handler to the checkbox.

指定者:

addClickHandler 在接口中 com.google.gwt.event.dom.client.HasClickHandlers

另请参阅:

HasClickHandlers.addClickHandler(com.google.gwt.event.dom.client.ClickHandler)

addValueChangeHandler

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

指定者:

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

另请参阅:

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

disable

public void disable(java.lang.String disabledReason)

Disables the checkbox and changes the checkbox title attribute to the disabled reason.

参数:

disabledReason - the disabled reason

enable

public void enable()

Enables the checkbox, switching the checkbox title attribute from the disabled reason to the original title.

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

getButton

public CmsToggleButton getButton()

Gets the toggle button used internally.

返回:

the toggle button

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

getHorizontalAlignment

public com.google.gwt.user.client.ui.HasHorizontalAlignment.HorizontalAlignmentConstant getHorizontalAlignment()

This is the alignment of the text in reference to the checkbox, possible values are left or right.

指定者:

getHorizontalAlignment 在接口中 com.google.gwt.user.client.ui.HasHorizontalAlignment

另请参阅:

HasHorizontalAlignment.getHorizontalAlignment()

getInternalValue

public java.lang.String getInternalValue()

Returns the internal value of this Checkbox.

返回:

the internal value of this Checkbox

getText

public java.lang.String getText()

Returns the text.

返回:

the text as String

isChecked

public boolean isChecked()

Returns true if the checkbox is checked.

返回:

true if the checkbox is checked

isEnabled

public boolean isEnabled()

Returns true if the checkbox is enabled.

指定者:

isEnabled 在接口中 I_CmsFormWidget

返回:

true if the checkbox is enabled

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)

setChecked

public void setChecked(boolean checked)

Checks or unchecks the checkbox.

参数:

checked - if true, check the checkbox else uncheck it

setEnabled

public void setEnabled(boolean enabled)

Enables or disables the checkbox.

指定者:

setEnabled 在接口中 I_CmsFormWidget

参数:

enabled - if true, enable the checkbox, else disable it

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

setHorizontalAlignment

public void setHorizontalAlignment(com.google.gwt.user.client.ui.HasHorizontalAlignment.HorizontalAlignmentConstant align)

This is the alignment of the text in reference to the checkbox, possible values are left or right.

指定者:

setHorizontalAlignment 在接口中 com.google.gwt.user.client.ui.HasHorizontalAlignment

另请参阅:

HasHorizontalAlignment.setHorizontalAlignment(com.google.gwt.user.client.ui.HasHorizontalAlignment.HorizontalAlignmentConstant)

setInternalValue

public void setInternalValue(java.lang.String value)

Sets the internal value of this Checkbox.

参数:

value - the new internal value

setText

public void setText(java.lang.String text)

Sets the text.

参数:

text - the text to set

fireValueChangedEvent

protected void fireValueChangedEvent()

Helper method for firing a 'value changed' event.