com.esri.arcgis.controls
Class IToolbarMenuProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.controls.IToolbarMenuProxy

All Implemented Interfaces:

IToolbarMenu, java.io.Externalizable, java.io.Serializable

Direct Known Subclasses:

IToolbarMenu2Proxy

Deprecated. Internal use only. Proxy for 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 =

public class IToolbarMenuProxy
extends com.esri.arcgis.interop.Dispatch
implements IToolbarMenu, java.io.Serializable

Internal use class

See Also:

Serialized Form

Field Summary

boolean	noncastable Deprecated.
static java.lang.Class	targetClass Deprecated.

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

IID, IIDe8f2ab83_e93b_4529_82f6_34b8e4544b9e

Constructor Summary

	IToolbarMenuProxy() Deprecated. For internal use only
	IToolbarMenuProxy(java.lang.Object obj) Deprecated.
protected	IToolbarMenuProxy(java.lang.Object obj, java.lang.String iid) Deprecated.
	IToolbarMenuProxy(java.lang.String CLSID, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo) Deprecated.
protected	IToolbarMenuProxy(java.lang.String CLSID, java.lang.String iid, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo) Deprecated.

Method Summary

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

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

Deprecated.

noncastable

public boolean noncastable

Deprecated.

Constructor Detail

IToolbarMenuProxy

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

Deprecated.

Throws:

java.net.UnknownHostException

java.io.IOException

IToolbarMenuProxy

public IToolbarMenuProxy()

Deprecated.

For internal use only

IToolbarMenuProxy

public IToolbarMenuProxy(java.lang.Object obj)
                  throws java.io.IOException

Deprecated.

Throws:

java.io.IOException

IToolbarMenuProxy

protected IToolbarMenuProxy(java.lang.Object obj,
                            java.lang.String iid)
                     throws java.io.IOException

Deprecated.

Throws:

java.io.IOException

IToolbarMenuProxy

protected IToolbarMenuProxy(java.lang.String CLSID,
                            java.lang.String iid,
                            java.lang.String host,
                            com.esri.arcgis.interop.AuthInfo authInfo)
                     throws java.io.IOException

Deprecated.

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

Deprecated.

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

Deprecated.

Overrides:

removeListener in class com.esri.arcgis.interop.Dispatch

Throws:

java.io.IOException

popupMenu

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

Deprecated.

Pops up the menu at the position specified.

Specified by:

popupMenu in interface IToolbarMenu

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

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

Deprecated.

The caption used by the ToolbarMenu.

Specified by:

setCaption in interface IToolbarMenu

Parameters:

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

Deprecated.

The caption used by the ToolbarMenu.

Specified by:

getCaption in interface IToolbarMenu

Returns:

The pCaption

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCommandPoolByRef

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

Deprecated.

The CommandPool used by the ToolbarMenu.

Specified by:

setCommandPoolByRef in interface IToolbarMenu

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

Deprecated.

The CommandPool used by the ToolbarMenu.

Specified by:

getCommandPool in interface IToolbarMenu

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

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

Deprecated.

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

Specified by:

setHook in interface IToolbarMenu

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

public java.lang.Object getHook()
                         throws java.io.IOException,
                                AutomationException

Deprecated.

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

Specified by:

getHook in interface IToolbarMenu

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

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

Deprecated.

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

Specified by:

getBitmap in interface IToolbarMenu

Returns:

The pVal (A COM typedef)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setBitmap

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

Deprecated.

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

Specified by:

setBitmap in interface IToolbarMenu

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

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

Deprecated.

Returns the menu definition, this method is obsolete.

Specified by:

getMenuDef in interface IToolbarMenu

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

public int addItem(java.lang.Object item,
                   int subType,
                   int index,
                   boolean beginGroup,
                   int style)
            throws java.io.IOException,
                   AutomationException

Deprecated.

Adds an item to the ToolbarMenu.

Specified by:

addItem in interface IToolbarMenu

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

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

Deprecated.

Adds a sub-menu to the ToolbarMenu.

Specified by:

addSubMenu in interface IToolbarMenu

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

public void remove(int index)
            throws java.io.IOException,
                   AutomationException

Deprecated.

Removes the item at the specified index from the ToolbarMenu.

Specified by:

remove in interface IToolbarMenu

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

Deprecated.

Removes all items from the ToolbarMenu.

Specified by:

removeAll in interface IToolbarMenu

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

Deprecated.

Returns the item at the specified index from the ToolbarMenu.

Specified by:

getItem in interface IToolbarMenu

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

Deprecated.

The number of items on the ToolbarMenu.

Specified by:

getCount in interface IToolbarMenu

Returns:

The count

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

Deprecated.

Returns the index of the first item containing the given command or menu. Returns -1 if it is not found.

Specified by:

find in interface IToolbarMenu

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

public void moveItem(int startIndex,
                     int finalIndex)
              throws java.io.IOException,
                     AutomationException

Deprecated.

Moves an item from one index to another.

Specified by:

moveItem in interface IToolbarMenu

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.