com.goldencode.p2j.ui.client.gui

Class GuiWidgetFactory

java.lang.Object

com.goldencode.p2j.ui.client.driver.WidgetFactoryAdapter<GuiOutputManager>

com.goldencode.p2j.ui.client.gui.GuiWidgetFactory

All Implemented Interfaces:

WidgetFactory<GuiOutputManager>

public class GuiWidgetFactory
extends WidgetFactoryAdapter<GuiOutputManager>

GUI-specific widget factory implementation.

The return type for the create APIs is different from the WidgetFactory versions because:

• it avoids adding at the signature the GuiOutputManager type, i.e. instead of using MessageArea<GuiOutputManager> as return type, MessageAreaGuiImpl can be used directly, with the same effect.
• adds an additional protection against incorrect usage of the WidgetFactory implementation classes: if the WidgetFactory implementation class is used explicitly, it prevents accidental mixing of ChUI and GUI widgets (i.e. if used from incorrect location).

Field Summary

Fields inherited from class com.goldencode.p2j.ui.client.driver.WidgetFactoryAdapter

classMap

Constructor Summary

Constructors

Constructor and Description
GuiWidgetFactory()

Method Summary

Modifier and Type	Method and Description
AlertBoxGuiImpl	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<GuiOutputManager>	createBorderedPanel() Creates new instance of BorderedPanel with BorderLayout as the layout manager and no border.
BorderedPanel<GuiOutputManager>	createBorderedPanel(LayoutManager<GuiOutputManager> mgr, Border<GuiOutputManager> border) Creates new instance of BorderedPanel with a specific layout manager and border.
ButtonGuiImpl	createButton(WidgetId id, Container<GuiOutputManager> container, java.lang.String text) Create new button for given container and text.
DropDownGuiImpl	createDropDown(ComboBox<GuiOutputManager> 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.
ImageGuiImpl	createImage(WidgetId id) Create UI-specific Image instance.
LabelGuiImpl	createLabel(WidgetId id, ClientDrivenLabel<GuiOutputManager> labelInstance, int frameId) Create UI-specific ClientDrivenLabel instance as a copy of given ClientDrivenLabel.
LabelGuiImpl	createLabel(WidgetId id, java.lang.String text, int frameId) Create new ClientDrivenLabel instance for given text.
LineBorderGuiImpl	createLineBorder() Creates new instance representing a default line border.
BorderedPanel<GuiOutputManager>	createLineBorderedPanel() Creates new instance of BorderedPanel with BorderLayout layout manager and simple border of width 1 measured in native units.
MessageArea<GuiOutputManager>	createMessageArea(WidgetId id, int lines) Create UI-specific MessageArea instance.
MnemonicInfo	createMnemonic() Create an object accumulating prepared label and mnemonic info.
RadioButtonGuiImpl	createRadioButton(RadioSetConfig config, java.lang.String label, BaseDataType value) Create GUI-specific RadioButton instance.
ScrollableSelectionListGuiImpl	createScrollableList(ComboBox<GuiOutputManager> parent, ListModel<java.lang.String> model) Create UI-specific ScrollableList implementation.
ScrollBarGuiImpl	createScrollBar(WidgetId id, ScrollBar.Orientation orientation, Viewport<GuiOutputManager> viewport) Create UI-specific ScrollBar instance.
SensitiveScrollContainer<GuiOutputManager>	createScrollContainer() Create UI-specific SensitiveScrollContainer implementation.
ScrollPaneGuiImpl	createScrollPane(ScrollableWidget<GuiOutputManager> widget) Create GUI-specific ScrollPane instance.
ScrollPaneGuiImpl	createScrollPane(ScrollableWidget<GuiOutputManager> widget, java.util.function.Supplier<TopLevelWindow<GuiOutputManager>> wnd) Create GUI-specific ScrollPane instance.
StatusLineGuiImpl	createStatusLine(WidgetId id) Create UI-specific StatusLine instance.
WindowGuiImpl	createWindow(WidgetId id) Create UI-specific Window instance.

Methods inherited from class com.goldencode.p2j.ui.client.driver.WidgetFactoryAdapter

addWidgetClass, create, createRectangle, createToggleBox

Methods inherited from class java.lang.Object

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

Constructor Detail

GuiWidgetFactory

public GuiWidgetFactory()

Method Detail

createMnemonic

public MnemonicInfo createMnemonic()

Create an object accumulating prepared label and mnemonic info.

Returns:

new MnemonicInfoGuiImpl instance.

createWindow

public WindowGuiImpl createWindow(WidgetId id)

Create UI-specific Window instance.

Parameters:

id - The widget's ID.

Returns:

An instance of the UI-specific implementation of Window.

createStatusLine

public StatusLineGuiImpl createStatusLine(WidgetId id)

Create UI-specific StatusLine instance.

Parameters:

id - The widget's ID.

Returns:

An instance of the UI-specific implementation of StatusLine.

createMessageArea

public MessageArea<GuiOutputManager> 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.

createImage

public ImageGuiImpl createImage(WidgetId id)

Create UI-specific Image instance.

Specified by:

createImage in interface WidgetFactory<GuiOutputManager>

Overrides:

createImage in class WidgetFactoryAdapter<GuiOutputManager>

Parameters:

id - The widget's ID.

Returns:

instance of UI-specific implementation of Image.

createScrollBar

public ScrollBarGuiImpl createScrollBar(WidgetId id,
                                        ScrollBar.Orientation orientation,
                                        Viewport<GuiOutputManager> viewport)

Create UI-specific ScrollBar instance.

Overrides:

createScrollBar in class WidgetFactoryAdapter<GuiOutputManager>

Parameters:

id - The widget's ID.

orientation - Scroll bar orientation horizontal or vertical.

viewport - Viewport.

Returns:

instance of UI-specific implementation of ScrollBarGuiImpl.

createDropDown

public DropDownGuiImpl createDropDown(ComboBox<GuiOutputManager> parent)

Create UI-specific DropDown implementation.

Parameters:

parent - Parent ComboBox widget.

Returns:

instance of UI-specific implementation of DropDown.

createScrollableList

public ScrollableSelectionListGuiImpl createScrollableList(ComboBox<GuiOutputManager> 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.

createScrollContainer

public SensitiveScrollContainer<GuiOutputManager> createScrollContainer()

Create UI-specific SensitiveScrollContainer implementation.

Returns:

instance of UI-specific implementation of SensitiveScrollContainer.

createScrollPane

public ScrollPaneGuiImpl createScrollPane(ScrollableWidget<GuiOutputManager> widget)

Create GUI-specific ScrollPane instance.

Parameters:

widget - Widget which will be scrolled.

Returns:

instance of GUI-specific implementation of ScrollPaneGuiImpl.

createScrollPane

public ScrollPaneGuiImpl createScrollPane(ScrollableWidget<GuiOutputManager> widget,
                                          java.util.function.Supplier<TopLevelWindow<GuiOutputManager>> wnd)

Create GUI-specific ScrollPane instance.

Parameters:

widget - Widget which will be scrolled.

wnd - TopLevelWindow supplier

Returns:

instance of GUI-specific implementation of ScrollPaneGuiImpl.

createLabel

public LabelGuiImpl createLabel(WidgetId id,
                                ClientDrivenLabel<GuiOutputManager> 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.

createLabel

public LabelGuiImpl 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

public ButtonGuiImpl createButton(WidgetId id,
                                  Container<GuiOutputManager> 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.

createAlertBox

public AlertBoxGuiImpl 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, ignored.

stack - Progress stack trace

Returns:

instance of UI-specific implementation of MessageArea.

createBorderedPanel

public BorderedPanel<GuiOutputManager> createBorderedPanel()

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

Returns:

instance of GUI-specific implementation of BorderedPanel.

createLineBorderedPanel

public BorderedPanel<GuiOutputManager> createLineBorderedPanel()

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

Returns:

instance of GUI-specific implementation of BorderedPanel.

createBorderedPanel

public BorderedPanel<GuiOutputManager> createBorderedPanel(LayoutManager<GuiOutputManager> mgr,
                                                           Border<GuiOutputManager> 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 GUI-specific implementation of BorderedPanel.

createLineBorder

public LineBorderGuiImpl createLineBorder()

Creates new instance representing a default line border.

Returns:

instance of GUI-specific implementation of Border.

createRadioButton

public RadioButtonGuiImpl createRadioButton(RadioSetConfig config,
                                            java.lang.String label,
                                            BaseDataType value)

Create GUI-specific RadioButton instance.

Parameters:

config - Parent config.

label - Radio button label.

value - Radio button data type.

Returns:

instance of GUI-specific implementation of RadioButton.

createFileSystemChooserDialog

public 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.