com.esri.arcgis.cartoUI
Class LegendWizard

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

All Implemented Interfaces:

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

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

COM Class 'LegendWizard'. Generated 3/19/2015 1:20:50 PM from 'C:\ArcGIS\COM\esriCartoUI.olb'

Description 'Legend wizard.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.esri.arcgis.cartoUI.ILegendWizard

IID, IID0f220a17_fabb_11d3_9fe4_00c04f6bc78e, xxDummy

Constructor Summary

LegendWizard()
Constructs a LegendWizard using ArcGIS Engine.

LegendWizard(java.lang.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(java.lang.Object o) Compare this object with another
static java.lang.String	getClsid() getClsid.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
IMapSurroundFrame	getLegendFrame() The legend frame (valid after calling DoModal).
int	hashCode() the hashcode for this object
void	release() Release a LegendWizard.
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

Constructor Detail

LegendWizard

public LegendWizard()
             throws java.io.IOException,
                    java.net.UnknownHostException

Constructs a LegendWizard using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

LegendWizard

public LegendWizard(java.lang.Object obj)
             throws java.io.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:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Deprecated. Internal use only.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()

Release a LegendWizard.

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

setPageLayoutByRef

public void setPageLayoutByRef(IPageLayout rhs1)
                        throws java.io.IOException,
                               AutomationException

The page layout containing the map frame.

Specified by:

setPageLayoutByRef in interface ILegendWizard

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setInitialLegendFrame

public void setInitialLegendFrame(IMapSurroundFrame rhs1)
                           throws java.io.IOException,
                                  AutomationException

The initial legend frame (optional).

Specified by:

setInitialLegendFrame in interface ILegendWizard

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLegendFrame

public IMapSurroundFrame getLegendFrame()
                                 throws java.io.IOException,
                                        AutomationException

The legend frame (valid after calling DoModal).

Specified by:

getLegendFrame in interface ILegendWizard

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

doModal

public boolean doModal(int parentHWnd)
                throws java.io.IOException,
                       AutomationException

Displays the legend wizard.

Specified by:

doModal in interface ILegendWizard

Parameters:

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

Returns:

The ok

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.