Package com.vaadin.ui

Class CheckBox

java.lang.Object

com.vaadin.server.AbstractClientConnector

com.vaadin.ui.AbstractComponent

com.vaadin.ui.AbstractField<Boolean>

com.vaadin.ui.CheckBox

All Implemented Interfaces:

Buffered, BufferedValidatable, Property<Boolean>, Property.Editor, Property.ReadOnlyStatusChangeListener, Property.ReadOnlyStatusChangeNotifier, Property.ValueChangeListener, Property.ValueChangeNotifier, Property.Viewer, Validatable, Action.ShortcutNotifier, ContextClickEvent.ContextClickNotifier, MethodEventSource, ClientConnector, Sizeable, Connector, Component, Component.Focusable, Field<Boolean>, Serializable

public class CheckBox
extends AbstractField<Boolean>

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.vaadin.ui.AbstractField

AbstractField.FocusShortcut, AbstractField.ReadOnlyStatusChangeEvent

Nested classes/interfaces inherited from interface com.vaadin.data.Buffered

Buffered.SourceException

Nested classes/interfaces inherited from interface com.vaadin.server.ClientConnector

ClientConnector.AttachEvent, ClientConnector.AttachListener, ClientConnector.ConnectorErrorEvent, ClientConnector.DetachEvent, ClientConnector.DetachListener

Nested classes/interfaces inherited from interface com.vaadin.ui.Component

Component.ErrorEvent, Component.Event, Component.Focusable, Component.Listener

Nested classes/interfaces inherited from interface com.vaadin.ui.Field

Field.ValueChangeEvent

Nested classes/interfaces inherited from interface com.vaadin.data.Property

Property.Editor, Property.ReadOnlyException, Property.ReadOnlyStatusChangeListener, Property.ReadOnlyStatusChangeNotifier, Property.Transactional<T>, Property.ValueChangeListener, Property.ValueChangeNotifier, Property.Viewer

Nested classes/interfaces inherited from interface com.vaadin.server.Sizeable

Sizeable.Unit

Field Summary

Fields inherited from class com.vaadin.ui.AbstractComponent

DESIGN_ATTR_PLAIN_TEXT

Fields inherited from interface com.vaadin.server.Sizeable

SIZE_UNDEFINED, UNITS_CM, UNITS_EM, UNITS_EX, UNITS_INCH, UNITS_MM, UNITS_PERCENTAGE, UNITS_PICAS, UNITS_PIXELS, UNITS_POINTS

Constructor Summary

Constructors

Constructor	Description
CheckBox()	Creates a new checkbox.
CheckBox(String caption)	Creates a new checkbox with a set caption.
CheckBox(String caption, boolean initialState)	Creates a new checkbox with a caption and a set initial state.
CheckBox(String caption, Property<?> dataSource)	Creates a new checkbox that is connected to a boolean property.

Method Summary

Modifier and Type	Method	Description
void	addBlurListener(FieldEvents.BlurListener listener)
void	addFocusListener(FieldEvents.FocusListener listener)
void	addListener(FieldEvents.BlurListener listener)	Deprecated. As of 7.0, replaced by addBlurListener(BlurListener)
void	addListener(FieldEvents.FocusListener listener)	Deprecated. As of 7.0, replaced by addFocusListener(FocusListener)
boolean	booleanValue()	Deprecated. As of 7.0, use AbstractField.getValue() instead and, if needed, handle null values.
void	clear()	Clears the value of the field.
protected Collection<String>	getCustomAttributes()	Returns a collection of attributes that should not be handled by the basic implementation of the AbstractComponent.readDesign(org.jsoup.nodes.Element,com.vaadin.ui.declarative.DesignContext) and AbstractComponent.writeDesign(org.jsoup.nodes.Element,com.vaadin.ui.declarative.DesignContext) methods.
protected CheckBoxState	getState()	Returns the shared state bean with information to be sent from the server to the client.
Class<Boolean>	getType()	Returns the type of the Field.
boolean	isEmpty()	Is the field empty? In general, "empty" state is same as null.
void	readDesign(org.jsoup.nodes.Element design, DesignContext designContext)	Reads the component state from the given design.
void	removeBlurListener(FieldEvents.BlurListener listener)
void	removeFocusListener(FieldEvents.FocusListener listener)
void	removeListener(FieldEvents.BlurListener listener)	Deprecated. As of 7.0, replaced by removeBlurListener(BlurListener)
void	removeListener(FieldEvents.FocusListener listener)	Deprecated. As of 7.0, replaced by removeFocusListener(FocusListener)
protected void	setInternalValue(Boolean newValue)	Sets the internal field value.
void	writeDesign(org.jsoup.nodes.Element design, DesignContext designContext)	Writes the component state to the given design.

Methods inherited from class com.vaadin.ui.AbstractField

addListener, addListener, addReadOnlyStatusChangeListener, addValidator, addValueChangeListener, attach, beforeClientResponse, commit, detach, discard, fireReadOnlyStatusChange, fireValueChange, focus, getConversionError, getConversionError, getConvertedValue, getConverter, getCurrentBufferedSourceException, getErrorMessage, getInternalValue, getModelType, getPropertyDataSource, getRequiredError, getState, getTabIndex, getValidators, getValue, isBuffered, isImmediate, isInvalidAllowed, isInvalidCommitted, isModified, isReadOnly, isRequired, isValid, isValidationVisible, readOnlyStatusChange, removeAllValidators, removeListener, removeListener, removeReadOnlyStatusChangeListener, removeValidator, removeValueChangeListener, setBuffered, setConversionError, setConvertedValue, setConverter, setConverter, setCurrentBufferedSourceException, setInvalidAllowed, setInvalidCommitted, setLocale, setPropertyDataSource, setReadOnly, setRequired, setRequiredError, setTabIndex, setValidationVisible, setValue, setValue, setValue, shouldHideErrors, toString, validate, validate, valueChange

Methods inherited from class com.vaadin.ui.AbstractComponent

addContextClickListener, addListener, addShortcutListener, addStyleName, findAncestor, fireComponentErrorEvent, fireComponentEvent, getActionManager, getCaption, getComponentError, getData, getDebugId, getDescription, getExplicitImmediateValue, getHeight, getHeightUnits, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, getWidth, getWidthUnits, isCaptionAsHtml, isConnectorEnabled, isEnabled, isOrHasAncestor, isResponsive, isVisible, removeContextClickListener, removeListener, removeShortcutListener, removeStyleName, setCaption, setCaptionAsHtml, setComponentError, setData, setDebugId, setDescription, setEnabled, setHeight, setHeight, setHeightUndefined, setIcon, setId, setImmediate, setParent, setPrimaryStyleName, setResponsive, setSizeFull, setSizeUndefined, setStyleName, setStyleName, setVisible, setWidth, setWidth, setWidthUndefined

Methods inherited from class com.vaadin.server.AbstractClientConnector

addAttachListener, addDetachListener, addExtension, addListener, addListener, addListener, addMethodInvocationToQueue, createState, encodeState, equals, fireEvent, getAllChildrenIterable, getConnectorId, getErrorHandler, getExtensions, getListeners, getResource, getRpcManager, getRpcProxy, getSession, getStateType, getUI, handleConnectorRequest, hashCode, hasListeners, isAttached, isThis, markAsDirty, markAsDirtyRecursive, registerRpc, registerRpc, removeAttachListener, removeDetachListener, removeExtension, removeListener, removeListener, removeListener, removeListener, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler, setResource

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.vaadin.event.Action.ShortcutNotifier

addShortcutListener, removeShortcutListener

Methods inherited from interface com.vaadin.server.ClientConnector

addAttachListener, addDetachListener, encodeState, getErrorHandler, getExtensions, getRpcManager, getStateType, handleConnectorRequest, isAttached, isConnectorEnabled, markAsDirty, markAsDirtyRecursive, removeAttachListener, removeDetachListener, removeExtension, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler

Methods inherited from interface com.vaadin.ui.Component

addListener, addStyleName, getCaption, getDescription, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, getUI, isEnabled, isVisible, removeListener, removeStyleName, setCaption, setEnabled, setIcon, setId, setParent, setPrimaryStyleName, setStyleName, setVisible

Methods inherited from interface com.vaadin.shared.Connector

getConnectorId

Methods inherited from interface com.vaadin.server.Sizeable

getHeight, getHeightUnits, getWidth, getWidthUnits, setHeight, setHeight, setHeightUndefined, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthUndefined

Constructor Detail

CheckBox

public CheckBox()

Creates a new checkbox.

CheckBox

public CheckBox(String caption)

Creates a new checkbox with a set caption.

Parameters:

caption - the Checkbox caption.

CheckBox

public CheckBox(String caption,
                boolean initialState)

Creates a new checkbox with a caption and a set initial state.

Parameters:

caption - the caption of the checkbox

initialState - the initial state of the checkbox

CheckBox

public CheckBox(String caption,
                Property<?> dataSource)

Creates a new checkbox that is connected to a boolean property.

Parameters:

state - the Initial state of the switch-button.

dataSource -

Method Detail

getType

public Class<Boolean> getType()

Description copied from class: AbstractField

Returns the type of the Field. The methods getValue and setValue must be compatible with this type: one must be able to safely cast the value returned from getValue to the given type and pass any variable assignable to this type as an argument to setValue.

Specified by:

getType in interface Property<Boolean>

Specified by:

getType in class AbstractField<Boolean>

Returns:

the type of the Field

getState

protected CheckBoxState getState()

Description copied from class: AbstractComponent

Returns the shared state bean with information to be sent from the server to the client. Subclasses should override this method and set any relevant fields of the state returned by super.getState().

Overrides:

getState in class AbstractField<Boolean>

Returns:

updated component shared state

setInternalValue

protected void setInternalValue(Boolean newValue)

Description copied from class: AbstractField

Sets the internal field value. This is purely used by AbstractField to change the internal Field value. It does not trigger valuechange events. It can be overridden by the inheriting classes to update all dependent variables. Subclasses can also override AbstractField.getInternalValue() if necessary.

Overrides:

setInternalValue in class AbstractField<Boolean>

Parameters:

newValue - the new value to be set.

addBlurListener

public void addBlurListener(FieldEvents.BlurListener listener)

addListener

@Deprecated
public void addListener(FieldEvents.BlurListener listener)

Deprecated.

As of 7.0, replaced by addBlurListener(BlurListener)

removeBlurListener

public void removeBlurListener(FieldEvents.BlurListener listener)

removeListener

@Deprecated
public void removeListener(FieldEvents.BlurListener listener)

Deprecated.

As of 7.0, replaced by removeBlurListener(BlurListener)

addFocusListener

public void addFocusListener(FieldEvents.FocusListener listener)

addListener

@Deprecated
public void addListener(FieldEvents.FocusListener listener)

Deprecated.

As of 7.0, replaced by addFocusListener(FocusListener)

removeFocusListener

public void removeFocusListener(FieldEvents.FocusListener listener)

removeListener

@Deprecated
public void removeListener(FieldEvents.FocusListener listener)

Deprecated.

As of 7.0, replaced by removeFocusListener(FocusListener)

booleanValue

@Deprecated
public boolean booleanValue()

Deprecated.

As of 7.0, use AbstractField.getValue() instead and, if needed, handle null values.

Get the boolean value of the button state.

Returns:

True iff the button is pressed down or checked.

readDesign

public void readDesign(org.jsoup.nodes.Element design,
                       DesignContext designContext)

Description copied from interface: Component

Reads the component state from the given design.

The component is responsible not only for updating its own state but also for ensuring that its children update their state based on the design.

It is assumed that the component is in its default state when this method is called. Reading should only take into consideration attributes specified in the design and not reset any unspecified attributes to their defaults.

This method must not modify the design.

Specified by:

readDesign in interface Component

Overrides:

readDesign in class AbstractField<Boolean>

Parameters:

design - The element to obtain the state from

designContext - The DesignContext instance used for parsing the design

getCustomAttributes

protected Collection<String> getCustomAttributes()

Description copied from class: AbstractComponent

Returns a collection of attributes that should not be handled by the basic implementation of the AbstractComponent.readDesign(org.jsoup.nodes.Element,com.vaadin.ui.declarative.DesignContext) and AbstractComponent.writeDesign(org.jsoup.nodes.Element,com.vaadin.ui.declarative.DesignContext) methods. Typically these are handled in a custom way in the overridden versions of the above methods

Overrides:

getCustomAttributes in class AbstractField<Boolean>

Returns:

the collection of attributes that are not handled by the basic implementation

writeDesign

public void writeDesign(org.jsoup.nodes.Element design,
                        DesignContext designContext)

Description copied from interface: Component

Writes the component state to the given design.

The component is responsible not only for writing its own state but also for ensuring that its children write their state to the design.

This method must not modify the component state.

Specified by:

writeDesign in interface Component

Overrides:

writeDesign in class AbstractField<Boolean>

Parameters:

design - The element to write the component state to. Any previous attributes or child nodes are not cleared.

designContext - The DesignContext instance used for writing the design

clear

public void clear()

Description copied from interface: Field

Clears the value of the field.

The field value is typically reset to the initial value of the field. Calling Field.isEmpty() on a cleared field must always returns true.

Specified by:

clear in interface Field<Boolean>

Overrides:

clear in class AbstractField<Boolean>

isEmpty

public boolean isEmpty()

Description copied from interface: Field

Is the field empty? In general, "empty" state is same as null. As an exception, TextField also treats empty string as "empty".

Specified by:

isEmpty in interface Field<Boolean>

Overrides:

isEmpty in class AbstractField<Boolean>

Returns:

true if the field is empty, false otherwise