net.sf.jacobie.ie
Class Select

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

public class Select

extends HTMLElement

Select HTML object.

Author:

Nick Neuberger

Field Summary

Fields inherited from class net.sf.jacobie.ie.JacobieShared

ID_GET_ELEMENTS_BY_TAG_NAME

Fields inherited from class net.sf.jacobie.ie.JacobieDispatch

componentName, CRLF, 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

Select(com.jacob.com.Dispatch aDispatch)

Method Summary

Option	getOptionBasedOnText(java.lang.String aText) Gets the option based on the "text" of the option.
java.util.Vector	getOptions() Gets the Options collection.
Option	getSelectedOption() Gets the selected option based on the "selected" attribute.
boolean	hasOptionBasedOnText(java.lang.String aText) Convience method to easily determine if the method getOptionBasedOnText will return a null object.
boolean	hasSelectedOption() Ensures there is a selected option.
void	setSelectedOption(java.lang.String aOptionText) Selects the option based on the text of the option.

Methods inherited from class net.sf.jacobie.ie.HTMLElement

blur, click, getID, getInnerHTML, getInnerText, getName, getType, getValue, isChecked, setChecked, setInnerHTML, setInnerText, setName, setType, setValue, toString

Methods inherited from class net.sf.jacobie.ie.JacobieShared

focus, getElementsByTagName

Methods inherited from class net.sf.jacobie.ie.JacobieDispatch

getMaxWaitDispatchCount, getReadyState, getWaitDispatchSleepTime, resetWaitTimes, setMaxWaitDispatchCount, setWaitDispatchSleepTime, waitWhileDispatchBusy

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, wait, wait, wait

Constructor Detail

Select

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

Parameters:

aDispatch -

Method Detail

hasSelectedOption

public boolean hasSelectedOption()

Ensures there is a selected option.

Returns:

true / false if there is a select option.

getSelectedOption

public Option getSelectedOption()

Gets the selected option based on the "selected" attribute. If nothing is found, then this method will return a null object.

Returns:

Option

hasOptionBasedOnText

public boolean hasOptionBasedOnText(java.lang.String aText)

Convience method to easily determine if the method getOptionBasedOnText will return a null object.

Returns:

boolean. True if it has found the object. False if it didn't find it.

getOptionBasedOnText

public Option getOptionBasedOnText(java.lang.String aText)

Gets the option based on the "text" of the option. Example: one the method will search for the "one" text and not the value. If nothing is found, then this method will return a null object.

Returns:

Option

getOptions

public java.util.Vector getOptions()

Gets the Options collection.

setSelectedOption

public void setSelectedOption(java.lang.String aOptionText)
                       throws JacobieException

Selects the option based on the text of the option. * Example: Solar Pass in the option text [Solar] and this option will be set.

Parameters:

aOptionText - Pass in the option text [Solar] and this option will be set.

JacobieException