Eclipse Plug-in Developer Guide (Galileo) - ToggleState (Eclipse Platform API Specification)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Eclipse Platform
Release 3.5

PREV CLASS NEXT CLASS

NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.jface.commands
Class ToggleState


java.lang.Object
  

org.eclipse.core.commands.common.EventManager
      

org.eclipse.core.commands.State
          

org.eclipse.jface.commands.PersistentState
              
org.eclipse.jface.commands.ToggleState

Direct Known Subclasses:: RadioState, RegistryToggleState

public class ToggleState
extends PersistentState
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 Summary

ToggleState ()
          Constructs a new ToggleState.

Method Summary

void load ( IPreferenceStore store, String preferenceKey)
          Loads this state from the preference store, given the location at which to look.

void save ( IPreferenceStore store, String preferenceKey)
          Saves this state to the preference store, given the location at which to write.

void setValue ( Object value)
          Sets the value for this state object.

Methods inherited from class org.eclipse.jface.commands. PersistentState

setShouldPersist, shouldPersist

Methods inherited from class org.eclipse.core.commands. State

addListener, dispose, fireStateChanged, getId, getValue, removeListener, setId

Methods inherited from class org.eclipse.core.commands.common. EventManager

addListenerObject, clearListeners, getListeners, isListenerAttached, removeListenerObject

Methods inherited from class java.lang. Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ToggleState

public ToggleState()

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

Method Detail

load

public final void load(
IPreferenceStore store,
                       
String preferenceKey)

Description copied from class: PersistentState

Loads this state from the preference store, given the location at which to look. This method must be symmetric with a call to PersistentState.save(IPreferenceStore, String).

Specified by:: load in class PersistentState

Parameters:: store - The store from which to read; must not be null.; preferenceKey - The key at which the state is stored; must not be null.

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.