|
Runtime | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.gmf.runtime.diagram.core.preferences.PreferencesHint
public class PreferencesHint
This specifies the hint with which a preference store containing the diagram preferences will be registered against in the preferences registry. This hint will be passed around and when a view is created it will use this hint to initialize its properties based on the values in the preference store registered against this hint in the preferences registry.
Field Summary | |
---|---|
static PreferencesHint |
USE_DEFAULTS
The hint that indicates there are no preferences to be used for the generic diagram preferences, instead use the default values. |
Constructor Summary | |
---|---|
PreferencesHint(java.lang.String id)
Creates a new instance. |
Method Summary | |
---|---|
boolean |
equals(java.lang.Object arg0)
|
java.lang.Object |
getPreferenceStore()
Gets the preference store registered with the preference hint given. |
int |
hashCode()
|
static boolean |
registerPreferenceStore(PreferencesHint preferencesHint,
java.lang.Object preferenceStore)
Registers a preference store containing some or all of the generic diagram preferences (those preferences defined in the diagram layer) to a preference hint. |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static PreferencesHint USE_DEFAULTS
Constructor Detail |
---|
public PreferencesHint(java.lang.String id)
id
- the unique id string of this hintMethod Detail |
---|
public boolean equals(java.lang.Object arg0)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public static boolean registerPreferenceStore(PreferencesHint preferencesHint, java.lang.Object preferenceStore)
preferencesHint
- the preference hint for which the preferences store is to be
associatedpreferenceStore
- the preference store initialized with the diagram preferences
(an instance of
IPreferenceStore
)
public java.lang.Object getPreferenceStore()
preferenceHint
- the preference hint
IPreferenceStore
)
registered with the preferences hint given; if no preference
store has been registered with this hint the preference store
with the default values is returned.
|
Runtime | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp., Borland Software Corp., and others 2005,2006. All rights reserved.