com.esri.arcgis.controls
Interface IToolbarMenu

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

IToolbarMenu2

All Known Implementing Classes:

IToolbarMenu2Proxy, IToolbarMenuProxy, ToolbarMenu

public interface IToolbarMenu
extends java.io.Serializable

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

Description: 'Provides access to members that control ToolbarControl menu 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	IIDe8f2ab83_e93b_4529_82f6_34b8e4544b9e
static int	xxDummy Deprecated. Internal use only

Method Summary

int	addItem(java.lang.Object item, int subType, int index, boolean beginGroup, int style) Adds an item to the ToolbarMenu.
int	addSubMenu(java.lang.Object menuOrPalette, int index, boolean beginGroup) Adds a sub-menu to the ToolbarMenu.
int	find(java.lang.Object item) Returns the index of the first item containing the given command or menu.
int	getBitmap() The bitmap that is used as the icon on this ToolbarMenu.
java.lang.String	getCaption() The caption used by the ToolbarMenu.
ICommandPool	getCommandPool() The CommandPool used by the ToolbarMenu.
int	getCount() The number of items on the ToolbarMenu.
java.lang.Object	getHook() The object that is passed as a hook to the OnCreate event of each item's command.
IToolbarItem	getItem(int index) Returns the item at the specified index from the ToolbarMenu.
IMenuDef	getMenuDef() Returns the menu definition, this method is obsolete.
void	moveItem(int startIndex, int finalIndex) Moves an item from one index to another.
void	popupMenu(int x, int y, int hWndParent) Pops up the menu at the position specified.
void	remove(int index) Removes the item at the specified index from the ToolbarMenu.
void	removeAll() Removes all items from the ToolbarMenu.
void	setBitmap(int pVal) The bitmap that is used as the icon on this ToolbarMenu.
void	setCaption(java.lang.String pCaption) The caption used by the ToolbarMenu.
void	setCommandPoolByRef(ICommandPool ppCommandPool) The CommandPool used by the ToolbarMenu.
void	setHook(java.lang.Object pHook) Sets the object that is passed as a hook to the OnCreate event of each item's command.

Field Detail

IIDe8f2ab83_e93b_4529_82f6_34b8e4544b9e

static final int IIDe8f2ab83_e93b_4529_82f6_34b8e4544b9e

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

popupMenu

void popupMenu(int x,
               int y,
               int hWndParent)
               throws java.io.IOException,
                      AutomationException

Pops up the menu 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.

setCaption

void setCaption(java.lang.String pCaption)
                throws java.io.IOException,
                       AutomationException

The caption used by the ToolbarMenu.

Parameters:

pCaption - The pCaption (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 ToolbarMenu.

Returns:

The pCaption

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCommandPoolByRef

void setCommandPoolByRef(ICommandPool ppCommandPool)
                         throws java.io.IOException,
                                AutomationException

The CommandPool used by the ToolbarMenu.

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

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.

setHook

void setHook(java.lang.Object pHook)
             throws java.io.IOException,
                    AutomationException

Sets the object that is passed as a hook to the OnCreate event of each item's command.

Parameters:

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

getBitmap

int getBitmap()
              throws java.io.IOException,
                     AutomationException

The bitmap that is used as the icon on this ToolbarMenu.

Returns:

The pVal (A COM typedef)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBitmap

void setBitmap(int pVal)
               throws java.io.IOException,
                      AutomationException

The bitmap that is used as the icon on this ToolbarMenu.

Parameters:

pVal - The pVal (A COM typedef) (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMenuDef

IMenuDef getMenuDef()
                    throws java.io.IOException,
                           AutomationException

Returns the menu definition, this method is obsolete.

Returns:

A reference to a com.esri.arcgis.systemUI.IMenuDef

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,
            boolean beginGroup,
            int style)
            throws java.io.IOException,
                   AutomationException

Adds an item to the ToolbarMenu.

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)

style - A com.esri.arcgis.systemUI.esriCommandStyles constant (in, optional, pass 2 if not required)

Returns:

The itemIndex

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addSubMenu

int addSubMenu(java.lang.Object menuOrPalette,
               int index,
               boolean beginGroup)
               throws java.io.IOException,
                      AutomationException

Adds a sub-menu to the ToolbarMenu.

Parameters:

menuOrPalette - A Variant (in)

index - The index (in, optional, pass -1 if not required)

beginGroup - The beginGroup (in, optional, pass false if not required)

Returns:

The itemIndex

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

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

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

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

int getCount()
             throws java.io.IOException,
                    AutomationException

The number of items on the ToolbarMenu.

Returns:

The count

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 or menu. 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.

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, optional, pass -1 if not required)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.