|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.esri.arcgis.schematic.SchematicAlgoSmartTree
public class SchematicAlgoSmartTree
Smart Tree schematic algorithm object.
Constructor Summary | |
---|---|
SchematicAlgoSmartTree()
Constructs a SchematicAlgoSmartTree using ArcGIS Engine. |
|
SchematicAlgoSmartTree(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. SchematicAlgoSmartTree theSchematicAlgoSmartTree = (SchematicAlgoSmartTree) obj; |
Method Summary | |
---|---|
boolean |
equals(Object o)
Compare this object with another |
void |
execute(ISchematicLayer schematicLayer,
ITrackCancel cancelTracker)
Execute the schematic algorithm. |
String |
getAlgorithmCLSID()
The CLSID of the algorithm. |
double |
getBreakPoint()
Number comprised between 0 and 1 that defines the relative position of the break point on the last segment of the links; that is on the link segment that is paralleled to the tree direction. |
static String |
getClsid()
getClsid. |
int |
getDirection()
Smart tree structure direction. |
double |
getDistanceAlongTheDirection()
Spacing between the nodes that display along the smart tree direction; that is, spacing between a node belonging to the (n) hierarchical level and a node belonging to the (n+1) hierarchical level. |
double |
getDistancePerpendicularToDirection()
Spacing between the nodes that display perpendicularly to the smart tree direction and that belong to the same subtree level; that is, spacing between the nodes that belong to the same hierarchical level in the same subtree. |
IJSONArray |
getJSONParametersArray()
JSON parameters array. |
String |
getLabel()
The label of the algorithm. |
IPropertySet |
getPropertySet()
The property set of the algorithm contains a collection of its parameters and their values. |
ISchematicDiagramClassName |
getSchematicDiagramClassName()
The diagram class object used to initialize the algorithm. |
double |
getSubtreeSeparation()
Spacing between two neighbor subtrees; that is, spacing between the nodes that display perpendicularly to the smart tree direction and that belong to two different subtrees. |
int |
hashCode()
the hashcode for this object |
boolean |
isAbsoluteParameters()
Indicates if the values set for the spacing parameters must be interpreted as absolute units. |
boolean |
isAvailable()
Indicates if the algorithm is currently available. |
boolean |
isEnabled(ISchematicLayer schematicLayer)
Indicates if the algorithm is currently enabled. |
boolean |
isOrthogonalDisplay()
Indicates if the links must display with right angles. |
boolean |
isOverridable()
Indicates if the algorithm properties page is editable from ArcMap; that is, enabling the Layout Properties button in ArcMap. |
boolean |
isUseEndNode()
Indicates if the algorithm use end nodes. |
boolean |
isUseRootNode()
Indicates if the algorithm use root nodes. |
void |
setAbsoluteParameters(boolean pVal)
Indicates if the values set for the spacing parameters must be interpreted as absolute units. |
void |
setAvailable(boolean available)
Indicates if the algorithm is currently available. |
void |
setBreakPoint(double pVal)
Number comprised between 0 and 1 that defines the relative position of the break point on the last segment of the links; that is on the link segment that is paralleled to the tree direction. |
void |
setDirection(int pVal)
Smart tree structure direction. |
void |
setDistanceAlongTheDirection(double pVal)
Spacing between the nodes that display along the smart tree direction; that is, spacing between a node belonging to the (n) hierarchical level and a node belonging to the (n+1) hierarchical level. |
void |
setDistancePerpendicularToDirection(double pVal)
Spacing between the nodes that display perpendicularly to the smart tree direction and that belong to the same subtree level; that is, spacing between the nodes that belong to the same hierarchical level in the same subtree. |
void |
setJSONParametersObject(IJSONObject rhs1)
JSON parameters object. |
void |
setLabel(String label)
The label of the algorithm. |
void |
setOrthogonalDisplay(boolean pVal)
Indicates if the links must display with right angles. |
void |
setOverridable(boolean pOverridable)
Indicates if the algorithm properties page is editable from ArcMap; that is, enabling the Layout Properties button in ArcMap. |
void |
setPropertySet(IPropertySet propertySet)
The property set of the algorithm contains a collection of its parameters and their values. |
void |
setSchematicDiagramClassNameByRef(ISchematicDiagramClassName schematicDiagramClassName)
The diagram class object used to initialize the algorithm. |
void |
setSubtreeSeparation(double pVal)
Spacing between two neighbor subtrees; that is, spacing between the nodes that display perpendicularly to the smart tree direction and that belong to two different subtrees. |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef |
---|
getJintegraDispatch, release |
Constructor Detail |
---|
public SchematicAlgoSmartTree() throws IOException, UnknownHostException
IOException
- if there are interop problems
UnknownHostException
- if there are interop problemspublic SchematicAlgoSmartTree(Object obj) throws IOException
SchematicAlgoSmartTree theSchematicAlgoSmartTree = (SchematicAlgoSmartTree) obj;
obj
to SchematicAlgoSmartTree
.
obj
- an object returned from ArcGIS Engine or Server
IOException
- if there are interop problemsMethod Detail |
---|
public static String getClsid()
public boolean equals(Object o)
equals
in class Object
public int hashCode()
hashCode
in class Object
public double getDistanceAlongTheDirection() throws IOException, AutomationException
getDistanceAlongTheDirection
in interface ISchematicAlgoSmartTree
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setDistanceAlongTheDirection(double pVal) throws IOException, AutomationException
setDistanceAlongTheDirection
in interface ISchematicAlgoSmartTree
pVal
- The pVal (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public double getDistancePerpendicularToDirection() throws IOException, AutomationException
getDistancePerpendicularToDirection
in interface ISchematicAlgoSmartTree
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setDistancePerpendicularToDirection(double pVal) throws IOException, AutomationException
setDistancePerpendicularToDirection
in interface ISchematicAlgoSmartTree
pVal
- The pVal (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public double getSubtreeSeparation() throws IOException, AutomationException
getSubtreeSeparation
in interface ISchematicAlgoSmartTree
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setSubtreeSeparation(double pVal) throws IOException, AutomationException
setSubtreeSeparation
in interface ISchematicAlgoSmartTree
pVal
- The pVal (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getDirection() throws IOException, AutomationException
getDirection
in interface ISchematicAlgoSmartTree
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setDirection(int pVal) throws IOException, AutomationException
setDirection
in interface ISchematicAlgoSmartTree
pVal
- A com.esri.arcgis.schematic.esriSchematicAlgoDirection constant (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public double getBreakPoint() throws IOException, AutomationException
getBreakPoint
in interface ISchematicAlgoSmartTree
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setBreakPoint(double pVal) throws IOException, AutomationException
setBreakPoint
in interface ISchematicAlgoSmartTree
pVal
- The pVal (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isOrthogonalDisplay() throws IOException, AutomationException
isOrthogonalDisplay
in interface ISchematicAlgoSmartTree
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setOrthogonalDisplay(boolean pVal) throws IOException, AutomationException
setOrthogonalDisplay
in interface ISchematicAlgoSmartTree
pVal
- The pVal (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isAbsoluteParameters() throws IOException, AutomationException
isAbsoluteParameters
in interface ISchematicAlgoSmartTree
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setAbsoluteParameters(boolean pVal) throws IOException, AutomationException
setAbsoluteParameters
in interface ISchematicAlgoSmartTree
pVal
- The pVal (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isEnabled(ISchematicLayer schematicLayer) throws IOException, AutomationException
isEnabled
in interface ISchematicAlgorithm
schematicLayer
- A reference to a com.esri.arcgis.schematic.ISchematicLayer (in, optional, pass 0 if not required)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isAvailable() throws IOException, AutomationException
isAvailable
in interface ISchematicAlgorithm
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setAvailable(boolean available) throws IOException, AutomationException
setAvailable
in interface ISchematicAlgorithm
available
- The available (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isOverridable() throws IOException, AutomationException
isOverridable
in interface ISchematicAlgorithm
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setOverridable(boolean pOverridable) throws IOException, AutomationException
setOverridable
in interface ISchematicAlgorithm
pOverridable
- The pOverridable (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public ISchematicDiagramClassName getSchematicDiagramClassName() throws IOException, AutomationException
getSchematicDiagramClassName
in interface ISchematicAlgorithm
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setSchematicDiagramClassNameByRef(ISchematicDiagramClassName schematicDiagramClassName) throws IOException, AutomationException
setSchematicDiagramClassNameByRef
in interface ISchematicAlgorithm
schematicDiagramClassName
- A reference to a com.esri.arcgis.schematic.ISchematicDiagramClassName (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getLabel() throws IOException, AutomationException
getLabel
in interface ISchematicAlgorithm
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setLabel(String label) throws IOException, AutomationException
setLabel
in interface ISchematicAlgorithm
label
- The label (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isUseRootNode() throws IOException, AutomationException
isUseRootNode
in interface ISchematicAlgorithm
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isUseEndNode() throws IOException, AutomationException
isUseEndNode
in interface ISchematicAlgorithm
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IPropertySet getPropertySet() throws IOException, AutomationException
getPropertySet
in interface ISchematicAlgorithm
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setPropertySet(IPropertySet propertySet) throws IOException, AutomationException
setPropertySet
in interface ISchematicAlgorithm
propertySet
- A reference to a com.esri.arcgis.system.IPropertySet (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getAlgorithmCLSID() throws IOException, AutomationException
getAlgorithmCLSID
in interface ISchematicAlgorithm
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void execute(ISchematicLayer schematicLayer, ITrackCancel cancelTracker) throws IOException, AutomationException
execute
in interface ISchematicAlgorithm
schematicLayer
- A reference to a com.esri.arcgis.schematic.ISchematicLayer (in, optional, pass 0 if not required)cancelTracker
- A reference to a com.esri.arcgis.system.ITrackCancel (in, optional, pass 0 if not required)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IJSONArray getJSONParametersArray() throws IOException, AutomationException
getJSONParametersArray
in interface ISchematicJSONParameters
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setJSONParametersObject(IJSONObject rhs1) throws IOException, AutomationException
setJSONParametersObject
in interface ISchematicJSONParameters
rhs1
- A reference to a com.esri.arcgis.system.IJSONObject (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |