com.esri.arcgis.controls
Class ToolbarPalette

java.lang.Object
  extended by com.esri.arcgis.controls.ToolbarPalette
All Implemented Interfaces:
IToolbarPalette, com.esri.arcgis.interop.RemoteObjRef, ISupportErrorInfo, java.io.Serializable

public class ToolbarPalette
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IToolbarPalette, ISupportErrorInfo

COM Class 'ToolbarPalette'. Generated 3/19/2015 1:20:47 PM from 'C:\ArcGIS\COM\esriControls.olb'

Description 'A palette containing commands that can be used from a ToolbarControl or as a popup palette.' 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.controls.IToolbarPalette
IID, IID3a7ec31f_ea85_4b2b_9a29_f9505c0265a4, xxDummy
 
Fields inherited from interface com.esri.arcgis.system.ISupportErrorInfo
IID, IIDdf0b3d60_548f_101b_8e65_08002b2bd119, xxDummy
 
Constructor Summary
ToolbarPalette()
          Constructs a ToolbarPalette using ArcGIS Engine.
ToolbarPalette(java.lang.Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ToolbarPalette theToolbarPalette = (ToolbarPalette) obj;
 
Method Summary
 int addItem(java.lang.Object item, int subType, int index)
          Adds an item to the ToolbarPalette.
 boolean equals(java.lang.Object o)
          Compare this object with another
 int find(java.lang.Object item)
          Returns the index of the first item containing the given command.
 IToolbarItem getActiveItem()
          The palette item currently displayed on the ToolbarControl.
 java.lang.String getCaption()
          The caption used by the ToolbarPalette.
static java.lang.String getClsid()
          getClsid.
 ICommandPool getCommandPool()
          The CommandPool used by the ToolbarPalette.
 int getCount()
          The number of items on the ToolbarPalette.
 java.lang.Object getHook()
          The object that is passed as a hook to the OnCreate event of each item's command.
 int getIconSize()
          Indicates the size in pixels of icons displayed on the ToolbarPalette.
 IToolbarItem getItem(int index)
          Returns the item at the specified index from the ToolbarPalette.
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 Picture getMouseIcon()
          Custom mouse icon used if MousePointer is 99.
 int getMousePointer()
          The mouse pointer displayed over the ToolbarPalette.
 int hashCode()
          the hashcode for this object
 void interfaceSupportsErrorInfo(GUID riid)
          interfaceSupportsErrorInfo
 boolean isAlignLeft()
          Indicates if the ToolbarPalette displays aligned to the left or right.
 boolean isCustomize()
          Indicates if the ToolbarPalette is in customize mode.
 boolean isThemedDrawing()
          Indicates if the ToolbarPalette uses themed drawing.
 boolean isToolTips()
          Indicates if the items tooltips are shown.
 void moveItem(int startIndex, int finalIndex)
          Moves an item from one index to another.
 void popupPalette(int x, int y, int hWndParent)
          Pops up the ToolbarPalette at the position specified.
 void release()
          Release a ToolbarPalette.
 void remove(int index)
          Removes the item at the specified index from the ToolbarPalette.
 void removeAll()
          Removes all items from the ToolbarPalette.
 void setAlignLeft(boolean pVal)
          Indicates if the ToolbarPalette displays aligned to the left or right.
 void setCaption(java.lang.String pVal)
          The caption used by the ToolbarPalette.
 void setCommandPoolByRef(ICommandPool ppCommandPool)
          The CommandPool used by the ToolbarPalette.
 void setCustomize(boolean newVal)
          Indicates if the ToolbarPalette is in customize mode.
 void setHook(java.lang.Object hook)
          Sets the object that is passed as a hook to the OnCreate event of each item's command.
 void setIconSize(int pVal)
          Indicates the size in pixels of icons displayed on the ToolbarPalette.
 void setMouseIconByRef(Picture ppMouseIcon)
          Custom mouse icon used if MousePointer is 99.
 void setMousePointer(int pVal)
          The mouse pointer displayed over the ToolbarPalette.
 void setThemedDrawing(boolean pVal)
          Indicates if the ToolbarPalette uses themed drawing.
 void setToolTips(boolean pVal)
          Indicates if the items tooltips are shown.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ToolbarPalette

public ToolbarPalette()
               throws java.io.IOException,
                      java.net.UnknownHostException
Constructs a ToolbarPalette using ArcGIS Engine.

Throws:
java.io.IOException - if there are interop problems
java.net.UnknownHostException - if there are interop problems

ToolbarPalette

public ToolbarPalette(java.lang.Object obj)
               throws java.io.IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ToolbarPalette theToolbarPalette = (ToolbarPalette) obj;

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

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

Specified by:
release in interface com.esri.arcgis.interop.RemoteObjRef

setCommandPoolByRef

public void setCommandPoolByRef(ICommandPool ppCommandPool)
                         throws java.io.IOException,
                                AutomationException
The CommandPool used by the ToolbarPalette.

Specified by:
setCommandPoolByRef in interface IToolbarPalette
Parameters:
ppCommandPool - A reference to a com.esri.arcgis.controls.ICommandPool (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCommandPool

public ICommandPool getCommandPool()
                            throws java.io.IOException,
                                   AutomationException
The CommandPool used by the ToolbarPalette.

Specified by:
getCommandPool in interface IToolbarPalette
Returns:
A reference to a com.esri.arcgis.controls.ICommandPool
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

popupPalette

public void popupPalette(int x,
                         int y,
                         int hWndParent)
                  throws java.io.IOException,
                         AutomationException
Pops up the ToolbarPalette at the position specified.

Specified by:
popupPalette in interface IToolbarPalette
Parameters:
x - The x (in)
y - The y (in)
hWndParent - The hWndParent (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setHook

public void setHook(java.lang.Object hook)
             throws java.io.IOException,
                    AutomationException
Sets the object that is passed as a hook to the OnCreate event of each item's command.

Specified by:
setHook in interface IToolbarPalette
Parameters:
hook - A reference to another Automation Object (IDispatch) (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getHook

public java.lang.Object getHook()
                         throws java.io.IOException,
                                AutomationException
The object that is passed as a hook to the OnCreate event of each item's command.

Specified by:
getHook in interface IToolbarPalette
Returns:
A reference to another Automation Object (IDispatch)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

moveItem

public void moveItem(int startIndex,
                     int finalIndex)
              throws java.io.IOException,
                     AutomationException
Moves an item from one index to another.

Specified by:
moveItem in interface IToolbarPalette
Parameters:
startIndex - The startIndex (in)
finalIndex - The finalIndex (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addItem

public int addItem(java.lang.Object item,
                   int subType,
                   int index)
            throws java.io.IOException,
                   AutomationException
Adds an item to the ToolbarPalette.

Specified by:
addItem in interface IToolbarPalette
Parameters:
item - A Variant (in)
subType - The subType (in, optional, pass 0 if not required)
index - The index (in, optional, pass -1 if not required)
Returns:
The insertIndex
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

remove

public void remove(int index)
            throws java.io.IOException,
                   AutomationException
Removes the item at the specified index from the ToolbarPalette.

Specified by:
remove in interface IToolbarPalette
Parameters:
index - The index (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

removeAll

public void removeAll()
               throws java.io.IOException,
                      AutomationException
Removes all items from the ToolbarPalette.

Specified by:
removeAll in interface IToolbarPalette
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCaption

public void setCaption(java.lang.String pVal)
                throws java.io.IOException,
                       AutomationException
The caption used by the ToolbarPalette.

Specified by:
setCaption in interface IToolbarPalette
Parameters:
pVal - The pVal (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCaption

public java.lang.String getCaption()
                            throws java.io.IOException,
                                   AutomationException
The caption used by the ToolbarPalette.

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

getCount

public int getCount()
             throws java.io.IOException,
                    AutomationException
The number of items on the ToolbarPalette.

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

getActiveItem

public IToolbarItem getActiveItem()
                           throws java.io.IOException,
                                  AutomationException
The palette item currently displayed on the ToolbarControl.

Specified by:
getActiveItem in interface IToolbarPalette
Returns:
A reference to a com.esri.arcgis.controls.IToolbarItem
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isToolTips

public boolean isToolTips()
                   throws java.io.IOException,
                          AutomationException
Indicates if the items tooltips are shown.

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

setToolTips

public void setToolTips(boolean pVal)
                 throws java.io.IOException,
                        AutomationException
Indicates if the items tooltips are shown.

Specified by:
setToolTips in interface IToolbarPalette
Parameters:
pVal - The pVal (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getItem

public IToolbarItem getItem(int index)
                     throws java.io.IOException,
                            AutomationException
Returns the item at the specified index from the ToolbarPalette.

Specified by:
getItem in interface IToolbarPalette
Parameters:
index - The index (in)
Returns:
A reference to a com.esri.arcgis.controls.IToolbarItem
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

find

public int find(java.lang.Object item)
         throws java.io.IOException,
                AutomationException
Returns the index of the first item containing the given command. Returns -1 if it is not found.

Specified by:
find in interface IToolbarPalette
Parameters:
item - A Variant (in)
Returns:
The pVal
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCustomize

public void setCustomize(boolean newVal)
                  throws java.io.IOException,
                         AutomationException
Indicates if the ToolbarPalette is in customize mode.

Specified by:
setCustomize in interface IToolbarPalette
Parameters:
newVal - The newVal (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isCustomize

public boolean isCustomize()
                    throws java.io.IOException,
                           AutomationException
Indicates if the ToolbarPalette is in customize mode.

Specified by:
isCustomize in interface IToolbarPalette
Returns:
The newVal
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isThemedDrawing

public boolean isThemedDrawing()
                        throws java.io.IOException,
                               AutomationException
Indicates if the ToolbarPalette uses themed drawing.

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

setThemedDrawing

public void setThemedDrawing(boolean pVal)
                      throws java.io.IOException,
                             AutomationException
Indicates if the ToolbarPalette uses themed drawing.

Specified by:
setThemedDrawing in interface IToolbarPalette
Parameters:
pVal - The pVal (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMousePointer

public int getMousePointer()
                    throws java.io.IOException,
                           AutomationException
The mouse pointer displayed over the ToolbarPalette.

Specified by:
getMousePointer in interface IToolbarPalette
Returns:
A com.esri.arcgis.controls.esriControlsMousePointer constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMousePointer

public void setMousePointer(int pVal)
                     throws java.io.IOException,
                            AutomationException
The mouse pointer displayed over the ToolbarPalette.

Specified by:
setMousePointer in interface IToolbarPalette
Parameters:
pVal - A com.esri.arcgis.controls.esriControlsMousePointer constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getIconSize

public int getIconSize()
                throws java.io.IOException,
                       AutomationException
Indicates the size in pixels of icons displayed on the ToolbarPalette.

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

setIconSize

public void setIconSize(int pVal)
                 throws java.io.IOException,
                        AutomationException
Indicates the size in pixels of icons displayed on the ToolbarPalette.

Specified by:
setIconSize in interface IToolbarPalette
Parameters:
pVal - The pVal (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isAlignLeft

public boolean isAlignLeft()
                    throws java.io.IOException,
                           AutomationException
Indicates if the ToolbarPalette displays aligned to the left or right.

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

setAlignLeft

public void setAlignLeft(boolean pVal)
                  throws java.io.IOException,
                         AutomationException
Indicates if the ToolbarPalette displays aligned to the left or right.

Specified by:
setAlignLeft in interface IToolbarPalette
Parameters:
pVal - The pVal (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMouseIconByRef

public void setMouseIconByRef(Picture ppMouseIcon)
                       throws java.io.IOException,
                              AutomationException
Custom mouse icon used if MousePointer is 99.

Specified by:
setMouseIconByRef in interface IToolbarPalette
Parameters:
ppMouseIcon - A reference to a com.esri.arcgis.support.ms.stdole.Picture (A com.esri.arcgis.support.ms.stdole.Picture COM typedef) (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMouseIcon

public Picture getMouseIcon()
                     throws java.io.IOException,
                            AutomationException
Custom mouse icon used if MousePointer is 99.

Specified by:
getMouseIcon in interface IToolbarPalette
Returns:
A reference to a com.esri.arcgis.support.ms.stdole.Picture (A com.esri.arcgis.support.ms.stdole.Picture COM typedef)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws java.io.IOException,
                                       AutomationException
interfaceSupportsErrorInfo

Specified by:
interfaceSupportsErrorInfo in interface ISupportErrorInfo
Parameters:
riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.