com.esri.arcgis.framework
Class ICommandBarProxy

java.lang.Object
  extended by com.esri.arcgis.interop.Dispatch
      extended by com.esri.arcgis.framework.ICommandBarProxy
All Implemented Interfaces:
ICommandBar, java.io.Externalizable, java.io.Serializable

public class ICommandBarProxy
extends com.esri.arcgis.interop.Dispatch
implements ICommandBar, java.io.Serializable

Internal use class Proxy for COM Interface 'ICommandBar'. Generated 3/19/2015 1:20:51 PM from 'C:\ArcGIS\COM\esriFramework.olb'

Description: 'Provides access to members that modify a commandbar.' 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.framework.ICommandBar
IID, IID32e9d003_b867_11d1_947b_080009eebecb
 
Constructor Summary
  ICommandBarProxy()
          For internal use only
  ICommandBarProxy(java.lang.Object obj)
           
protected ICommandBarProxy(java.lang.Object obj, java.lang.String iid)
           
  ICommandBarProxy(java.lang.String CLSID, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo)
           
protected ICommandBarProxy(java.lang.String CLSID, java.lang.String iid, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo)
           
 
Method Summary
 ICommandItem add(IUID cmdID, java.lang.Object index)
          Adds a new command to this commandbar.
 void addListener(java.lang.String iidStr, java.lang.Object theListener, java.lang.Object theSource)
           
 ICommandItem createMacroItem(java.lang.String name, java.lang.Object faceID, java.lang.String action, java.lang.Object index)
          Creates a new macro item on this commandbar at the specified position.
 ICommandBar createMenu(java.lang.String name, java.lang.Object index)
          Creates a new blank menu on this commandbar at the specified position.
 void dock(int dockFlags, ICommandBar referenceBar)
          Docks or undocks this commandbar.
 ICommandItem find(java.lang.Object identifier, boolean noRecurse)
          Finds a command on this commandbar.
 int getCount()
          The number of items contained within this commandbar.
 ICommandItem getItem(int index)
          The command item on this commandbar at the specified index.
 boolean isVisible()
          Indicates if this commandbar is visible.
 ICommandItem popup(int x, int y)
          Displays this commandbar as a popup menu at the specified location.
 void removeListener(java.lang.String iidStr, java.lang.Object theListener)
           
 
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

ICommandBarProxy

public ICommandBarProxy(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

ICommandBarProxy

public ICommandBarProxy()
For internal use only


ICommandBarProxy

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

ICommandBarProxy

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

ICommandBarProxy

protected ICommandBarProxy(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

add

public ICommandItem add(IUID cmdID,
                        java.lang.Object index)
                 throws java.io.IOException,
                        AutomationException
Adds a new command to this commandbar.

Specified by:
add in interface ICommandBar
Parameters:
cmdID - A reference to a com.esri.arcgis.system.IUID (in)
index - A Variant (in, optional, pass null if not required)
Returns:
A reference to a com.esri.arcgis.framework.ICommandItem
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

createMenu

public ICommandBar createMenu(java.lang.String name,
                              java.lang.Object index)
                       throws java.io.IOException,
                              AutomationException
Creates a new blank menu on this commandbar at the specified position.

Specified by:
createMenu in interface ICommandBar
Parameters:
name - The name (in)
index - A Variant (in, optional, pass null if not required)
Returns:
A reference to a com.esri.arcgis.framework.ICommandBar
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

createMacroItem

public ICommandItem createMacroItem(java.lang.String name,
                                    java.lang.Object faceID,
                                    java.lang.String action,
                                    java.lang.Object index)
                             throws java.io.IOException,
                                    AutomationException
Creates a new macro item on this commandbar at the specified position.

Specified by:
createMacroItem in interface ICommandBar
Parameters:
name - The name (in)
faceID - A Variant (in, optional, pass null if not required)
action - The action (in, optional, pass null if not required)
index - A Variant (in, optional, pass null if not required)
Returns:
A reference to a com.esri.arcgis.framework.ICommandItem
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 contained within this commandbar.

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

find

public ICommandItem find(java.lang.Object identifier,
                         boolean noRecurse)
                  throws java.io.IOException,
                         AutomationException
Finds a command on this commandbar.

Specified by:
find in interface ICommandBar
Parameters:
identifier - A Variant (in)
noRecurse - The noRecurse (in, optional, pass false if not required)
Returns:
A reference to a com.esri.arcgis.framework.ICommandItem
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getItem

public ICommandItem getItem(int index)
                     throws java.io.IOException,
                            AutomationException
The command item on this commandbar at the specified index.

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

popup

public ICommandItem popup(int x,
                          int y)
                   throws java.io.IOException,
                          AutomationException
Displays this commandbar as a popup menu at the specified location.

Specified by:
popup in interface ICommandBar
Parameters:
x - The x (in, optional, pass 0 if not required)
y - The y (in, optional, pass 0 if not required)
Returns:
A reference to a com.esri.arcgis.framework.ICommandItem
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

dock

public void dock(int dockFlags,
                 ICommandBar referenceBar)
          throws java.io.IOException,
                 AutomationException
Docks or undocks this commandbar.

Specified by:
dock in interface ICommandBar
Parameters:
dockFlags - A com.esri.arcgis.framework.esriDockFlags constant (in)
referenceBar - A reference to a com.esri.arcgis.framework.ICommandBar (in, optional, pass null if not required)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isVisible

public boolean isVisible()
                  throws java.io.IOException,
                         AutomationException
Indicates if this commandbar is visible.

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