com.esri.arcgis.display
Interface ISymbolCollection2

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

ISymbolCollection2Proxy, SymbolCollection

public interface ISymbolCollection2
extends java.io.Serializable

COM Interface 'ISymbolCollection2'. Generated 3/19/2015 1:20:55 PM from 'C:\ArcGIS\COM\esriDisplay.olb'

Description: 'Provides access to members that control a 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 =

Field Summary

static java.lang.String	IID Deprecated. Internal use only
static int	IID7ed742b9_0aef_40a0_a9a5_de2a302692f2
static int	xxDummy Deprecated. Internal use only

Method Summary

void	addSymbol(ISymbol symbol, java.lang.String name, ISymbolIdentifier2[] symbolID) Adds a symbol to the collection.
int	getCount() The number of symbols in the collection.
ISymbol	getSymbol(int symbolID) The symbol associated with the symbolID.
void	getSymbolIdentifier(int iD, ISymbolIdentifier2[] symbolID) Returns the symbol with the given ID.
ISymbolIdentifier	next() Returns the next symbolID-symbol pair in the collection.
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	setSymbolByRef(int symbolID, ISymbol symbol) The symbol associated with the symbolID.

Field Detail

IID7ed742b9_0aef_40a0_a9a5_de2a302692f2

static final int IID7ed742b9_0aef_40a0_a9a5_de2a302692f2

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

getSymbol

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

The symbol associated with the symbolID.

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

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

The symbol associated with the symbolID.

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

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

Prepares the collection for Next to be called.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

next

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

Returns the next symbolID-symbol pair in the collection.

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

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

Replaces the symbol associated with the symbolID.

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

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

Removes the symbolID-symbol pair in the collection.

Parameters:

symbolID - The symbolID (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

removeAll

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

Removes all the symbolID-symbol pairs in the collection.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addSymbol

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.

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

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

Returns the symbol with the given ID.

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

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

Renames the symbol with the given ID.

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

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

The number of symbols in the collection.

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.