com.goldencode.p2j.ui.client.driver

Interface WidgetFactory<O extends OutputManager<?>>

All Known Implementing Classes:

ChuiWidgetFactory, GuiWidgetFactory, WidgetFactoryAdapter

public interface WidgetFactory<O extends OutputManager<?>>

This interface provides access to driver-specific widget factory necessary to hide from client-level code implementations of driver-specific widgets.

Method Summary

Modifier and Type	Method and Description
void	addWidgetClass(java.lang.Class<? extends WidgetConfig> cfgClass, java.lang.Class<? extends Widget> widgetFace, java.lang.Class<? extends Widget> widgetImpl) Registers a widget interface class and implementation class with a particular widget configuration.
<T extends Widget<O>> T	create(java.lang.Class<T> clazz, WidgetId id, WidgetConfig cfg) Instantiate UI-specific version of the specified widget class.
AlertBox<O>	createAlertBox(int alertType, java.lang.Object[] content, int buttonSet, logical var, java.lang.String title, Color color, java.lang.String[] stack) Create UI-specific AlertBox instance.
BorderedPanel<O>	createBorderedPanel() Creates new instance of BorderedPanel with BorderLayout as the layout manager and no border.
BorderedPanel<O>	createBorderedPanel(LayoutManager<O> mgr, Border<O> border) Creates new instance of BorderedPanel with a specific layout manager and border.
Button<O>	createButton(WidgetId id, Container<O> container, java.lang.String text) Create new button for given container and text.
DropDown<O>	createDropDown(ComboBox<O> parent) Create UI-specific DropDown implementation.
AbstractFileChooserDialog	createFileSystemChooserDialog(java.lang.String title, int parentWindow, boolean dir) Creates a new instance of a dialog that allows the user to navigate and choose a file-system entity.
Image<O>	createImage(WidgetId id) Create UI-specific Image instance.
ClientDrivenLabel<O>	createLabel(WidgetId id, ClientDrivenLabel<O> labelInstance, int frameId) Create UI-specific ClientDrivenLabel instance as a copy of given ClientDrivenLabel.
ClientDrivenLabel<O>	createLabel(WidgetId id, java.lang.String text, int frameId) Create new ClientDrivenLabel instance for given text.
Border<O>	createLineBorder() Creates new instance representing a default line border.
BorderedPanel<O>	createLineBorderedPanel() Creates new instance of BorderedPanel with BorderLayout layout manager and simple border of width 1 measured in native units.
MessageArea<O>	createMessageArea(WidgetId id, int lines) Create UI-specific MessageArea instance.
MnemonicInfo	createMnemonic() Create an object accumulating prepared label and mnemonic info.
RadioButton<O>	createRadioButton(RadioSetConfig config, java.lang.String label, BaseDataType value) Create UI-specific RadioButton instance.
Rect<O>	createRectangle(WidgetId id, Container<O> container) Create new rectangle for given container.
ScrollableList<O>	createScrollableList(ComboBox<O> parent, ListModel<java.lang.String> model) Create UI-specific ScrollableList implementation.
SensitiveScrollContainer<O>	createScrollContainer() Create UI-specific SensitiveScrollContainer implementation.
ScrollPane<O>	createScrollPane(ScrollableWidget<O> widget) Create UI-specific ScrollPane implementation.
ScrollPane<O>	createScrollPane(ScrollableWidget<O> widget, java.util.function.Supplier<TopLevelWindow<O>> wnd) Create UI-specific ScrollPane implementation.
StatusLine<O>	createStatusLine(WidgetId id) Create UI-specific StatusLine instance.
ToggleBox<O>	createToggleBox(WidgetId id, Container<O> container, java.lang.String text) Create new toggle-box for given container and text.
Window<O>	createWindow(WidgetId id) Create UI-specific Window instance.

Method Detail

createMnemonic

MnemonicInfo createMnemonic()

Create an object accumulating prepared label and mnemonic info.

Returns:

new MnemonicInfo instance.

createLabel

ClientDrivenLabel<O> createLabel(WidgetId id,
                                 java.lang.String text,
                                 int frameId)

Create new ClientDrivenLabel instance for given text.

Parameters:

id - The widget's ID.

text - Label text.

frameId - The ID of the frame to which the label belongs, or -1 if unknown at the time of the creation.

Returns:

new ClientDrivenLabel instance.

createButton

Button<O> createButton(WidgetId id,
                       Container<O> container,
                       java.lang.String text)

Create new button for given container and text.

Parameters:

id - The widget's ID.

container - Container to which new instance will belong.

text - Button text.

Returns:

new Button instance.

createToggleBox

ToggleBox<O> createToggleBox(WidgetId id,
                             Container<O> container,
                             java.lang.String text)

Create new toggle-box for given container and text.

Parameters:

id - The widget's ID.

container - Container to which new instance will belong.

text - ToggleBox label text.

Returns:

new ToggleBox instance.

createRectangle

Rect<O> createRectangle(WidgetId id,
                        Container<O> container)

Create new rectangle for given container.

Parameters:

id - The widget's ID.

container - Container to which new instance will belong.

Returns:

new Rect instance.

create

<T extends Widget<O>> T create(java.lang.Class<T> clazz,
                               WidgetId id,
                               WidgetConfig cfg)

Instantiate UI-specific version of the specified widget class.

Type Parameters:

T - Widget abstract class type.

Parameters:

clazz - Widget abstract class for which UI-specific implementation should be instantiated.

id - The widget's ID.

cfg - Widget configuration container.

Returns:

new UI-specific instance of the requested class.

createScrollableList

ScrollableList<O> createScrollableList(ComboBox<O> parent,
                                       ListModel<java.lang.String> model)

Create UI-specific ScrollableList implementation.

Parameters:

parent - Parent ComboBox widget.

model - Scrollable list model.

Returns:

instance of UI-specific implementation of ScrollableList.

createDropDown

DropDown<O> createDropDown(ComboBox<O> parent)

Create UI-specific DropDown implementation.

Parameters:

parent - Parent ComboBox widget.

Returns:

instance of UI-specific implementation of DropDown.

createScrollContainer

SensitiveScrollContainer<O> createScrollContainer()

Create UI-specific SensitiveScrollContainer implementation.

Returns:

instance of UI-specific implementation of SensitiveScrollContainer.

createScrollPane

ScrollPane<O> createScrollPane(ScrollableWidget<O> widget)

Create UI-specific ScrollPane implementation.

Parameters:

widget - Widget which will be scrolled.

Returns:

instance of UI-specific implementation of ScrollPane.

createScrollPane

ScrollPane<O> createScrollPane(ScrollableWidget<O> widget,
                               java.util.function.Supplier<TopLevelWindow<O>> wnd)

Create UI-specific ScrollPane implementation.

Parameters:

widget - Widget which will be scrolled.

wnd - Top-level window supplier.

Returns:

instance of UI-specific implementation of ScrollPane.

createLabel

ClientDrivenLabel<O> createLabel(WidgetId id,
                                 ClientDrivenLabel<O> labelInstance,
                                 int frameId)

Create UI-specific ClientDrivenLabel instance as a copy of given ClientDrivenLabel.

Parameters:

id - The widget's ID.

labelInstance - Source ClientDrivenLabel instance.

frameId - The ID of the frame to which the label belongs, or -1 if unknown at the time of the creation.

Returns:

instance of UI-specific implementation of ClientDrivenLabel.

createRadioButton

RadioButton<O> createRadioButton(RadioSetConfig config,
                                 java.lang.String label,
                                 BaseDataType value)

Create UI-specific RadioButton instance.

Parameters:

config - Parent config.

label - Radio button label.

value - Radio button data type.

Returns:

instance of UI-specific implementation of RadioButton.

createWindow

Window<O> createWindow(WidgetId id)

Create UI-specific Window instance.

Parameters:

id - The widget's ID.

Returns:

instance of UI-specific implementation of Window.

createMessageArea

MessageArea<O> createMessageArea(WidgetId id,
                                 int lines)

Create UI-specific MessageArea instance.

Parameters:

id - The widget's ID.

lines - Number of visible lines in message area.

Returns:

instance of UI-specific implementation of MessageArea.

createStatusLine

StatusLine<O> createStatusLine(WidgetId id)

Create UI-specific StatusLine instance.

Parameters:

id - The widget's ID.

Returns:

instance of UI-specific implementation of StatusLine.

createImage

Image<O> createImage(WidgetId id)

Create UI-specific Image instance.

Parameters:

id - The widget's ID.

Returns:

instance of UI-specific implementation of Image.

createAlertBox

AlertBox<O> createAlertBox(int alertType,
                           java.lang.Object[] content,
                           int buttonSet,
                           logical var,
                           java.lang.String title,
                           Color color,
                           java.lang.String[] stack)

Create UI-specific AlertBox instance.

Parameters:

alertType - One of the ALERT_* constants specifying message type.

content - The list of message text components.

buttonSet - One of the BTN_* constants specifying used button set.

var - The variable to update if not null.

title - The dialog title.

color - Color scheme to use.

stack - Progress stack trace

Returns:

instance of UI-specific implementation of MessageArea.

createBorderedPanel

BorderedPanel<O> createBorderedPanel()

Creates new instance of BorderedPanel with BorderLayout as the layout manager and no border.

Returns:

instance of UI-specific implementation of BorderedPanel.

createLineBorderedPanel

BorderedPanel<O> createLineBorderedPanel()

Creates new instance of BorderedPanel with BorderLayout layout manager and simple border of width 1 measured in native units.

Returns:

instance of UI-specific implementation of BorderedPanel.

createBorderedPanel

BorderedPanel<O> createBorderedPanel(LayoutManager<O> mgr,
                                     Border<O> border)

Creates new instance of BorderedPanel with a specific layout manager and border.

Parameters:

mgr - Layout manager.

border - Border for this widget.

Returns:

instance of UI-specific implementation of BorderedPanel.

createLineBorder

Border<O> createLineBorder()

Creates new instance representing a default line border.

Returns:

instance of UI-specific implementation of Border.

createFileSystemChooserDialog

AbstractFileChooserDialog createFileSystemChooserDialog(java.lang.String title,
                                                        int parentWindow,
                                                        boolean dir)

Creates a new instance of a dialog that allows the user to navigate and choose a file-system entity.

Parameters:

title - The title of the dialog. Optional. If null the dialog will use its default window title.

parentWindow - The id of the window to be parent of the newly created dialog.

dir - If true the dialog returned will be able to select only directories, otherwise the dialog will allow selection of files only.

Returns:

An instance of the dialog for selection of file or directories.

addWidgetClass

void addWidgetClass(java.lang.Class<? extends WidgetConfig> cfgClass,
                    java.lang.Class<? extends Widget> widgetFace,
                    java.lang.Class<? extends Widget> widgetImpl)

Registers a widget interface class and implementation class with a particular widget configuration. Use this method for any non built-in widgets so that create(Class, WidgetId, WidgetConfig) method is capable to instantiate the expected widget implementation.

Parameters:

cfgClass - Widget config class.

widgetFace - Widget interface class.

widgetImpl - Widget implementation class.