com.esri.arcgis.cartoUI
Class SymbolLevelsDialog

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

All Implemented Interfaces:

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

public class SymbolLevelsDialog
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ISymbolLevelsDialog

A dialog for setting symbol levels.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

See Also:

Serialized Form

Constructor Summary

SymbolLevelsDialog()
Constructs a SymbolLevelsDialog using ArcGIS Engine.

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

Method Summary

boolean	doModal(int parentHWnd) Displays the dialog.
void	enableApplyButton(boolean bEnable, IMap pMap) Enable apply button in dialog and pass map to refresh if apply is pressed.
boolean	equals(Object o) Compare this object with another
static String	getClsid() getClsid.
IArray	getSymbolArray() Provides access to the modified symbols from the dialog.
int	hashCode() the hashcode for this object
boolean	isUseSymbolLevels() Indicates if symbol levels are used.
void	setControlLayer(ILayer rhs1) Inform the dialog about a layer that controls the symbol levels at a more global scope.
void	setLayer(ILayer rhs1) The Layer for which the symbol levels should be displayed.
void	setSymbols(Object vSymbols, Object vLabelNames, Object vLayerNames, Object rhs4) Add data to populate the symbol level list control.
void	setUseSymbolLevels(boolean pbUsesLevels) Indicates if symbol levels are used.

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

SymbolLevelsDialog

public SymbolLevelsDialog()
                   throws IOException,
                          UnknownHostException

Constructs a SymbolLevelsDialog using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

SymbolLevelsDialog

public SymbolLevelsDialog(Object obj)
                   throws IOException

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

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

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

setLayer

public void setLayer(ILayer rhs1)
              throws IOException,
                     AutomationException

The Layer for which the symbol levels should be displayed.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setLayer in interface ISymbolLevelsDialog

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSymbols

public void setSymbols(Object vSymbols,
                       Object vLabelNames,
                       Object vLayerNames,
                       Object rhs4)
                throws IOException,
                       AutomationException

Add data to populate the symbol level list control.

Product Availability

Available with ArcGIS Desktop.

Specified by:

setSymbols in interface ISymbolLevelsDialog

Parameters:

vSymbols - A Variant (in)

vLabelNames - A Variant (in)

vLayerNames - A Variant (in)

rhs4 - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSymbolArray

public IArray getSymbolArray()
                      throws IOException,
                             AutomationException

Provides access to the modified symbols from the dialog.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getSymbolArray in interface ISymbolLevelsDialog

Returns:

A reference to a com.esri.arcgis.system.IArray

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseSymbolLevels

public void setUseSymbolLevels(boolean pbUsesLevels)
                        throws IOException,
                               AutomationException

Indicates if symbol levels are used.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setUseSymbolLevels in interface ISymbolLevelsDialog

Parameters:

pbUsesLevels - The pbUsesLevels (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUseSymbolLevels

public boolean isUseSymbolLevels()
                          throws IOException,
                                 AutomationException

Indicates if symbol levels are used.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

isUseSymbolLevels in interface ISymbolLevelsDialog

Returns:

The pbUsesLevels

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

enableApplyButton

public void enableApplyButton(boolean bEnable,
                              IMap pMap)
                       throws IOException,
                              AutomationException

Enable apply button in dialog and pass map to refresh if apply is pressed.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

enableApplyButton in interface ISymbolLevelsDialog

Parameters:

bEnable - The bEnable (in)

pMap - A reference to a com.esri.arcgis.carto.IMap (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setControlLayer

public void setControlLayer(ILayer rhs1)
                     throws IOException,
                            AutomationException

Inform the dialog about a layer that controls the symbol levels at a more global scope.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setControlLayer in interface ISymbolLevelsDialog

Parameters:

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

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 dialog.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

doModal in interface ISymbolLevelsDialog

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.