com.esri.arcgis.display
Class SymbolIdentifier

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

All Implemented Interfaces:

ISymbolIdentifier, ISymbolIdentifier2, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class SymbolIdentifier
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ISymbolIdentifier, ISymbolIdentifier2

Groups a symbol with both an ID and Name.

Description

A SymbolIdentifier is a simple grouping of a Symbol with an ID and a Name. Any symbol that implements ISymbol can be stored in a SymbolIdentifier, however they are most commonly used with a TextSymbol in the SymbolCollection of an Annotation Feature class which is stored in the AnnotationFeatureClassExtension.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

SymbolIdentifier()
Constructs a SymbolIdentifier using ArcGIS Engine.

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

Method Summary

boolean	equals(Object o) Compare this object with another
static String	getClsid() getClsid.
int	getID() The symbolID associated with the symbol.
String	getName() The name associated with the symbol.
ISymbol	getSymbol() The symbol associated with the symbolID.
int	hashCode() the hashcode for this object
void	setID(int symbolID) The symbolID associated with the symbol.
void	setName(String name) The name associated with the symbol.
void	setSymbolByRef(ISymbol symbol) The symbol associated with the symbolID.

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

SymbolIdentifier

public SymbolIdentifier()
                 throws IOException,
                        UnknownHostException

Constructs a SymbolIdentifier using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

SymbolIdentifier

public SymbolIdentifier(Object obj)
                 throws IOException

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

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

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

getSymbol

public ISymbol getSymbol()
                  throws IOException,
                         AutomationException

The symbol associated with the symbolID.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSymbol in interface ISymbolIdentifier

Specified by:

getSymbol in interface ISymbolIdentifier2

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSymbolByRef

public void setSymbolByRef(ISymbol symbol)
                    throws IOException,
                           AutomationException

The symbol associated with the symbolID.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setSymbolByRef in interface ISymbolIdentifier

Specified by:

setSymbolByRef in interface ISymbolIdentifier2

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getID

public int getID()
          throws IOException,
                 AutomationException

The symbolID associated with the symbol.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getID in interface ISymbolIdentifier

Specified by:

getID in interface ISymbolIdentifier2

Returns:

The symbolID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setID

public void setID(int symbolID)
           throws IOException,
                  AutomationException

The symbolID associated with the symbol.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setID in interface ISymbolIdentifier

Specified by:

setID in interface ISymbolIdentifier2

Parameters:

symbolID - The symbolID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getName

public String getName()
               throws IOException,
                      AutomationException

The name associated with the symbol.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getName in interface ISymbolIdentifier2

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setName

public void setName(String name)
             throws IOException,
                    AutomationException

The name associated with the symbol.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setName in interface ISymbolIdentifier2

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.