com.esri.arcgis.schematic
Interface ISchematicAlgoSmartTree

All Superinterfaces:
ISchematicAlgorithm, java.io.Serializable
All Known Implementing Classes:
ISchematicAlgoSmartTreeProxy, SchematicAlgoSmartTree

public interface ISchematicAlgoSmartTree
extends ISchematicAlgorithm, java.io.Serializable

COM Interface 'ISchematicAlgoSmartTree'. Generated 3/19/2015 1:21:00 PM from 'C:\ArcGIS\COM\esriSchematic.olb'

Description: 'Provides access to members that control the Smart Tree schematic algorithm.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =


Field Summary
static java.lang.String IID
          Deprecated. Internal use only
static int IID1a959572_a8ce_4445_acb1_4097b612134f
           
static int xxDummy
          Deprecated. Internal use only
 
Fields inherited from interface com.esri.arcgis.schematic.ISchematicAlgorithm
IIDbef20014_837c_4387_83ba_8523b7897a36
 
Method Summary
 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.
 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.
 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.
 boolean isAbsoluteParameters()
          Indicates if the values set for the spacing parameters must be interpreted as absolute units.
 boolean isOrthogonalDisplay()
          Indicates if the links must display with right angles.
 void setAbsoluteParameters(boolean pVal)
          Indicates if the values set for the spacing parameters must be interpreted as absolute units.
 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 setOrthogonalDisplay(boolean pVal)
          Indicates if the links must display with right angles.
 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 interface com.esri.arcgis.schematic.ISchematicAlgorithm
execute, getAlgorithmCLSID, getLabel, getPropertySet, getSchematicDiagramClassName, isAvailable, isEnabled, isOverridable, isUseEndNode, isUseRootNode, setAvailable, setLabel, setOverridable, setPropertySet, setSchematicDiagramClassNameByRef
 

Field Detail

IID1a959572_a8ce_4445_acb1_4097b612134f

static final int IID1a959572_a8ce_4445_acb1_4097b612134f
See Also:
Constant Field Values

xxDummy

static final int xxDummy
Deprecated. Internal use only
See Also:
Constant Field Values

IID

static final java.lang.String IID
Deprecated. Internal use only
See Also:
Constant Field Values
Method Detail

getDistanceAlongTheDirection

double getDistanceAlongTheDirection()
                                    throws java.io.IOException,
                                           AutomationException
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.

Returns:
The pVal
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDistanceAlongTheDirection

void setDistanceAlongTheDirection(double pVal)
                                  throws java.io.IOException,
                                         AutomationException
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.

Parameters:
pVal - The pVal (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDistancePerpendicularToDirection

double getDistancePerpendicularToDirection()
                                           throws java.io.IOException,
                                                  AutomationException
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.

Returns:
The pVal
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDistancePerpendicularToDirection

void setDistancePerpendicularToDirection(double pVal)
                                         throws java.io.IOException,
                                                AutomationException
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.

Parameters:
pVal - The pVal (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSubtreeSeparation

double getSubtreeSeparation()
                            throws java.io.IOException,
                                   AutomationException
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.

Returns:
The pVal
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSubtreeSeparation

void setSubtreeSeparation(double pVal)
                          throws java.io.IOException,
                                 AutomationException
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.

Parameters:
pVal - The pVal (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDirection

int getDirection()
                 throws java.io.IOException,
                        AutomationException
Smart tree structure direction.

Returns:
A com.esri.arcgis.schematic.esriSchematicAlgoDirection constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDirection

void setDirection(int pVal)
                  throws java.io.IOException,
                         AutomationException
Smart tree structure direction.

Parameters:
pVal - A com.esri.arcgis.schematic.esriSchematicAlgoDirection constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBreakPoint

double getBreakPoint()
                     throws java.io.IOException,
                            AutomationException
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.

Returns:
The pVal
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBreakPoint

void setBreakPoint(double pVal)
                   throws java.io.IOException,
                          AutomationException
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.

Parameters:
pVal - The pVal (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isOrthogonalDisplay

boolean isOrthogonalDisplay()
                            throws java.io.IOException,
                                   AutomationException
Indicates if the links must display with right angles.

Returns:
The pVal
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setOrthogonalDisplay

void setOrthogonalDisplay(boolean pVal)
                          throws java.io.IOException,
                                 AutomationException
Indicates if the links must display with right angles.

Parameters:
pVal - The pVal (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isAbsoluteParameters

boolean isAbsoluteParameters()
                             throws java.io.IOException,
                                    AutomationException
Indicates if the values set for the spacing parameters must be interpreted as absolute units.

Returns:
The pVal
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAbsoluteParameters

void setAbsoluteParameters(boolean pVal)
                           throws java.io.IOException,
                                  AutomationException
Indicates if the values set for the spacing parameters must be interpreted as absolute units.

Parameters:
pVal - The pVal (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.