com.esri.arcgis.schematic
Class SchematicAutomaticScaling

java.lang.Object
  extended by com.esri.arcgis.schematic.SchematicAutomaticScaling
All Implemented Interfaces:
com.esri.arcgis.interop.RemoteObjRef, ISchematicAlgorithm, ISchematicAutomaticScaling, Serializable

public class SchematicAutomaticScaling
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ISchematicAutomaticScaling, ISchematicAlgorithm

Schematic automatic scaling object.

Product Availability

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

See Also:
Serialized Form

Constructor Summary
SchematicAutomaticScaling()
          Constructs a SchematicAutomaticScaling using ArcGIS Engine.
SchematicAutomaticScaling(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
SchematicAutomaticScaling theSchematicAutomaticScaling = (SchematicAutomaticScaling) obj;
 
Method Summary
 boolean equals(Object o)
          Compare this object with another
 void execute(INgDiagram pDiagram)
          Executes the automatic scaling in the specified graphic diagram.
 void execute(INgView view, INgCancelTracker tracker)
          Executes the schematic algorithm.
 String getAlgorithmCLSID()
          CLSID of the schematic algorithm.
static String getClsid()
          getClsid.
 String getLabel()
          Label for the schematic algorithm that displays in the Layout Task dropdown list.
 INgProject getProject()
          Project the schematic algorithm is related to.
 int hashCode()
          the hashcode for this object
 void initialize(INgProject ngProject)
          Initializes the automatic scaling for the specified graphic project.
 boolean isAvailable()
          Indicates if the schematic algorithm is available from the Layout Task dropdown list.
 boolean isEnabled(INgView view)
          Indicates if the schematic algorithm is enabled.
 void setAvailable(boolean pVal)
          Indicates if the schematic algorithm is available from the Layout Task dropdown list.
 void setLabel(String pVal)
          Label for the schematic algorithm that displays in the Layout Task dropdown list.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef
getJintegraDispatch, release
 

Constructor Detail

SchematicAutomaticScaling

public SchematicAutomaticScaling()
                          throws IOException,
                                 UnknownHostException
Constructs a SchematicAutomaticScaling using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

SchematicAutomaticScaling

public SchematicAutomaticScaling(Object obj)
                          throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
SchematicAutomaticScaling theSchematicAutomaticScaling = (SchematicAutomaticScaling) obj;

Construct a SchematicAutomaticScaling using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to SchematicAutomaticScaling.

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
IOException - if there are interop problems
Method Detail

getClsid

public static String getClsid()
getClsid.


equals

public boolean equals(Object o)
Compare this object with another

Overrides:
equals in class Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class Object

initialize

public void initialize(INgProject ngProject)
                throws IOException,
                       AutomationException
Initializes the automatic scaling for the specified graphic project.

Product Availability

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

Specified by:
initialize in interface ISchematicAlgorithm
Specified by:
initialize in interface ISchematicAutomaticScaling
Parameters:
ngProject - A reference to a com.esri.arcgis.schematic.INgProject (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

execute

public void execute(INgDiagram pDiagram)
             throws IOException,
                    AutomationException
Executes the automatic scaling in the specified graphic diagram.

Product Availability

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

Specified by:
execute in interface ISchematicAutomaticScaling
Parameters:
pDiagram - A reference to a com.esri.arcgis.schematic.INgDiagram (in, optional, pass null if not required)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

execute

public void execute(INgView view,
                    INgCancelTracker tracker)
             throws IOException,
                    AutomationException
Executes the schematic algorithm.

Product Availability

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

Specified by:
execute in interface ISchematicAlgorithm
Parameters:
view - A reference to a com.esri.arcgis.schematic.INgView (in, optional, pass 0 if not required)
tracker - A reference to a com.esri.arcgis.schematic.INgCancelTracker (in, optional, pass 0 if not required)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isEnabled

public boolean isEnabled(INgView view)
                  throws IOException,
                         AutomationException
Indicates if the schematic algorithm is enabled. That is, if the Apply button is available.

Product Availability

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

Specified by:
isEnabled in interface ISchematicAlgorithm
Parameters:
view - A reference to a com.esri.arcgis.schematic.INgView (in, optional, pass 0 if not required)
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isAvailable

public boolean isAvailable()
                    throws IOException,
                           AutomationException
Indicates if the schematic algorithm is available from the Layout Task dropdown list.

Product Availability

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

Specified by:
isAvailable in interface ISchematicAlgorithm
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAvailable

public void setAvailable(boolean pVal)
                  throws IOException,
                         AutomationException
Indicates if the schematic algorithm is available from the Layout Task dropdown list.

Product Availability

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

Specified by:
setAvailable in interface ISchematicAlgorithm
Parameters:
pVal - The pVal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLabel

public String getLabel()
                throws IOException,
                       AutomationException
Label for the schematic algorithm that displays in the Layout Task dropdown list.

Product Availability

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

Specified by:
getLabel in interface ISchematicAlgorithm
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLabel

public void setLabel(String pVal)
              throws IOException,
                     AutomationException
Label for the schematic algorithm that displays in the Layout Task dropdown list.

Product Availability

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

Specified by:
setLabel in interface ISchematicAlgorithm
Parameters:
pVal - The pVal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAlgorithmCLSID

public String getAlgorithmCLSID()
                         throws IOException,
                                AutomationException
CLSID of the schematic algorithm.

Product Availability

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

Specified by:
getAlgorithmCLSID in interface ISchematicAlgorithm
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getProject

public INgProject getProject()
                      throws IOException,
                             AutomationException
Project the schematic algorithm is related to.

Product Availability

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

Specified by:
getProject in interface ISchematicAlgorithm
Returns:
A reference to a com.esri.arcgis.schematic.INgProject
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.