com.goldencode.p2j.ui.client.gui

Class ModalWindow

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<O>

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

com.goldencode.p2j.ui.client.TopLevelWindow<GuiOutputManager>

com.goldencode.p2j.ui.client.gui.ModalWindow

All Implemented Interfaces:

GuiWindow, IsModal, Container<GuiOutputManager>, Widget<GuiOutputManager>, java.awt.event.MouseListener, java.awt.event.MouseMotionListener, java.awt.event.MouseWheelListener, java.util.EventListener

Direct Known Subclasses:

AlertBoxGuiImpl, DialogBoxWindow

public class ModalWindow
extends TopLevelWindow<GuiOutputManager>
implements GuiWindow, IsModal

The class implements GUI modal top level window. When a modal window is visible it blocks user input to all other application windows.

Nested Class Summary

Nested classes/interfaces inherited from class com.goldencode.p2j.ui.client.TopLevelWindow

TopLevelWindow.IconDataType

Field Summary

Fields

Modifier and Type	Field and Description
protected BorderedPanelGuiImpl	contentPane Inner content pane.
protected boolean	destroyInProgress Destroy flag.
private boolean	focusCreatedByKeyboard Flag that indicates if a focus event was created by keyboard in the window.
protected GuiDriver<?,?>	gd Cached GUI driver reference.
private WidgetId	id Window id.
private Widget<GuiOutputManager>	mousePressedSource The last mouse pressed determined for this window.
private boolean	realized Cached realized flag.
private WindowTitleBar	titleBar The title-bar widget for this window.
protected BorderedPanelGuiImpl	windowPane Window outer frame.

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

listeners, location, mousePtr, nativeInsets, physicalLocation

Fields inherited from interface com.goldencode.p2j.ui.client.gui.GuiWindow

ZSCORE_ALWAYS_ON_TOP, ZSCORE_NORMAL, ZSCORE_TOP_ONLY

Constructor Summary

Constructors

Constructor and Description
ModalWindow(java.lang.String title) Default constructor.
ModalWindow(java.lang.String title, TopLevelWindow<GuiOutputManager> owner) Default constructor.

Method Summary

Modifier and Type	Method and Description
CoordinatesConversion	coordinates() Returns the output window's coordinates conversion service.
void	destroy() Destroy this window.
void	doLayout() Lay out container.
void	draw() Draw widget.
Widget<GuiOutputManager>	findMouseSource(MouseEvt evt) Find the widget to which the given mouse event can be applied.
Border<GuiOutputManager>	getBorder() Returns the window's border implementation.
Container<GuiOutputManager>	getClientContentPane() Returns the container where useful client content widgets are placed.
protected GuiColorResolver	getColorResolver() Get the color resolver.
Container<GuiOutputManager>	getContentPane() Get window content pane.
boolean	getFocusCreatedByKeyboard() Getter for the focusCreatedByKeyboard.
MessageAreaGuiImpl	getGuiMessageArea() Get the message area widget associated with this window.
WidgetId	getId() Widget ID.
Dimension	getMaxWorkspaceSize() Get the maximum size of the window workspace area.
MessageArea<GuiOutputManager>	getMessageArea() Get the message area widget associated with this window.
NativeDimension	getMinSize() Returns the window minimum size.
NativePoint	getPortableMouseEventCoordinates(NativePoint point) Get a point to represent the LAST-EVENT:X and LAST-EVENT:Y coordinates.
WidgetLocationRef	getRelativeTo() Returns the widget location relativity.
NativeDimension	getResizedSize() Determine the resized window size.
Dimension	getScreenDimension() Get dimension of screen area available for the placement of frames.
StatusLine<GuiOutputManager>	getStatusArea() Get the status area widget associated with this window.
WindowTitleBar	getTitleBar() Get the title bar widget associated witn this window.
NativeDimension	getWorkspaceNativeSize() Get the native size of the window workspace area.
NativePoint	getWorkspaceScreenLocation() Get the screen location of the window workspace area, in native units.
Dimension	getWorkspaceSize() Get the size of the window workspace area.
int	getZOrderScore() The method returns the window's relative z-order.
boolean	hasDecorations() Determine if this window can have decorations.
boolean	hasTitlebar() Check if window has title bar.
void	hide() Hide window.
boolean	isModal() The method returns true if this represents a modal window.
boolean	isRealized() Returns true when the modal window has been realized.
boolean	isResizeWorkspace() Determine if this window workspace needs to be resized.
boolean	isResizing() Determine if this window is being resized.
void	processEvent(Event event) Process event and dispatch it to specific method.
void	realize() The method realizes this modal window.
void	resizeTo(NativePoint origin, NativeDimension size) Resize the widget to the specified dimensions.
static TopLevelWindow<GuiOutputManager>	resolveOwner() Returns the expected owner of a modal window.
void	setColorResolver(GuiColorResolver resolver) Sets color resolved for the modal window.
void	setFocusCreatedByKeyboard(boolean focusCreatedByKeyboard) Setter for focusCreatedByKeyboard.
void	setSize(double width, double height) Set container size.
void	setWorkspaceLocation(int x, int y) Sets the window workspace location.
void	setWorkspaceNativeSize(int width, int height) Sets the native size of the window workspace area.
void	show() Show window.

Methods inherited from class com.goldencode.p2j.ui.client.TopLevelWindow

addFrame, ancestor, bounds, clipRectangle, close, defaultFocus, findFrames, findFrames, getFirstVisibleFrame, getFrames, getNextEnabledFrame, getNextVisibleFrame, getOwner, getOwnerOpt, getPlacementManager, getPrevEnabledFrame, getTopFrame, getTopVisibleFrame, getWindowDefaultIcon, isFocusable, isLastLeaveResult, isMaximized, isMinimized, loadWindowIcon, parentOrSelfHidden, physicalBounds, processFocusEvent, reflectLocationChanged, repaint, repaintDecorations, resetMousePointer, resolveTitleFont, screenLocation, screenPhysicalLocation, setLastLeaveResult, setOwner, setWindowDefaultIcon, setWindowIcon, setWindowIcon, window

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

drawInt

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

destroyWidgets, focusTraversable, getZOrderClass, hasFocus, hasTitle, isDisplayed, processKeyEvent, setTitle, 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, deregisterSelectedWidget, detach, dimension, dumpCurrentWidgets, dumpWidgets, endSizeChange, findMouseSource, firstFocus, focus, focusWorker, formatDump, get, getAllSelectedWidgets, getClipRect, getEffectiveScrollableSize, getFocusInt, getIgnoreFocus, getLayout, getScrollableSize, getTabItemList, hasFocusable, height, insets, lastFocus, minimumSize, moveAfterTabItem, moveBeforeTabItem, moveToBottom, moveToBottomInClass, moveToTop, moveToTopInClass, moveToZpos, nextFocus, normalizeZOrder, onWidgetAdded, onWidgetRemoved, paintOnTop, parentOf, prepareWidgets, prevFocus, reflectAncestorChange, registerSelectedWidget, remove, removeContainerStateListener, replace, requestFocus, requestFocus, setFocus, setFocusInt, setHeight, setIgnoreFocus, setInsets, setLayout, setPhysicalDimensionInt, 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, ancestorId, autoResize, clear, clearWidget, 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, getLoadedMousePointer, getMenuMouse, getMouseActions, getMousePosition, getSelectedText, getState, getTextHeight, getTextHeightNative, getTextHeightNative, getTextWidth, getTextWidth, getTextWidthNative, getTextWidthNative, getVisiblePart, hasFocus, hasTooltip, hidden, highlighted, ignoreAction, initialHeight, initialWidth, isCurrent, isDirectManipulationActive, isDirectManipulationActiveOrInUIB, isDirectManipulationCapable, isDirectManipulationRequired, isEnabled, isHeader, isMouseDrag, 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, physicalDimension, physicalLocation, postprocessConfig, prepParentLocation, preventFocusWhenMouseDownEventDefined, processDirectManipulationEvent, processKeyEventForSelectableWidget, processKeyListeners, processMnemonic, processMnemonicImpl, processSystemKey, raiseLegacyMouseEvents, reflectSizeChanged, refresh, registerWidgetListener, repaint, repaint, requestSync, resetBitmap, resizeTo, resolveFont, resolvePopupMenuId, screen, screenDimension, screenHeight, screenWidth, setBitmap, setCachedScreenLocation, setCachedScreenPhysicalLocation, setDirectManipulationActive, setEnabled, setHidden, setHighlighted, setLocation, setLocation, setMousePointer, setMousePointer, setParent, setPhysicalLocation, setSensitiveForUIB, setState, setVisible, setWindow, showPopupMenu, supportsCustomMousePointer, sync, topLevelWindow, translate, triggerLocationChanged, unregisterWidgetListener, updateSystemParent, widgetRealized

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.gui.GuiWindow

close, iconify, isDesktopMinimized, isMaximized, isMinimized, isShareActivationWithOwner, loadWindowIcon, maximize, resizeTo, resolveTitleFont, restore, setLocation, setPhysicalLocation, setWindowIcon

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

acceptsEscAsAnyKey, acceptTrigger, addFocusListener, addKeyListener, ancestor, ancestorId, bounds, canMovetoTop, clearWidget, completeTrigger, config, defaultMousePtr, dimension, displayPhysicalLocation, drawCaret, enclosingFrame, enforceDefaultMousePtr, findMouseSource, focusTraversable, forceCursorOnFocus, forceVisibility, getActualBounds, getCustomMousePointer, getEffectiveMousePointer, getIdForTrigger, getLegacyWidget, getLoadedMousePointer, getMenuMouse, getMouseActions, getMousePosition, getSelectedText, getState, getTriggerWidget, getTriggerWidget, getVisiblePart, getZOrderClass, hasFocus, hasFocus, hasTooltip, height, hidden, highlighted, ignoreEnable, initialHeight, initialWidth, insets, isCurrent, isCurrent, isDirectManipulable, isDirectManipulationActive, isDirectManipulationActiveOrInUIB, isDisplayed, isDroppable, isEnabled, isFocusable, isHeader, isInitialValueLayout, isLegacyFocus, isProcessProgressEvent, 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, processFocusEvent, processKeyEvent, processKeyListeners, processMnemonic, raiseLegacyMouseEvents, refreshWidget, registerWidgetListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocus, requestSync, resolvePopupMenuId, screen, screenLocation, screenPhysicalLocation, setDirectManipulationActive, setEnabled, setHidden, setHighlighted, setLocation, setMousePointer, setMousePointer, setParent, setSensitiveForUIB, setState, setVisible, setWindow, 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

Methods inherited from interface com.goldencode.p2j.ui.client.IsModal

dismiss, isDismissed

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

widgetsAsList

Field Detail

id

private WidgetId id

Window id.

windowPane

protected BorderedPanelGuiImpl windowPane

Window outer frame.

contentPane

protected BorderedPanelGuiImpl contentPane

Inner content pane.

titleBar

private WindowTitleBar titleBar

The title-bar widget for this window.

focusCreatedByKeyboard

private boolean focusCreatedByKeyboard

Flag that indicates if a focus event was created by keyboard in the window.

gd

protected GuiDriver<?,?> gd

Cached GUI driver reference.

mousePressedSource

private Widget<GuiOutputManager> mousePressedSource

The last mouse pressed determined for this window.

destroyInProgress

protected boolean destroyInProgress

Destroy flag.

realized

private boolean realized

Cached realized flag.

Constructor Detail

ModalWindow

public ModalWindow(java.lang.String title)

Default constructor.

Parameters:

title - Window title.

ModalWindow

public ModalWindow(java.lang.String title,
                   TopLevelWindow<GuiOutputManager> owner)

Default constructor.

Parameters:

title - Window title.

owner - The owner window.

Throws:

java.lang.IllegalArgumentException - when owner is null.

Method Detail

resolveOwner

public static TopLevelWindow<GuiOutputManager> resolveOwner()

Returns the expected owner of a modal window.

Returns:

a valid TopLevelWindow instance.

processEvent

public void processEvent(Event event)

Process event and dispatch it to specific method.

Specified by:

processEvent in interface Widget<GuiOutputManager>

Overrides:

processEvent in class TitledWindow<GuiOutputManager>

Parameters:

event - Event to process.

hasDecorations

public boolean hasDecorations()

Determine if this window can have decorations.

Specified by:

hasDecorations in interface GuiWindow

Returns:

Always true - all modal windows have decorations, regardless if embedded mode or not.

doLayout

public void doLayout()

Lay out container.

Specified by:

doLayout in interface Container<GuiOutputManager>

Overrides:

doLayout in class AbstractContainer<GuiOutputManager>

getId

public WidgetId getId()

Widget ID.

Specified by:

getId in interface Widget<GuiOutputManager>

Overrides:

getId in class AbstractWidget<GuiOutputManager>

Returns:

see above.

getContentPane

public Container<GuiOutputManager> getContentPane()

Get window content pane.

Specified by:

getContentPane in class TopLevelWindow<GuiOutputManager>

Returns:

content pane.

isModal

public boolean isModal()

The method returns true if this represents a modal window. That is a window that sits on top of other windows and takes exclusive user input.

This implementation always returns true.

Overrides:

isModal in class TitledWindow<GuiOutputManager>

Returns:

See above.

draw

public void draw()

Draw widget.

Specified by:

draw in interface Widget<GuiOutputManager>

Overrides:

draw in class OuterFrame<GuiOutputManager>

isRealized

public boolean isRealized()

Returns true when the modal window has been realized.

Specified by:

isRealized in interface Widget<GuiOutputManager>

Overrides:

isRealized in class AbstractWidget<GuiOutputManager>

Returns:

See above.

getRelativeTo

public WidgetLocationRef getRelativeTo()

Returns the widget location relativity.

Specified by:

getRelativeTo in class TopLevelWindow<GuiOutputManager>

Returns:

See above.

realize

public void realize()

The method realizes this modal window. If the window has been realized, this method is a no-op.

show

public void show()

Show window.

Specified by:

show in interface Widget<GuiOutputManager>

Overrides:

show in class TitledWindow<GuiOutputManager>

hide

public void hide()

Hide window.

Specified by:

hide in interface Widget<GuiOutputManager>

Overrides:

hide in class TitledWindow<GuiOutputManager>

getGuiMessageArea

public MessageAreaGuiImpl getGuiMessageArea()

Get the message area widget associated with this window.

Specified by:

getGuiMessageArea in interface GuiWindow

Returns:

See above.

resizeTo

public void resizeTo(NativePoint origin,
                     NativeDimension size)

Resize the widget to the specified dimensions.

Specified by:

resizeTo in interface GuiWindow

Parameters:

origin - The top-left window corner new position.

size - The new window size.

coordinates

public CoordinatesConversion coordinates()

Returns the output window's coordinates conversion service.

Specified by:

coordinates in interface GuiWindow

Returns:

a reference to the CoordinatesConversion instance.

setSize

public void setSize(double width,
                    double height)

Set container size.

Specified by:

setSize in interface GuiWindow

Specified by:

setSize in interface Container<GuiOutputManager>

Overrides:

setSize in class AbstractContainer<GuiOutputManager>

Parameters:

width - New width.

height - New height.

isResizing

public boolean isResizing()

Determine if this window is being resized.

Specified by:

isResizing in interface GuiWindow

Returns:

This implementation always returns false.

isResizeWorkspace

public boolean isResizeWorkspace()

Determine if this window workspace needs to be resized.

Specified by:

isResizeWorkspace in interface GuiWindow

Returns:

This implementation always returns false.

getResizedSize

public NativeDimension getResizedSize()

Determine the resized window size.

Specified by:

getResizedSize in interface GuiWindow

Returns:

The new size.

hasTitlebar

public boolean hasTitlebar()

Check if window has title bar. This should return true for GUI window even if the title length is zero.

Overrides:

hasTitlebar in class TitledWindow<GuiOutputManager>

Returns:

true if window has title to repaint.

getTitleBar

public WindowTitleBar getTitleBar()

Get the title bar widget associated witn this window.

Specified by:

getTitleBar in interface GuiWindow

Overrides:

getTitleBar in class TopLevelWindow<GuiOutputManager>

Returns:

See above.

getMessageArea

public MessageArea<GuiOutputManager> getMessageArea()

Get the message area widget associated with this window.

Specified by:

getMessageArea in interface GuiWindow

Returns:

Always null, as modal windows don't have a message area.

getStatusArea

public StatusLine<GuiOutputManager> getStatusArea()

Get the status area widget associated with this window.

Specified by:

getStatusArea in interface GuiWindow

Returns:

See above.

getWorkspaceSize

public Dimension getWorkspaceSize()

Get the size of the window workspace area.

Overrides:

getWorkspaceSize in class TitledWindow<GuiOutputManager>

Returns:

See above.

getWorkspaceScreenLocation

public NativePoint getWorkspaceScreenLocation()

Get the screen location of the window workspace area, in native units.

Specified by:

getWorkspaceScreenLocation in interface GuiWindow

Returns:

See above.

getWorkspaceNativeSize

public NativeDimension getWorkspaceNativeSize()

Get the native size of the window workspace area.

Specified by:

getWorkspaceNativeSize in interface GuiWindow

Returns:

See above.

setWorkspaceNativeSize

public void setWorkspaceNativeSize(int width,
                                   int height)

Sets the native size of the window workspace area.

Specified by:

setWorkspaceNativeSize in interface GuiWindow

Parameters:

width - New workspace width.

height - New workspace height.

setWorkspaceLocation

public void setWorkspaceLocation(int x,
                                 int y)

Sets the window workspace location.

Specified by:

setWorkspaceLocation in interface GuiWindow

Parameters:

x - The x location.

y - The y location.

getScreenDimension

public Dimension getScreenDimension()

Get dimension of screen area available for the placement of frames.

Specified by:

getScreenDimension in class TopLevelWindow<GuiOutputManager>

Returns:

Instance of Dimension which describes size of the available screen area.

findMouseSource

public Widget<GuiOutputManager> findMouseSource(MouseEvt evt)

Find the widget to which the given mouse event can be applied.

Overrides:

findMouseSource in class TitledWindow<GuiOutputManager>

Parameters:

evt - The mouse event.

Returns:

A widget over which the mouse is positioned or null if none found.

getPortableMouseEventCoordinates

public NativePoint getPortableMouseEventCoordinates(NativePoint point)

Get a point to represent the LAST-EVENT:X and LAST-EVENT:Y coordinates. For modal windows, this returns always null.

Overrides:

getPortableMouseEventCoordinates in class AbstractWidget<GuiOutputManager>

Parameters:

point - The point (relative to the window's top-left corner) for which the coordinates for the portable mouse events are needed.

Returns:

Always null.

destroy

public void destroy()

Destroy this window.

Specified by:

destroy in interface Widget<GuiOutputManager>

Overrides:

destroy in class TitledWindow<GuiOutputManager>

getMaxWorkspaceSize

public Dimension getMaxWorkspaceSize()

Get the maximum size of the window workspace area.

Specified by:

getMaxWorkspaceSize in interface GuiWindow

Returns:

See above.

getMinSize

public NativeDimension getMinSize()

Returns the window minimum size.

Specified by:

getMinSize in interface GuiWindow

Returns:

See above.

getBorder

public Border<GuiOutputManager> getBorder()

Returns the window's border implementation. If null is returned, the window has no border.

Specified by:

getBorder in interface GuiWindow

Returns:

A border implementation or null.

getZOrderScore

public int getZOrderScore()

The method returns the window's relative z-order. The value is used to compare the expected z-order between two windows and serves as the primary key for the final windows z-ordering.

Specified by:

getZOrderScore in interface GuiWindow

Returns:

The ordinal value that represents the window's relative z-order.

setColorResolver

public void setColorResolver(GuiColorResolver resolver)

Sets color resolved for the modal window. The resolver will be used on the window and content panes.

Parameters:

resolver - The resolves, may be null.

getClientContentPane

public Container<GuiOutputManager> getClientContentPane()

Returns the container where useful client content widgets are placed.

Specified by:

getClientContentPane in interface GuiWindow

Returns:

see above

getFocusCreatedByKeyboard

public boolean getFocusCreatedByKeyboard()

Getter for the focusCreatedByKeyboard.

Specified by:

getFocusCreatedByKeyboard in interface GuiWindow

setFocusCreatedByKeyboard

public void setFocusCreatedByKeyboard(boolean focusCreatedByKeyboard)

Setter for focusCreatedByKeyboard.

Specified by:

setFocusCreatedByKeyboard in interface GuiWindow

Parameters:

focusCreatedByKeyboard - The new value of focusCreatedByKeyboard.

getColorResolver

protected GuiColorResolver getColorResolver()

Get the color resolver.

Returns:

null by default.