com.esri.arcgis.controls
Class IToolbarControlProxy

java.lang.Object
  extended by com.esri.arcgis.interop.Dispatch
      extended by com.esri.arcgis.controls.IToolbarControlProxy
All Implemented Interfaces:
IToolbarControl, java.io.Externalizable, java.io.Serializable
Direct Known Subclasses:
IToolbarControl2Proxy

public class IToolbarControlProxy
extends com.esri.arcgis.interop.Dispatch
implements IToolbarControl, java.io.Serializable

Internal use class Proxy for COM Interface 'IToolbarControl'. Generated 3/19/2015 1:21:01 PM from 'C:\ArcGIS\COM\esriControls.olb'

Description: 'Provides access to members that control the ToolbarControl.' 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
 boolean noncastable
           
static java.lang.Class targetClass
           
 
Fields inherited from class com.esri.arcgis.interop.Dispatch
DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef
 
Fields inherited from interface com.esri.arcgis.controls.IToolbarControl
DISPID__504_GET_NAME, DISPID__504_PUT_NAME, DISPID__514_GET_NAME, DISPID__514_PUT_NAME, DISPID__515_GET_NAME, DISPID__520_GET_NAME, DISPID__520_PUT_NAME, DISPID__521_GET_NAME, DISPID__521_PUT_NAME, DISPID__522_GET_NAME, DISPID__522_PUTREF_NAME, DISPID__552_NAME, DISPID_1_NAME, DISPID_10_GET_NAME, DISPID_10_PUT_NAME, DISPID_11_GET_NAME, DISPID_11_PUT_NAME, DISPID_12_NAME, DISPID_13_GET_NAME, DISPID_13_PUTREF_NAME, DISPID_14_NAME, DISPID_15_GET_NAME, DISPID_15_PUT_NAME, DISPID_16_GET_NAME, DISPID_16_PUT_NAME, DISPID_17_GET_NAME, DISPID_17_PUT_NAME, DISPID_18_NAME, DISPID_19_NAME, DISPID_2_NAME, DISPID_20_NAME, DISPID_21_GET_NAME, DISPID_21_PUTREF_NAME, DISPID_22_GET_NAME, DISPID_22_PUT_NAME, DISPID_23_NAME, DISPID_24_GET_NAME, DISPID_24_PUT_NAME, DISPID_25_NAME, DISPID_26_GET_NAME, DISPID_27_GET_NAME, DISPID_27_PUT_NAME, DISPID_3_NAME, DISPID_4_NAME, DISPID_5_GET_NAME, DISPID_6_NAME, DISPID_7_GET_NAME, DISPID_8_GET_NAME, DISPID_8_PUTREF_NAME, DISPID_9_GET_NAME, DISPID_9_PUT_NAME, IID, IIDb7d4358d_3cbc_11d6_aa09_00104bb6fc1c
 
Constructor Summary
  IToolbarControlProxy()
          For internal use only
  IToolbarControlProxy(java.lang.Object obj)
           
protected IToolbarControlProxy(java.lang.Object obj, java.lang.String iid)
           
  IToolbarControlProxy(java.lang.String CLSID, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo)
           
protected IToolbarControlProxy(java.lang.String CLSID, java.lang.String iid, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo)
           
 
Method Summary
 void aboutBox()
          Displays a dialog of information about the ToolbarControl.
 int addItem(java.lang.Object item, int subType, int index, boolean beginGroup, int groupSpacing, int style)
          Adds an item to the ToolbarControl.
 void addListener(java.lang.String iidStr, java.lang.Object theListener, java.lang.Object theSource)
           
 int addMenuItem(java.lang.Object menu, int index, boolean beginGroup, int groupSpacing)
          Adds a menu item to the ToolbarControl.
 int addToolbarDef(java.lang.Object toolbarDef, int startIndex, boolean group, int groupSpacing, int style)
          Appends the contents of the toolbar definition, specified by Guid or ToolbarDef, to the toolbar control.
 boolean esri_isEnabled()
          Indicates whether the ToolbarControl can respond to user generated events.
 void esri_setEnabled(boolean pbool)
          Indicates whether the ToolbarControl can respond to user generated events.
 int find(java.lang.Object item)
          Returns the index of the first item containing the given command, menu or palette.
 int getAppearance()
          The appearance of the ToolbarControl.
 int getBorderStyle()
          The border style of the ToolbarControl.
 java.lang.Object getBuddy()
          The object that will have its current tool managed by the toolbar.
 ICommandPool getCommandPool()
          The command pool used by the ToolbarControl to manage command objects.
 int getCount()
          The number of items on the ToolbarControl.
 ITool getCurrentTool()
          The current tool of the buddy.
 java.lang.Object getCustomProperty()
          A property to associate data with a control.
 int getHWnd()
          Handle to the window associated with the ToolbarControl.
 IToolbarItem getItem(int index)
          Returns the item at the specified index from the ToolbarControl.
 int getItemAppearance()
          The appearance of the items on the ToolbarControl.
 void getItemRect(int index, int[] top, int[] left, int[] bottom, int[] right)
          Returns the dimensions of the item at the specified index.
 int getKeyIntercept()
          A property that specifies interception of key strokes that are normally handled by the container.
 Picture getMouseIcon()
          Custom mouse icon used if MousePointer is 99.
 int getMousePointer()
          The mouse pointer displayed over the ToolbarControl.
 java.lang.Object getObject()
          A property that returns the underlying control.
 IOperationStack getOperationStack()
          The operation stack used for undo and redo functionality.
 int getTextAlignment()
          The caption placement for all items on the ToolbarControl.
 int getUpdateInterval()
          The frequency in millisecs that update method is called on the ToolbarControl.
 int hitTest(int x, int y, boolean nearest)
          Returns the index of the item at the specified x and y coordinates.
 boolean isCustomize()
          Indicates if the ToolbarControl is in customize mode.
 boolean isLargeIcons()
          Indicates if large icons are shown on all items on the ToolbarControl.
 boolean isMenuTracking()
          Indicates if menu tracking is enabled on the ToolbarControl.
 boolean isToolTips()
          Indicates if the items tooltips are shown.
 void moveItem(int startIndex, int finalIndex)
          Moves an item from one index to another.
 void remove(int index)
          Removes the item at the specified index from the ToolbarControl.
 void removeAll()
          Removes all items from the ToolbarControl.
 void removeListener(java.lang.String iidStr, java.lang.Object theListener)
           
 void setAppearance(int pappearance)
          The appearance of the ToolbarControl.
 void setBorderStyle(int pstyle)
          The border style of the ToolbarControl.
 void setBuddyControl(java.lang.Object pToolbarBuddy)
          Sets a control to be a buddy of the toolbar, this control must support IToolbarBuddy.
 void setCommandPoolByRef(ICommandPool pVal)
          The command pool used by the ToolbarControl to manage command objects.
 void setCurrentToolByRef(ITool pVal)
          The current tool of the buddy.
 void setCustomize(boolean pVal)
          Indicates if the ToolbarControl is in customize mode.
 void setCustomProperty(java.lang.Object pVal)
          A property to associate data with a control.
 void setItemAppearance(int pappearance)
          The appearance of the items on the ToolbarControl.
 void setKeyIntercept(int pVal)
          A property that specifies interception of key strokes that are normally handled by the container.
 void setLargeIcons(boolean pVal)
          Indicates if large icons are shown on all items on the ToolbarControl.
 void setMenuTracking(boolean pVal)
          Indicates if menu tracking is enabled on the ToolbarControl.
 void setMouseIconByRef(Picture ppMouseIcon)
          Custom mouse icon used if MousePointer is 99.
 void setMousePointer(int ppointer)
          The mouse pointer displayed over the ToolbarControl.
 void setOperationStackByRef(IOperationStack operationStack)
          The operation stack used for undo and redo functionality.
 void setTextAlignment(int pVal)
          The caption placement for all items on the ToolbarControl.
 void setToolTips(boolean pVal)
          Indicates if the items tooltips are shown.
 void setUpdateInterval(int pVal)
          The frequency in millisecs that update method is called on the ToolbarControl.
 void update(int index, boolean fullUpdate)
          Updates the enabled state of the specified item or all items if an index of -1 is specified.
 
Methods inherited from class com.esri.arcgis.interop.Dispatch
bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

targetClass

public static final java.lang.Class targetClass

noncastable

public boolean noncastable
Constructor Detail

IToolbarControlProxy

public IToolbarControlProxy(java.lang.String CLSID,
                            java.lang.String host,
                            com.esri.arcgis.interop.AuthInfo authInfo)
                     throws java.net.UnknownHostException,
                            java.io.IOException
Throws:
java.net.UnknownHostException
java.io.IOException

IToolbarControlProxy

public IToolbarControlProxy()
For internal use only


IToolbarControlProxy

public IToolbarControlProxy(java.lang.Object obj)
                     throws java.io.IOException
Throws:
java.io.IOException

IToolbarControlProxy

protected IToolbarControlProxy(java.lang.Object obj,
                               java.lang.String iid)
                        throws java.io.IOException
Throws:
java.io.IOException

IToolbarControlProxy

protected IToolbarControlProxy(java.lang.String CLSID,
                               java.lang.String iid,
                               java.lang.String host,
                               com.esri.arcgis.interop.AuthInfo authInfo)
                        throws java.io.IOException
Throws:
java.io.IOException
Method Detail

addListener

public void addListener(java.lang.String iidStr,
                        java.lang.Object theListener,
                        java.lang.Object theSource)
                 throws java.io.IOException
Overrides:
addListener in class com.esri.arcgis.interop.Dispatch
Throws:
java.io.IOException

removeListener

public void removeListener(java.lang.String iidStr,
                           java.lang.Object theListener)
                    throws java.io.IOException
Overrides:
removeListener in class com.esri.arcgis.interop.Dispatch
Throws:
java.io.IOException

setBorderStyle

public void setBorderStyle(int pstyle)
                    throws java.io.IOException,
                           AutomationException
The border style of the ToolbarControl.

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

getBorderStyle

public int getBorderStyle()
                   throws java.io.IOException,
                          AutomationException
The border style of the ToolbarControl.

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

esri_setEnabled

public void esri_setEnabled(boolean pbool)
                     throws java.io.IOException,
                            AutomationException
Indicates whether the ToolbarControl can respond to user generated events.

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

esri_isEnabled

public boolean esri_isEnabled()
                       throws java.io.IOException,
                              AutomationException
Indicates whether the ToolbarControl can respond to user generated events.

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

setAppearance

public void setAppearance(int pappearance)
                   throws java.io.IOException,
                          AutomationException
The appearance of the ToolbarControl.

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

getAppearance

public int getAppearance()
                  throws java.io.IOException,
                         AutomationException
The appearance of the ToolbarControl.

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

setMousePointer

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

Specified by:
setMousePointer in interface IToolbarControl
Parameters:
ppointer - 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.

getMousePointer

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

Specified by:
getMousePointer in interface IToolbarControl
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.

setMouseIconByRef

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

Specified by:
setMouseIconByRef in interface IToolbarControl
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 IToolbarControl
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.

getHWnd

public int getHWnd()
            throws java.io.IOException,
                   AutomationException
Handle to the window associated with the ToolbarControl.

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

aboutBox

public void aboutBox()
              throws java.io.IOException,
                     AutomationException
Displays a dialog of information about the ToolbarControl.

Specified by:
aboutBox in interface IToolbarControl
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,
                   boolean beginGroup,
                   int groupSpacing,
                   int style)
            throws java.io.IOException,
                   AutomationException
Adds an item to the ToolbarControl.

Specified by:
addItem in interface IToolbarControl
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)
beginGroup - The beginGroup (in, optional, pass false if not required)
groupSpacing - The groupSpacing (in, optional, pass 0 if not required)
style - A com.esri.arcgis.systemUI.esriCommandStyles constant (in, optional, pass 1 if not required)
Returns:
The itemIndex
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 ToolbarControl.

Specified by:
remove in interface IToolbarControl
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 ToolbarControl.

Specified by:
removeAll in interface IToolbarControl
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 ToolbarControl.

Specified by:
getItem in interface IToolbarControl
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.

getCount

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

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

update

public void update(int index,
                   boolean fullUpdate)
            throws java.io.IOException,
                   AutomationException
Updates the enabled state of the specified item or all items if an index of -1 is specified. Specify fullUpdate to update the group, group spacing, style and bitmap properties.

Specified by:
update in interface IToolbarControl
Parameters:
index - The index (in, optional, pass -1 if not required)
fullUpdate - The fullUpdate (in, optional, pass false if not required)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBuddy

public java.lang.Object getBuddy()
                          throws java.io.IOException,
                                 AutomationException
The object that will have its current tool managed by the toolbar.

Specified by:
getBuddy in interface IToolbarControl
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.

getCurrentTool

public ITool getCurrentTool()
                     throws java.io.IOException,
                            AutomationException
The current tool of the buddy.

Specified by:
getCurrentTool in interface IToolbarControl
Returns:
A reference to a com.esri.arcgis.systemUI.ITool
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCurrentToolByRef

public void setCurrentToolByRef(ITool pVal)
                         throws java.io.IOException,
                                AutomationException
The current tool of the buddy.

Specified by:
setCurrentToolByRef in interface IToolbarControl
Parameters:
pVal - A reference to a com.esri.arcgis.systemUI.ITool (in)
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 IToolbarControl
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 IToolbarControl
Parameters:
pVal - The pVal (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getItemAppearance

public int getItemAppearance()
                      throws java.io.IOException,
                             AutomationException
The appearance of the items on the ToolbarControl.

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

setItemAppearance

public void setItemAppearance(int pappearance)
                       throws java.io.IOException,
                              AutomationException
The appearance of the items on the ToolbarControl.

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

getUpdateInterval

public int getUpdateInterval()
                      throws java.io.IOException,
                             AutomationException
The frequency in millisecs that update method is called on the ToolbarControl.

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

setUpdateInterval

public void setUpdateInterval(int pVal)
                       throws java.io.IOException,
                              AutomationException
The frequency in millisecs that update method is called on the ToolbarControl.

Specified by:
setUpdateInterval in interface IToolbarControl
Parameters:
pVal - The pVal (in)
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, menu or palette. Returns -1 if the command is not found.

Specified by:
find in interface IToolbarControl
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.

getCommandPool

public ICommandPool getCommandPool()
                            throws java.io.IOException,
                                   AutomationException
The command pool used by the ToolbarControl to manage command objects. The command pool object maybe shared with other ToolbarControls and ToolbarMenus.

Specified by:
getCommandPool in interface IToolbarControl
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.

setCommandPoolByRef

public void setCommandPoolByRef(ICommandPool pVal)
                         throws java.io.IOException,
                                AutomationException
The command pool used by the ToolbarControl to manage command objects. The command pool object maybe shared with other ToolbarControls and ToolbarMenus.

Specified by:
setCommandPoolByRef in interface IToolbarControl
Parameters:
pVal - 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.

addToolbarDef

public int addToolbarDef(java.lang.Object toolbarDef,
                         int startIndex,
                         boolean group,
                         int groupSpacing,
                         int style)
                  throws java.io.IOException,
                         AutomationException
Appends the contents of the toolbar definition, specified by Guid or ToolbarDef, to the toolbar control.

Specified by:
addToolbarDef in interface IToolbarControl
Parameters:
toolbarDef - A Variant (in)
startIndex - The startIndex (in, optional, pass -1 if not required)
group - The group (in, optional, pass false if not required)
groupSpacing - The groupSpacing (in, optional, pass 4 if not required)
style - A com.esri.arcgis.systemUI.esriCommandStyles constant (in, optional, pass 1 if not required)
Returns:
The count
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTextAlignment

public int getTextAlignment()
                     throws java.io.IOException,
                            AutomationException
The caption placement for all items on the ToolbarControl.

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

setTextAlignment

public void setTextAlignment(int pVal)
                      throws java.io.IOException,
                             AutomationException
The caption placement for all items on the ToolbarControl.

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

isLargeIcons

public boolean isLargeIcons()
                     throws java.io.IOException,
                            AutomationException
Indicates if large icons are shown on all items on the ToolbarControl.

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

setLargeIcons

public void setLargeIcons(boolean pVal)
                   throws java.io.IOException,
                          AutomationException
Indicates if large icons are shown on all items on the ToolbarControl.

Specified by:
setLargeIcons in interface IToolbarControl
Parameters:
pVal - The pVal (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 ToolbarControl is in customize mode.

Specified by:
isCustomize in interface IToolbarControl
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 pVal)
                  throws java.io.IOException,
                         AutomationException
Indicates if the ToolbarControl is in customize mode.

Specified by:
setCustomize in interface IToolbarControl
Parameters:
pVal - The pVal (in)
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 IToolbarControl
Parameters:
startIndex - The startIndex (in)
finalIndex - The finalIndex (in, optional, pass -1 if not required)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

hitTest

public int hitTest(int x,
                   int y,
                   boolean nearest)
            throws java.io.IOException,
                   AutomationException
Returns the index of the item at the specified x and y coordinates.

Specified by:
hitTest in interface IToolbarControl
Parameters:
x - The x (in)
y - The y (in)
nearest - The nearest (in, optional, pass false if not required)
Returns:
The index
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getItemRect

public void getItemRect(int index,
                        int[] top,
                        int[] left,
                        int[] bottom,
                        int[] right)
                 throws java.io.IOException,
                        AutomationException
Returns the dimensions of the item at the specified index.

Specified by:
getItemRect in interface IToolbarControl
Parameters:
index - The index (in)
top - The top (in/out: use single element array)
left - The left (in/out: use single element array)
bottom - The bottom (in/out: use single element array)
right - The right (in/out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getOperationStack

public IOperationStack getOperationStack()
                                  throws java.io.IOException,
                                         AutomationException
The operation stack used for undo and redo functionality. If present commands can use it to store operations.

Specified by:
getOperationStack in interface IToolbarControl
Returns:
A reference to a com.esri.arcgis.systemUI.IOperationStack
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setOperationStackByRef

public void setOperationStackByRef(IOperationStack operationStack)
                            throws java.io.IOException,
                                   AutomationException
The operation stack used for undo and redo functionality. If present commands can use it to store operations.

Specified by:
setOperationStackByRef in interface IToolbarControl
Parameters:
operationStack - A reference to a com.esri.arcgis.systemUI.IOperationStack (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCustomProperty

public java.lang.Object getCustomProperty()
                                   throws java.io.IOException,
                                          AutomationException
A property to associate data with a control.

Specified by:
getCustomProperty in interface IToolbarControl
Returns:
A Variant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCustomProperty

public void setCustomProperty(java.lang.Object pVal)
                       throws java.io.IOException,
                              AutomationException
A property to associate data with a control.

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

setBuddyControl

public void setBuddyControl(java.lang.Object pToolbarBuddy)
                     throws java.io.IOException,
                            AutomationException
Sets a control to be a buddy of the toolbar, this control must support IToolbarBuddy.

Specified by:
setBuddyControl in interface IToolbarControl
Parameters:
pToolbarBuddy - 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.

isMenuTracking

public boolean isMenuTracking()
                       throws java.io.IOException,
                              AutomationException
Indicates if menu tracking is enabled on the ToolbarControl.

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

setMenuTracking

public void setMenuTracking(boolean pVal)
                     throws java.io.IOException,
                            AutomationException
Indicates if menu tracking is enabled on the ToolbarControl.

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

addMenuItem

public int addMenuItem(java.lang.Object menu,
                       int index,
                       boolean beginGroup,
                       int groupSpacing)
                throws java.io.IOException,
                       AutomationException
Adds a menu item to the ToolbarControl.

Specified by:
addMenuItem in interface IToolbarControl
Parameters:
menu - A Variant (in)
index - The index (in, optional, pass -1 if not required)
beginGroup - The beginGroup (in, optional, pass false if not required)
groupSpacing - The groupSpacing (in, optional, pass 4 if not required)
Returns:
The itemIndex
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getObject

public java.lang.Object getObject()
                           throws java.io.IOException,
                                  AutomationException
A property that returns the underlying control. This can be used when the control is inside a wrapper object that has been added by a development environment.

Specified by:
getObject in interface IToolbarControl
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.

getKeyIntercept

public int getKeyIntercept()
                    throws java.io.IOException,
                           AutomationException
A property that specifies interception of key strokes that are normally handled by the container. When intercepted the OnKeyDown and OnKeyUp events will be called. This value can be a combined bit mask of esriKeyIntercept enum values.

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

setKeyIntercept

public void setKeyIntercept(int pVal)
                     throws java.io.IOException,
                            AutomationException
A property that specifies interception of key strokes that are normally handled by the container. When intercepted the OnKeyDown and OnKeyUp events will be called. This value can be a combined bit mask of esriKeyIntercept enum values.

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