com.esri.arcgis.schematic
Class INgLegendProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.schematic.INgLegendProxy

All Implemented Interfaces:

INgLegend, Externalizable, Serializable

public class INgLegendProxy
extends com.esri.arcgis.interop.Dispatch
implements INgLegend, Serializable

Provides access to members that control the graphic legend.

Description

The Legend window is a child of the schematic window. By default, each legend entry is featured with its matching element occurrence count. The legend content depends on the element types and properties defined for the related element type.

Custom behavior can be added to the items in a legend. For example, a toggle option to show or hide the legend item in the view can be added to the right-click function on the legend.

The Legend subwindow cannot be printed with the print function of ArcGIS Schematics.

Product Availability

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

See Also:

INgLegendDescription, Serialized Form

Field Summary

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, E

Constructor Summary

	INgLegendProxy()
	INgLegendProxy(Object obj)
protected	INgLegendProxy(Object obj, String iid)

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
INgView	getView() View the legend is related to.
void	hide() Hides the legend.
boolean	isVisible() Indicates if the legend window displays in the view.
void	readExternal(ObjectInput in)
void	refresh(int displayMode) Refreshes the legend window and diplays it in the 'displayMode' mode.
void	removeListener(String iidStr, Object theListener)
void	show(int displayMode) Displays the legend in the 'displayMode' mode (see esriNgLegendDisplayMode).
void	writeExternal(ObjectOutput out)

Methods inherited from class com.esri.arcgis.interop.Dispatch

bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, queryInterface, release, setNativeMode, setPropertyByName, toString, vtblInvoke

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

INgLegendProxy

public INgLegendProxy()

INgLegendProxy

public INgLegendProxy(Object obj)
               throws IOException

Throws:

IOException

INgLegendProxy

protected INgLegendProxy(Object obj,
                         String iid)
                  throws IOException

Throws:

IOException

Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException

Overrides:

addListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException

Overrides:

removeListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

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.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Overrides:

writeExternal in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Overrides:

readExternal in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

ClassNotFoundException