com.esri.arcgis.carto
Class ElementCollection

java.lang.Object
  com.esri.arcgis.carto.ElementCollection

All Implemented Interfaces:

IElementCollection, IElementCollection2, com.esri.arcgis.interop.RemoteObjRef, IDocumentVersionSupportGEN, IPersist, IPersistStream, Externalizable, Serializable

public class ElementCollection
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IElementCollection, IElementCollection2, IPersist, IPersistStream, IDocumentVersionSupportGEN, Externalizable

Collection of elements.

Remarks

An ElementCollection is a collection of graphics elements typically used to manage TextElements used in annotation.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

ElementCollection()
Constructs a ElementCollection using ArcGIS Engine.

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

Method Summary

void	add(IElement element, int linkedFeatureID) Adds an element to the collection.
void	add(IElement element, int linkedFeatureID, int annotationClassID, int status) Adds an element to the collection.
void	clear() Removes all the elements in the collection.
Object	convertToSupportedObject(int docVersion) Convert the object to another object that is supported.
boolean	equals(Object o) Compare this object with another
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
int	getCount() Number of elements in the collection.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
int	hashCode() the hashcode for this object
void	isDirty() isDirty
boolean	isSupportedAtVersion(int docVersion) Is this object valid at the given document version.
void	load(IStream pstm) load
void	queryItem(int index, IElement[] element, int[] linkedFeatureID) Element at the given index.
void	queryItem(int index, IElement[] element, int[] linkedFeatureID, int[] annotationClassID, int[] status) Element at the given index.
void	readExternal(ObjectInput in)
void	remove(IElement element) Remove an element from the collection.
void	save(IStream pstm, int fClearDirty) save
void	writeExternal(ObjectOutput out)

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

ElementCollection

public ElementCollection()
                  throws IOException,
                         UnknownHostException

Constructs a ElementCollection using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

ElementCollection

public ElementCollection(Object obj)
                  throws IOException

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

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

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

add

public void add(IElement element,
                int linkedFeatureID)
         throws IOException,
                AutomationException

Adds an element to the collection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

add in interface IElementCollection

Parameters:

element - A reference to a com.esri.arcgis.carto.IElement (in)

linkedFeatureID - The linkedFeatureID (in, optional, pass -1 if not required)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCount

public int getCount()
             throws IOException,
                    AutomationException

Number of elements in the collection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getCount in interface IElementCollection

Specified by:

getCount in interface IElementCollection2

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryItem

public void queryItem(int index,
                      IElement[] element,
                      int[] linkedFeatureID)
               throws IOException,
                      AutomationException

Element at the given index.

Description

Passes out the element at the specified index. Will also pass out the feature ID for feature-linked elements if the FeatureID parameter is used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

queryItem in interface IElementCollection

Parameters:

index - The index (in)

element - A reference to a com.esri.arcgis.carto.IElement (out: use single element array)

linkedFeatureID - The linkedFeatureID (out: use single element array, optional, pass single element of null if not required)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

clear

public void clear()
           throws IOException,
                  AutomationException

Removes all the elements in the collection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

clear in interface IElementCollection

Specified by:

clear in interface IElementCollection2

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

remove

public void remove(IElement element)
            throws IOException,
                   AutomationException

Remove an element from the collection.

Remarks

Removes specific elements from ElementCollection. Query method and TypeOf Statement can be used to determine a particular element before removing it.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

remove in interface IElementCollection

Specified by:

remove in interface IElementCollection2

Parameters:

element - A reference to a com.esri.arcgis.carto.IElement (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

add

public void add(IElement element,
                int linkedFeatureID,
                int annotationClassID,
                int status)
         throws IOException,
                AutomationException

Adds an element to the collection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

add in interface IElementCollection2

Parameters:

element - A reference to a com.esri.arcgis.carto.IElement (in)

linkedFeatureID - The linkedFeatureID (in, optional, pass 0 if not required)

annotationClassID - The annotationClassID (in, optional, pass -1 if not required)

status - A com.esri.arcgis.carto.esriAnnotationStatus constant (in, optional, pass 0 if not required)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryItem

public void queryItem(int index,
                      IElement[] element,
                      int[] linkedFeatureID,
                      int[] annotationClassID,
                      int[] status)
               throws IOException,
                      AutomationException

Element at the given index.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

queryItem in interface IElementCollection2

Parameters:

index - The index (in)

element - A reference to a com.esri.arcgis.carto.IElement (out: use single element array)

linkedFeatureID - The linkedFeatureID (out: use single element array, optional, pass single element of null if not required)

annotationClassID - The annotationClassID (out: use single element array, optional, pass single element of null if not required)

status - A com.esri.arcgis.carto.esriAnnotationStatus constant (out: use single element array, optional, pass single element of null if not required)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws IOException,
                       AutomationException

getClassID

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException

isDirty

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isDirty in interface IPersistStream

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException

load

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws IOException,
                 AutomationException

save

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws IOException,
                       AutomationException

getSizeMax

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSupportedAtVersion

public boolean isSupportedAtVersion(int docVersion)
                             throws IOException,
                                    AutomationException

Is this object valid at the given document version.

Remarks

Use IsSupportedAtVersion to identify if a particular object should be saved to the ObjectStream. This result is based on the esriArcGISVersion enumeration. In some instances, if the object is not supported at a particular ArcGIS version, the object may support conversion to another similar object; use IDocumentVersionSupportGEN::ConvertToSupportedObject to accomplish this.

Product Availability

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

Specified by:

isSupportedAtVersion in interface IDocumentVersionSupportGEN

Parameters:

docVersion - A com.esri.arcgis.system.esriArcGISVersion constant (in)

Returns:

The supported

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

convertToSupportedObject

public Object convertToSupportedObject(int docVersion)
                                throws IOException,
                                       AutomationException

Convert the object to another object that is supported.

Remarks

This method should be used when IDocumentVersionSupportGEN::IsSupportedAtVersion returns FALSE. Calling ConvertToSupportedObject will return an IUnknown pointer to a relevant object supported at the particular ArcGIS version. Not all objects will return a supported object; in these cases a null pointer will be returned.

Product Availability

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

Specified by:

convertToSupportedObject in interface IDocumentVersionSupportGEN

Parameters:

docVersion - A com.esri.arcgis.system.esriArcGISVersion constant (in)

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException