|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.sun.electric.database.text.Setting
public class Setting
Nested Class Summary | |
---|---|
static class |
Setting.SettingChangeBatch
|
Constructor Summary | |
---|---|
Setting(java.lang.String prefName,
Pref.Group group,
ProjSettingsNode xmlNode,
java.lang.String xmlName,
java.lang.String location,
java.lang.String description,
java.lang.Object factoryObj)
Creates a new instance of Setting |
Method Summary | |
---|---|
static void |
finishSettingReconcilation(java.util.Map<Setting,java.lang.Object> settingsToReconcile)
This method is called after reconciling project settings with OptionReconcile dialog or in a batch mode |
boolean |
getBoolean()
Method to get the boolean value on this Setting object. |
boolean |
getBoolean(java.util.List<java.lang.Object> context)
Method to get the boolean value on this Setting object in a specified context. |
static java.util.List<java.lang.Object> |
getContext()
|
java.lang.String |
getDescription()
Method to return the description of this Meaning option. |
double |
getDouble()
Method to get the double value on this Setting object. |
double |
getDouble(java.util.List<java.lang.Object> context)
Method to get the double value on this Setting object in a specified context. |
double |
getDoubleFactoryValue()
Method to get the factory-default double value of this Pref object. |
java.lang.Object |
getFactoryValue()
Method to get the factory-default value of this Pref object. |
int |
getInt()
Method to get the integer value on this Setting object. |
int |
getInt(java.util.List<java.lang.Object> context)
Method to get the integer value on this Setting object in a specified context. |
java.lang.String |
getLocation()
Method to return the user-command that can affect this Meaning option. |
long |
getLong()
Method to get the long value on this Setting object. |
long |
getLong(java.util.List<java.lang.Object> context)
Method to get the long value on this Setting object in a specified context. |
java.lang.String |
getPrefName()
Method to get the name of this Setting object. |
static Setting |
getSetting(java.lang.String xmlPath)
Method to find the project Setting object by its xml path. |
static Setting |
getSettingByPrefPath(java.lang.String prefPath)
Method to find the project Setting object by its pref path. |
static java.util.Collection<Setting> |
getSettings()
|
static java.util.List<Setting> |
getSettings(ProjSettingsNode node)
Method to get a list of projecy Settings assiciatiated with the given owner object. |
java.lang.String |
getString()
Method to get the string value on this Setting object. |
java.lang.String |
getString(java.util.List<java.lang.Object> context)
Method to get the string value on this Setting object in a specified context. |
java.lang.String[] |
getTrueMeaning()
Method to return an array of strings to be used for integer Meaning options. |
java.lang.Object |
getValue()
Method to get the value of this Setting object as an Object. |
java.lang.Object |
getValue(java.util.List<java.lang.Object> context)
Method to get the value of this Setting object as an Object in a specified context. |
java.lang.String |
getXmlPath()
Method to get the xml name of this Setting object. |
static void |
implementSettingChanges(Setting.SettingChangeBatch batch)
Method to make a collection of project settings changes. |
boolean |
isValidOption()
Method to tell whether this Meaning option is valid and should be reconciled. |
static Setting |
makeBooleanSetting(java.lang.String name,
Pref.Group group,
ProjSettingsNode xmlNode,
java.lang.String xmlName,
java.lang.String location,
java.lang.String description,
boolean factory)
Factory methods to create a boolean project setting objects. |
static Setting |
makeDoubleSetting(java.lang.String name,
Pref.Group group,
ProjSettingsNode xmlNode,
java.lang.String xmlName,
java.lang.String location,
java.lang.String description,
double factory)
Factory methods to create a double project setting objects. |
static Setting |
makeIntSetting(java.lang.String name,
Pref.Group group,
ProjSettingsNode xmlNode,
java.lang.String xmlName,
java.lang.String location,
java.lang.String description,
int factory)
Factory methods to create an integerproject setting objects. |
static Setting |
makeLongSetting(java.lang.String name,
Pref.Group group,
ProjSettingsNode xmlNode,
java.lang.String xmlName,
java.lang.String location,
java.lang.String description,
long factory)
Factory methods to create a long project setting objects. |
static Setting |
makeStringSetting(java.lang.String name,
Pref.Group group,
ProjSettingsNode xmlNode,
java.lang.String xmlName,
java.lang.String location,
java.lang.String description,
java.lang.String factory)
Factory methods to create a string project setting objects. |
static java.util.Map<Setting,java.lang.Object> |
reconcileSettings(java.util.Map<Setting,java.lang.Object> projectSettings)
Method to adjust project that were saved with a library. |
static java.util.List<java.lang.Object> |
resetContext()
|
static void |
restoreContext(java.util.List<java.lang.Object> savedContext)
|
void |
set(java.util.List<java.lang.Object> context,
java.lang.Object v)
|
void |
set(java.lang.Object v)
|
protected void |
setSideEffect()
Method called when this Pref is changed. |
void |
setTrueMeaning(java.lang.String[] trueMeaning)
Method to associate an array of strings to be used for integer Meaning options. |
void |
setValidOption(boolean valid)
Method to set whether this Meaning option is valid and should be reconciled. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public Setting(java.lang.String prefName, Pref.Group group, ProjSettingsNode xmlNode, java.lang.String xmlName, java.lang.String location, java.lang.String description, java.lang.Object factoryObj)
Method Detail |
---|
public boolean getBoolean()
public int getInt()
public long getLong()
public double getDouble()
public java.lang.String getString()
public boolean getBoolean(java.util.List<java.lang.Object> context)
context
- specified context.
public int getInt(java.util.List<java.lang.Object> context)
context
- specified context.
public long getLong(java.util.List<java.lang.Object> context)
context
- specified context.
public double getDouble(java.util.List<java.lang.Object> context)
context
- specified context.
public java.lang.String getString(java.util.List<java.lang.Object> context)
context
- specified context.
public void set(java.lang.Object v)
public void set(java.util.List<java.lang.Object> context, java.lang.Object v)
protected void setSideEffect()
public java.lang.String getXmlPath()
public java.lang.String getPrefName()
public java.lang.Object getValue()
public java.lang.Object getValue(java.util.List<java.lang.Object> context)
context
- specified context
public java.lang.String getLocation()
public java.lang.String getDescription()
public void setValidOption(boolean valid)
valid
- true if this Meaning option is valid and should be reconciled.public boolean isValidOption()
public void setTrueMeaning(java.lang.String[] trueMeaning)
trueMeaning
- the array of strings that should be used for this integer Meaning option.
Some options are multiple-choice, for example the MOSIS CMOS rule set which can be
0, 1, or 2 depending on whether the set is SCMOS, Submicron, or Deep.
By giving an array of 3 strings to this method, a proper description of the option
can be given to the user.public java.lang.String[] getTrueMeaning()
public java.lang.Object getFactoryValue()
public double getDoubleFactoryValue()
public static Setting makeBooleanSetting(java.lang.String name, Pref.Group group, ProjSettingsNode xmlNode, java.lang.String xmlName, java.lang.String location, java.lang.String description, boolean factory)
name
- the name of this Pref.group
- group of preferences to which a new Pref belongslocation
- the user-command that can affect this meaning option.description
- the description of this meaning option.factory
- the "factory" default value (if nothing is stored).public static Setting makeIntSetting(java.lang.String name, Pref.Group group, ProjSettingsNode xmlNode, java.lang.String xmlName, java.lang.String location, java.lang.String description, int factory)
name
- the name of this Pref.group
- group of preferences to which a new Pref belongslocation
- the user-command that can affect this meaning option.description
- the description of this meaning option.factory
- the "factory" default value (if nothing is stored).public static Setting makeLongSetting(java.lang.String name, Pref.Group group, ProjSettingsNode xmlNode, java.lang.String xmlName, java.lang.String location, java.lang.String description, long factory)
name
- the name of this Pref.group
- group of preferences to which a new Pref belongslocation
- the user-command that can affect this meaning option.description
- the description of this meaning option.factory
- the "factory" default value (if nothing is stored).public static Setting makeDoubleSetting(java.lang.String name, Pref.Group group, ProjSettingsNode xmlNode, java.lang.String xmlName, java.lang.String location, java.lang.String description, double factory)
name
- the name of this Pref.group
- group of preferences to which a new Pref belongslocation
- the user-command that can affect this meaning option.description
- the description of this meaning option.factory
- the "factory" default value (if nothing is stored).public static Setting makeStringSetting(java.lang.String name, Pref.Group group, ProjSettingsNode xmlNode, java.lang.String xmlName, java.lang.String location, java.lang.String description, java.lang.String factory)
name
- the name of this Pref.group
- group of preferences to which a new Pref belongslocation
- the user-command that can affect this meaning option.description
- the description of this meaning option.factory
- the "factory" default value (if nothing is stored).public static Setting getSetting(java.lang.String xmlPath)
xmlPath
- the xml path of the desired project Setting object.
public static Setting getSettingByPrefPath(java.lang.String prefPath)
prefPath
- the pref path of the desired project Setting object.
public static java.util.List<Setting> getSettings(ProjSettingsNode node)
node
- owner object
public static java.util.Map<Setting,java.lang.Object> reconcileSettings(java.util.Map<Setting,java.lang.Object> projectSettings)
public static void finishSettingReconcilation(java.util.Map<Setting,java.lang.Object> settingsToReconcile)
public static void implementSettingChanges(Setting.SettingChangeBatch batch)
batch
- the collection of project setting changes.public static java.util.List<java.lang.Object> getContext()
public static java.util.List<java.lang.Object> resetContext()
public static void restoreContext(java.util.List<java.lang.Object> savedContext)
public static java.util.Collection<Setting> getSettings()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |