com.esri.arcgis.framework
Class ISelectionPaletteProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.framework.ISelectionPaletteProxy

All Implemented Interfaces:

ISelectionPalette, Externalizable, Serializable

public class ISelectionPaletteProxy
extends com.esri.arcgis.interop.Dispatch
implements ISelectionPalette, Serializable

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

Product Availability

Available with ArcGIS Desktop.

See Also:

Serialized Form

Field Summary

boolean

noncastable

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

Constructor Summary

	ISelectionPaletteProxy()
	ISelectionPaletteProxy(Object obj)
protected	ISelectionPaletteProxy(Object obj, String iid)

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
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	removeListener(String iidStr, Object theListener)
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.

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

noncastable

public boolean noncastable

Constructor Detail

ISelectionPaletteProxy

public ISelectionPaletteProxy()

ISelectionPaletteProxy

public ISelectionPaletteProxy(Object obj)
                       throws IOException

Throws:

IOException

ISelectionPaletteProxy

protected ISelectionPaletteProxy(Object obj,
                                 String iid)
                          throws IOException

Throws:

IOException

Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException

Overrides:

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

Throws:

IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException

Overrides:

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

Throws:

IOException

isEnabled

public boolean isEnabled()
                  throws IOException,
                         AutomationException

Indicates if the palette is enabled.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

isEnabled in interface ISelectionPalette

Returns:

The enabled

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getName

public 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

Specified by:

getName in interface ISelectionPalette

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getItemCount

public int getItemCount()
                 throws IOException,
                        AutomationException

The number of items in the palette.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getItemCount in interface ISelectionPalette

Returns:

The itemCount

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryItem

public 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

Specified by:

queryItem in interface ISelectionPalette

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

public int getMoreButtonCount()
                       throws IOException,
                              AutomationException

The number of more buttons in the palette.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getMoreButtonCount in interface ISelectionPalette

Returns:

The moreButtonCount

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryMoreButton

public 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

Specified by:

queryMoreButton in interface ISelectionPalette

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

public String getCategory()
                   throws IOException,
                          AutomationException

The category the palette belongs to.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getCategory in interface ISelectionPalette

Returns:

The category

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getShortCutKey

public String getShortCutKey()
                      throws IOException,
                             AutomationException

The shortcut key to show this palette.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getShortCutKey in interface ISelectionPalette

Returns:

The shortCutText

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNumColumns

public int getNumColumns()
                  throws IOException,
                         AutomationException

The number of columns in this palette.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getNumColumns in interface ISelectionPalette

Returns:

The numColumns

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setNumColumns

public void setNumColumns(int numColumns)
                   throws IOException,
                          AutomationException

The number of columns in this palette.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setNumColumns in interface ISelectionPalette

Parameters:

numColumns - The numColumns (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNumRows

public int getNumRows()
               throws IOException,
                      AutomationException

The number of rows in this palette.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getNumRows in interface ISelectionPalette

Returns:

The numRows

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setNumRows

public void setNumRows(int numRows)
                throws IOException,
                       AutomationException

The number of rows in this palette.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setNumRows in interface ISelectionPalette

Parameters:

numRows - The numRows (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLastSelected

public 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

Specified by:

getLastSelected in interface ISelectionPalette

Returns:

The index

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLastSelected

public 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

Specified by:

setLastSelected in interface ISelectionPalette

Parameters:

index - The index (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onCreate

public void onCreate(Object hook)
              throws IOException,
                     AutomationException

Gives the palette a hook into the application.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

onCreate in interface ISelectionPalette

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

public 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

Specified by:

onClick in interface ISelectionPalette

Parameters:

index - The index (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.