com.vaadin.ui.

Class OptionGroup

    • Constructor Detail

      • OptionGroup

        public OptionGroup()

      • OptionGroup

        public OptionGroup(String caption)

    • Method Detail

      • changeVariables

        public void changeVariables(Object source,
                            Map<String,Object> variables)

        Description copied from class: AbstractSelect

        Invoked when the value of a variable has changed.

        Specified by:

        changeVariables in interface VariableOwner

        Overrides:

        changeVariables in class AbstractSelect

        Parameters:

        source - the Source of the variable change. This is the origin of the event. For example in Web Adapter this is the request.

        variables - the Mapping from variable names to new variable values.

        See Also:

        AbstractComponent#changeVariables(java.lang.Object, java.util.Map)

      • setValue

        protected void setValue(Object newValue,
                        boolean repaintIsNotNeeded)

        Description copied from class: AbstractField

        Sets the value of the field.

        Overrides:

        setValue in class AbstractField<Object>

        Parameters:

        newValue - the New value of the field.

        repaintIsNotNeeded - True iff caller is sure that repaint is not needed.

      • setItemEnabled

        public void setItemEnabled(Object itemId,
                           boolean enabled)

        Sets an item disabled or enabled. In the multiselect mode, a disabled item cannot be selected or deselected by the user. In the single selection mode, a disable item cannot be selected. However, programmatical selection or deselection of an disable item is possible. By default, items are enabled.

        Parameters:

        itemId - the id of the item to be disabled or enabled

        enabled - if true the item is enabled, otherwise the item is disabled

      • isItemEnabled

        public boolean isItemEnabled(Object itemId)

        Returns true if the item is enabled.

        Parameters:

        itemId - the id of the item to be checked

        Returns:

        true if the item is enabled, false otherwise

        See Also:

        setItemEnabled(Object, boolean)

      • setHtmlContentAllowed

        public void setHtmlContentAllowed(boolean htmlContentAllowed)

        Sets whether html is allowed in the item captions. If set to true, the captions are passed to the browser as html and the developer is responsible for ensuring no harmful html is used. If set to false, the content is passed to the browser as plain text.

        Parameters:

        htmlContentAllowed - true if the captions are used as html, false if used as plain text

      • isHtmlContentAllowed

        public boolean isHtmlContentAllowed()

        Checks whether captions are interpreted as html or plain text.

        Returns:

        true if the captions are used as html, false if used as plain text

        See Also:

        setHtmlContentAllowed(boolean)

      • readItem

        protected Object readItem(org.jsoup.nodes.Element child,
                          Set<String> selected,
                          DesignContext context)

        Description copied from class: AbstractSelect

        Reads an Item from a design and inserts it into the data source. Hierarchical select components should override this method to recursively recursively read any child items as well.

        Overrides:

        readItem in class AbstractSelect

        Parameters:

        child - a child element representing the item

        selected - A set accumulating selected items. If the item that is read is marked as selected, its item id should be added to this set.

        context - the DesignContext instance used in parsing

        Returns:

        the item id of the new item

      • writeItem

        protected org.jsoup.nodes.Element writeItem(org.jsoup.nodes.Element design,
                                            Object itemId,
                                            DesignContext context)

        Description copied from class: AbstractSelect

        Writes a data source Item to a design. Hierarchical select components should override this method to recursively write any child items as well.

        Overrides:

        writeItem in class AbstractSelect

        Parameters:

        design - the element into which to insert the item

        itemId - the id of the item to write

        context - the DesignContext instance used in writing

        Returns:

      • getState

        protected OptionGroupState 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 AbstractSelect

        Returns:

        updated component shared state