com.goldencode.p2j.ui.chui

Class ChuiWidgetFactory

java.lang.Object

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

com.goldencode.p2j.ui.chui.ChuiWidgetFactory

All Implemented Interfaces:

WidgetFactory<ChuiOutputManager>

public class ChuiWidgetFactory
extends WidgetFactoryAdapter<ChuiOutputManager>

CHUI-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 ChuiOutputManager type, i.e. instead of using Label<ChuiOutputManager> as return type, LabelImpl 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
ChuiWidgetFactory()

Method Summary

Modifier and Type	Method and Description
AlertBoxImpl	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<ChuiOutputManager>	createBorderedPanel() Creates new instance of BorderedPanel with BorderLayout as the layout manager and no border.
BorderedPanel<ChuiOutputManager>	createBorderedPanel(LayoutManager<ChuiOutputManager> mgr, Border<ChuiOutputManager> border) Creates new instance of BorderedPanel with a specific layout manager and border.
ButtonImpl	createButton(WidgetId id, Container<ChuiOutputManager> container, java.lang.String text) Create new button for given container and text.
DropDownImpl	createDropDown(ComboBox<ChuiOutputManager> 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.
LabelImpl	createLabel(WidgetId id, ClientDrivenLabel<ChuiOutputManager> labelInstance, int frameId) Create UI-specific ClientDrivenLabel instance as a copy of given ClientDrivenLabel.
ClientDrivenLabel	createLabel(WidgetId id, java.lang.String text, int frameId) Create new ClientDrivenLabel instance for given text.
LineBorder	createLineBorder() Creates new instance representing a default line border.
BorderedPanel<ChuiOutputManager>	createLineBorderedPanel() Creates new instance of BorderedPanel with BorderLayout layout manager and simple border of width 1 measured in native units.
MessageAreaImpl	createMessageArea(WidgetId id, int lines) Create UI-specific MessageArea instance.
MnemonicInfo	createMnemonic() Create an object accumulating prepared label and mnemonic info.
RadioButtonImpl	createRadioButton(RadioSetConfig config, java.lang.String label, BaseDataType value) Create UI-specific RadioButton instance.
RectangleImpl	createRectangle(WidgetId id, Container<ChuiOutputManager> container) Create new rectangle for given container.
ScrollableListImpl	createScrollableList(ComboBox<ChuiOutputManager> parent, ListModel<java.lang.String> model) Create UI-specific ScrollableList implementation.
SensitiveScrollContainer<ChuiOutputManager>	createScrollContainer() Create UI-specific SensitiveScrollContainer implementation.
ScrollPaneImpl	createScrollPane(ScrollableWidget<ChuiOutputManager> widget) Create UI-specific ScrollPane implementation.
ScrollPaneImpl	createScrollPane(ScrollableWidget<ChuiOutputManager> widget, java.util.function.Supplier<TopLevelWindow<ChuiOutputManager>> wnd) Create UI-specific ScrollPane instance.
StatusLineImpl	createStatusLine(WidgetId id) Create UI-specific StatusLine instance.
ToggleBoxImpl	createToggleBox(WidgetId id, Container<ChuiOutputManager> container, java.lang.String text) Create new toggle-box for given container and text.
WindowChuiImpl	createWindow(WidgetId id) Create UI-specific Window instance.

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

addWidgetClass, create, createImage, createScrollBar

Methods inherited from class java.lang.Object

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

Constructor Detail

ChuiWidgetFactory

public ChuiWidgetFactory()

Method Detail

createMnemonic

public MnemonicInfo createMnemonic()

Create an object accumulating prepared label and mnemonic info.

Returns:

new MnemonicInfo instance.

createLabel

public ClientDrivenLabel 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 ButtonImpl createButton(WidgetId id,
                               Container<ChuiOutputManager> 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

public ToggleBoxImpl createToggleBox(WidgetId id,
                                     Container<ChuiOutputManager> container,
                                     java.lang.String text)

Create new toggle-box for given container and text.

Specified by:

createToggleBox in interface WidgetFactory<ChuiOutputManager>

Overrides:

createToggleBox in class WidgetFactoryAdapter<ChuiOutputManager>

Parameters:

id - The widget's ID.

container - Container to which new instance will belong.

text - Toggle Box text.

Returns:

new ToggleBox instance.

createRectangle

public RectangleImpl createRectangle(WidgetId id,
                                     Container<ChuiOutputManager> container)

Create new rectangle for given container.

Specified by:

createRectangle in interface WidgetFactory<ChuiOutputManager>

Overrides:

createRectangle in class WidgetFactoryAdapter<ChuiOutputManager>

Parameters:

id - The widget's ID.

container - Container to which new instance will belong.

Returns:

new Rect instance.

createDropDown

public DropDownImpl createDropDown(ComboBox<ChuiOutputManager> parent)

Create UI-specific DropDown implementation.

Parameters:

parent - Parent ComboBox widget.

Returns:

instance of UI-specific implementation of DropDown.

createScrollableList

public ScrollableListImpl createScrollableList(ComboBox<ChuiOutputManager> 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<ChuiOutputManager> createScrollContainer()

Create UI-specific SensitiveScrollContainer implementation.

Returns:

instance of UI-specific implementation of SensitiveScrollContainer.

createScrollPane

public ScrollPaneImpl createScrollPane(ScrollableWidget<ChuiOutputManager> widget)

Create UI-specific ScrollPane implementation.

Parameters:

widget - Widget which will be scrolled.

Returns:

instance of UI-specific implementation of ScrollPane.

createScrollPane

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

Create UI-specific ScrollPane instance.

Parameters:

widget - Widget which will be scrolled.

wnd - TopLevelWindow supplier

Returns:

instance of UI-specific implementation of ScrollPane.

createLabel

public LabelImpl createLabel(WidgetId id,
                             ClientDrivenLabel<ChuiOutputManager> 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

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

public WindowChuiImpl createWindow(WidgetId id)

Create UI-specific Window instance.

Parameters:

id - The widget's ID.

Returns:

instance of UI-specific implementation of Window.

createStatusLine

public StatusLineImpl createStatusLine(WidgetId id)

Create UI-specific StatusLine instance.

Parameters:

id - The widget's ID.

Returns:

instance of UI-specific implementation of StatusLine.

createMessageArea

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

createAlertBox

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

public BorderedPanel<ChuiOutputManager> createBorderedPanel()

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

Returns:

instance of ChUI-specific implementation of BorderedPanel.

createLineBorderedPanel

public BorderedPanel<ChuiOutputManager> createLineBorderedPanel()

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

Returns:

instance of ChUI-specific implementation of BorderedPanel.

createBorderedPanel

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

createLineBorder

public LineBorder createLineBorder()

Creates new instance representing a default line border.

Returns:

instance of ChUI-specific implementation of Border.

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.