com.esri.arcgis.systemUI
Class IComboBoxHookProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.systemUI.IComboBoxHookProxy

All Implemented Interfaces:

IComboBoxHook, Externalizable, Serializable

public class IComboBoxHookProxy
extends com.esri.arcgis.interop.Dispatch
implements IComboBoxHook, Serializable

Provides methods to program system provided combo boxes.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

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

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

Method Summary

int	add(String str) Add an element to the combo box.
void	addListener(String iidStr, Object theListener, Object theSource)
void	clear() Clear the combo box of all items.
Object	getHook() Get Application hook.
int	getSelected() GetThe currently selected item in the combo box.
String	getValue() Set the value for the edit control.
void	remove(int cookie) Remove an element from the combo box.
void	removeListener(String iidStr, Object theListener)
void	select(int cookie) Select an Item in the combo box.
void	setValue(String value) Set the value for the edit control.

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

IComboBoxHookProxy

public IComboBoxHookProxy()

IComboBoxHookProxy

public IComboBoxHookProxy(Object obj)
                   throws IOException

Throws:

IOException

IComboBoxHookProxy

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

getHook

public Object getHook()
               throws IOException,
                      AutomationException

Get Application hook.

Description

Returns the hook to the application.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getHook in interface IComboBoxHook

Returns:

A reference to another Automation Object (IDispatch)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

add

public int add(String str)
        throws IOException,
               AutomationException

Add an element to the combo box.

Description

Add an item to the combo box.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

add in interface IComboBoxHook

Parameters:

str - The str (in)

Returns:

The cookie

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

remove

public void remove(int cookie)
            throws IOException,
                   AutomationException

Remove an element from the combo box.

Description

Removes the item that corresponds to the provided cookie.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

remove in interface IComboBoxHook

Parameters:

cookie - The cookie (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setValue

public void setValue(String value)
              throws IOException,
                     AutomationException

Set the value for the edit control.

Description

Sets the string that will show in the editbox.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setValue in interface IComboBoxHook

Parameters:

value - The value (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getValue

public String getValue()
                throws IOException,
                       AutomationException

Set the value for the edit control.

Description

Gets the string that will show in the editbox.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getValue in interface IComboBoxHook

Returns:

The value

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

clear

public void clear()
           throws IOException,
                  AutomationException

Clear the combo box of all items.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

clear in interface IComboBoxHook

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

select

public void select(int cookie)
            throws IOException,
                   AutomationException

Select an Item in the combo box.

Description

Selects a combo box item based on the provided cookie.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

select in interface IComboBoxHook

Parameters:

cookie - The cookie (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSelected

public int getSelected()
                throws IOException,
                       AutomationException

GetThe currently selected item in the combo box.

Description

Returns the cookie of the current selected item.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getSelected in interface IComboBoxHook

Returns:

The cookie

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.