Package org.pushingpixels.radiance.component.api.ribbon.synapse.model

Class RibbonRadioButtonGroupModel

  • public class RibbonRadioButtonGroupModel
extends java.lang.Object
    Group of ribbon radio buttons.

    • Constructor Detail

      • RibbonRadioButtonGroupModel

        public RibbonRadioButtonGroupModel()
        Creates a new radio button group.

    • Method Detail

      • getRadioButtonModels

        public java.util.Collection<RibbonRadioButtonContentModel> getRadioButtonModels()
        Returns an unmodifiable collection with all the content models tracked by this model.
        Returns:
        An unmodifiable collection with all the content models tracked by this model.

      • setAllowsClearingSelection

        public void setAllowsClearingSelection​(boolean allowsClearingSelection)
        Sets the new value for clearing selection. If true is passed, the selection can be cleared in clearSelection() or setSelected(RibbonRadioButtonContentModel, boolean) (passing the currently selected content model and false).
        Parameters:
        allowsClearingSelection - The new value for clearing selection.

      • isAllowsClearingSelection

        public boolean isAllowsClearingSelection()
        Returns the current value for clearing selection. true is returned when selection can be cleared in clearSelection() or setSelected(RibbonRadioButtonContentModel, boolean) (passing the currently selected content model and false).
        Returns:
        The current value for clearing selection.

      • add

        public void add​(RibbonRadioButtonContentModel radioButtonContentModel)
        Adds the specified content model to the group. If the content model is selected, and the group has a selected content model, the newly added content model is marked as unselected.
        Parameters:
        radioButtonContentModel - The content model to be added.

      • remove

        public void remove​(RibbonRadioButtonContentModel radioButtonContentModel)
        Removes the specified content model from the group.
        Parameters:
        radioButtonContentModel - The content model to be removed

      • removeAll

        public void removeAll()

      • setSelected

        public void setSelected​(RibbonRadioButtonContentModel radioButtonContentModel,
                        boolean isSelected)
        Changes the selected status of the specified content model.
        Parameters:
        radioButtonContentModel - Content model.
        isSelected - Selection indication.

      • getSelected

        public RibbonRadioButtonContentModel getSelected()
        Returns the selected content model of this group model.
        Returns:
        The selected content model of this group model. The result can be null.

      • clearSelection

        public void clearSelection()
        Clears the selection of this content model toggle group model.