com.esri.arcgis.cartoUI
Class LegendItemSelector

java.lang.Object
  extended by com.esri.arcgis.cartoUI.LegendItemSelector
All Implemented Interfaces:
IStyleSelector, com.esri.arcgis.interop.RemoteObjRef, IComPropertySheetEvents, Serializable, EventListener

public class LegendItemSelector
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IStyleSelector, IComPropertySheetEvents

Style selector for legend items.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

See Also:
Serialized Form

Constructor Summary
LegendItemSelector()
          Constructs a LegendItemSelector using ArcGIS Engine.
LegendItemSelector(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
LegendItemSelector theLegendItemSelector = (LegendItemSelector) obj;
 
Method Summary
 boolean addStyle(Object style)
          Specifies the original style.
 boolean doModal(int parentHWnd)
          Shows the style selector dialog.
 boolean equals(Object o)
          Compare this object with another
static String getClsid()
          getClsid.
 Object getStyle(int index)
          Returns the updated style.
 int hashCode()
          the hashcode for this object
 void onApply(IComPropertySheetEventsOnApplyEvent theEvent)
          Occurs when changes are applied.
 
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

LegendItemSelector

public LegendItemSelector()
                   throws IOException,
                          UnknownHostException
Constructs a LegendItemSelector using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

LegendItemSelector

public LegendItemSelector(Object obj)
                   throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
LegendItemSelector theLegendItemSelector = (LegendItemSelector) obj;

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

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

addStyle

public boolean addStyle(Object style)
                 throws IOException,
                        AutomationException
Specifies the original style. May specify more than one.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
addStyle in interface IStyleSelector
Parameters:
style - A reference to another Object (IUnknown) (in)
Returns:
The result
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getStyle

public Object getStyle(int index)
                throws IOException,
                       AutomationException
Returns the updated style. Index is required when more than one style was originally added.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
getStyle in interface IStyleSelector
Parameters:
index - The index (in)
Returns:
A reference to another Object (IUnknown)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

doModal

public boolean doModal(int parentHWnd)
                throws IOException,
                       AutomationException
Shows the style selector dialog.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
doModal in interface IStyleSelector
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.

onApply

public void onApply(IComPropertySheetEventsOnApplyEvent theEvent)
             throws IOException,
                    AutomationException
Occurs when changes are applied.

Description

Call OnApply to notify other parts of the application that the objects passed to the property sheet have been edited.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
onApply in interface IComPropertySheetEvents
Parameters:
theEvent - The event
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.