com.esri.arcgis.schematic
Class NgLegend

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

All Implemented Interfaces:

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

public class NgLegend
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, INgLegend

Graphic legend object.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

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

Method Summary

boolean	equals(Object o) Compare this object with another
INgView	getView() View the legend is related to.
int	hashCode() the hashcode for this object
void	hide() Hides the legend.
boolean	isVisible() Indicates if the legend window displays in the view.
void	refresh(int displayMode) Refreshes the legend window and diplays it in the 'displayMode' mode.
void	show(int displayMode) Displays the legend in the 'displayMode' mode (see esriNgLegendDisplayMode).

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

NgLegend

public NgLegend(Object obj)
         throws IOException

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

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

Throws:

IOException - if there are interop problems NgLegend theNgLegend = (NgLegend) 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 is related to.

Product Availability

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

Specified by:

getView in interface INgLegend

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.

isVisible

public boolean isVisible()
                  throws IOException,
                         AutomationException

Indicates if the legend window displays in the view.

Product Availability

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

Specified by:

isVisible in interface INgLegend

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgLegend.hide(), INgLegend.show(int)

hide

public void hide()
          throws IOException,
                 AutomationException

Hides the legend.

Product Availability

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

Specified by:

hide in interface INgLegend

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgLegend.isVisible(), INgLegend.show(int)

show

public void show(int displayMode)
          throws IOException,
                 AutomationException

Displays the legend in the 'displayMode' mode (see esriNgLegendDisplayMode).

Product Availability

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

Specified by:

show in interface INgLegend

Parameters:

displayMode - A com.esri.arcgis.schematic.esriNgLegendDisplayMode constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgLegend.hide(), INgLegend.isVisible()

refresh

public void refresh(int displayMode)
             throws IOException,
                    AutomationException

Refreshes the legend window and diplays it in the 'displayMode' mode.

Product Availability

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

Specified by:

refresh in interface INgLegend

Parameters:

displayMode - A com.esri.arcgis.schematic.esriNgLegendDisplayMode constant (in, optional, pass 1 if not required)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.