com.esri.arcgis.schematic
Class ISchematicAlgoRadialTreeProxy

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

All Implemented Interfaces:

ISchematicAlgoRadialTree, Externalizable, Serializable

public class ISchematicAlgoRadialTreeProxy
extends com.esri.arcgis.interop.Dispatch
implements ISchematicAlgoRadialTree, Serializable

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

Description

The Radial Tree layout arranges hierarchically all the nodes and links in the active schematic diagram and place them as a radial tree. It detects the node of the graph that it uses as the circle center to arrange the subtrees starting from this root around concentric circles, each circle corresponding to one hierarchical level. If a schematic root node is set, the Radial Tree algorithm considers this root element as the center of the concentric circles. 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

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

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
double	getInitialRadius() Radius of the first concentric circle which center is the Radial Tree root node.
double	getRadiusFactor() Multiplicative factor used to increase or decrease the radius of each concentric circle corresponding to a hierarchical level.
boolean	isAbsoluteParameters() Indicates if the values set for the Initial radius must be interpreted as absolute units.
boolean	isWorkOnUnvisibleObjects() Indicates if the Radial 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 Initial radius must be interpreted as absolute units.
void	setInitialRadius(double pVal) Radius of the first concentric circle which center is the Radial Tree root node.
void	setRadiusFactor(double pVal) Multiplicative factor used to increase or decrease the radius of each concentric circle corresponding to a hierarchical level.
void	setWorkOnUnvisibleObjects(boolean pVal) Indicates if the Radial 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

ISchematicAlgoRadialTreeProxy

public ISchematicAlgoRadialTreeProxy()

ISchematicAlgoRadialTreeProxy

public ISchematicAlgoRadialTreeProxy(Object obj)
                              throws IOException

Throws:

IOException

ISchematicAlgoRadialTreeProxy

protected ISchematicAlgoRadialTreeProxy(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

getRadiusFactor

public double getRadiusFactor()
                       throws IOException,
                              AutomationException

Multiplicative factor used to increase or decrease the radius of each concentric circle corresponding to a hierarchical level.

Description

By default, the RadiusFactor value is 1; that is, the InitialRadius also represents the distance that separates each concentric circle related to a hierarchical level. When setting a RadiusFactor lower than 1, the distance that separates the nodes belonging to the N hierarchical level and the N+1 hierarchical level progressively decreased; with factor upper than 1, the distance between the hierarchical levels increases progressively.

Product Availability

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

Specified by:

getRadiusFactor in interface ISchematicAlgoRadialTree

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

ISchematicAlgoRadialTree.getInitialRadius()

setRadiusFactor

public void setRadiusFactor(double pVal)
                     throws IOException,
                            AutomationException

Multiplicative factor used to increase or decrease the radius of each concentric circle corresponding to a hierarchical level.

Product Availability

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

Specified by:

setRadiusFactor in interface ISchematicAlgoRadialTree

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getInitialRadius

public double getInitialRadius()
                        throws IOException,
                               AutomationException

Radius of the first concentric circle which center is the Radial Tree root node.

Description

That is, the intial radius is the radius of the circle around which the nodes belonging to the first hierarchical level are placed.

Product Availability

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

Specified by:

getInitialRadius in interface ISchematicAlgoRadialTree

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

ISchematicAlgoRadialTree.getRadiusFactor()

setInitialRadius

public void setInitialRadius(double pVal)
                      throws IOException,
                             AutomationException

Radius of the first concentric circle which center is the Radial Tree root node.

Product Availability

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

Specified by:

setInitialRadius in interface ISchematicAlgoRadialTree

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 Radial 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 ISchematicAlgoRadialTree

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 Radial 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 ISchematicAlgoRadialTree

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 Initial radius must be interpreted as absolute units.

Description

When this property returns false, the parameters that define the radius is expressed as relative units to the average of the current symbols sizes used to represent the schematic nodes in the diagram; that is, when the InitialRadius parameter value is 2, the radius for the first concentric circle centered around the root node corresponds to the average size of two symbols placed side by side (or 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 ISchematicAlgoRadialTree

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 Initial radius must be interpreted as absolute units.

Product Availability

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

Specified by:

setAbsoluteParameters in interface ISchematicAlgoRadialTree

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