com.haulmont.cuba.desktop.gui.components

Class DesktopCheckBox

java.lang.Object

com.haulmont.cuba.desktop.gui.components.DesktopAbstractComponent<C>

com.haulmont.cuba.desktop.gui.components.DesktopAbstractField<javax.swing.JCheckBox>

com.haulmont.cuba.desktop.gui.components.DesktopCheckBox

All Implemented Interfaces:

DesktopComponent, CheckBox, Component, Component.BelongToFrame, Component.Buffered, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasIcon, Component.HasValue, Component.HasXmlDescriptor, Component.Validatable, Component.Wrapper, DatasourceComponent, Field

public class DesktopCheckBox
extends DesktopAbstractField<javax.swing.JCheckBox>
implements CheckBox

Nested Class Summary

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.Field

Field.Validator

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.Component

Component.ActionOwner, Component.ActionsHolder, Component.Alignment, Component.BelongToFrame, Component.Buffered, Component.ChildEditableController, Component.Collapsable, Component.Container, Component.Disposable, Component.Editable, Component.EditableChangeEvent, Component.EditableChangeListener, Component.EditableChangeNotifier, Component.ExpandedStateChangeEvent, Component.ExpandedStateChangeListener, Component.Focusable, Component.HasBorder, Component.HasButtonsPanel, Component.HasCaption, Component.HasFormatter, Component.HasIcon, Component.HasInputPrompt, Component.HasNamedComponents, Component.HasPresentations, Component.HasRowsCount, Component.HasSettings, Component.HasValue, Component.HasXmlDescriptor, Component.LayoutClickEvent, Component.LayoutClickListener, Component.LayoutClickNotifier, Component.Margin, Component.MouseEventDetails, Component.OrderedContainer, Component.OuterMargin, Component.SecuredActionsHolder, Component.ShortcutAction, Component.ShortcutNotifier, Component.ShortcutTriggeredEvent, Component.Spacing, Component.UiPermissionAware, Component.Validatable, Component.ValueChangeEvent, Component.ValueChangeListener, Component.Wrapper

Field Summary

Fields inherited from class com.haulmont.cuba.desktop.gui.components.DesktopAbstractComponent

SWING_PROPERTY_CLASS, SWING_PROPERTY_ID

Fields inherited from interface com.haulmont.cuba.gui.components.CheckBox

NAME

Fields inherited from interface com.haulmont.cuba.gui.components.Component

AUTO_SIZE, AUTO_SIZE_PX, UNITS_PERCENTAGE, UNITS_PIXELS

Constructor Summary

Constructors

Constructor and Description
DesktopCheckBox()

Method Summary

Modifier and Type	Method and Description
void	commit() Updates all changes since the previous commit to the data source.
void	discard() Discards all changes since last commit.
Datasource	getDatasource()
java.lang.String	getDescription()
MetaProperty	getMetaProperty()
MetaPropertyPath	getMetaPropertyPath()
java.lang.Boolean	getValue()
boolean	isBuffered()
boolean	isChecked()
boolean	isModified() Tests if the value stored in the object has been modified since it was last updated from the data source.
void	setBuffered(boolean buffered) Sets the buffered mode.
void	setDatasource(Datasource datasource, java.lang.String property) Set datasource and its property.
void	setDescription(java.lang.String description)
void	setParent(Component parent) INTERNAL. Component.Container.add(Component) is normally used for adding components to a parent and the used method will call this method implicitly.
void	setValue(java.lang.Object value)
void	updateEnabled()

Methods inherited from class com.haulmont.cuba.desktop.gui.components.DesktopAbstractField

addListener, addValidator, addValueChangeListener, getRequiredMessage, getValidators, isEditable, isRequired, isValid, removeListener, removeValidator, removeValueChangeListener, setEditable, setRequired, setRequiredMessage, updateMissingValueState, validate

Methods inherited from class com.haulmont.cuba.desktop.gui.components.DesktopAbstractComponent

addStyleName, assignAutoDebugId, getAlignment, getCaption, getComponent, getComposition, getDebugId, getFrame, getHeight, getHeightUnits, getIcon, getId, getParent, getStyleName, getTabIndex, getWidth, getWidthUnits, getXmlDescriptor, isComponentVisible, isEnabled, isEnabledItself, isParentEnabled, isResponsive, isVisible, isVisibleItself, removeStyleName, requestFocus, setAlignment, setCaption, setContainer, setDebugId, setEnabled, setExpanded, setFrame, setHeight, setIcon, setId, setParentEnabled, setResponsive, setStyleName, setTabIndex, setVisible, setWidth, setXmlDescriptor, unwrap, unwrapComposition

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.haulmont.cuba.gui.components.Field

addValidator, getRequiredMessage, getValidators, isRequired, removeValidator, setRequired, setRequiredMessage

Methods inherited from interface com.haulmont.cuba.gui.components.Component.HasValue

addListener, addValueChangeListener, removeListener, removeValueChangeListener

Methods inherited from interface com.haulmont.cuba.gui.components.Component.Editable

isEditable, isEditableWithParent, setEditable

Methods inherited from interface com.haulmont.cuba.gui.components.Component.BelongToFrame

getFrame, setFrame

Methods inherited from interface com.haulmont.cuba.gui.components.Component

addStyleName, getAlignment, getDebugId, getHeight, getHeightUnits, getId, getParent, getStyleName, getWidth, getWidthUnits, isEnabled, isEnabledItself, isResponsive, isVisible, isVisibleItself, removeStyleName, requestFocus, setAlignment, setDebugId, setEnabled, setHeight, setHeightAuto, setHeightFull, setId, setResponsive, setSizeAuto, setSizeFull, setStyleName, setVisible, setWidth, setWidthAuto, setWidthFull, unwrap, unwrapComposition

Methods inherited from interface com.haulmont.cuba.gui.components.Component.HasCaption

getCaption, setCaption

Methods inherited from interface com.haulmont.cuba.gui.components.Component.Validatable

isValid, isValidateOnCommit, validate

Methods inherited from interface com.haulmont.cuba.gui.components.Component.HasIcon

getIcon, setIcon

Methods inherited from interface com.haulmont.cuba.gui.components.Component.Focusable

getTabIndex, isFocusable, setFocusable, setTabIndex

Constructor Detail

DesktopCheckBox

public DesktopCheckBox()

Method Detail

getValue

public java.lang.Boolean getValue()

Specified by:

getValue in interface CheckBox

Specified by:

getValue in interface Component.HasValue

setValue

public void setValue(java.lang.Object value)

Specified by:

setValue in interface Component.HasValue

getDatasource

public Datasource getDatasource()

Specified by:

getDatasource in interface DatasourceComponent

Returns:

datasource instance

getMetaProperty

public MetaProperty getMetaProperty()

Specified by:

getMetaProperty in interface DatasourceComponent

Returns:

datasource property

getMetaPropertyPath

public MetaPropertyPath getMetaPropertyPath()

Specified by:

getMetaPropertyPath in interface DatasourceComponent

Returns:

datasource property path

setDatasource

public void setDatasource(Datasource datasource,
                          java.lang.String property)

Description copied from interface: DatasourceComponent

Set datasource and its property.

Specified by:

setDatasource in interface DatasourceComponent

setParent

public void setParent(Component parent)

Description copied from interface: Component

INTERNAL.
Component.Container.add(Component) is normally used for adding components to a parent and the used method will call this method implicitly.

Specified by:

setParent in interface Component

Overrides:

setParent in class DesktopAbstractField<javax.swing.JCheckBox>

Parameters:

parent - Parent component

getDescription

public java.lang.String getDescription()

Specified by:

getDescription in interface Component.HasCaption

setDescription

public void setDescription(java.lang.String description)

Specified by:

setDescription in interface Component.HasCaption

updateEnabled

public void updateEnabled()

isChecked

public boolean isChecked()

Specified by:

isChecked in interface CheckBox

Returns:

true if value is equal to Boolean.TRUE

commit

public void commit()

Description copied from interface: Component.Buffered

Updates all changes since the previous commit to the data source.

Specified by:

commit in interface Component.Buffered

discard

public void discard()

Description copied from interface: Component.Buffered

Discards all changes since last commit. The object updates its value from the data source.

Specified by:

discard in interface Component.Buffered

isBuffered

public boolean isBuffered()

Specified by:

isBuffered in interface Component.Buffered

Returns:

true if buffered mode is on, false otherwise

setBuffered

public void setBuffered(boolean buffered)

Description copied from interface: Component.Buffered

Sets the buffered mode.

When in buffered mode, an internal buffer will be used to store changes until Component.Buffered.commit() is called. Calling Component.Buffered.discard() will revert the internal buffer to the value of the data source.

When in non-buffered mode both read and write operations will be done directly on the data source. In this mode the Component.Buffered.commit() and Component.Buffered.discard() methods serve no purpose.

Specified by:

setBuffered in interface Component.Buffered

Parameters:

buffered - true if buffered mode should be turned on, false otherwise

isModified

public boolean isModified()

Description copied from interface: Component.Buffered

Tests if the value stored in the object has been modified since it was last updated from the data source.

Specified by:

isModified in interface Component.Buffered

Returns:

true if the value in the object has been modified since the last data source update, false if not.