com.esri.arcgis.schematic
Class ISchematicAlgoMainLineTreeProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.schematic.ISchematicAlgoMainLineTreeProxy

All Implemented Interfaces:

ISchematicAlgoMainLineTree, Externalizable, Serializable

public class ISchematicAlgoMainLineTreeProxy
extends com.esri.arcgis.interop.Dispatch
implements ISchematicAlgoMainLineTree, Serializable

Provides access to members that control the Main Line schematic algorithm.

Description

The Main Line Tree layout arranges hierarchically all the nodes and links in the active schematic diagram along the detected main line.

By default, when no schematic root and schematic end elements are set, the main line is the longest branch of the diagram; that is, the branch composed by the most number of links. When a schematic root element is set, the main line is the branch composed by the most number of links starting from this schematic root element. When a schematic end element is set, the main line is the branch composed by the most number of links ending from this schematic end element. When the schematic root and schematic end elements are set, the main line is the branch composed by the most number of links starting from this schematic root element and ending by this schematic end element.

In any case, the detected main line is placed as a central line and its related branches are placed either both sides, left or right side of it.

If a selected set has been defined in the active schematic diagram, the algorithm only applies to the selected schematic elements.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

See Also:

ISchematicAlgoCompactTree, Serialized Form

Field Summary

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, E

Constructor Summary

	ISchematicAlgoMainLineTreeProxy()
	ISchematicAlgoMainLineTreeProxy(Object obj)
protected	ISchematicAlgoMainLineTreeProxy(Object obj, String iid)

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
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 main line.
int	getDirection() Main line tree direction.
double	getDistanceAlongTheDirection() Spacing between the nodes that display along the main line 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 main line direction; that is, spacing between the nodes that belong to a same hierarchical level.
int	getPageLayout() Main line tree layout type.
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.
boolean	isWorkOnUnvisibleObjects() Indicates if the Main Line Tree algorithm must work both with the visible and invisible graphic elements.
void	readExternal(ObjectInput in)
void	removeListener(String iidStr, Object theListener)
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 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 main line.
void	setDirection(int pVal) Main line tree direction.
void	setDistanceAlongTheDirection(double pVal) Spacing between the nodes that display along the main line 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 main line direction; that is, spacing between the nodes that belong to a same hierarchical level.
void	setOrthogonalDisplay(boolean pVal) Indicates if the links must display with right angles.
void	setPageLayout(int pVal) Main line tree layout type.
void	setWorkOnUnvisibleObjects(boolean pVal) Indicates if the Main Line Tree algorithm must work both with the visible and invisible graphic elements.
void	writeExternal(ObjectOutput out)

Methods inherited from class com.esri.arcgis.interop.Dispatch

bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, queryInterface, release, setNativeMode, setPropertyByName, toString, vtblInvoke

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ISchematicAlgoMainLineTreeProxy

public ISchematicAlgoMainLineTreeProxy()

ISchematicAlgoMainLineTreeProxy

public ISchematicAlgoMainLineTreeProxy(Object obj)
                                throws IOException

Throws:

IOException

ISchematicAlgoMainLineTreeProxy

protected ISchematicAlgoMainLineTreeProxy(Object obj,
                                          String iid)
                                   throws IOException

Throws:

IOException

Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException

Overrides:

addListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException

Overrides:

removeListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

getDistanceAlongTheDirection

public double getDistanceAlongTheDirection()
                                    throws IOException,
                                           AutomationException

Spacing between the nodes that display along the main line direction; that is, spacing between a node belonging to the (n) hierarchical level and a node belonging to the (n+1) hierarchical level.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getDistanceAlongTheDirection in interface ISchematicAlgoMainLineTree

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

ISchematicAlgoMainLineTree.getDistancePerpendicularToDirection()

setDistanceAlongTheDirection

public void setDistanceAlongTheDirection(double pVal)
                                  throws IOException,
                                         AutomationException

Spacing between the nodes that display along the main line direction; that is, spacing between a node belonging to the (n) hierarchical level and a node belonging to the (n+1) hierarchical level.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setDistanceAlongTheDirection in interface ISchematicAlgoMainLineTree

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDistancePerpendicularToDirection

public double getDistancePerpendicularToDirection()
                                           throws IOException,
                                                  AutomationException

Spacing between the nodes that display perpendicularly to the main line direction; that is, spacing between the nodes that belong to a same hierarchical level.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getDistancePerpendicularToDirection in interface ISchematicAlgoMainLineTree

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

ISchematicAlgoMainLineTree.getDistanceAlongTheDirection()

setDistancePerpendicularToDirection

public void setDistancePerpendicularToDirection(double pVal)
                                         throws IOException,
                                                AutomationException

Spacing between the nodes that display perpendicularly to the main line direction; that is, spacing between the nodes that belong to a same hierarchical level.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setDistancePerpendicularToDirection in interface ISchematicAlgoMainLineTree

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBreakPoint

public double getBreakPoint()
                     throws 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 main line.

Description

With a break point value of 0, this segment length is the longest and it displays with a right angle. With a break point value of 1, this segment doesn’t exist; each link directly connects its two extremity nodes without intermediate point.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getBreakPoint in interface ISchematicAlgoMainLineTree

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

ISchematicAlgoMainLineTree.isOrthogonalDisplay()

setBreakPoint

public void setBreakPoint(double pVal)
                   throws 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 main line.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setBreakPoint in interface ISchematicAlgoMainLineTree

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDirection

public int getDirection()
                 throws IOException,
                        AutomationException

Main line tree direction.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getDirection in interface ISchematicAlgoMainLineTree

Returns:

A com.esri.arcgis.schematic.esriSchematicAlgoDirection constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

ISchematicAlgoMainLineTree.getPageLayout()

setDirection

public void setDirection(int pVal)
                  throws IOException,
                         AutomationException

Main line tree direction.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setDirection in interface ISchematicAlgoMainLineTree

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPageLayout

public int getPageLayout()
                  throws IOException,
                         AutomationException

Main line tree layout type.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getPageLayout in interface ISchematicAlgoMainLineTree

Returns:

A com.esri.arcgis.schematic.esriSchematicAlgoMainLineType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

ISchematicAlgoMainLineTree.getDirection()

setPageLayout

public void setPageLayout(int pVal)
                   throws IOException,
                          AutomationException

Main line tree layout type.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setPageLayout in interface ISchematicAlgoMainLineTree

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isOrthogonalDisplay

public boolean isOrthogonalDisplay()
                            throws IOException,
                                   AutomationException

Indicates if the links must display with right angles.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

isOrthogonalDisplay in interface ISchematicAlgoMainLineTree

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

ISchematicAlgoMainLineTree.getBreakPoint()

setOrthogonalDisplay

public void setOrthogonalDisplay(boolean pVal)
                          throws IOException,
                                 AutomationException

Indicates if the links must display with right angles.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setOrthogonalDisplay in interface ISchematicAlgoMainLineTree

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAbsoluteParameters

public boolean isAbsoluteParameters()
                             throws IOException,
                                    AutomationException

Indicates if the values set for the spacing parameters must be interpreted as absolute units.

Description

When this property returns false, the parameters that define the distances are expressed as relative units to the average of the current symbols sizes used to represent the schematic nodes in the diagram; for instance, when the DistanceAlongTheDirection property value is 2, the distance that separates two nodes belonging to the (n) and the (n+1) hierarchical levels corresponds to the average size of two symbols placed side by side.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

isAbsoluteParameters in interface ISchematicAlgoMainLineTree

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAbsoluteParameters

public void setAbsoluteParameters(boolean pVal)
                           throws IOException,
                                  AutomationException

Indicates if the values set for the spacing parameters must be interpreted as absolute units.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setAbsoluteParameters in interface ISchematicAlgoMainLineTree

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isWorkOnUnvisibleObjects

public boolean isWorkOnUnvisibleObjects()
                                 throws IOException,
                                        AutomationException

Indicates if the Main Line Tree algorithm must work both with the visible and invisible graphic elements.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

isWorkOnUnvisibleObjects in interface ISchematicAlgoMainLineTree

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setWorkOnUnvisibleObjects

public void setWorkOnUnvisibleObjects(boolean pVal)
                               throws IOException,
                                      AutomationException

Indicates if the Main Line Tree algorithm must work both with the visible and invisible graphic elements.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setWorkOnUnvisibleObjects in interface ISchematicAlgoMainLineTree

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Overrides:

writeExternal in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Overrides:

readExternal in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

ClassNotFoundException