com.goldencode.p2j.ui.chui

Class AlertBoxImpl

java.lang.Object

com.goldencode.p2j.ui.client.widget.AbstractWidget<O>

com.goldencode.p2j.ui.client.widget.AbstractContainer<O>

com.goldencode.p2j.ui.client.widget.TitledWindow<ChuiOutputManager>

com.goldencode.p2j.ui.chui.AlertBoxImpl

All Implemented Interfaces:

AlertBox<ChuiOutputManager>, IsModal, Container<ChuiOutputManager>, Widget<ChuiOutputManager>, java.awt.event.MouseListener, java.awt.event.MouseMotionListener, java.awt.event.MouseWheelListener, java.util.EventListener

public class AlertBoxImpl
extends TitledWindow<ChuiOutputManager>
implements AlertBox<ChuiOutputManager>

This class is an specific implementation of the AlertBox for CHUI.

Field Summary

Fields

Modifier and Type	Field and Description
private AlertBoxCommons<ChuiOutputManager>	commons Externalized logic.
private static int	INITIAL_HEIGHT Initial AlertBox width.
private static int	INITIAL_WIDTH Initial AlertBox width.
private WidgetFactory<ChuiOutputManager>	widgetFactory Cached widget factory.
private static int	WIDTH_DELTA Width delta - honor the border and a space on each side.

Fields inherited from class com.goldencode.p2j.ui.client.widget.AbstractWidget

listeners, location, mousePtr, nativeInsets, physicalLocation

Constructor Summary

Constructors

Constructor and Description
AlertBoxImpl(java.lang.Object[] content, int buttonSet, logical var, java.lang.String title, Color color, java.lang.String[] stack) Creates a modal dialog with a title and with a frame owner.

Method Summary

Modifier and Type	Method and Description
Widget<ChuiOutputManager>	createGap(WidgetRegistry<ChuiOutputManager> registry) Create effectively invisible widget (the gap) for the stack trace dialog to avoid explicit coordinates' usage TODO: at this moment the layout manager doesn't support this approach.
TitledWindow	createStackTraceWindow(java.lang.String title) Create window for the stack trace
void	dismiss() Let the modal UI element now that it should finish its modal input processing.
void	doLayout() Lay out container.
void	draw() The main AlertBox renderer.
boolean	findButton(KeyInput keyEvent) Find the button that matches a passed key event.
logical	getResult() Helper method to get the edited result when finished.
java.util.List<Widget<ChuiOutputManager>>	getTabItemList() Returns the tab item list for this container that is the same as its widgets list.
void	hide() Hide this widget and remove it.
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	prevFocus() Move the input focus to the last widget which can receive a focus in the peer container.
void	setClipboardSelection() Chui does not support selection.
void	setResult(logical value) Sets the alert-box result value.
void	setVisible(boolean visible) Hide/show widget.

Methods inherited from class com.goldencode.p2j.ui.client.widget.TitledWindow

destroy, destroyWidgets, findMouseSource, focusTraversable, getWorkspaceSize, getZOrderClass, hasFocus, hasTitle, hasTitlebar, isDisplayed, isModal, processEvent, processKeyEvent, screenLocation, setTitle, show, title, toString

Methods inherited from class com.goldencode.p2j.ui.client.widget.AbstractContainer

add, add, add, addContainerStateListener, addDirectly, belongsTo, checkWidget, childrenLocation, clipping, clipRectangle, copyState, currentFocus, currentFocus, cycleFocus, defaultFocus, deregisterSelectedWidget, detach, dimension, dumpCurrentWidgets, dumpWidgets, endSizeChange, findMouseSource, firstFocus, focus, focusWorker, formatDump, get, getAllSelectedWidgets, getClipRect, getEffectiveScrollableSize, getFocusInt, getIgnoreFocus, getLayout, getScrollableSize, hasFocusable, height, insets, lastFocus, minimumSize, moveAfterTabItem, moveBeforeTabItem, moveToBottom, moveToBottomInClass, moveToTop, moveToTopInClass, moveToZpos, normalizeZOrder, onWidgetAdded, onWidgetRemoved, paintOnTop, parentOf, prepareWidgets, reflectAncestorChange, reflectLocationChanged, registerSelectedWidget, remove, removeContainerStateListener, repaint, replace, requestFocus, requestFocus, setFocus, setFocusInt, setHeight, setIgnoreFocus, setInsets, setLayout, setPhysicalDimensionInt, setSize, setSize, setTabItemList, setWidth, startSizeChange, swap, triggerContainerStateRedrawEnabled, unrealize, updateSizeWorker, widgets, widgetsAsList, widgetStateChanged, width

Methods inherited from class com.goldencode.p2j.ui.client.widget.AbstractWidget

_setHidden, _setVisible, activateDirectManipulation, addFocusListener, addKeyListener, afterConfigUpdateBase, ancestor, ancestorId, autoResize, bounds, clear, clearWidget, clipRectangle, clipRectangle, clipWith, config, copyColors, createMouseHoverAction, deactivateDirectManipulation, debug, disable, disableTooltip, displayPhysicalLocation, drawCaret, enable, enableTooltip, enclosingFrame, forceCursorOnFocus, forceVisibility, getActualBounds, getAndResetBitmap, getAndSetBitmap, getBitmapCopy, getCachedScreenLocation, getCachedScreenPhysicalLocation, getCustomMousePointer, getDefaultEvent, getEffectiveMousePointer, getId, getLoadedMousePointer, getMenuMouse, getMouseActions, getMousePosition, getPortableMouseEventCoordinates, getSelectedText, getState, getTextHeight, getTextHeightNative, getTextHeightNative, getTextWidth, getTextWidth, getTextWidthNative, getTextWidthNative, getVisiblePart, hasFocus, hasTooltip, hidden, highlighted, ignoreAction, initialHeight, initialWidth, isCurrent, isDirectManipulationActive, isDirectManipulationActiveOrInUIB, isDirectManipulationCapable, isDirectManipulationRequired, isEnabled, isFocusable, isHeader, isMouseDrag, isRealized, isRepaintDisabled, isRMBEntrySupported, isScreenLocationCached, isTabStop, isThreeD, isTotallyObscured, isVisible, isVisible, location, manageSystemActions, mouseActions, mouseClicked, mouseDragged, mouseEntered, mouseExited, mouseMoved, mousePressed, mouseReleased, mouseWheelMoved, moveToBottom, moveToTop, name, navigable, oleDoDrop, oleDrag, oleDragging, oleStartDragging, onOleDragging, onOleDropEnd, parent, parent, parentObject, parentOrSelf, parentOrSelfObject, physicalBounds, physicalDimension, physicalLocation, postprocessConfig, prepParentLocation, preventFocusWhenMouseDownEventDefined, processDirectManipulationEvent, processFocusEvent, processKeyEventForSelectableWidget, processKeyListeners, processMnemonic, processMnemonicImpl, processSystemKey, raiseLegacyMouseEvents, reflectSizeChanged, refresh, registerWidgetListener, repaint, repaint, requestSync, resetBitmap, resizeTo, resolveFont, resolvePopupMenuId, resolveTitleFont, screen, screenDimension, screenHeight, screenPhysicalLocation, screenWidth, setBitmap, setCachedScreenLocation, setCachedScreenPhysicalLocation, setDirectManipulationActive, setEnabled, setHidden, setHighlighted, setLocation, setLocation, setMousePointer, setMousePointer, setParent, setPhysicalLocation, setSensitiveForUIB, setState, setWindow, showPopupMenu, supportsCustomMousePointer, sync, topLevelWindow, translate, triggerLocationChanged, unregisterWidgetListener, updateSystemParent, widgetRealized, window

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.goldencode.p2j.ui.client.widget.Container

add, add, add, addContainerStateListener, childrenLocation, clipping, currentFocus, currentFocus, defaultFocus, detach, endSizeChange, firstFocus, focus, get, getClipRect, getIgnoreFocus, getLayout, hasFocusable, insets, lastFocus, moveAfterTabItem, moveBeforeTabItem, moveToBottom, moveToBottomInClass, moveToTop, moveToTopInClass, moveToZpos, parentOf, remove, removeContainerStateListener, replace, setFocus, setHeight, setIgnoreFocus, setInsets, setLayout, setSize, setSize, setWidth, startSizeChange, widgets, widgetsAsList, widgetsAsList

Methods inherited from interface com.goldencode.p2j.ui.client.widget.Widget

acceptsEscAsAnyKey, acceptTrigger, addFocusListener, addKeyListener, ancestor, ancestorId, bounds, canMovetoTop, clearWidget, completeTrigger, config, defaultMousePtr, destroy, dimension, displayPhysicalLocation, drawCaret, enclosingFrame, enforceDefaultMousePtr, findMouseSource, focusTraversable, forceCursorOnFocus, forceVisibility, getActualBounds, getCustomMousePointer, getEffectiveMousePointer, getId, getIdForTrigger, getLegacyWidget, getLoadedMousePointer, getMenuMouse, getMouseActions, getMousePosition, getSelectedText, getState, getTriggerWidget, getTriggerWidget, getVisiblePart, getZOrderClass, hasFocus, hasFocus, hasTooltip, height, hidden, highlighted, ignoreEnable, initialHeight, initialWidth, isCurrent, isCurrent, isDirectManipulable, isDirectManipulationActive, isDirectManipulationActiveOrInUIB, isDisplayed, isDroppable, isEnabled, isFocusable, isHeader, isInitialValueLayout, isLegacyFocus, isProcessProgressEvent, isRealized, isRepaintDisabled, isRMBEntrySupported, isTabStop, isThreeD, isTotallyObscured, isVisible, isVisible, location, maySwitchFocus, minimumSize, moveToBottom, moveToTop, name, navigable, oleDrag, parent, parent, parent, parentObject, parentOrSelf, parentOrSelfObject, physicalBounds, physicalDimension, physicalLocation, postprocessConfig, preventFocusWhenMouseDownEventDefined, processDirectManipulationEvent, processEvent, processFocusEvent, processKeyEvent, processKeyListeners, processMnemonic, raiseLegacyMouseEvents, refreshWidget, registerWidgetListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocus, requestSync, resizeTo, resolvePopupMenuId, screen, screenLocation, screenPhysicalLocation, setDirectManipulationActive, setEnabled, setHidden, setHighlighted, setLocation, setLocation, setMousePointer, setMousePointer, setParent, setPhysicalLocation, setSensitiveForUIB, setState, setWindow, show, startTrigger, supportsCustomMousePointer, systemFocusGrabbed, topLevelWindow, unrealize, unregisterWidgetListener, validateDisplayValue, widgetStateChanged, width, window

Methods inherited from interface java.awt.event.MouseListener

mouseClicked, mouseEntered, mouseExited, mousePressed, mouseReleased

Methods inherited from interface java.awt.event.MouseMotionListener

mouseDragged, mouseMoved

Methods inherited from interface java.awt.event.MouseWheelListener

mouseWheelMoved

Field Detail

WIDTH_DELTA

private static final int WIDTH_DELTA

Width delta - honor the border and a space on each side.

See Also:

Constant Field Values

INITIAL_WIDTH

private static final int INITIAL_WIDTH

Initial AlertBox width.

See Also:

Constant Field Values

INITIAL_HEIGHT

private static final int INITIAL_HEIGHT

Initial AlertBox width.

See Also:

Constant Field Values

commons

private AlertBoxCommons<ChuiOutputManager> commons

Externalized logic.

widgetFactory

private WidgetFactory<ChuiOutputManager> widgetFactory

Cached widget factory.

Constructor Detail

AlertBoxImpl

AlertBoxImpl(java.lang.Object[] content,
             int buttonSet,
             logical var,
             java.lang.String title,
             Color color,
             java.lang.String[] stack)

Creates a modal dialog with a title and with a frame owner. This constructor creates an AlertBox with a message body which is represented by a content array. The alert box can contain a user defined button set and the specified title. Each line of the message including any number of empty lines (skip) are elements of the content array. Text elements of the content array must be strings. In addition, there may be any number of skip elements which are encoded as a Java Integer instance where the integral value is equivalent to the number of lines to skip.

The value of the var being edited determines the default button (true is the first button, false is the second button and for a 3-button dialog, unknown is the third button).

The result of the user's selection can be read via getResult(). The mapping of the result value to a button follows the same mapping as used for setting the default button (see above).

Parameters:

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.

title - AlertBox title to be rendered at the top of the one line border.

color - Color scheme to use.

stack - Progress stack trace

Method Detail

setVisible

public void setVisible(boolean visible)

Hide/show widget.

If the alert box is being shown and not yet attached to a window, attached it to the default window.

Specified by:

setVisible in interface Widget<ChuiOutputManager>

Overrides:

setVisible in class AbstractWidget<ChuiOutputManager>

Parameters:

visible - New visible state.

doLayout

public void doLayout()

Lay out container.

Specified by:

doLayout in interface Container<ChuiOutputManager>

Overrides:

doLayout in class AbstractContainer<ChuiOutputManager>

draw

public void draw()

The main AlertBox renderer. Draws the contents of the AlertBox and requests the focus to the one of the button within the container.

Specified by:

draw in interface Widget<ChuiOutputManager>

Overrides:

draw in class AbstractContainer<ChuiOutputManager>

hide

public void hide()

Hide this widget and remove it.

Specified by:

hide in interface Widget<ChuiOutputManager>

Overrides:

hide in class TitledWindow<ChuiOutputManager>

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.

Specified by:

nextFocus in interface Container<ChuiOutputManager>

Overrides:

nextFocus in class AbstractContainer<ChuiOutputManager>

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.

Specified by:

prevFocus in interface Container<ChuiOutputManager>

Overrides:

prevFocus in class AbstractContainer<ChuiOutputManager>

findButton

public boolean findButton(KeyInput keyEvent)

Find the button that matches a passed key event.

Specified by:

findButton in interface AlertBox<ChuiOutputManager>

Parameters:

keyEvent - Event to check.

Returns:

true if matching button is found and event is processed.

setResult

public void setResult(logical value)

Sets the alert-box result value.

Specified by:

setResult in interface AlertBox<ChuiOutputManager>

Parameters:

value - The result logical value.

dismiss

public void dismiss()

Let the modal UI element now that it should finish its modal input processing.

Specified by:

dismiss in interface IsModal

isDismissed

public boolean isDismissed()

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

Specified by:

isDismissed in interface IsModal

Returns:

see above.

getResult

public logical getResult()

Helper method to get the edited result when finished.

Specified by:

getResult in interface AlertBox<ChuiOutputManager>

Returns:

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

getTabItemList

public java.util.List<Widget<ChuiOutputManager>> getTabItemList()

Returns the tab item list for this container that is the same as its widgets list.

Specified by:

getTabItemList in interface Container<ChuiOutputManager>

Overrides:

getTabItemList in class AbstractContainer<ChuiOutputManager>

Returns:

The tab item list.

createStackTraceWindow

public TitledWindow createStackTraceWindow(java.lang.String title)

Create window for the stack trace

Specified by:

createStackTraceWindow in interface AlertBox<ChuiOutputManager>

Parameters:

title - window title

Returns:

window for the stack trace

createGap

public Widget<ChuiOutputManager> createGap(WidgetRegistry<ChuiOutputManager> registry)

Create effectively invisible widget (the gap) for the stack trace dialog to avoid explicit coordinates' usage TODO: at this moment the layout manager doesn't support this approach.

Specified by:

createGap in interface AlertBox<ChuiOutputManager>

Parameters:

registry - widget registry

Returns:

the gap widget

setClipboardSelection

public void setClipboardSelection()

Chui does not support selection.

Specified by:

setClipboardSelection in interface AlertBox<ChuiOutputManager>