com.esri.arcgis.schematic
Class NgSymbol

java.lang.Object
  com.esri.arcgis.schematic.NgSymbol

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, INgSymbol, Serializable

public class NgSymbol
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, INgSymbol

Graphic symbol object.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

NgSymbol(Object obj)
Construct a NgSymbol using a reference to such an object returned from ArcGIS Engine or Server.

Method Summary

boolean	equals(Object o) Compare this object with another
void	getBoundingBox(INgPoint[] upperLeftCorner, INgPoint[] lowerRightCorner) Returns the 'upperLeftCorner' and 'lowerRightCorner' points defining the symbol bounding box.
String	getName() Name of the symbol.
INgSymbols	getSubSymbols() List of the sub-symbols that compose the symbol.
int	hashCode() the hashcode for this object

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

NgSymbol

public NgSymbol(Object obj)
         throws IOException

Construct a NgSymbol using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to NgSymbol.
Casting to this class from the return value of a method will not work, as this class represents an abstract class in ArcObjects.
*
NgSymbol o = (NgSymbol)obj; // will not work

NgSymbol o = new NgSymbol(obj); // Use this constructor instead
* @param obj an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems NgSymbol theNgSymbol = (NgSymbol) obj;

Method Detail

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

getBoundingBox

public void getBoundingBox(INgPoint[] upperLeftCorner,
                           INgPoint[] lowerRightCorner)
                    throws IOException,
                           AutomationException

Returns the 'upperLeftCorner' and 'lowerRightCorner' points defining the symbol bounding box.

Product Availability

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

Specified by:

getBoundingBox in interface INgSymbol

Parameters:

upperLeftCorner - A reference to a com.esri.arcgis.schematic.INgPoint (out: use single element array)

lowerRightCorner - A reference to a com.esri.arcgis.schematic.INgPoint (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgProject.getSymbol(String)

getSubSymbols

public INgSymbols getSubSymbols()
                         throws IOException,
                                AutomationException

List of the sub-symbols that compose the symbol.

Product Availability

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

Specified by:

getSubSymbols in interface INgSymbol

Returns:

A reference to a com.esri.arcgis.schematic.INgSymbols

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgProject.getSymbol(String)

getName

public String getName()
               throws IOException,
                      AutomationException

Name of the symbol.

Description

It is the name of the associated CGM file.

Product Availability

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

Specified by:

getName in interface INgSymbol

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgProject.getSymbol(String)