com.esri.arcgis.framework
Interface ICommandBar

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
CommandBar, ICommandBarProxy

public interface ICommandBar
extends java.io.Serializable

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 =


Field Summary
static java.lang.String IID
          Deprecated. Internal use only
static int IID32e9d003_b867_11d1_947b_080009eebecb
           
static int xxDummy
          Deprecated. Internal use only
 
Method Summary
 ICommandItem add(IUID cmdID, java.lang.Object index)
          Adds a new command to this commandbar.
 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.
 

Field Detail

IID32e9d003_b867_11d1_947b_080009eebecb

static final int IID32e9d003_b867_11d1_947b_080009eebecb
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

add

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

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

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.

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

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.

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

int getCount()
             throws java.io.IOException,
                    AutomationException
The number of items contained within this commandbar.

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

find

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

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

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

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

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

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

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

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

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

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