com.esri.arcgis.display
Class SymbolCollection

java.lang.Object
  com.esri.arcgis.display.SymbolCollection

All Implemented Interfaces:

ISymbolCollection, ISymbolCollection2, com.esri.arcgis.interop.RemoteObjRef, IClone, IPersist, IPersistStream, java.io.Externalizable, java.io.Serializable

public class SymbolCollection
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, ISymbolCollection, ISymbolCollection2, IPersist, IPersistStream, IClone, java.io.Externalizable

COM Class 'SymbolCollection'. Generated 3/19/2015 1:20:43 PM from 'C:\ArcGIS\COM\esriDisplay.olb'

Description 'Collection of symbols and id pairs.' 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.display.ISymbolCollection

IID, IID0e5d8c65_8d91_11d3_9fca_00c04f6bc6a5, xxDummy

Fields inherited from interface com.esri.arcgis.display.ISymbolCollection2

IID, IID7ed742b9_0aef_40a0_a9a5_de2a302692f2, 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.system.IClone

IID, IID9bff8aeb_e415_11d0_943c_080009eebecb, xxDummy

Constructor Summary

SymbolCollection()
Constructs a SymbolCollection using ArcGIS Engine.

SymbolCollection(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
SymbolCollection theSymbolCollection = (SymbolCollection) obj;

Method Summary

void	addSymbol(ISymbol symbol, java.lang.String name, ISymbolIdentifier2[] symbolID) Adds a symbol to the collection.
void	assign(IClone src) Assigns the properties of src to the receiver.
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 symbols in the collection.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
ISymbol	getSymbol(int symbolID) The symbol associated with the symbolID.
void	getSymbolIdentifier(int iD, ISymbolIdentifier2[] symbolID) Returns the symbol with the given ID.
int	hashCode() the hashcode for this object
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
ISymbolIdentifier	next() Returns the next symbolID-symbol pair in the collection.
void	readExternal(java.io.ObjectInput in)
void	release() Release a SymbolCollection.
void	remove(int symbolID) Removes the symbolID-symbol pair in the collection.
void	removeAll() Removes all the symbolID-symbol pairs in the collection.
void	renameSymbol(int symbolID, java.lang.String name) Renames the symbol with the given ID.
void	replace(int symbolID, ISymbol symbol) Replaces the symbol associated with the symbolID.
void	reset() Prepares the collection for Next to be called.
void	save(IStream pstm, int fClearDirty) save
void	setSymbolByRef(int symbolID, ISymbol symbol) The symbol associated with the symbolID.
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

SymbolCollection

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

Constructs a SymbolCollection using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

SymbolCollection

public SymbolCollection(java.lang.Object obj)
                 throws java.io.IOException

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

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

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 SymbolCollection.

Specified by:

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

getSymbol

public ISymbol getSymbol(int symbolID)
                  throws java.io.IOException,
                         AutomationException

The symbol associated with the symbolID.

Specified by:

getSymbol in interface ISymbolCollection

Specified by:

getSymbol in interface ISymbolCollection2

Parameters:

symbolID - The symbolID (in)

Returns:

A reference to a com.esri.arcgis.display.ISymbol

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSymbolByRef

public void setSymbolByRef(int symbolID,
                           ISymbol symbol)
                    throws java.io.IOException,
                           AutomationException

The symbol associated with the symbolID.

Specified by:

setSymbolByRef in interface ISymbolCollection

Specified by:

setSymbolByRef in interface ISymbolCollection2

Parameters:

symbolID - The symbolID (in)

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

reset

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

Prepares the collection for Next to be called.

Specified by:

reset in interface ISymbolCollection

Specified by:

reset in interface ISymbolCollection2

Throws:

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

AutomationException - If the ArcObject component throws an exception.

next

public ISymbolIdentifier next()
                       throws java.io.IOException,
                              AutomationException

Returns the next symbolID-symbol pair in the collection.

Specified by:

next in interface ISymbolCollection

Specified by:

next in interface ISymbolCollection2

Returns:

A reference to a com.esri.arcgis.display.ISymbolIdentifier

Throws:

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

AutomationException - If the ArcObject component throws an exception.

replace

public void replace(int symbolID,
                    ISymbol symbol)
             throws java.io.IOException,
                    AutomationException

Replaces the symbol associated with the symbolID.

Specified by:

replace in interface ISymbolCollection

Specified by:

replace in interface ISymbolCollection2

Parameters:

symbolID - The symbolID (in)

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

remove

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

Removes the symbolID-symbol pair in the collection.

Specified by:

remove in interface ISymbolCollection

Specified by:

remove in interface ISymbolCollection2

Parameters:

symbolID - The symbolID (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

removeAll

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

Removes all the symbolID-symbol pairs in the collection.

Specified by:

removeAll in interface ISymbolCollection

Specified by:

removeAll in interface ISymbolCollection2

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addSymbol

public void addSymbol(ISymbol symbol,
                      java.lang.String name,
                      ISymbolIdentifier2[] symbolID)
               throws java.io.IOException,
                      AutomationException

Adds a symbol to the collection. The ID will be set by the collection.

Specified by:

addSymbol in interface ISymbolCollection2

Parameters:

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

name - The name (in)

symbolID - A reference to a com.esri.arcgis.display.ISymbolIdentifier2 (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSymbolIdentifier

public void getSymbolIdentifier(int iD,
                                ISymbolIdentifier2[] symbolID)
                         throws java.io.IOException,
                                AutomationException

Returns the symbol with the given ID.

Specified by:

getSymbolIdentifier in interface ISymbolCollection2

Parameters:

iD - The iD (in)

symbolID - A reference to a com.esri.arcgis.display.ISymbolIdentifier2 (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

renameSymbol

public void renameSymbol(int symbolID,
                         java.lang.String name)
                  throws java.io.IOException,
                         AutomationException

Renames the symbol with the given ID.

Specified by:

renameSymbol in interface ISymbolCollection2

Parameters:

symbolID - The symbolID (in)

name - The name (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 symbols in the collection.

Specified by:

getCount in interface ISymbolCollection2

Returns:

The count

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.

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.

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