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, java.io.Externalizable, java.io.Serializable

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

COM Class 'AnnotateLayerPropertiesCollection'. Generated 3/19/2015 1:20:41 PM from 'C:\ArcGIS\COM\esriCarto.olb'

Description 'A collection of annotation settings for a feature layer.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:

Serialized Form

Field Summary

static long

serialVersionUID

Fields inherited from interface com.esri.arcgis.carto.IAnnotateLayerPropertiesCollection

IID, IID1d5849f2_0d33_11d2_a26f_080009b6f22b, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersistStream

IID, IID00000109_0000_0000_c000_000000000046, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersist

IID0000010c_0000_0000_c000_000000000046

Fields inherited from interface com.esri.arcgis.carto.IAnnotateLayerPropertiesCollection2

IID, IID2b35e113_9f11_43d5_914f_5c7055db37bc, xxDummy

Fields inherited from interface com.esri.arcgis.system.IClone

IID, IID9bff8aeb_e415_11d0_943c_080009eebecb, xxDummy

Constructor Summary

AnnotateLayerPropertiesCollection()
Constructs a AnnotateLayerPropertiesCollection using ArcGIS Engine.

AnnotateLayerPropertiesCollection(java.lang.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(java.lang.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 java.lang.String	getClsid() getClsid.
int	getCount() The number of items in the collection.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
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(java.io.ObjectInput in)
void	release() Release a AnnotateLayerPropertiesCollection.
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(java.io.ObjectOutput out)

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

AnnotateLayerPropertiesCollection

public AnnotateLayerPropertiesCollection()
                                  throws java.io.IOException,
                                         java.net.UnknownHostException

Constructs a AnnotateLayerPropertiesCollection using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

AnnotateLayerPropertiesCollection

public AnnotateLayerPropertiesCollection(java.lang.Object obj)
                                  throws java.io.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:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Deprecated. Internal use only.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()

Release a AnnotateLayerPropertiesCollection.

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

add

public void add(IAnnotateLayerProperties item)
         throws java.io.IOException,
                AutomationException

Adds an item to the collection.

Specified by:

add in interface IAnnotateLayerPropertiesCollection

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCount

public int getCount()
             throws java.io.IOException,
                    AutomationException

The number of items in the collection.

Specified by:

getCount in interface IAnnotateLayerPropertiesCollection

Specified by:

getCount in interface IAnnotateLayerPropertiesCollection2

Returns:

The count

Throws:

java.io.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 java.io.IOException,
                      AutomationException

Returns the item in the collection at the specified index.

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

clear

public void clear()
           throws java.io.IOException,
                  AutomationException

Removes all the items in the collection.

Specified by:

clear in interface IAnnotateLayerPropertiesCollection

Specified by:

clear in interface IAnnotateLayerPropertiesCollection2

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

remove

public void remove(IAnnotateLayerProperties layerProps)
            throws java.io.IOException,
                   AutomationException

Removes the item in the collection at the specified index.

Specified by:

remove in interface IAnnotateLayerPropertiesCollection

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

sort

public void sort()
          throws java.io.IOException,
                 AutomationException

Sorts the items in the collection.

Specified by:

sort in interface IAnnotateLayerPropertiesCollection

Specified by:

sort in interface IAnnotateLayerPropertiesCollection2

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws java.io.IOException,
                    AutomationException

isDirty

Specified by:

isDirty in interface IPersistStream

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException

load

Specified by:

load in interface IPersistStream

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

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

save

Specified by:

save in interface IPersistStream

Parameters:

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

fClearDirty - The fClearDirty (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

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

getSizeMax

Specified by:

getSizeMax in interface IPersistStream

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

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

getClassID

Specified by:

getClassID in interface IPersist

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

IAnnotateLayerPropertiesCollection2_add

public int IAnnotateLayerPropertiesCollection2_add(IAnnotateLayerProperties item)
                                            throws java.io.IOException,
                                                   AutomationException

Adds an item to the collection.

Specified by:

IAnnotateLayerPropertiesCollection2_add in interface IAnnotateLayerPropertiesCollection2

Parameters:

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

Returns:

The iD

Throws:

java.io.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 java.io.IOException,
                      AutomationException

Returns the item in the collection at the specified index.

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

remove

public void remove(int iD)
            throws java.io.IOException,
                   AutomationException

Removes the item in the collection with the given id.

Specified by:

remove in interface IAnnotateLayerPropertiesCollection2

Parameters:

iD - The iD (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getProperties

public IAnnotateLayerProperties getProperties(int iD)
                                       throws java.io.IOException,
                                              AutomationException

The item in the collection with the given id.

Specified by:

getProperties in interface IAnnotateLayerPropertiesCollection2

Parameters:

iD - The iD (in)

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

replace

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

Replaces the item in the collection with the given id.

Specified by:

replace in interface IAnnotateLayerPropertiesCollection2

Parameters:

iD - The iD (in)

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

esri_clone

public IClone esri_clone()
                  throws java.io.IOException,
                         AutomationException

Clones the receiver and assigns the result to *clone.

Specified by:

esri_clone in interface IClone

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws java.io.IOException,
                   AutomationException

Assigns the properties of src to the receiver.

Specified by:

assign in interface IClone

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws java.io.IOException,
                       AutomationException

Indicates if the receiver and other have the same properties.

Specified by:

isEqual in interface IClone

Parameters:

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

Returns:

The equal

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws java.io.IOException,
                           AutomationException

Indicates if the receiver and other are the same object.

Specified by:

isIdentical in interface IClone

Parameters:

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

Returns:

The identical

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Throws:

java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Throws:

java.io.IOException

java.lang.ClassNotFoundException