com.esri.arcgis.framework
Interface ISelectionPalette

All Superinterfaces:

Serializable

All Known Implementing Classes:

ISelectionPaletteProxy

public interface ISelectionPalette
extends Serializable

Provides access to members that define a palette of selection choices.

Product Availability

Available with ArcGIS Desktop.

Method Summary

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.
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.
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(Object hook) Gives the palette a hook into the application.
void	queryItem(int index, int[] bitmap, String[] tooltip) The bitmap and tooltip for the given item.
void	queryMoreButton(int index, String[] tooltip, 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.

Method Detail

isEnabled

boolean isEnabled()
                  throws IOException,
                         AutomationException

Indicates if the palette is enabled.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The enabled

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getName

String getName()
               throws IOException,
                      AutomationException

The name of the palette. This will show in the title bar.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getItemCount

int getItemCount()
                 throws IOException,
                        AutomationException

The number of items in the palette.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The itemCount

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryItem

void queryItem(int index,
               int[] bitmap,
               String[] tooltip)
               throws IOException,
                      AutomationException

The bitmap and tooltip for the given item.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMoreButtonCount

int getMoreButtonCount()
                       throws IOException,
                              AutomationException

The number of more buttons in the palette.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The moreButtonCount

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryMoreButton

void queryMoreButton(int index,
                     String[] tooltip,
                     String[] name)
                     throws IOException,
                            AutomationException

The tooltip and text for the given more button.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

index - The index (in)

tooltip - The tooltip (out: use single element array)

name - The name (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCategory

String getCategory()
                   throws IOException,
                          AutomationException

The category the palette belongs to.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The category

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getShortCutKey

String getShortCutKey()
                      throws IOException,
                             AutomationException

The shortcut key to show this palette.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The shortCutText

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNumColumns

int getNumColumns()
                  throws IOException,
                         AutomationException

The number of columns in this palette.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The numColumns

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setNumColumns

void setNumColumns(int numColumns)
                   throws IOException,
                          AutomationException

The number of columns in this palette.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

numColumns - The numColumns (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNumRows

int getNumRows()
               throws IOException,
                      AutomationException

The number of rows in this palette.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The numRows

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setNumRows

void setNumRows(int numRows)
                throws IOException,
                       AutomationException

The number of rows in this palette.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

numRows - The numRows (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLastSelected

int getLastSelected()
                    throws IOException,
                           AutomationException

The index of the item in the palette that was last selected.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The index

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLastSelected

void setLastSelected(int index)
                     throws IOException,
                            AutomationException

The index of the item in the palette that was last selected.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

index - The index (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onCreate

void onCreate(Object hook)
              throws IOException,
                     AutomationException

Gives the palette a hook into the application.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

hook - A reference to another Automation Object (IDispatch) (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onClick

void onClick(int index)
             throws IOException,
                    AutomationException

Occurs when the user selects an item the palette.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

index - The index (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.