com.esri.arcgis.schematic
Class SchematicContainerManager

java.lang.Object
  extended by com.esri.arcgis.schematic.SchematicContainerManager
All Implemented Interfaces:
com.esri.arcgis.interop.RemoteObjRef, ISchematicContainerManager, ISchematicRelationManager, ISchematicRelationManagerEvent, Serializable

public class SchematicContainerManager
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ISchematicRelationManager, ISchematicRelationManagerEvent, ISchematicContainerManager

Schematic container manager object.

Product Availability

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

See Also:
Serialized Form

Constructor Summary
SchematicContainerManager()
          Constructs a SchematicContainerManager using ArcGIS Engine.
SchematicContainerManager(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
SchematicContainerManager theSchematicContainerManager = (SchematicContainerManager) obj;
 
Method Summary
 boolean equals(Object o)
          Compare this object with another
static String getClsid()
          getClsid.
 IUID getCLSID()
          CLSID of the schematic relation manager.
 double getContainerMargin(INgElement container)
          Returns the margin for the specified container.
 int hashCode()
          the hashcode for this object
 void moveParent(ISchematicRelationControllerTool controller, INgElement parent, double x, double y, int moveMode)
          Move the specified parent graphic element to the specified (X,Y) absolute or relative position.
 void onMoveElements(ISchematicRelationControllerTool relationController, INgElement parent, INgView view, INgElements elements, double deltaX, double deltaY)
          Fires when the user moves a parent graphic element and its related graphic elements with the mouse in any graphic view.
 void redrawParent(ISchematicRelationControllerTool controller, INgView view, INgElement pParent)
          Redraws the specified parent graphic element in the specified graphic view.
 void setContainerMargin(INgElement container, double margin)
          Sets the margin for the specified container.
 
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

SchematicContainerManager

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

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

SchematicContainerManager

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

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

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

redrawParent

public void redrawParent(ISchematicRelationControllerTool controller,
                         INgView view,
                         INgElement pParent)
                  throws IOException,
                         AutomationException
Redraws the specified parent graphic element in the specified graphic view.

Product Availability

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

Specified by:
redrawParent in interface ISchematicRelationManager
Parameters:
controller - A reference to a com.esri.arcgis.schematic.ISchematicRelationControllerTool (in)
view - A reference to a com.esri.arcgis.schematic.INgView (in)
pParent - A reference to a com.esri.arcgis.schematic.INgElement (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

moveParent

public void moveParent(ISchematicRelationControllerTool controller,
                       INgElement parent,
                       double x,
                       double y,
                       int moveMode)
                throws IOException,
                       AutomationException
Move the specified parent graphic element to the specified (X,Y) absolute or relative position.

Remarks

Itís the developer responsibility to call the appropriate ISchematicRelationController or ISchematicRelationManager methods for the related objects as the containers to be automatically redrawn when he uses any "Move" method on schematic element. Please also note that programming the relations redraw on the INgProjectEvents::OnMoveElements or ISchematicRelationControllerEvent::OnMoveElements events will be completely unuseful because these events are only triggered when schematic elements are moved using the GUI tools; that is when end-users move schematic elements using the mouse or the keyboard arrows. So when elements are moved by programming using any "Move" method, the custom code specified on these events will be not fired. In this case, you must either force the redraw at the end of the move operations sequences in your custom procedure or customize the SchematicAlgorithmEvents::AfterExecuteAlgorithm event (when the "Move" methods are called during a custom algorithm).

Product Availability

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

Specified by:
moveParent in interface ISchematicRelationManager
Parameters:
controller - A reference to a com.esri.arcgis.schematic.ISchematicRelationControllerTool (in)
parent - A reference to a com.esri.arcgis.schematic.INgElement (in)
x - The x (in)
y - The y (in)
moveMode - A com.esri.arcgis.schematic.esriNgMoveMode constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCLSID

public IUID getCLSID()
              throws IOException,
                     AutomationException
CLSID of the schematic relation manager.

Product Availability

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

Specified by:
getCLSID in interface ISchematicRelationManager
Returns:
A reference to a com.esri.arcgis.system.IUID
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

onMoveElements

public void onMoveElements(ISchematicRelationControllerTool relationController,
                           INgElement parent,
                           INgView view,
                           INgElements elements,
                           double deltaX,
                           double deltaY)
                    throws IOException,
                           AutomationException
Fires when the user moves a parent graphic element and its related graphic elements with the mouse in any graphic view.

Product Availability

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

Specified by:
onMoveElements in interface ISchematicRelationManagerEvent
Parameters:
relationController - A reference to a com.esri.arcgis.schematic.ISchematicRelationControllerTool (in)
parent - A reference to a com.esri.arcgis.schematic.INgElement (in)
view - A reference to a com.esri.arcgis.schematic.INgView (in)
elements - A reference to a com.esri.arcgis.schematic.INgElements (in)
deltaX - The deltaX (in)
deltaY - The deltaY (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getContainerMargin

public double getContainerMargin(INgElement container)
                          throws IOException,
                                 AutomationException
Returns the margin for the specified container.

Product Availability

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

Specified by:
getContainerMargin in interface ISchematicContainerManager
Parameters:
container - A reference to a com.esri.arcgis.schematic.INgElement (in)
Returns:
The margin
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
ISchematicContainerManager.setContainerMargin(com.esri.arcgis.schematic.INgElement, double)

setContainerMargin

public void setContainerMargin(INgElement container,
                               double margin)
                        throws IOException,
                               AutomationException
Sets the margin for the specified container.

Product Availability

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

Specified by:
setContainerMargin in interface ISchematicContainerManager
Parameters:
container - A reference to a com.esri.arcgis.schematic.INgElement (in)
margin - The margin (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
ISchematicContainerManager.getContainerMargin(com.esri.arcgis.schematic.INgElement)