com.esri.arcgis.schematiccontrols
Class EngineSchematicEnvironment

java.lang.Object
  com.esri.arcgis.schematiccontrols.EngineSchematicEnvironment

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, ISchematicDisplayDiagramHelper, ISchematicLayoutMgr, ISchematicNetworkAnalystMgr, ISchematicTarget, Serializable

public class EngineSchematicEnvironment
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ISchematicTarget, ISchematicLayoutMgr, ISchematicNetworkAnalystMgr, ISchematicDisplayDiagramHelper

Schematic engine environment (singleton).

See Also:

Serialized Form

Constructor Summary

EngineSchematicEnvironment()
Constructs a EngineSchematicEnvironment using ArcGIS Engine.

EngineSchematicEnvironment(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
EngineSchematicEnvironment theEngineSchematicEnvironment = (EngineSchematicEnvironment) obj;

Method Summary

ISchematicLayer	displayDiagram(ISchematicDiagram schematicDiagram, IMap[] map) Helper to display a diagram.
boolean	equals(Object o) Compare this object with another
static String	getClsid() getClsid.
ISchematicAlgorithm	getCurrentLayout() Active schematic layout in the Layout Task dropdown list.
ISchematicAlgorithm	getCurrentTrace() Active schematic trace task in the Trace Task dropdown list.
ISchematicLayer	getSchematicTarget() Current schematic layer target; that is, schematic layer related to the current active schematic diagram.
int	hashCode() the hashcode for this object
boolean	isChangeTargetWithFocusMap() Indicates if the schematic layer target changes when the focus map changes; that is, when the active data frame changes.
boolean	isMultiViews() Indicates if we want to display the diagrams in new windows.
void	setChangeTargetWithFocusMap(boolean pChangeTarget) Indicates if the schematic layer target changes when the focus map changes; that is, when the active data frame changes.
void	setCurrentLayoutByRef(ISchematicAlgorithm schematicAlgorithm) Active schematic layout in the Layout Task dropdown list.
void	setCurrentTraceByRef(ISchematicAlgorithm schematicAlgorithm) Active schematic trace task in the Trace Task dropdown list.
void	setMultiViews(boolean multiViews) Indicates if we want to display the diagrams in new windows.
void	setSchematicTargetByRef(ISchematicLayer ppSchematicLayer) Current schematic layer target; that is, schematic layer related to the current active schematic diagram.

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

EngineSchematicEnvironment

public EngineSchematicEnvironment()
                           throws IOException,
                                  UnknownHostException

Constructs a EngineSchematicEnvironment using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

EngineSchematicEnvironment

public EngineSchematicEnvironment(Object obj)
                           throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
EngineSchematicEnvironment theEngineSchematicEnvironment = (EngineSchematicEnvironment) obj;

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

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

setSchematicTargetByRef

public void setSchematicTargetByRef(ISchematicLayer ppSchematicLayer)
                             throws IOException,
                                    AutomationException

Current schematic layer target; that is, schematic layer related to the current active schematic diagram.

Specified by:

setSchematicTargetByRef in interface ISchematicTarget

Parameters:

ppSchematicLayer - A reference to a com.esri.arcgis.schematic.ISchematicLayer (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSchematicTarget

public ISchematicLayer getSchematicTarget()
                                   throws IOException,
                                          AutomationException

Current schematic layer target; that is, schematic layer related to the current active schematic diagram.

Specified by:

getSchematicTarget in interface ISchematicTarget

Returns:

A reference to a com.esri.arcgis.schematic.ISchematicLayer

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isChangeTargetWithFocusMap

public boolean isChangeTargetWithFocusMap()
                                   throws IOException,
                                          AutomationException

Indicates if the schematic layer target changes when the focus map changes; that is, when the active data frame changes.

Specified by:

isChangeTargetWithFocusMap in interface ISchematicTarget

Returns:

The pChangeTarget

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setChangeTargetWithFocusMap

public void setChangeTargetWithFocusMap(boolean pChangeTarget)
                                 throws IOException,
                                        AutomationException

Indicates if the schematic layer target changes when the focus map changes; that is, when the active data frame changes.

Specified by:

setChangeTargetWithFocusMap in interface ISchematicTarget

Parameters:

pChangeTarget - The pChangeTarget (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCurrentLayout

public ISchematicAlgorithm getCurrentLayout()
                                     throws IOException,
                                            AutomationException

Active schematic layout in the Layout Task dropdown list.

Specified by:

getCurrentLayout in interface ISchematicLayoutMgr

Returns:

A reference to a com.esri.arcgis.schematic.ISchematicAlgorithm

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCurrentLayoutByRef

public void setCurrentLayoutByRef(ISchematicAlgorithm schematicAlgorithm)
                           throws IOException,
                                  AutomationException

Active schematic layout in the Layout Task dropdown list.

Specified by:

setCurrentLayoutByRef in interface ISchematicLayoutMgr

Parameters:

schematicAlgorithm - A reference to a com.esri.arcgis.schematic.ISchematicAlgorithm (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCurrentTrace

public ISchematicAlgorithm getCurrentTrace()
                                    throws IOException,
                                           AutomationException

Active schematic trace task in the Trace Task dropdown list.

Specified by:

getCurrentTrace in interface ISchematicNetworkAnalystMgr

Returns:

A reference to a com.esri.arcgis.schematic.ISchematicAlgorithm

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCurrentTraceByRef

public void setCurrentTraceByRef(ISchematicAlgorithm schematicAlgorithm)
                          throws IOException,
                                 AutomationException

Active schematic trace task in the Trace Task dropdown list.

Specified by:

setCurrentTraceByRef in interface ISchematicNetworkAnalystMgr

Parameters:

schematicAlgorithm - A reference to a com.esri.arcgis.schematic.ISchematicAlgorithm (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

displayDiagram

public ISchematicLayer displayDiagram(ISchematicDiagram schematicDiagram,
                                      IMap[] map)
                               throws IOException,
                                      AutomationException

Helper to display a diagram. If the map is not given as input, a new map is created and is returned as output.

Specified by:

displayDiagram in interface ISchematicDisplayDiagramHelper

Parameters:

schematicDiagram - A reference to a com.esri.arcgis.schematic.ISchematicDiagram (in)

map - A reference to a com.esri.arcgis.carto.IMap (in/out: use single element array)

Returns:

A reference to a com.esri.arcgis.schematic.ISchematicLayer

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMultiViews

public void setMultiViews(boolean multiViews)
                   throws IOException,
                          AutomationException

Indicates if we want to display the diagrams in new windows.

Specified by:

setMultiViews in interface ISchematicDisplayDiagramHelper

Parameters:

multiViews - The multiViews (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isMultiViews

public boolean isMultiViews()
                     throws IOException,
                            AutomationException

Indicates if we want to display the diagrams in new windows.

Specified by:

isMultiViews in interface ISchematicDisplayDiagramHelper

Returns:

The multiViews

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.