Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.esri.arcgis.framework
Interface ISelectionPalette

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
ISelectionPaletteProxy
public interface ISelectionPalette
extends java.io.Serializable

COM Interface 'ISelectionPalette'. Generated 3/19/2015 1:21:02 PM from 'C:\ArcGIS\COM\esriFramework.olb'

Description: 'Provides access to members that define a palette of selection choices.' 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 IID5fdd7101_8e9f_11d1_a1b2_080009b6f22b
           
static int xxDummy
          Deprecated. Internal use only
 
Method Summary
 java.lang.String getCategory()
          The category the palette belongs to.
 int getItemCount()
          The number of items in the palette.
 int getLastSelected()
          The index of the item in the palette that was last selected.
 int getMoreButtonCount()
          The number of more buttons in the palette.
 java.lang.String getName()
          The name of the palette.
 int getNumColumns()
          The number of columns in this palette.
 int getNumRows()
          The number of rows in this palette.
 java.lang.String getShortCutKey()
          The shortcut key to show this palette.
 boolean isEnabled()
          Indicates if the palette is enabled.
 void onClick(int index)
          Occurs when the user selects an item the palette.
 void onCreate(java.lang.Object hook)
          Gives the palette a hook into the application.
 void queryItem(int index, int[] bitmap, java.lang.String[] tooltip)
          The bitmap and tooltip for the given item.
 void queryMoreButton(int index, java.lang.String[] tooltip, java.lang.String[] name)
          The tooltip and text for the given more button.
 void setLastSelected(int index)
          The index of the item in the palette that was last selected.
 void setNumColumns(int numColumns)
          The number of columns in this palette.
 void setNumRows(int numRows)
          The number of rows in this palette.
 

Field Detail

IID5fdd7101_8e9f_11d1_a1b2_080009b6f22b

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

isEnabled

boolean isEnabled()
                  throws java.io.IOException,
                         AutomationException
Indicates if the palette is enabled.

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

getName

java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException
The name of the palette. This will show in the title bar.

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

getItemCount

int getItemCount()
                 throws java.io.IOException,
                        AutomationException
The number of items in the palette.

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

queryItem

void queryItem(int index,
               int[] bitmap,
               java.lang.String[] tooltip)
               throws java.io.IOException,
                      AutomationException
The bitmap and tooltip for the given item.

Parameters:
index - The index (in)
bitmap - The bitmap (A COM typedef) (out: use single element array)
tooltip - The tooltip (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMoreButtonCount

int getMoreButtonCount()
                       throws java.io.IOException,
                              AutomationException
The number of more buttons in the palette.

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

queryMoreButton

void queryMoreButton(int index,
                     java.lang.String[] tooltip,
                     java.lang.String[] name)
                     throws java.io.IOException,
                            AutomationException
The tooltip and text for the given more button.

Parameters:
index - The index (in)
tooltip - The tooltip (out: use single element array)
name - The name (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCategory

java.lang.String getCategory()
                             throws java.io.IOException,
                                    AutomationException
The category the palette belongs to.

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

getShortCutKey

java.lang.String getShortCutKey()
                                throws java.io.IOException,
                                       AutomationException
The shortcut key to show this palette.

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

getNumColumns

int getNumColumns()
                  throws java.io.IOException,
                         AutomationException
The number of columns in this palette.

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

setNumColumns

void setNumColumns(int numColumns)
                   throws java.io.IOException,
                          AutomationException
The number of columns in this palette.

Parameters:
numColumns - The numColumns (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getNumRows

int getNumRows()
               throws java.io.IOException,
                      AutomationException
The number of rows in this palette.

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

setNumRows

void setNumRows(int numRows)
                throws java.io.IOException,
                       AutomationException
The number of rows in this palette.

Parameters:
numRows - The numRows (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLastSelected

int getLastSelected()
                    throws java.io.IOException,
                           AutomationException
The index of the item in the palette that was last selected.

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

setLastSelected

void setLastSelected(int index)
                     throws java.io.IOException,
                            AutomationException
The index of the item in the palette that was last selected.

Parameters:
index - The index (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

onCreate

void onCreate(java.lang.Object hook)
              throws java.io.IOException,
                     AutomationException
Gives the palette a hook into the application.

Parameters:
hook - 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.

onClick

void onClick(int index)
             throws java.io.IOException,
                    AutomationException
Occurs when the user selects an item the palette.

Parameters:
index - The index (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD