edu.wisc.trace.urcsdk.client
Interface IInteractor

All Known Implementing Classes:

AbstractInteractor, BooleanInteractor, DateInteractor, DateTimeInteractor, DayInteractor, DecimalInteractor, DurationInteractor, Group, InputInteractor, ModalDialogInteractor, MonthDayInteractor, MonthInteractor, OutputInteractor, RangeInteractor, SecretInteractor, Select1Interactor, SelectInteractor, TextAreaInteractor, TimedTriggerInteractor, TimeInteractor, TriggerInteractor, YearInteractor, YearMonthInteractor

public interface IInteractor

IInteractor is an interface for implementing new interactors that can be bound to socket elements in the PreT document.

Version:

$Revision: 1.21 $

Author:

Andrew Martin, Trace R&D Center Created on: Oct 18, 2004

Method Summary

int	getNavindex() Returns the int value indicating this interactor's navindex (set by setNavindex).
IUISocketElement	getSocketElement() getSocketElement returns the interactor's bound socket element.
java.lang.Object	getUIComponent() getUIComponent returns the UI component that represents this interactor.
void	parse() Parses the interactor starting from the root element (specified by called setRootElement).
void	setID(java.lang.String id) Set this interactor's ID.
void	setNavindex(int i) Sets the navindex for this interactor.
void	setRootElement(org.w3c.dom.Element rootElement) Sets the root element of this interactor for parsing purposes.
void	setSocketElement(IUISocketElement socketElement) setIUISocketElement sets the interactor's bound socket element.
void	setWidget(Widget w) Sets this interactor's renderable widget to the value specified.

Method Detail

getUIComponent

java.lang.Object getUIComponent()

getUIComponent returns the UI component that represents this interactor. For example, if the UI is Swing, the returned component would be a Swing component such as a JPanel.

Returns:

an Object value that is the UI component to be rendered.

getSocketElement

IUISocketElement getSocketElement()

getSocketElement returns the interactor's bound socket element.

Returns:

an IUISocketElement value; the bound socket element.

setSocketElement

void setSocketElement(IUISocketElement socketElement)

setIUISocketElement sets the interactor's bound socket element.

Parameters:

socketElement - the socket element that is to be bound to this interactor.

setNavindex

void setNavindex(int i)

Sets the navindex for this interactor. The navindex is used for determining tabbing order in the interactor's UI.

Parameters:

i - an int value indicating this interactor's place in the tabbing order.

setID

void setID(java.lang.String id)

Set this interactor's ID.

Parameters:

id - a String value indicating this interactor's ID.

setWidget

void setWidget(Widget w)

Sets this interactor's renderable widget to the value specified.

Parameters:

w - a Widget value that is the renderable UI component of this interactor.

setRootElement

void setRootElement(org.w3c.dom.Element rootElement)

Sets the root element of this interactor for parsing purposes. Must be a valid interactor element tag.

Parameters:

rootElement - a Element object that represents the XML element.

parse

void parse()
           throws UrcException

Parses the interactor starting from the root element (specified by called setRootElement).

Throws:

UrcException

getNavindex

int getNavindex()

Returns the int value indicating this interactor's navindex (set by setNavindex).

Returns:

int indicating this interactor's navindex (set by setNavindex).