|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.ibm.carma.ui.property.CarmaPreferenceStore
public class CarmaPreferenceStore
This class is used to access CARMA Specific preferences.
The suggested way to use this class is as follows:
CarmaPreferenceStore cStore = null;
IPreferenceStore store = CarmaUIPlugin.getDefault().getPreferenceStore();
if (store instanceof CarmaPreferenceStore)
cStore = (CarmaPreferenceStore) store;
else
cStore = new CarmaPreferenceStore(store);
This class can be instantiated and subclassed if desired.
| Field Summary | |
|---|---|
static java.lang.String |
COPYRIGHT
|
| Fields inherited from interface org.eclipse.jface.preference.IPreferenceStore |
|---|
BOOLEAN_DEFAULT_DEFAULT, DOUBLE_DEFAULT_DEFAULT, FALSE, FLOAT_DEFAULT_DEFAULT, INT_DEFAULT_DEFAULT, LONG_DEFAULT_DEFAULT, STRING_DEFAULT_DEFAULT, TRUE |
| Constructor Summary | |
|---|---|
CarmaPreferenceStore(org.eclipse.jface.preference.IPreferenceStore store)
|
|
| Method Summary | |
|---|---|
void |
addPropertyChangeListener(org.eclipse.jface.util.IPropertyChangeListener listener)
|
void |
clearStoredCustomParameters()
Should not be called by clients. |
boolean |
contains(java.lang.String name)
|
boolean |
displayUnsupportedActions()
|
void |
firePropertyChangeEvent(java.lang.String name,
java.lang.Object oldValue,
java.lang.Object newValue)
|
java.lang.String |
getActionConfirmationKey(java.lang.String actionId)
Generates the key needed to locate the preference for the given action confirmation. |
boolean |
getBoolean(java.lang.String name)
|
boolean |
getDefaultBoolean(java.lang.String name)
|
double |
getDefaultDouble(java.lang.String name)
|
float |
getDefaultFloat(java.lang.String name)
|
int |
getDefaultInt(java.lang.String name)
|
long |
getDefaultLong(java.lang.String name)
|
java.lang.String |
getDefaultString(java.lang.String name)
|
double |
getDouble(java.lang.String name)
|
float |
getFloat(java.lang.String name)
|
int |
getInt(java.lang.String name)
|
long |
getLong(java.lang.String name)
|
int[] |
getParameterSearchOrder()
Deprecated. use getParameterSearchOrderEnum() for type safety |
ICarmaPreferenceConstants.ParameterOrder[] |
getParameterSearchOrderEnum()
Returns the parameter search order as specified in the preferences. |
java.lang.Object[] |
getStoredCustomParameterValues(RepositoryInstance repository,
Action action)
Clients shouldn't call this method directly, they should call CustomActionParameterManager.getUserStoredParamValues() |
java.lang.Object[] |
getStoredCustomParameterValues(RepositoryManager repositoryManager,
Action action)
Clients shouldn't call this method directly, they should call CustomActionParameterManager.getUserStoredParamValues() |
java.lang.String |
getString(java.lang.String name)
|
boolean |
isDefault(java.lang.String name)
|
boolean |
needsSaving()
|
void |
putValue(java.lang.String name,
java.lang.String value)
|
void |
removePropertyChangeListener(org.eclipse.jface.util.IPropertyChangeListener listener)
|
void |
setDefault(java.lang.String name,
boolean value)
|
void |
setDefault(java.lang.String name,
double value)
|
void |
setDefault(java.lang.String name,
float value)
|
void |
setDefault(java.lang.String name,
int value)
|
void |
setDefault(java.lang.String name,
long value)
|
void |
setDefault(java.lang.String name,
java.lang.String defaultObject)
|
void |
setStoredCustomParameter(RepositoryInstance repository,
Action action,
java.lang.Object[] values)
Should not be called by clients. |
void |
setStoredCustomParameter(RepositoryManager repositoryManager,
Action action,
java.lang.Object[] values)
Should not be called by clients. |
void |
setToDefault(java.lang.String name)
|
void |
setValue(java.lang.String name,
boolean value)
|
void |
setValue(java.lang.String name,
double value)
|
void |
setValue(java.lang.String name,
float value)
|
void |
setValue(java.lang.String name,
int value)
|
void |
setValue(java.lang.String name,
long value)
|
void |
setValue(java.lang.String name,
java.lang.String value)
|
| Methods inherited from class java.lang.Object |
|---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
public static final java.lang.String COPYRIGHT
| Constructor Detail |
|---|
public CarmaPreferenceStore(org.eclipse.jface.preference.IPreferenceStore store)
| Method Detail |
|---|
public void addPropertyChangeListener(org.eclipse.jface.util.IPropertyChangeListener listener)
addPropertyChangeListener in interface org.eclipse.jface.preference.IPreferenceStorepublic boolean contains(java.lang.String name)
contains in interface org.eclipse.jface.preference.IPreferenceStore
public void firePropertyChangeEvent(java.lang.String name,
java.lang.Object oldValue,
java.lang.Object newValue)
firePropertyChangeEvent in interface org.eclipse.jface.preference.IPreferenceStorepublic boolean getBoolean(java.lang.String name)
getBoolean in interface org.eclipse.jface.preference.IPreferenceStorepublic boolean getDefaultBoolean(java.lang.String name)
getDefaultBoolean in interface org.eclipse.jface.preference.IPreferenceStorepublic double getDefaultDouble(java.lang.String name)
getDefaultDouble in interface org.eclipse.jface.preference.IPreferenceStorepublic float getDefaultFloat(java.lang.String name)
getDefaultFloat in interface org.eclipse.jface.preference.IPreferenceStorepublic int getDefaultInt(java.lang.String name)
getDefaultInt in interface org.eclipse.jface.preference.IPreferenceStorepublic long getDefaultLong(java.lang.String name)
getDefaultLong in interface org.eclipse.jface.preference.IPreferenceStorepublic java.lang.String getDefaultString(java.lang.String name)
getDefaultString in interface org.eclipse.jface.preference.IPreferenceStorepublic double getDouble(java.lang.String name)
getDouble in interface org.eclipse.jface.preference.IPreferenceStorepublic float getFloat(java.lang.String name)
getFloat in interface org.eclipse.jface.preference.IPreferenceStorepublic int getInt(java.lang.String name)
getInt in interface org.eclipse.jface.preference.IPreferenceStorepublic long getLong(java.lang.String name)
getLong in interface org.eclipse.jface.preference.IPreferenceStorepublic java.lang.String getString(java.lang.String name)
getString in interface org.eclipse.jface.preference.IPreferenceStorepublic boolean isDefault(java.lang.String name)
isDefault in interface org.eclipse.jface.preference.IPreferenceStorepublic boolean needsSaving()
needsSaving in interface org.eclipse.jface.preference.IPreferenceStore
public void putValue(java.lang.String name,
java.lang.String value)
putValue in interface org.eclipse.jface.preference.IPreferenceStorepublic void removePropertyChangeListener(org.eclipse.jface.util.IPropertyChangeListener listener)
removePropertyChangeListener in interface org.eclipse.jface.preference.IPreferenceStore
public void setDefault(java.lang.String name,
double value)
setDefault in interface org.eclipse.jface.preference.IPreferenceStore
public void setDefault(java.lang.String name,
float value)
setDefault in interface org.eclipse.jface.preference.IPreferenceStore
public void setDefault(java.lang.String name,
int value)
setDefault in interface org.eclipse.jface.preference.IPreferenceStore
public void setDefault(java.lang.String name,
long value)
setDefault in interface org.eclipse.jface.preference.IPreferenceStore
public void setDefault(java.lang.String name,
java.lang.String defaultObject)
setDefault in interface org.eclipse.jface.preference.IPreferenceStore
public void setDefault(java.lang.String name,
boolean value)
setDefault in interface org.eclipse.jface.preference.IPreferenceStorepublic void setToDefault(java.lang.String name)
setToDefault in interface org.eclipse.jface.preference.IPreferenceStore
public void setValue(java.lang.String name,
double value)
setValue in interface org.eclipse.jface.preference.IPreferenceStore
public void setValue(java.lang.String name,
float value)
setValue in interface org.eclipse.jface.preference.IPreferenceStore
public void setValue(java.lang.String name,
int value)
setValue in interface org.eclipse.jface.preference.IPreferenceStore
public void setValue(java.lang.String name,
long value)
setValue in interface org.eclipse.jface.preference.IPreferenceStore
public void setValue(java.lang.String name,
java.lang.String value)
setValue in interface org.eclipse.jface.preference.IPreferenceStore
public void setValue(java.lang.String name,
boolean value)
setValue in interface org.eclipse.jface.preference.IPreferenceStorepublic boolean displayUnsupportedActions()
public ICarmaPreferenceConstants.ParameterOrder[] getParameterSearchOrderEnum()
ICarmaPreferenceConstants.ParameterOrder but in
possibly a different order@Deprecated public int[] getParameterSearchOrder()
getParameterSearchOrderEnum() for type safety
ICarmaPreferenceConstants.PREF_PARAM_ORDER_DEFAULT_ID
ICarmaPreferenceConstants.PREF_PARAM_ORDER_METADATA_ID
ICarmaPreferenceConstants.PREF_PARAM_ORDER_USER_ID
public void clearStoredCustomParameters()
CustomActionParameterManager.clearAllUserStoredParamValues() instead.
public void setStoredCustomParameter(RepositoryManager repositoryManager,
Action action,
java.lang.Object[] values)
CustomActionParameterManager.setUserStoredParamValues(repositoryManager, action, values)
if values contains a null, that entry will not be modified
repositoryManager - RepositoryManager to store this information foraction - Action to store this information forvalues - The values to remember, must be the same length as action.getParameters().size()
ArrayOutOfBoundsException - if values.length < action.getParameters().size()
public void setStoredCustomParameter(RepositoryInstance repository,
Action action,
java.lang.Object[] values)
CustomActionParameterManager.setUserStoredParamValues(repository, action, values)
if values contains a null, that entry will not be modified
repository - RepositoryInstance to store this information foraction - Action to store this information forvalues - The values to remember, must be the same length as action.getParameters().size()
ArrayOutOfBoundsException - if values.length < action.getParameters().size()
public java.lang.Object[] getStoredCustomParameterValues(RepositoryManager repositoryManager,
Action action)
CustomActionParameterManager.getUserStoredParamValues()
repositoryManager - action -
public java.lang.Object[] getStoredCustomParameterValues(RepositoryInstance repository,
Action action)
CustomActionParameterManager.getUserStoredParamValues()
repository - action -
public java.lang.String getActionConfirmationKey(java.lang.String actionId)
actionId - the Id of the action to determine the key for
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||