com.alkacon.geranium.client.ui.input

Class RadioButtonGroupWidget

java.lang.Object

com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.Widget

com.google.gwt.user.client.ui.Composite

com.alkacon.geranium.client.ui.input.RadioButtonGroupWidget

All Implemented Interfaces:

I_HasInit, I_FormWidget, 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

public class RadioButtonGroupWidget
extends com.google.gwt.user.client.ui.Composite
implements I_FormWidget, com.google.gwt.event.logical.shared.HasValueChangeHandlers<java.lang.String>, I_HasInit

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 RadioButton instances and link them with a RadioButtonGroup.

Nested Class Summary

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 com.alkacon.geranium.client.ui.input.I_FormWidget

I_FormWidget.FieldType

Field Summary

Fields

Modifier and Type	Field and Description
protected com.google.gwt.event.shared.SimpleEventBus	m_eventBus The event bus.
static java.lang.String	WIDGET_TYPE The widget type identifier.

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

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor and Description
RadioButtonGroupWidget(java.util.Map<java.lang.String,java.lang.String> items) Creates a new instance from a map of strings.

Method Summary

Methods

Modifier and Type	Method and Description
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_FormWidget.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.
boolean	isEnabled() Returns true if this widget is enabled.
void	reset() Resets the widget to its default state.
void	setAutoHideParent(I_AutoHider 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.

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

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

Field Detail

WIDGET_TYPE

public static final java.lang.String WIDGET_TYPE

The widget type identifier.

See Also:

Constant Field Values

m_eventBus

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

The event bus.

Constructor Detail

RadioButtonGroupWidget

public RadioButtonGroupWidget(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.

Parameters:

items - the string map containing the select options

Method Detail

addValueChangeHandler

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

Specified by:

addValueChangeHandler in interface com.google.gwt.event.logical.shared.HasValueChangeHandlers<java.lang.String>

See Also:

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

fireEvent

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

Specified by:

fireEvent in interface com.google.gwt.event.shared.HasHandlers

Overrides:

fireEvent in class com.google.gwt.user.client.ui.Widget

See Also:

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

getApparentValue

public java.lang.String getApparentValue()

Description copied from interface: I_FormWidget

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_FormWidget

Returns:

the apparent value

See Also:

I_FormWidget.getApparentValue()

getFieldType

public I_FormWidget.FieldType getFieldType()

Description copied from interface: I_FormWidget

Returns the type of data this widget produces.

Specified by:

getFieldType in interface I_FormWidget

Returns:

the data type

See Also:

I_FormWidget.getFieldType()

getFormValue

public java.lang.Object getFormValue()

Description copied from interface: I_FormWidget

Gets the selected/entered value from the widget.

Specified by:

getFormValue in interface I_FormWidget

Returns:

the value

See Also:

I_FormWidget.getFormValue()

getFormValueAsString

public java.lang.String getFormValueAsString()

Description copied from interface: I_FormWidget

Gets the current value of the widget as a string.

Specified by:

getFormValueAsString in interface I_FormWidget

Returns:

the current value of the widget

See Also:

I_FormWidget.getFormValueAsString()

isEnabled

public boolean isEnabled()

Description copied from interface: I_FormWidget

Returns true if this widget is enabled.

Specified by:

isEnabled in interface I_FormWidget

Returns:

true if this widget is enabled

See Also:

I_FormWidget.isEnabled()

reset

public void reset()

Description copied from interface: I_FormWidget

Resets the widget to its default state.

Specified by:

reset in interface I_FormWidget

See Also:

I_FormWidget.reset()

setAutoHideParent

public void setAutoHideParent(I_AutoHider autoHideParent)

Description copied from interface: I_FormWidget

Call this when auto hiding parents are shown.

Specified by:

setAutoHideParent in interface I_FormWidget

Parameters:

autoHideParent - the auto hide parent

See Also:

I_FormWidget.setAutoHideParent(com.alkacon.geranium.client.ui.I_AutoHider)

setEnabled

public void setEnabled(boolean enabled)

Description copied from interface: I_FormWidget

Enables or disables the widget.

Specified by:

setEnabled in interface I_FormWidget

Parameters:

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

See Also:

I_FormWidget.setEnabled(boolean)

setErrorMessage

public void setErrorMessage(java.lang.String errorMessage)

Description copied from interface: I_FormWidget

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_FormWidget

Parameters:

errorMessage - an error message or null

See Also:

I_FormWidget.setErrorMessage(java.lang.String)

setFormValue

public void setFormValue(java.lang.Object value)

Sets the value of the widget.

Parameters:

value - the new value

setFormValueAsString

public void setFormValueAsString(java.lang.String formValue)

Description copied from interface: I_FormWidget

Sets the current value of the widget as a string.

Specified by:

setFormValueAsString in interface I_FormWidget

Parameters:

formValue - the new value of the widget

See Also:

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

Parameters:

items - the list of select options