com.esri.arcgis.cartoUI
Class LegendWizard

java.lang.Object
  com.esri.arcgis.cartoUI.LegendWizard

All Implemented Interfaces:

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

public class LegendWizard
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ILegendWizard

Legend wizard.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

See Also:

Serialized Form

Constructor Summary

LegendWizard()
Constructs a LegendWizard using ArcGIS Engine.

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

Method Summary

boolean	doModal(int parentHWnd) Displays the legend wizard.
boolean	equals(Object o) Compare this object with another
static String	getClsid() getClsid.
IMapSurroundFrame	getLegendFrame() The legend frame (valid after calling DoModal).
int	hashCode() the hashcode for this object
void	setInitialLegendFrame(IMapSurroundFrame rhs1) The initial legend frame (optional).
void	setPageLayoutByRef(IPageLayout rhs1) The page layout containing the map frame.

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

LegendWizard

public LegendWizard()
             throws IOException,
                    UnknownHostException

Constructs a LegendWizard using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

LegendWizard

public LegendWizard(Object obj)
             throws IOException

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

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

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

setPageLayoutByRef

public void setPageLayoutByRef(IPageLayout rhs1)
                        throws IOException,
                               AutomationException

The page layout containing the map frame.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setPageLayoutByRef in interface ILegendWizard

Parameters:

rhs1 - A reference to a com.esri.arcgis.carto.IPageLayout (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setInitialLegendFrame

public void setInitialLegendFrame(IMapSurroundFrame rhs1)
                           throws IOException,
                                  AutomationException

The initial legend frame (optional).

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setInitialLegendFrame in interface ILegendWizard

Parameters:

rhs1 - A reference to a com.esri.arcgis.carto.IMapSurroundFrame (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLegendFrame

public IMapSurroundFrame getLegendFrame()
                                 throws IOException,
                                        AutomationException

The legend frame (valid after calling DoModal).

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getLegendFrame in interface ILegendWizard

Returns:

A reference to a com.esri.arcgis.carto.IMapSurroundFrame

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

doModal

public boolean doModal(int parentHWnd)
                throws IOException,
                       AutomationException

Displays the legend wizard.

Remarks

Before calling the DoModal method on the LegendWizard, you must first do appropriate setup of a Legend object. This includes creating a Legend object, adding it as a MapSurround to the FocusMap, and assigning a valid Envelope to the Legend's element geometry.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

doModal in interface ILegendWizard

Parameters:

parentHWnd - The parentHWnd (A COM typedef) (in)

Returns:

The ok

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.