com.esri.arcgis.schematic
Class ISchematicElementProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.geodatabase.IRowBufferProxy
          com.esri.arcgis.geodatabase.IRowProxy
              com.esri.arcgis.geodatabase.IObjectProxy
                  com.esri.arcgis.schematic.ISchematicElementProxy

All Implemented Interfaces:

IObject, IRow, IRowBuffer, ISchematicElement, Externalizable, Serializable

public class ISchematicElementProxy
extends IObjectProxy
implements ISchematicElement, Serializable

Provides access to members that control the schematic element.

Description

Schematic elements are implemented by a schematic element class. These schematic elements display in schematic diagrams that are generated/opened in ArcMap, previewed in ArcCatalog, or created/visualized via any application developed with the ArcGIS Schematics API.

The schematic elements contained in a schematic diagram are regrouped into feature layers. There is a feature layer for each schematic element class that is associated with the diagram class that implements the diagram.

Product Availability

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

See Also:

Serialized Form

Field Summary

boolean

noncastable

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

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

Constructor Summary

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

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
void	alterPropertySet(IPropertySet propertySet) Changes the schematic element PropertySet with the specified PropertySet.
ISchematicElementAssociation	createAssociation(int dataSourceID, int cLSID, int oID, int sUBID, String gUID) Create a schematic association.
String	getName() Name of the schematic element.
IPropertySet	getPropertySet() PropertySet related to the schematic element.
ISchematicDiagram	getSchematicDiagram() Schematic diagram related to the schematic element.
ISchematicElementClass	getSchematicElementClass() Schematic element class related to the schematic element.
ISchematicElement	getSchematicRelation() Schematic element relation ship.
int	getUpdateStatus() Update status of the element.
boolean	isDisplayed() Indicates if the element is displayed.
boolean	isInitial() Indicates if the schematic element belongs to the initial list of elements specified for the schematic diagram.
void	removeListener(String iidStr, Object theListener)
void	setDisplayed(boolean displayed) Indicates if the element is displayed.
void	setInitial(boolean initial) Indicates if the schematic element belongs to the initial list of elements specified for the schematic diagram.
void	setSchematicRelationByRef(ISchematicElement schematicElement) Schematic element relation ship.
void	setUpdateStatus(int updateStatus) Update status of the element.

Methods inherited from class com.esri.arcgis.geodatabase.IObjectProxy

esri_getClass

Methods inherited from class com.esri.arcgis.geodatabase.IRowProxy

delete, getOID, getTable, isHasOID, store

Methods inherited from class com.esri.arcgis.geodatabase.IRowBufferProxy

getFields, getValue, setValue

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, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.esri.arcgis.geodatabase.IObject

esri_getClass

Methods inherited from interface com.esri.arcgis.geodatabase.IRow

delete, getOID, getTable, isHasOID, store

Methods inherited from interface com.esri.arcgis.geodatabase.IRowBuffer

getFields, getValue, setValue

Field Detail

noncastable

public boolean noncastable

Constructor Detail

ISchematicElementProxy

public ISchematicElementProxy()

ISchematicElementProxy

public ISchematicElementProxy(Object obj)
                       throws IOException

Throws:

IOException

ISchematicElementProxy

protected ISchematicElementProxy(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 IObjectProxy

Throws:

IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException

Overrides:

removeListener in class IObjectProxy

Throws:

IOException

getName

public String getName()
               throws IOException,
                      AutomationException

Name of the schematic element.

Product Availability

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

Specified by:

getName in interface ISchematicElement

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSchematicElementClass

public ISchematicElementClass getSchematicElementClass()
                                                throws IOException,
                                                       AutomationException

Schematic element class related to the schematic element.

Product Availability

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

Specified by:

getSchematicElementClass in interface ISchematicElement

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSchematicDiagram

public ISchematicDiagram getSchematicDiagram()
                                      throws IOException,
                                             AutomationException

Schematic diagram related to the schematic element.

Product Availability

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

Specified by:

getSchematicDiagram in interface ISchematicElement

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isInitial

public boolean isInitial()
                  throws IOException,
                         AutomationException

Indicates if the schematic element belongs to the initial list of elements specified for the schematic diagram.

Product Availability

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

Specified by:

isInitial in interface ISchematicElement

Returns:

The initial

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setInitial

public void setInitial(boolean initial)
                throws IOException,
                       AutomationException

Indicates if the schematic element belongs to the initial list of elements specified for the schematic diagram.

Product Availability

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

Specified by:

setInitial in interface ISchematicElement

Parameters:

initial - The initial (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDisplayed

public boolean isDisplayed()
                    throws IOException,
                           AutomationException

Indicates if the element is displayed.

Product Availability

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

Specified by:

isDisplayed in interface ISchematicElement

Returns:

The displayed

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDisplayed

public void setDisplayed(boolean displayed)
                  throws IOException,
                         AutomationException

Indicates if the element is displayed.

Product Availability

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

Specified by:

setDisplayed in interface ISchematicElement

Parameters:

displayed - The displayed (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getUpdateStatus

public int getUpdateStatus()
                    throws IOException,
                           AutomationException

Update status of the element.

Product Availability

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

Specified by:

getUpdateStatus in interface ISchematicElement

Returns:

A com.esri.arcgis.schematic.esriSchematicUpdateStatus constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUpdateStatus

public void setUpdateStatus(int updateStatus)
                     throws IOException,
                            AutomationException

Update status of the element.

Product Availability

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

Specified by:

setUpdateStatus in interface ISchematicElement

Parameters:

updateStatus - A com.esri.arcgis.schematic.esriSchematicUpdateStatus constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSchematicRelation

public ISchematicElement getSchematicRelation()
                                       throws IOException,
                                              AutomationException

Schematic element relation ship.

Product Availability

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

Specified by:

getSchematicRelation in interface ISchematicElement

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSchematicRelationByRef

public void setSchematicRelationByRef(ISchematicElement schematicElement)
                               throws IOException,
                                      AutomationException

Schematic element relation ship.

Product Availability

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

Specified by:

setSchematicRelationByRef in interface ISchematicElement

Parameters:

schematicElement - A reference to a com.esri.arcgis.schematic.ISchematicElement (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createAssociation

public ISchematicElementAssociation createAssociation(int dataSourceID,
                                                      int cLSID,
                                                      int oID,
                                                      int sUBID,
                                                      String gUID)
                                               throws IOException,
                                                      AutomationException

Create a schematic association.

Product Availability

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

Specified by:

createAssociation in interface ISchematicElement

Parameters:

dataSourceID - The dataSourceID (in)

cLSID - The cLSID (in)

oID - The oID (in)

sUBID - The sUBID (in)

gUID - The gUID (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPropertySet

public IPropertySet getPropertySet()
                            throws IOException,
                                   AutomationException

PropertySet related to the schematic element.

Product Availability

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

Specified by:

getPropertySet in interface ISchematicElement

Returns:

A reference to a com.esri.arcgis.system.IPropertySet

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

alterPropertySet

public void alterPropertySet(IPropertySet propertySet)
                      throws IOException,
                             AutomationException

Changes the schematic element PropertySet with the specified PropertySet.

Product Availability

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

Specified by:

alterPropertySet in interface ISchematicElement

Parameters:

propertySet - A reference to a com.esri.arcgis.system.IPropertySet (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.