com.esri.arcgis.schematic
Interface ISchematicAlgoMainRing

All Superinterfaces:

ISchematicAlgorithm, java.io.Serializable

All Known Implementing Classes:

ISchematicAlgoMainRingProxy, SchematicAlgoMainRing

public interface ISchematicAlgoMainRing
extends ISchematicAlgorithm, java.io.Serializable

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

Description: 'Provides access to members that control the Main Ring 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	IID14a327c6_1034_45eb_a051_33b00d0a493b
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 to define 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.
double	getDistanceAlongTheDirection() Spacing between the nodes that display along the 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 tree direction; that is, spacing between the nodes that belong to a same hierarchical level.
double	getHeight() Height of the main ring.
double	getLength() Width of the main ring.
int	getMainRingType() Main Ring form type.
int	getTreeType() Hierarchical trees layout type.
boolean	isAbsoluteParameters() Indicates if the values set for the spacing and dimension parameters must be interpreted as absolute units.
boolean	isLockLinks() Indicates if the links currently selected must be interprated as barriers that disable the Main Ring execution for a part of the diagram.
void	setAbsoluteParameters(boolean pVal) Indicates if the values set for the spacing and dimension parameters must be interpreted as absolute units.
void	setBreakPoint(double pVal) Number comprised between 0 and 1 to define 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	setDistanceAlongTheDirection(double pVal) Spacing between the nodes that display along the 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 tree direction; that is, spacing between the nodes that belong to a same hierarchical level.
void	setHeight(double pVal) Height of the main ring.
void	setLength(double pVal) Width of the main ring.
void	setLockLinks(boolean pVal) Indicates if the links currently selected must be interprated as barriers that disable the Main Ring execution for a part of the diagram.
void	setMainRingType(int pVal) Main Ring form type.
void	setTreeType(int pVal) Hierarchical trees layout type.

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

IID14a327c6_1034_45eb_a051_33b00d0a493b

static final int IID14a327c6_1034_45eb_a051_33b00d0a493b

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

isLockLinks

boolean isLockLinks()
                    throws java.io.IOException,
                           AutomationException

Indicates if the links currently selected must be interprated as barriers that disable the Main Ring execution for a part of the diagram.

Returns:

The pVal

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLockLinks

void setLockLinks(boolean pVal)
                  throws java.io.IOException,
                         AutomationException

Indicates if the links currently selected must be interprated as barriers that disable the Main Ring execution for a part of the diagram.

Parameters:

pVal - The pVal (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMainRingType

int getMainRingType()
                    throws java.io.IOException,
                           AutomationException

Main Ring form type.

Returns:

A com.esri.arcgis.schematic.esriSchematicAlgoMainRingType constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMainRingType

void setMainRingType(int pVal)
                     throws java.io.IOException,
                            AutomationException

Main Ring form type.

Parameters:

pVal - A com.esri.arcgis.schematic.esriSchematicAlgoMainRingType constant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDistanceAlongTheDirection

double getDistanceAlongTheDirection()
                                    throws java.io.IOException,
                                           AutomationException

Spacing between the nodes that display along the 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 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 tree direction; that is, spacing between the nodes that belong to a same hierarchical level.

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 tree direction; that is, spacing between the nodes that belong to a same hierarchical level.

Parameters:

pVal - The pVal (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHeight

double getHeight()
                 throws java.io.IOException,
                        AutomationException

Height of the main ring.

Returns:

The pVal

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHeight

void setHeight(double pVal)
               throws java.io.IOException,
                      AutomationException

Height of the main ring.

Parameters:

pVal - The pVal (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLength

double getLength()
                 throws java.io.IOException,
                        AutomationException

Width of the main ring.

Returns:

The pVal

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLength

void setLength(double pVal)
               throws java.io.IOException,
                      AutomationException

Width of the main ring.

Parameters:

pVal - The pVal (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 to define 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 to define 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.

getTreeType

int getTreeType()
                throws java.io.IOException,
                       AutomationException

Hierarchical trees layout type.

Returns:

A com.esri.arcgis.schematic.esriSchematicAlgoHierarchicalType constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTreeType

void setTreeType(int pVal)
                 throws java.io.IOException,
                        AutomationException

Hierarchical trees layout type.

Parameters:

pVal - A com.esri.arcgis.schematic.esriSchematicAlgoHierarchicalType constant (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 and dimension 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 and dimension 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.