com.goldencode.p2j.ui.client

Class AlertBoxCommons<O extends OutputManager<?>>

java.lang.Object

com.goldencode.p2j.ui.client.AlertBoxCommons<O>

All Implemented Interfaces:

ActionListener

public class AlertBoxCommons<O extends OutputManager<?>>
extends java.lang.Object
implements ActionListener

The class provides logic common to all implementations of AlertBox.

Field Summary

Fields

Modifier and Type	Field and Description
private AlertBox<O>	alertBox The related alert box reference.
Color	alertColor Default color scheme.
private Container<O>	buttonsContainer The buttons container.
int	buttonSet The button configuration.
java.lang.Object[]	content Alert box items.
boolean	forceTitleLeftAlign Flag indicating the title must be forced to left-align.
private boolean	inputDone Flag which tracks user input.
logical	result The variable which is being edited.
private java.lang.String	stack The Progress stack trace
private java.util.concurrent.atomic.AtomicBoolean	stackTraceActive Indicates that stack trace dialog is active
WidgetFactory<O>	widgetFactory Cached widget factory reference.

Constructor Summary

Constructors

Constructor and Description
AlertBoxCommons(AlertBox<O> alertBox, Container<O> buttonsContainer, WidgetFactory<O> widgetFactory, java.lang.Object[] content, int buttonSet, logical var, Color color, java.lang.String[] stack) The default constructor.

Method Summary

Modifier and Type	Method and Description
java.lang.String	buildMessageText() Builds a multiline string from the alert box content array.
private Button<O>	createButton(java.lang.String text) Creates and initializes a button widget to be used in the alert box.
private Button<O>	createButton(java.lang.String text, ActionListener listener) Creates and initializes a button widget to be used in the alert box.
private Button<O>	createButton(java.lang.String text, ActionListener listener, int mnemIdx) Creates and initializes a button widget to be used in the alert box.
private Button<O>	createButton(java.lang.String text, int mnemIdx) Creates and initializes a button widget to be used in the alert box.
java.util.List<Button<O>>	createButtonSet() Constructs the alert box button set.
private Widget<O>	createSkip(WidgetRegistry<O> registry, int lines) Create SKIP(n) widget
void	dismiss() Set the result code, hide the dialog and flag input as complete.
boolean	findButton(KeyInput keyEvent) Find the button that matches a passed key event.
int	getDefaultButton() Returns the index of the default button.
logical	getResult() Helper method to get the edited result when finished.
boolean	isDismissed() Returns true when the modal UI element has dismissed (finished its modal input).
void	nextFocus() Move the input focus to the first widget which can receive a focus in the peer container.
void	onAction(ActionEvent action) Action handler to process the AlertBox buttons event.
void	prevFocus() Move the input focus to the last widget which can receive a focus in the peer container.
void	setResult(logical value) Sets the alert-box result value.
private void	showStackTrace() Display dialog with the Progress stack trace

Methods inherited from class java.lang.Object

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

Field Detail

content

public java.lang.Object[] content

Alert box items.

alertColor

public Color alertColor

Default color scheme.

result

public logical result

The variable which is being edited.

buttonSet

public int buttonSet

The button configuration.

forceTitleLeftAlign

public boolean forceTitleLeftAlign

Flag indicating the title must be forced to left-align.

widgetFactory

public WidgetFactory<O extends OutputManager<?>> widgetFactory

Cached widget factory reference.

inputDone

private boolean inputDone

Flag which tracks user input.

alertBox

private AlertBox<O extends OutputManager<?>> alertBox

The related alert box reference.

buttonsContainer

private Container<O extends OutputManager<?>> buttonsContainer

The buttons container.

stack

private final java.lang.String stack

The Progress stack trace

stackTraceActive

private final java.util.concurrent.atomic.AtomicBoolean stackTraceActive

Indicates that stack trace dialog is active

Constructor Detail

AlertBoxCommons

public AlertBoxCommons(AlertBox<O> alertBox,
                       Container<O> buttonsContainer,
                       WidgetFactory<O> widgetFactory,
                       java.lang.Object[] content,
                       int buttonSet,
                       logical var,
                       Color color,
                       java.lang.String[] stack)

The default constructor.

Parameters:

alertBox - The owner instance.

buttonsContainer - The buttons container.

widgetFactory - Reference to widget factory.

content - Array of elements which form alert box content.

buttonSet - Button set type to be constructed for this AlertBox.

var - The variable to be edited. The initial value sets the default button and the resulting value is changed by the user's press of a button.

color - Color scheme to use.

stack - Progress stack trace

Method Detail

onAction

public void onAction(ActionEvent action)

Action handler to process the AlertBox buttons event. Each event changes the return code appropriately.

Specified by:

onAction in interface ActionListener

Parameters:

action - The action event to handle is coming from defined buttons.

dismiss

public void dismiss()

Set the result code, hide the dialog and flag input as complete.

getResult

public logical getResult()

Helper method to get the edited result when finished.

Returns:

The result of the editing operation which was set depending on the pressed button.

setResult

public void setResult(logical value)

Sets the alert-box result value.

Parameters:

value - The result logical value.

isDismissed

public boolean isDismissed()

Returns true when the modal UI element has dismissed (finished its modal input).

Returns:

see above.

createButtonSet

public java.util.List<Button<O>> createButtonSet()

Constructs the alert box button set. Only the required number of buttons are created here. The value of the logical variable being edited determines the default button (true == the first button, false == the second button and for a 3-button dialog, unknown == the third button).

getDefaultButton

public int getDefaultButton()

Returns the index of the default button. The index is compatible with the return value of createButtonSet().

Returns:

Index of the default button.

nextFocus

public void nextFocus()

Move the input focus to the first widget which can receive a focus in the peer container. This is required to handle the situation when the current widget with the focus is the last one within the container and we have to simulate the Progress behavior in which the next focused widget will be the first widget which can receive a focus in a container.

prevFocus

public void prevFocus()

Move the input focus to the last widget which can receive a focus in the peer container. This is required to handle the situation when the current widget with the focus is the first one within the container and we have to simulate the Progress behavior in which the previous focused widget will be the last widget which can receive a focus in a container.

findButton

public boolean findButton(KeyInput keyEvent)

Find the button that matches a passed key event.

Parameters:

keyEvent - Event to check.

Returns:

true if matching button is found and event is processed.

buildMessageText

public java.lang.String buildMessageText()

Builds a multiline string from the alert box content array.

Returns:

See above.

showStackTrace

private void showStackTrace()

Display dialog with the Progress stack trace

createSkip

private Widget<O> createSkip(WidgetRegistry<O> registry,
                             int lines)

Create SKIP(n) widget

Parameters:

registry - widget registry

lines - lines to skip

Returns:

SKIP(n) widget

createButton

private Button<O> createButton(java.lang.String text,
                               ActionListener listener)

Creates and initializes a button widget to be used in the alert box.

Parameters:

text - The button's label

listener - The button's action listener

Returns:

A reference to Button instance.

createButton

private Button<O> createButton(java.lang.String text,
                               ActionListener listener,
                               int mnemIdx)

Creates and initializes a button widget to be used in the alert box.

Parameters:

text - The button's label

listener - The button's action listener

mnemIdx - The mnemonic index within its label; if its value is negative, then the button doesn't have a mnemonic key.

Returns:

A reference to Button instance.

createButton

private Button<O> createButton(java.lang.String text,
                               int mnemIdx)

Creates and initializes a button widget to be used in the alert box.

Parameters:

text - The button's label

mnemIdx - The mnemonic index within its label; if its value is negative, then the button doesn't use a mnemonic.

Returns:

A reference to Button instance.

createButton

private Button<O> createButton(java.lang.String text)

Creates and initializes a button widget to be used in the alert box.

Parameters:

text - The button's label

Returns:

A reference to Button instance.