|
Eclipse Platform Release 3.7 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.eclipse.core.commands.common.EventManager
org.eclipse.core.commands.State
org.eclipse.jface.commands.PersistentState
org.eclipse.jface.menus.TextState
public class 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.
INamedHandleStateIds| Constructor Summary | |
|---|---|
TextState()
|
|
| 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 |
|---|
public TextState()
| Method Detail |
|---|
public final void load(IPreferenceStore store,
String preferenceKey)
PersistentStatePersistentState.save(IPreferenceStore, String).
load in class PersistentStatestore - 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)
PersistentStatePersistentState.load(IPreferenceStore, String).
save in class PersistentStatestore - 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.public void setValue(Object value)
State
setValue in class Statevalue - The value to set; may be anything.
|
Eclipse Platform Release 3.7 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2011. All rights reserved.