|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.sun.electric.tool.Tool
public class Tool
This class represents a Tool in Electric. It's here mostly for the name of the tool and the variables attached. The User holds variables that keep track of the currently selected object, and other useful information.
Field Summary | |
---|---|
Pref.Group |
prefs
Preferences for this Tool |
Constructor Summary | |
---|---|
protected |
Tool(java.lang.String toolName)
The constructor for Tool is only called by subclasses. |
Method Summary | |
---|---|
void |
clearAnalysis()
Method to set this Tool to be analysis. |
void |
clearBackground()
Method to set this Tool to be in the foreground. |
void |
clearFixErrors()
Method to set this Tool to fix errors. |
void |
clearIncremental()
Method to set this Tool to be incremental. |
void |
clearOn()
Method to set this Tool to be off. |
void |
clearSynthesis()
Method to set this Tool to be synthesis. |
int |
compareTo(java.lang.Object obj)
Compares Tools by their definition order. |
static Tool |
findTool(java.lang.String name)
Method to find the Tool with a specified name. |
int |
getIndex()
Method to return the index of this Tool. |
static java.util.Iterator<Listener> |
getListeners()
Method to return an Iterator over all of the Listener in Electric which are on. |
java.lang.String |
getName()
Method to return the name of this Tool. |
static int |
getNumTools()
Method to return the number of Tools. |
ProjSettingsNode |
getProjectSettings()
|
static java.util.Iterator<Tool> |
getTools()
Method to return an Iterator over all of the Tools in Electric. |
void |
init()
The initialization method for this Tool. |
static void |
initAllTools()
This is called once, at the start of Electric, to initialize the Tools. |
protected void |
initProjectSettings()
Subclasses override this method to create ProjectSettings by Tool.makeXXXSetting methods declared below. |
boolean |
isAnalysis()
Method to tell whether this Tool does analysis. |
boolean |
isBackground()
Method to tell whether this Tool is in the background. |
boolean |
isFixErrors()
Method to tell whether this Tool fixes errors. |
boolean |
isIncremental()
Method to tell whether this Tool is incremental. |
boolean |
isOn()
Method to tell whether this Tool is on. |
boolean |
isSynthesis()
Method to tell whether this Tool does synthesis. |
protected void |
makeBooleanSetting(java.lang.String name,
java.lang.String location,
java.lang.String description,
boolean factory)
Factory methods to create a boolean project setting objects. |
protected void |
makeDoubleSetting(java.lang.String name,
java.lang.String location,
java.lang.String description,
double factory)
Factory methods to create a double project setting objects. |
protected void |
makeIntSetting(java.lang.String name,
java.lang.String location,
java.lang.String description,
int factory)
Factory methods to create an integer project setting objects. |
protected void |
makeLongSetting(java.lang.String name,
java.lang.String location,
java.lang.String description,
long factory)
Factory methods to create a long project setting objects. |
protected void |
makeStringSetting(java.lang.String name,
java.lang.String location,
java.lang.String description,
java.lang.String factory)
Factory methods to create a string project setting objects. |
void |
setAnalysis()
Method to set this Tool to be analysis. |
void |
setBackground()
Method to set this Tool to be in the background. |
void |
setFixErrors()
Method to set this Tool to fix errors. |
void |
setIncremental()
Method to set this Tool to be incremental. |
void |
setOn()
Method to set this Tool to be on. |
void |
setSynthesis()
Method to set this Tool to be synthesis. |
void |
setVarInJob(ElectricObject obj,
Variable.Key key,
java.lang.Object newVal)
Method to set a variable on an ElectricObject in a new Job. |
static boolean |
testAll()
Test interface |
java.lang.String |
toString()
Returns a printable version of this Tool. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public Pref.Group prefs
Constructor Detail |
---|
protected Tool(java.lang.String toolName)
toolName
- the name of this tool.Method Detail |
---|
public static void initAllTools()
public static Tool findTool(java.lang.String name)
name
- the name of the desired Tool.
public static java.util.Iterator<Tool> getTools()
public static int getNumTools()
public static java.util.Iterator<Listener> getListeners()
public java.lang.String getName()
public int getIndex()
public void setOn()
public void clearOn()
public boolean isOn()
public void setBackground()
public void clearBackground()
public boolean isBackground()
public void setFixErrors()
public void clearFixErrors()
public boolean isFixErrors()
public void setIncremental()
public void clearIncremental()
public boolean isIncremental()
public void setAnalysis()
public void clearAnalysis()
public boolean isAnalysis()
public void setSynthesis()
public void clearSynthesis()
public boolean isSynthesis()
public ProjSettingsNode getProjectSettings()
public int compareTo(java.lang.Object obj)
compareTo
in interface java.lang.Comparable
obj
- the other Tool.
public java.lang.String toString()
toString
in class java.lang.Object
protected void initProjectSettings()
protected void makeBooleanSetting(java.lang.String name, java.lang.String location, java.lang.String description, boolean factory)
name
- the name of this Pref.location
- 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).protected void makeIntSetting(java.lang.String name, java.lang.String location, java.lang.String description, int factory)
name
- the name of this Pref.location
- 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).protected void makeLongSetting(java.lang.String name, java.lang.String location, java.lang.String description, long factory)
name
- the name of this Pref.location
- 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).protected void makeDoubleSetting(java.lang.String name, java.lang.String location, java.lang.String description, double factory)
name
- the name of this Pref.location
- 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).protected void makeStringSetting(java.lang.String name, java.lang.String location, java.lang.String description, java.lang.String factory)
name
- the name of this Pref.location
- 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 void setVarInJob(ElectricObject obj, Variable.Key key, java.lang.Object newVal)
obj
- the ElectricObject on which to set the variable.key
- the Variable key.newVal
- the new value of the Variable.public void init()
public static boolean testAll()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |