com.goldencode.p2j.ui.client.gui.driver.web

Class WebDriverWidget<T extends BaseConfig,C extends java.lang.Enum>

java.lang.Object

com.goldencode.p2j.ui.client.gui.driver.web.WebDriverWidget<T,C>

All Implemented Interfaces:

DriverWidget<C>

Direct Known Subclasses:

SignatureDriverWidget, SpreadsheetDriverWidget, WebHtmlBrowser

public abstract class WebDriverWidget<T extends BaseConfig,C extends java.lang.Enum>
extends java.lang.Object
implements DriverWidget<C>

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	visible Cached visibility state
protected GuiWebSocket	websock The web socket.
protected int	widgetId The widget's ID.
protected GuiWebEmulatedWindow	window The widget's window.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	WebDriverWidget(int widgetId, GuiWebSocket websock) Initialize the web component.

Method Summary

Modifier and Type	Method and Description
T	config() Returns widget config.
void	destroy() Destroy the driver-specific widget.
EmulatedWindowState	getWindow() Get the widget's window.
void	placeWidget(NativeRectangle bounds) Place the driver-specific widget at the specified bounds, using the currently selected window.
void	setEnabled(boolean enabled) Change the sensitivity of a driver-implemented widget.
void	setVisible(boolean visible) Change the visibility of a driver-implemented widget.
void	setWidgetBounds(NativeRectangle bounds) Updates the driver widget's bounds on the window screen.
void	setWindow(EmulatedWindowState window) Set the widget's window.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.goldencode.p2j.ui.client.gui.driver.DriverWidget

invokeWidgetCommand, invokeWidgetCommand, setWidgetAttribute

Field Detail

window

protected GuiWebEmulatedWindow window

The widget's window.

widgetId

protected int widgetId

The widget's ID.

websock

protected final GuiWebSocket websock

The web socket.

visible

protected boolean visible

Cached visibility state

Constructor Detail

WebDriverWidget

protected WebDriverWidget(int widgetId,
                          GuiWebSocket websock)

Initialize the web component.

Parameters:

widgetId - The widget's ID.

websock - The web socket.

Method Detail

config

public T config()

Returns widget config.

Returns:

See above.

destroy

public void destroy()

Destroy the driver-specific widget.

Specified by:

destroy in interface DriverWidget<C extends java.lang.Enum>

setVisible

public void setVisible(boolean visible)

Change the visibility of a driver-implemented widget.

Specified by:

setVisible in interface DriverWidget<C extends java.lang.Enum>

Parameters:

visible - The visibility state.

setEnabled

public void setEnabled(boolean enabled)

Change the sensitivity of a driver-implemented widget.

Specified by:

setEnabled in interface DriverWidget<C extends java.lang.Enum>

Parameters:

enabled - The enabled state.

placeWidget

public void placeWidget(NativeRectangle bounds)

Place the driver-specific widget at the specified bounds, using the currently selected window.

Specified by:

placeWidget in interface DriverWidget<C extends java.lang.Enum>

Parameters:

bounds - Widget bounds.

setWidgetBounds

public void setWidgetBounds(NativeRectangle bounds)

Description copied from interface: DriverWidget

Updates the driver widget's bounds on the window screen. These bounds are different from the widget's legacy location and size.

The window screen bounds is the visible portion of the widget in respect to the state of the widget tree. This allows the driver widget to be only partially visible when scrolled out of the visible screen for example.

Specified by:

setWidgetBounds in interface DriverWidget<C extends java.lang.Enum>

Parameters:

bounds - The new screen bounds.

setWindow

public void setWindow(EmulatedWindowState window)

Set the widget's window.

Specified by:

setWindow in interface DriverWidget<C extends java.lang.Enum>

Parameters:

window - The window where to attach. May be null (it will remain detached).

getWindow

public EmulatedWindowState getWindow()

Get the widget's window.

Specified by:

getWindow in interface DriverWidget<C extends java.lang.Enum>

Returns:

See above.