com.esri.arcgis.carto
Class AnnotateLayerPropertiesCollection

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

All Implemented Interfaces:

IAnnotateLayerPropertiesCollection, IAnnotateLayerPropertiesCollection2, com.esri.arcgis.interop.RemoteObjRef, IClone, IPersist, IPersistStream, Externalizable, Serializable

public class AnnotateLayerPropertiesCollection
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IAnnotateLayerPropertiesCollection, IPersistStream, IAnnotateLayerPropertiesCollection2, IClone, Externalizable

A collection of annotation settings for a feature layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

AnnotateLayerPropertiesCollection()
Constructs a AnnotateLayerPropertiesCollection using ArcGIS Engine.

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

Method Summary

void	add(IAnnotateLayerProperties item) Adds an item to the collection.
void	assign(IClone src) Assigns the properties of src to the receiver.
void	clear() Removes all the items in the collection.
boolean	equals(Object o) Compare this object with another
IClone	esri_clone() Clones the receiver and assigns the result to *clone.
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
int	getCount() The number of items in the collection.
IAnnotateLayerProperties	getProperties(int iD) The item in the collection with the given id.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
int	hashCode() the hashcode for this object
int	IAnnotateLayerPropertiesCollection2_add(IAnnotateLayerProperties item) Adds an item to the collection.
void	isDirty() isDirty
boolean	isEqual(IClone other) Indicates if the receiver and other have the same properties.
boolean	isIdentical(IClone other) Indicates if the receiver and other are the same object.
void	load(IStream pstm) load
void	queryItem(int index, IAnnotateLayerProperties[] item, IElementCollection[] placedElements, IElementCollection[] unplacedElements) Returns the item in the collection at the specified index.
void	queryItem(int index, IAnnotateLayerProperties[] item, int[] iD) Returns the item in the collection at the specified index.
void	readExternal(ObjectInput in)
void	remove(IAnnotateLayerProperties layerprops) Removes the item in the collection at the specified index.
void	remove(int iD) Removes the item in the collection with the given id.
void	replace(int iD, IAnnotateLayerProperties pAnnotateLayerProperties) Replaces the item in the collection with the given id.
void	save(IStream pstm, int fClearDirty) save
void	sort() Sorts the items in the collection.
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

AnnotateLayerPropertiesCollection

public AnnotateLayerPropertiesCollection()
                                  throws IOException,
                                         UnknownHostException

Constructs a AnnotateLayerPropertiesCollection using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

AnnotateLayerPropertiesCollection

public AnnotateLayerPropertiesCollection(Object obj)
                                  throws IOException

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

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

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(IAnnotateLayerProperties item)
         throws IOException,
                AutomationException

Adds an item to the collection.

Description

Add adds an item to the collection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

add in interface IAnnotateLayerPropertiesCollection

Parameters:

item - A reference to a com.esri.arcgis.carto.IAnnotateLayerProperties (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCount

public int getCount()
             throws IOException,
                    AutomationException

The number of items in the collection.

Description

Count is the number of items in the collection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getCount in interface IAnnotateLayerPropertiesCollection

Specified by:

getCount in interface IAnnotateLayerPropertiesCollection2

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryItem

public void queryItem(int index,
                      IAnnotateLayerProperties[] item,
                      IElementCollection[] placedElements,
                      IElementCollection[] unplacedElements)
               throws IOException,
                      AutomationException

Returns the item in the collection at the specified index.

Description

QueryItem returns the specified item from the collection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

queryItem in interface IAnnotateLayerPropertiesCollection

Parameters:

index - The index (in)

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

placedElements - A reference to a com.esri.arcgis.carto.IElementCollection (out: use single element array, optional, pass single element of null if not required)

unplacedElements - A reference to a com.esri.arcgis.carto.IElementCollection (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 items in the collection.

Description

Clear removes all the items in the collection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

clear in interface IAnnotateLayerPropertiesCollection

Specified by:

clear in interface IAnnotateLayerPropertiesCollection2

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

remove

public void remove(IAnnotateLayerProperties layerprops)
            throws IOException,
                   AutomationException

Removes the item in the collection at the specified index.

Description

Remove removes the specified item from the collection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

remove in interface IAnnotateLayerPropertiesCollection

Parameters:

layerprops - A reference to a com.esri.arcgis.carto.IAnnotateLayerProperties (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

sort

public void sort()
          throws IOException,
                 AutomationException

Sorts the items in the collection.

Description

Sort sorts the collection based on the priority of the layer properties.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

sort in interface IAnnotateLayerPropertiesCollection

Specified by:

sort in interface IAnnotateLayerPropertiesCollection2

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.

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.

IAnnotateLayerPropertiesCollection2_add

public int IAnnotateLayerPropertiesCollection2_add(IAnnotateLayerProperties item)
                                            throws IOException,
                                                   AutomationException

Adds an item to the collection.

Product Availability

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

Specified by:

IAnnotateLayerPropertiesCollection2_add in interface IAnnotateLayerPropertiesCollection2

Parameters:

item - A reference to a com.esri.arcgis.carto.IAnnotateLayerProperties (in)

Returns:

The iD

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryItem

public void queryItem(int index,
                      IAnnotateLayerProperties[] item,
                      int[] iD)
               throws IOException,
                      AutomationException

Returns the item in the collection at the specified index.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

queryItem in interface IAnnotateLayerPropertiesCollection2

Parameters:

index - The index (in)

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

iD - The iD (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

remove

public void remove(int iD)
            throws IOException,
                   AutomationException

Removes the item in the collection with the given id.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

remove in interface IAnnotateLayerPropertiesCollection2

Parameters:

iD - The iD (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getProperties

public IAnnotateLayerProperties getProperties(int iD)
                                       throws IOException,
                                              AutomationException

The item in the collection with the given id.

Product Availability

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

Specified by:

getProperties in interface IAnnotateLayerPropertiesCollection2

Parameters:

iD - The iD (in)

Returns:

A reference to a com.esri.arcgis.carto.IAnnotateLayerProperties

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

replace

public void replace(int iD,
                    IAnnotateLayerProperties pAnnotateLayerProperties)
             throws IOException,
                    AutomationException

Replaces the item in the collection with the given id.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

replace in interface IAnnotateLayerPropertiesCollection2

Parameters:

iD - The iD (in)

pAnnotateLayerProperties - A reference to a com.esri.arcgis.carto.IAnnotateLayerProperties (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

esri_clone

public IClone esri_clone()
                  throws IOException,
                         AutomationException

Clones the receiver and assigns the result to *clone.

Product Availability

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

Specified by:

esri_clone in interface IClone

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws IOException,
                   AutomationException

Assigns the properties of src to the receiver.

Description

Use Assign method to assign the properties of source object to receiver object. Both objects need to have the same CLSIDs. Both source and receiver objects need to be instantiated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

assign in interface IClone

Parameters:

src - A reference to a com.esri.arcgis.system.IClone (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws IOException,
                       AutomationException

Indicates if the receiver and other have the same properties.

Description

IsEqual returns True if the receiver and the source have the same properties. Note, this does not imply that the receiver and the source reference the same object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isEqual in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The equal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws IOException,
                           AutomationException

Indicates if the receiver and other are the same object.

Description

IsIdentical returns true if the receiver and the source reference the same object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isIdentical in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The identical

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