com.vaadin.ui.

Class CheckBox

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

      • 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 readDesign and writeDesign 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