com.esri.arcgis.schematic
Class NgLegendDescription

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

All Implemented Interfaces:

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

public class NgLegendDescription
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, INgLegendDescription

Graphic legend description object.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

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

Method Summary

boolean	equals(Object o) Compare this object with another
int	getEntriesCount() Number of legend entries.
void	getEntryInfo(int index, String[] pDesc, String[] pLabel, String[] pSymbolEMF) Returns the information related to the 'Index' legend entry.
INgView	getView() View the legend description is related to.
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

NgLegendDescription

public NgLegendDescription(Object obj)
                    throws IOException

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

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

Throws:

IOException - if there are interop problems NgLegendDescription theNgLegendDescription = (NgLegendDescription) 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

getView

public INgView getView()
                throws IOException,
                       AutomationException

View the legend description is related to.

Product Availability

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

Specified by:

getView in interface INgLegendDescription

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getEntriesCount

public int getEntriesCount()
                    throws IOException,
                           AutomationException

Number of legend entries.

Product Availability

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

Specified by:

getEntriesCount in interface INgLegendDescription

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getEntryInfo

public void getEntryInfo(int index,
                         String[] pDesc,
                         String[] pLabel,
                         String[] pSymbolEMF)
                  throws IOException,
                         AutomationException

Returns the information related to the 'Index' legend entry.

Product Availability

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

Specified by:

getEntryInfo in interface INgLegendDescription

Parameters:

index - The index (in)

pDesc - The pDesc (out: use single element array)

pLabel - The pLabel (out: use single element array)

pSymbolEMF - The pSymbolEMF (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.