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.
Constructor and Description |
---|
ToggleState()
Constructs a new
ToggleState . |
Modifier and Type | Method and Description |
---|---|
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.
|
setShouldPersist, shouldPersist
addListener, dispose, fireStateChanged, getId, getValue, removeListener, setId
addListenerObject, clearListeners, getListeners, isListenerAttached, removeListenerObject
public ToggleState()
ToggleState
. By default, the toggle is off
(e.g., false
).public final void load(IPreferenceStore store, String preferenceKey)
PersistentState
PersistentState.save(IPreferenceStore, String)
.load
in class PersistentState
store
- The store from which to read; must not be null
.preferenceKey
- The key at which the state is stored; must not be
null
.public final void save(IPreferenceStore store, String preferenceKey)
PersistentState
PersistentState.load(IPreferenceStore, String)
.save
in class PersistentState
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
.
Copyright (c) 2000, 2015 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.