net.sf.jacobie.ie
Class JacobieDispatch

java.lang.Object
  |
  +--com.jacob.com.JacobObject
        |
        +--com.jacob.com.Dispatch
              |
              +--net.sf.jacobie.ie.JacobieDispatch

Direct Known Subclasses:

IE, JacobieCollection, JacobieShared

public class JacobieDispatch

extends com.jacob.com.Dispatch

All Jacobie objects that utilize the jacob com interface should extend from this class.

Author:

Nick Neuberger

Field Summary

static java.lang.String	componentName
static java.lang.String	CRLF
static java.lang.String	READY_STATE_COMPLETE

Fields inherited from class com.jacob.com.Dispatch

DISPID_ABOUTBOX, DISPID_AMBIENT_APPEARANCE, DISPID_AMBIENT_AUTOCLIP, DISPID_AMBIENT_BACKCOLOR, DISPID_AMBIENT_CHARSET, DISPID_AMBIENT_CODEPAGE, DISPID_AMBIENT_DISPLAYASDEFAULT, DISPID_AMBIENT_DISPLAYNAME, DISPID_AMBIENT_FONT, DISPID_AMBIENT_FORECOLOR, DISPID_AMBIENT_LOCALEID, DISPID_AMBIENT_MESSAGEREFLECT, DISPID_AMBIENT_PALETTE, DISPID_AMBIENT_SCALEUNITS, DISPID_AMBIENT_SHOWGRABHANDLES, DISPID_AMBIENT_SHOWHATCHING, DISPID_AMBIENT_SUPPORTSMNEMONICS, DISPID_AMBIENT_TEXTALIGN, DISPID_AMBIENT_TRANSFERPRIORITY, DISPID_AMBIENT_UIDEAD, DISPID_AMBIENT_USERMODE, DISPID_APPEARANCE, DISPID_AUTOSIZE, DISPID_BACKCOLOR, DISPID_BACKSTYLE, DISPID_BORDERCOLOR, DISPID_BORDERSTYLE, DISPID_BORDERVISIBLE, DISPID_BORDERWIDTH, DISPID_CAPTION, DISPID_CLICK, DISPID_COLLECT, DISPID_CONSTRUCTOR, DISPID_DBLCLICK, DISPID_DESTRUCTOR, DISPID_DOCLICK, DISPID_DRAWMODE, DISPID_DRAWSTYLE, DISPID_DRAWWIDTH, DISPID_ENABLED, DISPID_ERROREVENT, DISPID_EVALUATE, DISPID_FILLCOLOR, DISPID_FILLSTYLE, DISPID_FONT, DISPID_FORECOLOR, DISPID_HWND, DISPID_KEYDOWN, DISPID_KEYPRESS, DISPID_KEYUP, DISPID_MOUSEDOWN, DISPID_MOUSEICON, DISPID_MOUSEMOVE, DISPID_MOUSEPOINTER, DISPID_MOUSEUP, DISPID_NEWENUM, DISPID_PICTURE, DISPID_PROPERTYPUT, DISPID_READYSTATE, DISPID_READYSTATECHANGE, DISPID_REFRESH, DISPID_TABSTOP, DISPID_TEXT, DISPID_UNKNOWN, DISPID_VALID, DISPID_VALUE, fdexNameCaseSensitive, Get, LOCALE_SYSTEM_DEFAULT, m_pDispatch, Method, Put, PutRef

Constructor Summary

JacobieDispatch(com.jacob.com.Dispatch aDispatch)
This constructor is used instead of a case operation to turn a Dispatch object into a wider object - it must exist in every wrapper class whose instances may be returned from method calls wrapped in VT_DISPATCH Variants.

JacobieDispatch(java.lang.String aCompName)

Method Summary

long	getMaxWaitDispatchCount()
java.lang.String	getReadyState() Gets the value of the ready state property from a dispatch interface.
long	getWaitDispatchSleepTime()
void	resetWaitTimes() Resets the default wait dispatch times to original values.
void	setMaxWaitDispatchCount(long maxWaitDispatchCount)
void	setWaitDispatchSleepTime(long waitDispatchSleepTime)
void	waitWhileDispatchBusy() This will wait the current dispatch object is busy.

Methods inherited from class com.jacob.com.Dispatch

call, call, call, call, call, call, call, call, call, call, call, call, call, call, call, call, call, call, callN_CaseSensitive, callN, callN, callSub, callSub, callSub, callSub, callSub, callSub, callSub, callSub, callSub, callSub, callSub, callSub, callSub, callSub, callSub, callSub, callSub, callSub, callSubN, callSubN, createInstance, finalize, get_CaseSensitive, get, get, getIDOfName, getIDsOfNames, getIDsOfNames, invoke, invoke, invoke, invokeSub, invokeSub, invokeSub, invokeSubv, invokeSubv, invokeSubv, invokev, invokev, invokev, invokev, obj2variant, obj2variant, put_Casesensitive, put, put, putRef, putRef, QueryInterface, release

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CRLF

public static final java.lang.String CRLF

See Also:

Constant Field Values

componentName

public static final java.lang.String componentName

See Also:

Constant Field Values

READY_STATE_COMPLETE

public static final java.lang.String READY_STATE_COMPLETE

See Also:

Constant Field Values

Constructor Detail

JacobieDispatch

public JacobieDispatch(java.lang.String aCompName)

JacobieDispatch

public JacobieDispatch(com.jacob.com.Dispatch aDispatch)

This constructor is used instead of a case operation to turn a Dispatch object into a wider object - it must exist in every wrapper class whose instances may be returned from method calls wrapped in VT_DISPATCH Variants.

Method Detail

resetWaitTimes

public void resetWaitTimes()

Resets the default wait dispatch times to original values.

Returns:

getReadyState

public java.lang.String getReadyState()

Gets the value of the ready state property from a dispatch interface.

waitWhileDispatchBusy

public void waitWhileDispatchBusy()
                           throws JacobieException

This will wait the current dispatch object is busy. should be called after executing any process that could take a while such as: click, navigation, etc.

Throws:

JacobieException

setMaxWaitDispatchCount

public void setMaxWaitDispatchCount(long maxWaitDispatchCount)

getMaxWaitDispatchCount

public long getMaxWaitDispatchCount()

setWaitDispatchSleepTime

public void setWaitDispatchSleepTime(long waitDispatchSleepTime)

getWaitDispatchSleepTime

public long getWaitDispatchSleepTime()