com.esri.arcgis.schematic
Class ISchematicAlgoGridProxy

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

All Implemented Interfaces:

ISchematicAlgoGrid, Externalizable, Serializable

public class ISchematicAlgoGridProxy
extends com.esri.arcgis.interop.Dispatch
implements ISchematicAlgoGrid, Serializable

Provides access to members that control the Grid schematic algorithm.

Description

The Grid algorithm lays out the nodes in the active schematic diagram relative to a magnetic grid regarding to their current positions so that only one node holds on a grid cell. 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:

Serialized Form

Field Summary

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

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, E

Constructor Summary

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

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
double	getHorizontalStep() Horizontal step for the grid; that is the wide of each grid cell.
double	getOriginX() Horizontal coordinate for the origin of the grid.
double	getOriginY() Vertical coordinate for the origin of the grid.
double	getVerticalStep() Vertical step for the grid; that is the wide of each grid cell.
boolean	isAbsoluteParameters() Indicates if the values set for the step parameters must be interpreted as absolute units.
boolean	isWorkOnUnvisibleObjects() Indicates if the Grid 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 step parameters must be interpreted as absolute units.
void	setHorizontalStep(double pVal) Horizontal step for the grid; that is the wide of each grid cell.
void	setOriginX(double pVal) Horizontal coordinate for the origin of the grid.
void	setOriginY(double pVal) Vertical coordinate for the origin of the grid.
void	setVerticalStep(double pVal) Vertical step for the grid; that is the wide of each grid cell.
void	setWorkOnUnvisibleObjects(boolean pVal) Indicates if the Grid 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

ISchematicAlgoGridProxy

public ISchematicAlgoGridProxy()

ISchematicAlgoGridProxy

public ISchematicAlgoGridProxy(Object obj)
                        throws IOException

Throws:

IOException

ISchematicAlgoGridProxy

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

getOriginX

public double getOriginX()
                  throws IOException,
                         AutomationException

Horizontal coordinate for the origin of the grid.

Product Availability

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

Specified by:

getOriginX in interface ISchematicAlgoGrid

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

ISchematicAlgoGrid.getHorizontalStep(), ISchematicAlgoGrid.getVerticalStep(), ISchematicAlgoGrid.getOriginY()

setOriginX

public void setOriginX(double pVal)
                throws IOException,
                       AutomationException

Horizontal coordinate for the origin of the grid.

Product Availability

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

Specified by:

setOriginX in interface ISchematicAlgoGrid

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOriginY

public double getOriginY()
                  throws IOException,
                         AutomationException

Vertical coordinate for the origin of the grid.

Product Availability

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

Specified by:

getOriginY in interface ISchematicAlgoGrid

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

ISchematicAlgoGrid.getHorizontalStep(), ISchematicAlgoGrid.getVerticalStep(), ISchematicAlgoGrid.getOriginX()

setOriginY

public void setOriginY(double pVal)
                throws IOException,
                       AutomationException

Vertical coordinate for the origin of the grid.

Product Availability

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

Specified by:

setOriginY in interface ISchematicAlgoGrid

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHorizontalStep

public double getHorizontalStep()
                         throws IOException,
                                AutomationException

Horizontal step for the grid; that is the wide of each grid cell.

Product Availability

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

Specified by:

getHorizontalStep in interface ISchematicAlgoGrid

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

ISchematicAlgoGrid.getVerticalStep(), ISchematicAlgoGrid.getOriginX(), ISchematicAlgoGrid.getOriginY()

setHorizontalStep

public void setHorizontalStep(double pVal)
                       throws IOException,
                              AutomationException

Horizontal step for the grid; that is the wide of each grid cell.

Product Availability

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

Specified by:

setHorizontalStep in interface ISchematicAlgoGrid

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getVerticalStep

public double getVerticalStep()
                       throws IOException,
                              AutomationException

Vertical step for the grid; that is the wide of each grid cell.

Product Availability

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

Specified by:

getVerticalStep in interface ISchematicAlgoGrid

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

ISchematicAlgoGrid.getHorizontalStep(), ISchematicAlgoGrid.getOriginX()

setVerticalStep

public void setVerticalStep(double pVal)
                     throws IOException,
                            AutomationException

Vertical step for the grid; that is the wide of each grid cell.

Product Availability

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

Specified by:

setVerticalStep in interface ISchematicAlgoGrid

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 step 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 HorizontalStep parameter value is 2, the wide for the grid cells 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 ISchematicAlgoGrid

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 step parameters must be interpreted as absolute units.

Product Availability

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

Specified by:

setAbsoluteParameters in interface ISchematicAlgoGrid

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 Grid 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 ISchematicAlgoGrid

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 Grid 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 ISchematicAlgoGrid

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