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
-
public class TextState extends PersistentState
A piece of state carrying a single
String
.If this state is registered using
INamedHandleStateIds.NAME
orINamedHandleStateIds.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 aTextState
.Clients may instantiate this class, but must not extend.
- Since:
- 3.2
- See Also:
INamedHandleStateIds
-
-
Constructor Summary
Constructors Constructor Description TextState()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method 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.-
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
-
-
-
-
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 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
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 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
.
-
-