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

Interface DriverWidget<C extends java.lang.Enum>

All Known Implementing Classes:

SignatureDriverWidget, SpreadsheetDriverWidget, SwingHtmlBrowser, WebDriverWidget, WebHtmlBrowser

public interface DriverWidget<C extends java.lang.Enum>

Describes the common APIs required by driver-implemented widgets.

Method Summary

Modifier and Type	Method and Description
void	destroy() Destroy the driver-specific widget.
EmulatedWindowState	getWindow() Get the widget's window.
default java.lang.Object	invokeWidgetCommand(C command, java.lang.Object[] args) Invokes a command on this widget.
default java.lang.Object	invokeWidgetCommand(java.lang.String command, java.lang.Object[] args) Invokes a command on this widget.
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.
default boolean	setWidgetAttribute(java.lang.String attr, java.lang.String val) Set an attribute for a widget implemented at the driver level.
void	setWidgetBounds(NativeRectangle bounds) Updates the driver widget's bounds on the window screen.
void	setWindow(EmulatedWindowState ews) Set the widget's window.

Method Detail

destroy

void destroy()

Destroy the driver-specific widget.

setVisible

void setVisible(boolean visible)

Change the visibility of a driver-implemented widget.

Parameters:

visible - The visibility state.

setEnabled

void setEnabled(boolean enabled)

Change the sensitivity of a driver-implemented widget.

Parameters:

enabled - The enabled state.

setWidgetAttribute

default boolean setWidgetAttribute(java.lang.String attr,
                                   java.lang.String val)

Set an attribute for a widget implemented at the driver level. These are custom attributes which have no counterpart at the FWD client side.

This works only for GUI drivers.

Parameters:

attr - The attribute name.

val - The attribute's value.

Returns:

true if setting this attribute completed.

invokeWidgetCommand

default java.lang.Object invokeWidgetCommand(java.lang.String command,
                                             java.lang.Object[] args)

Invokes a command on this widget.

Parameters:

command - The command to invoke.

args - Optional event arguments.

Returns:

the event return value.

invokeWidgetCommand

default java.lang.Object invokeWidgetCommand(C command,
                                             java.lang.Object[] args)

Invokes a command on this widget. Optional event arguments.

Parameters:

command - The command to invoke.

args -

Returns:

the event return value.

placeWidget

void placeWidget(NativeRectangle bounds)

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

setWidgetBounds

void setWidgetBounds(NativeRectangle bounds)

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.

Parameters:

bounds - The new screen bounds.

setWindow

void setWindow(EmulatedWindowState ews)

Set the widget's window.

Parameters:

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

getWindow

EmulatedWindowState getWindow()

Get the widget's window.

Returns:

See above.