com.esri.arcgis.controls
Class IToolbarBuddyProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.controls.IToolbarBuddyProxy

All Implemented Interfaces:

IToolbarBuddy, Externalizable, Serializable

public class IToolbarBuddyProxy
extends com.esri.arcgis.interop.Dispatch
implements IToolbarBuddy, Serializable

Provides access to members that control the ToolbarControl buddy.

Description

Objects that implement the IToolbarBuddy interface can be passed to the IToolbarControl::SetBuddyControl method. The ToolbarControl will set properties on this interface in repsonse to the CurrentTool being set.

Product Availability

Available with ArcGIS Engine.

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

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

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
ITool	getCurrentTool() Current active tool for the buddy.
void	removeListener(String iidStr, Object theListener)
void	setCurrentToolByRef(ITool pTool) Current active tool for the buddy.

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

IToolbarBuddyProxy

public IToolbarBuddyProxy()

IToolbarBuddyProxy

public IToolbarBuddyProxy(Object obj)
                   throws IOException

Throws:

IOException

IToolbarBuddyProxy

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

getCurrentTool

public ITool getCurrentTool()
                     throws IOException,
                            AutomationException

Current active tool for the buddy.

Description

The CurrentTool is the tool used to interact with the display area of the IToolbarControl::Buddy. The IToolbarBuddy references this tool so that it can:

• Call ITool::Refresh after a Windows paint event.
• Set the windows cursor to the ITool::Cursor property.
• Respond to mouse events with the ITool::OnMouseUp, ITool::OnMouseDown and ITool::OnMouseMove events.
• Respond to keyboard events with the ITool::OnKeyDown and ITool::OnKeyUp events.

Product Availability

Available with ArcGIS Engine.

Specified by:

getCurrentTool in interface IToolbarBuddy

Returns:

A reference to a com.esri.arcgis.systemUI.ITool

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCurrentToolByRef

public void setCurrentToolByRef(ITool pTool)
                         throws IOException,
                                AutomationException

Current active tool for the buddy.

Product Availability

Available with ArcGIS Engine.

Specified by:

setCurrentToolByRef in interface IToolbarBuddy

Parameters:

pTool - A reference to a com.esri.arcgis.systemUI.ITool (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.