com.esri.arcgis.schematic
Class ISchematicAlgoSmartTreeProxy

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

All Implemented Interfaces:

ISchematicAlgoSmartTree, Externalizable, Serializable

public class ISchematicAlgoSmartTreeProxy
extends com.esri.arcgis.interop.Dispatch
implements ISchematicAlgoSmartTree, Serializable

Provides access to members that control the Smart Tree schematic algorithm.

Description

The Smart Tree layout arranges hierarchically all the nodes and links in the active schematic diagram and place them as a smart tree. If a schematic root node is set, the smart tree starts with the root element.

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

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

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
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.
boolean	isWorkOnUnvisibleObjects() Indicates if the Smart 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 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.
void	setWorkOnUnvisibleObjects(boolean pVal) Indicates if the Smart 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

ISchematicAlgoSmartTreeProxy

public ISchematicAlgoSmartTreeProxy()

ISchematicAlgoSmartTreeProxy

public ISchematicAlgoSmartTreeProxy(Object obj)
                             throws IOException

Throws:

IOException

ISchematicAlgoSmartTreeProxy

protected ISchematicAlgoSmartTreeProxy(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 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.

Product Availability

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

Specified by:

getDistanceAlongTheDirection in interface ISchematicAlgoSmartTree

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

ISchematicAlgoSmartTree.getSubtreeSeparation(), ISchematicAlgoSmartTree.getDistancePerpendicularToDirection()

setDistanceAlongTheDirection

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

Product Availability

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

Specified by:

setDistanceAlongTheDirection in interface ISchematicAlgoSmartTree

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 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.

Product Availability

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

Specified by:

getDistancePerpendicularToDirection in interface ISchematicAlgoSmartTree

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

ISchematicAlgoSmartTree.getSubtreeSeparation(), ISchematicAlgoSmartTree.getDistanceAlongTheDirection()

setDistancePerpendicularToDirection

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

Product Availability

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

Specified by:

setDistancePerpendicularToDirection in interface ISchematicAlgoSmartTree

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSubtreeSeparation

public double getSubtreeSeparation()
                            throws 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.

Product Availability

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

Specified by:

getSubtreeSeparation in interface ISchematicAlgoSmartTree

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

ISchematicAlgoSmartTree.getDistancePerpendicularToDirection()

setSubtreeSeparation

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

Product Availability

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

Specified by:

setSubtreeSeparation in interface ISchematicAlgoSmartTree

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

Smart tree structure direction.

Product Availability

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

Specified by:

getDirection in interface ISchematicAlgoSmartTree

Returns:

A com.esri.arcgis.schematic.esriSchematicAlgoDirection constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDirection

public void setDirection(int pVal)
                  throws IOException,
                         AutomationException

Smart tree structure direction.

Product Availability

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

Specified by:

setDirection in interface ISchematicAlgoSmartTree

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.

getBreakPoint

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

Description

With a BreakPoint property value of 0, this segment length is the longest and it displays with a right angle. With a BreakPoint property 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 ISchematicAlgoSmartTree

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

ISchematicAlgoSmartTree.isOrthogonalDisplay()

setBreakPoint

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

Product Availability

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

Specified by:

setBreakPoint in interface ISchematicAlgoSmartTree

Parameters:

pVal - The pVal (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 ISchematicAlgoSmartTree

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

ISchematicAlgoSmartTree.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 ISchematicAlgoSmartTree

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 the AbsoluteParameters is false, the distance parameters are interpreted as relative units to the average of the current symbols sizes used to represent the schematic nodes in the diagram; that is, 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 ISchematicAlgoSmartTree

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 ISchematicAlgoSmartTree

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 Smart 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 ISchematicAlgoSmartTree

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 Smart 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 ISchematicAlgoSmartTree

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