Package org.eclipse.jface.menus
Class TextState
java.lang.Object
org.eclipse.core.commands.common.EventManager
org.eclipse.core.commands.State
org.eclipse.jface.commands.PersistentState
org.eclipse.jface.menus.TextState
A piece of state carrying a single String
.
If this state is registered using INamedHandleStateIds.NAME
or
INamedHandleStateIds.DESCRIPTION
, then this allows the handler to
communicate a textual change for a given command. This is typically used by
graphical applications to allow more specific text to be displayed in the
menus. For example, "Undo" might become "Undo Typing" through the use of a
TextState
.
Clients may instantiate this class, but must not extend.
- Since:
- 3.2
- See Also:
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal void
load
(IPreferenceStore store, String preferenceKey) Loads this state from the preference store, given the location at which to look.final void
save
(IPreferenceStore store, String preferenceKey) Saves this state to the preference store, given the location at which to write.void
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
-
Constructor Details
-
TextState
public TextState()
-
-
Method Details
-
load
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 toPersistentState.save(IPreferenceStore, String)
.- Specified by:
load
in classPersistentState
- Parameters:
store
- The store from which to read; must not benull
.preferenceKey
- The key at which the state is stored; must not benull
.
-
save
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 toPersistentState.load(IPreferenceStore, String)
.- Specified by:
save
in classPersistentState
- Parameters:
store
- The store to which the state should be written; must not benull
.preferenceKey
- The key at which the state should be stored; must not benull
.
-
setValue
Description copied from class:State
Sets the value for this state object.
-