com.esri.arcgis.controls
Class ControlsInkHighlightPalette

java.lang.Object
  extended by com.esri.arcgis.controls.ControlsInkHighlightPalette
All Implemented Interfaces:
com.esri.arcgis.interop.RemoteObjRef, IPaletteDef, Serializable

public class ControlsInkHighlightPalette
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IPaletteDef

A palette containing 3 different highlighter tools.

Description

The CLSID of this palette is: {80A102AC-45AA-4254-B432-35F379F3A7F2}.

This palette works with the ToolbarControl, PageLayoutControl, MapControl and ArcMap.

Product Availability

Available with ArcGIS Engine.

Supported Platforms

Windows

This Command is not supported on Unix.

See Also:
Serialized Form

Constructor Summary
ControlsInkHighlightPalette()
          Constructs a ControlsInkHighlightPalette using ArcGIS Engine.
ControlsInkHighlightPalette(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ControlsInkHighlightPalette theControlsInkHighlightPalette = (ControlsInkHighlightPalette) obj;
 
Method Summary
 boolean equals(Object o)
          Compare this object with another
 String getCaption()
          The caption of this palette.
static String getClsid()
          getClsid.
 int getItemCount()
          The number of items on this palette.
 void getItemInfo(int pos, IItemDef itemDef)
          The CLSID for the item on this palette at the specified index.
 String getName()
          The name of this palette.
 int hashCode()
          the hashcode for this object
 
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

ControlsInkHighlightPalette

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

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

ControlsInkHighlightPalette

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

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

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

getCaption

public String getCaption()
                  throws IOException,
                         AutomationException
The caption of this palette.

Product Availability

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

Specified by:
getCaption in interface IPaletteDef
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getName

public String getName()
               throws IOException,
                      AutomationException
The name of this palette.

Product Availability

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

Specified by:
getName in interface IPaletteDef
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getItemCount

public int getItemCount()
                 throws IOException,
                        AutomationException
The number of items on this palette.

Product Availability

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

Specified by:
getItemCount in interface IPaletteDef
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getItemInfo

public void getItemInfo(int pos,
                        IItemDef itemDef)
                 throws IOException,
                        AutomationException
The CLSID for the item on this palette at the specified index.

Product Availability

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

Specified by:
getItemInfo in interface IPaletteDef
Parameters:
pos - The pos (in)
itemDef - A reference to a com.esri.arcgis.systemUI.IItemDef (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.