Class ToggleState

  • Direct Known Subclasses:
    RadioState, RegistryToggleState

    public class ToggleState
    extends PersistentState

    A piece of state storing a Boolean.

    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 this class, but must not extend.

    Since:
    3.2
    • Constructor Detail

      • ToggleState

        public ToggleState()
        Constructs a new ToggleState. By default, the toggle is off (e.g., false).
    • Method Detail

      • save

        public final void save​(IPreferenceStore store,
                               String preferenceKey)
        Description copied from class: PersistentState
        Saves this state to the preference store, given the location at which to write. This method must be symmetric with a call to PersistentState.load(IPreferenceStore, String).
        Specified by:
        save in class PersistentState
        Parameters:
        store - The store to which the state should be written; must not be null.
        preferenceKey - The key at which the state should be stored; must not be null.
      • setValue

        public void setValue​(Object value)
        Description copied from class: State
        Sets the value for this state object.
        Overrides:
        setValue in class State
        Parameters:
        value - The value to set; may be anything.