Class RadioState

  • Direct Known Subclasses:
    RegistryRadioState

    public class RadioState
    extends ToggleState

    A piece of boolean state grouped with other boolean states. Of these states, only one may have a value of Boolean.TRUE at any given point in time. The values of all other states must be Boolean.FALSE.

    If this state is registered using IMenuStateIds.STYLE, then it will control the presentation of the command if displayed in the menus, tool bars or status line.

    Clients may instantiate or extend this interface.

    Since:
    3.2
    • Constructor Detail

      • RadioState

        public RadioState()
    • Method Detail

      • dispose

        public void dispose()
        Unregisters this state from the manager, which detaches the listeners.
        Overrides:
        dispose in class State
      • setRadioGroupIdentifier

        public final void setRadioGroupIdentifier​(String identifier)
        Sets the identifier of the radio group for this piece of state. If the identifier is cleared, then the state is unregistered.
        Parameters:
        identifier - The identifier of the radio group for this state; may be null if the identifier is being cleared.
      • setValue

        public void setValue​(Object value)
        Sets the value for this object. This notifies the radio state manager of the change.
        Overrides:
        setValue in class ToggleState
        Parameters:
        value - The new value; should be a Boolean.