org.opencms.gwt.client.ui.input

类 CmsRadioButtonGroupWidget

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

所有已实现的接口:

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

Widget class consisting of a group of radio buttons, of which at most one may be active.

This is mostly a 'convenience widget' for creating and handling multiple radio buttons as a single widget. The radio buttons will be layed out vertically. If you need more control about the layout of the radio buttons, use multiple CmsRadioButton instances and link them with a CmsRadioButtonGroup.

从以下版本开始:

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 com.google.gwt.event.shared.SimpleEventBus	m_eventBus The event bus.
static java.lang.String	WIDGET_TYPE The widget type identifier.

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

DEBUG_ID_PREFIX

构造器概要

构造器

构造器和说明
CmsRadioButtonGroupWidget(java.util.List<CmsPair<java.lang.String,java.lang.String>> items) Creates a new instance from a list of key/value pairs.
CmsRadioButtonGroupWidget(java.util.Map<java.lang.String,java.lang.String> items) Creates a new instance from a map of strings.

方法概要

方法

限定符和类型	方法和说明
com.google.gwt.event.shared.HandlerRegistration	addValueChangeHandler(com.google.gwt.event.logical.shared.ValueChangeHandler<java.lang.String> handler)
void	fireEvent(com.google.gwt.event.shared.GwtEvent<?> 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.
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.
protected void	init(java.util.Map<java.lang.String,java.lang.String> items) Internal method for initializing the widget with a list 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.

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

字段详细资料

WIDGET_TYPE

public static final java.lang.String WIDGET_TYPE

The widget type identifier.

另请参阅:

常量字段值

m_eventBus

protected com.google.gwt.event.shared.SimpleEventBus m_eventBus

The event bus.

构造器详细资料

CmsRadioButtonGroupWidget

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

Creates a new instance from a list of key/value pairs.

The first component of each pair is the value of the radio buttons, the second component is used as the label.

参数:

items - a list of pairs of strings

CmsRadioButtonGroupWidget

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

Creates a new instance from a map of strings.

The keys of the map are used as the values of the radio buttons, and the values of the map are used as labels for the radio buttons.

参数:

items - the string map containing the select 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)

fireEvent

public void fireEvent(com.google.gwt.event.shared.GwtEvent<?> event)

指定者:

fireEvent 在接口中 com.google.gwt.event.shared.HasHandlers

覆盖:

fireEvent 在类中 com.google.gwt.user.client.ui.Widget

另请参阅:

Widget.fireEvent(com.google.gwt.event.shared.GwtEvent)

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

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)

init

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

Internal method for initializing the widget with a list of select options.

参数:

items - the list of select options