com.alkacon.geranium.client.ui.input

Class CheckBox

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

All Implemented Interfaces:

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

public class CheckBox
extends com.google.gwt.user.client.ui.Composite
implements com.google.gwt.event.dom.client.HasClickHandlers, I_FormWidget, I_HasInit, 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.

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

Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.HasHorizontalAlignment

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

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	WIDGET_TYPE Type string for this widget.

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

DEBUG_ID_PREFIX

Fields inherited from interface com.google.gwt.user.client.ui.HasHorizontalAlignment

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

Constructor Summary

Constructors

Constructor and Description
CheckBox() Default constructor which creates a checkbox without a label.
CheckBox(java.lang.String labelText) Public constructor for a checkbox.

Method Summary

Methods

Modifier and Type	Method and Description
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.
I_FormWidget.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.
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_AutoHider 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	setText(java.lang.String text) Sets the text.

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, fireEvent, getHandlerCount, getLayoutData, getParent, isOrWasAttached, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents

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, unsinkEvents

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.gwt.event.shared.HasHandlers

fireEvent

Field Detail

WIDGET_TYPE

public static final java.lang.String WIDGET_TYPE

Type string for this widget.

See Also:

Constant Field Values

Constructor Detail

CheckBox

public CheckBox()

Default constructor which creates a checkbox without a label.

CheckBox

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

Parameters:

labelText - the label text

Method Detail

addClickHandler

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

Adds a click handler to the checkbox.

Specified by:

addClickHandler in interface com.google.gwt.event.dom.client.HasClickHandlers

See Also:

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)

Specified by:

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

See Also:

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.

Parameters:

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

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

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.

Specified by:

getHorizontalAlignment in interface com.google.gwt.user.client.ui.HasHorizontalAlignment

See Also:

HasHorizontalAlignment.getHorizontalAlignment()

isChecked

public boolean isChecked()

Returns true if the checkbox is checked.

Returns:

true if the checkbox is checked

isEnabled

public boolean isEnabled()

Returns true if the checkbox is enabled.

Specified by:

isEnabled in interface I_FormWidget

Returns:

true if the checkbox is enabled

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)

setChecked

public void setChecked(boolean checked)

Checks or unchecks the checkbox.

Parameters:

checked - if true, check the checkbox else uncheck it

setEnabled

public void setEnabled(boolean enabled)

Enables or disables the checkbox.

Specified by:

setEnabled in interface I_FormWidget

Parameters:

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

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

Description copied from interface: I_FormWidget

Sets the current value of the widget as a string.

Specified by:

setFormValueAsString in interface I_FormWidget

Parameters:

value - the new value of the widget

See Also:

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

Specified by:

setHorizontalAlignment in interface com.google.gwt.user.client.ui.HasHorizontalAlignment

See Also:

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

setText

public void setText(java.lang.String text)

Sets the text.

Parameters:

text - the text to set

fireValueChangedEvent

protected void fireValueChangedEvent()

Helper method for firing a 'value changed' event.