Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.esri.arcgis.controls
Interface IToolbarPalette

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
IToolbarPaletteProxy, ToolbarPalette
public interface IToolbarPalette
extends java.io.Serializable

COM Interface 'IToolbarPalette'. Generated 3/19/2015 1:21:01 PM from 'C:\ArcGIS\COM\esriControls.olb'

Description: 'Provides access to members that control palette items.' 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 =

Field Summary
static java.lang.String IID
          Deprecated. Internal use only
static int IID3a7ec31f_ea85_4b2b_9a29_f9505c0265a4
           
static int xxDummy
          Deprecated. Internal use only
 
Method Summary
 int addItem(java.lang.Object item, int subType, int index)
          Adds an item to the ToolbarPalette.
 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.
 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.
 Picture getMouseIcon()
          Custom mouse icon used if MousePointer is 99.
 int getMousePointer()
          The mouse pointer displayed over the ToolbarPalette.
 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 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.
 

Field Detail

IID3a7ec31f_ea85_4b2b_9a29_f9505c0265a4

static final int IID3a7ec31f_ea85_4b2b_9a29_f9505c0265a4
See Also:
Constant Field Values

xxDummy

static final int xxDummy
Deprecated. Internal use only
See Also:
Constant Field Values

IID

static final java.lang.String IID
Deprecated. Internal use only
See Also:
Constant Field Values
Method Detail

setCommandPoolByRef

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

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

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

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

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

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

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.

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

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.

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

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

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

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

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

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

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

removeAll

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

Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCaption

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

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

getCaption

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

Returns:
The pVal
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCount

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

Returns:
The pVal
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getActiveItem

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

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

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

Returns:
The pVal
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setToolTips

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

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

getItem

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

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

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.

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

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

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

isCustomize

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

Returns:
The newVal
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isThemedDrawing

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

Returns:
The pVal
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setThemedDrawing

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

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

getMousePointer

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

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

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

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

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

Returns:
The pVal
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setIconSize

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

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

isAlignLeft

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

Returns:
The pVal
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAlignLeft

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

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

setMouseIconByRef

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

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

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

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.
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD