com.esri.arcgis.schematic
Class SchematicContainerManager

java.lang.Object
  com.esri.arcgis.schematic.SchematicContainerManager

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, ISchematicContainerManager, ISchematicRelationManager, Serializable

public class SchematicContainerManager
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ISchematicRelationManager, 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
double	getBottomMargin(ISchematicInMemoryFeature container) Bottom margin of the specified container.
static String	getClsid() getClsid.
double	getLeftMargin(ISchematicInMemoryFeature container) Left margin of the specified container.
IGeometry	getParentGeometry(ISchematicRelationController controller, IDisplay display, ILayer layer, ISchematicInMemoryFeature inMemoryParent) Geometry of the specified schematic parent.
double	getRightMargin(ISchematicInMemoryFeature container) Right margin of the specified container.
double	getTopMargin(ISchematicInMemoryFeature container) Top margin of the specified container.
int	hashCode() the hashcode for this object
void	moveParent(ISchematicRelationController controller, IDisplay display, ILayer layer, ISchematicInMemoryFeature inMemoryParent, IEnumSchematicInMemoryFeature inMemoryFeatures, ILine shift) Moves the specified parent schematic feature.
void	setBottomMargin(ISchematicInMemoryFeature container, double margin) Changes the bottom margin of the specified container.
void	setLeftMargin(ISchematicInMemoryFeature container, double margin) Changes the left margin of the specified container.
void	setRightMargin(ISchematicInMemoryFeature container, double margin) Changes the right margin of the specified container.
void	setTopMargin(ISchematicInMemoryFeature container, double margin) Changes the top margin of 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

moveParent

public void moveParent(ISchematicRelationController controller,
                       IDisplay display,
                       ILayer layer,
                       ISchematicInMemoryFeature inMemoryParent,
                       IEnumSchematicInMemoryFeature inMemoryFeatures,
                       ILine shift)
                throws IOException,
                       AutomationException

Moves the specified parent schematic feature.

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.ISchematicRelationController (in)

display - A reference to a com.esri.arcgis.display.IDisplay (in)

layer - A reference to a com.esri.arcgis.carto.ILayer (in)

inMemoryParent - A reference to a com.esri.arcgis.schematic.ISchematicInMemoryFeature (in)

inMemoryFeatures - A reference to a com.esri.arcgis.schematic.IEnumSchematicInMemoryFeature (in)

shift - A reference to a com.esri.arcgis.geometry.ILine (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getParentGeometry

public IGeometry getParentGeometry(ISchematicRelationController controller,
                                   IDisplay display,
                                   ILayer layer,
                                   ISchematicInMemoryFeature inMemoryParent)
                            throws IOException,
                                   AutomationException

Geometry of the specified schematic parent.

Product Availability

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

Specified by:

getParentGeometry in interface ISchematicRelationManager

Parameters:

controller - A reference to a com.esri.arcgis.schematic.ISchematicRelationController (in)

display - A reference to a com.esri.arcgis.display.IDisplay (in)

layer - A reference to a com.esri.arcgis.carto.ILayer (in)

inMemoryParent - A reference to a com.esri.arcgis.schematic.ISchematicInMemoryFeature (in)

Returns:

A reference to a com.esri.arcgis.geometry.IGeometry

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLeftMargin

public double getLeftMargin(ISchematicInMemoryFeature container)
                     throws IOException,
                            AutomationException

Left margin of the specified container.

Product Availability

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

Specified by:

getLeftMargin in interface ISchematicContainerManager

Parameters:

container - A reference to a com.esri.arcgis.schematic.ISchematicInMemoryFeature (in)

Returns:

The margin

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLeftMargin

public void setLeftMargin(ISchematicInMemoryFeature container,
                          double margin)
                   throws IOException,
                          AutomationException

Changes the left margin of the specified container.

Product Availability

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

Specified by:

setLeftMargin in interface ISchematicContainerManager

Parameters:

container - A reference to a com.esri.arcgis.schematic.ISchematicInMemoryFeature (in)

margin - The margin (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRightMargin

public double getRightMargin(ISchematicInMemoryFeature container)
                      throws IOException,
                             AutomationException

Right margin of the specified container.

Product Availability

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

Specified by:

getRightMargin in interface ISchematicContainerManager

Parameters:

container - A reference to a com.esri.arcgis.schematic.ISchematicInMemoryFeature (in)

Returns:

The margin

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRightMargin

public void setRightMargin(ISchematicInMemoryFeature container,
                           double margin)
                    throws IOException,
                           AutomationException

Changes the right margin of the specified container.

Product Availability

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

Specified by:

setRightMargin in interface ISchematicContainerManager

Parameters:

container - A reference to a com.esri.arcgis.schematic.ISchematicInMemoryFeature (in)

margin - The margin (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTopMargin

public double getTopMargin(ISchematicInMemoryFeature container)
                    throws IOException,
                           AutomationException

Top margin of the specified container.

Product Availability

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

Specified by:

getTopMargin in interface ISchematicContainerManager

Parameters:

container - A reference to a com.esri.arcgis.schematic.ISchematicInMemoryFeature (in)

Returns:

The margin

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTopMargin

public void setTopMargin(ISchematicInMemoryFeature container,
                         double margin)
                  throws IOException,
                         AutomationException

Changes the top margin of the specified container.

Product Availability

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

Specified by:

setTopMargin in interface ISchematicContainerManager

Parameters:

container - A reference to a com.esri.arcgis.schematic.ISchematicInMemoryFeature (in)

margin - The margin (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBottomMargin

public double getBottomMargin(ISchematicInMemoryFeature container)
                       throws IOException,
                              AutomationException

Bottom margin of the specified container.

Product Availability

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

Specified by:

getBottomMargin in interface ISchematicContainerManager

Parameters:

container - A reference to a com.esri.arcgis.schematic.ISchematicInMemoryFeature (in)

Returns:

The margin

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBottomMargin

public void setBottomMargin(ISchematicInMemoryFeature container,
                            double margin)
                     throws IOException,
                            AutomationException

Changes the bottom margin of the specified container.

Product Availability

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

Specified by:

setBottomMargin in interface ISchematicContainerManager

Parameters:

container - A reference to a com.esri.arcgis.schematic.ISchematicInMemoryFeature (in)

margin - The margin (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.