com.goldencode.p2j.ui.client.gui

Class OverlayWindow<TChild extends Widget<GuiOutputManager>>

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.OverlayWindow<TChild>

All Implemented Interfaces:

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

Direct Known Subclasses:

FrameOverlay, MenuOverlayWindow

public class OverlayWindow<TChild extends Widget<GuiOutputManager>>
extends TopLevelWindow<GuiOutputManager>
implements GuiWindow

The class implements GUI top level window that can overlay the main window. Modality feature is disabled unconditionally for this class.

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
private boolean	activateOnShow Flag indicating if the window should be activated when it's shown.
private Container	childParent Stores a reference to a parent container that contains the child widget used to construct this object.
private java.lang.Runnable	destroyingListener The callback called when window is being destroyed.
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 WidgetLocationRef	relativeTo Represents the location relative to which the overlay window is positioned.
protected BorderedPanel<GuiOutputManager>	windowPane Overlay window single content pane.

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
OverlayWindow(TChild child) Default constructor.
OverlayWindow(TChild child, TopLevelWindow<GuiOutputManager> owner) Default constructor .
OverlayWindow(TChild child, TopLevelWindow<GuiOutputManager> owner, WidgetLocationRef relativeTo) Default constructor.
OverlayWindow(TChild child, TopLevelWindow<GuiOutputManager> owner, WidgetLocationRef relativeTo, boolean activateOnShow) 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	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.
TChild	getChild() Returns the child widget instance passed in the constructor.
Container<GuiOutputManager>	getClientContentPane() Returns the container where useful client content widgets are placed.
Container<GuiOutputManager>	getContentPane() Get window content pane.
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.
void	hide() Hide window.
protected boolean	isCloseOnWindowDeactivated() Determines whether the window should be closed when it is deactivated.
boolean	isRealized() Returns true when the overlay window has been realized.
boolean	isResizeWorkspace() Determine if this window workspace needs to be resized.
boolean	isResizing() Determine if this window is being resized.
boolean	isShareActivationWithOwner() This method indicates whether the window shares its activation state with its owner.
void	processEvent(Event event) Process event and dispatch it to specific method.
void	realize() The method realizes this overlay window.
void	resizeTo(NativePoint origin, NativeDimension size) Resize the widget to the specified dimensions.
void	setDestroyingListener(java.lang.Runnable run) Sets the destroying listener.
void	setRelativeTo(WidgetLocationRef relativeTo) Sets the widget location relativity.
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.
protected void	updateLocation() This method updates the location of the overlay 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, hasTitlebar, isDisplayed, isModal, 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, doLayout, 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, getFocusCreatedByKeyboard, iconify, isDesktopMinimized, isMaximized, isMinimized, loadWindowIcon, maximize, resizeTo, resolveTitleFont, restore, setFocusCreatedByKeyboard, 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.widget.Container

widgetsAsList

Field Detail

id

private WidgetId id

Window id.

windowPane

protected BorderedPanel<GuiOutputManager> windowPane

Overlay window single content pane.

gd

protected GuiDriver<?,?> gd

Cached GUI driver reference.

mousePressedSource

private Widget<GuiOutputManager> mousePressedSource

The last mouse pressed determined for this window.

realized

private boolean realized

Cached realized flag.

relativeTo

private WidgetLocationRef relativeTo

Represents the location relative to which the overlay window is positioned.

destroyingListener

private java.lang.Runnable destroyingListener

The callback called when window is being destroyed.

childParent

private Container childParent

Stores a reference to a parent container that contains the child widget used to construct this object.

activateOnShow

private boolean activateOnShow

Flag indicating if the window should be activated when it's shown.

Constructor Detail

OverlayWindow

public OverlayWindow(TChild child)

Default constructor.

Parameters:

child - Widget to put inside the overlay window.

OverlayWindow

public OverlayWindow(TChild child,
                     TopLevelWindow<GuiOutputManager> owner)

Default constructor .

Parameters:

child - Widget to put inside the overlay window.

owner - Window that is the owner of the child widget used inside overlay window.

OverlayWindow

public OverlayWindow(TChild child,
                     TopLevelWindow<GuiOutputManager> owner,
                     WidgetLocationRef relativeTo)

Default constructor.

Parameters:

child - Widget to put inside the overlay window.

owner - Window that is the owner of the child widget used inside overlay window.

relativeTo - Widget location relativity.

OverlayWindow

public OverlayWindow(TChild child,
                     TopLevelWindow<GuiOutputManager> owner,
                     WidgetLocationRef relativeTo,
                     boolean activateOnShow)

Default constructor.

Parameters:

child - Widget to put inside the overlay window.

owner - Window that is the owner of the child widget used inside overlay window.

relativeTo - Widget location relativity.

activateOnShow - Flag indicating if the window should be activated when it is shown.

Method Detail

getChild

public TChild getChild()

Returns the child widget instance passed in the constructor.

Returns:

See above.

hasDecorations

public boolean hasDecorations()

Determine if this window can have decorations.

Specified by:

hasDecorations in interface GuiWindow

Returns:

Always true.

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.

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 overlay window has been realized.

Specified by:

isRealized in interface Widget<GuiOutputManager>

Overrides:

isRealized in class AbstractWidget<GuiOutputManager>

Returns:

See above.

realize

public void realize()

The method realizes this overlay 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>

updateLocation

protected void updateLocation()

This method updates the location of the overlay window.

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.

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 overlay 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 overlay windows, these 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>

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.

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.

isShareActivationWithOwner

public boolean isShareActivationWithOwner()

This method indicates whether the window shares its activation state with its owner. This method allows multiple windows to be considered active simultaneously. Example use cases are the COMBO-BOX drop-down window or menu window. Note that while at the application level we may recognize multiple active windows simultaneously, at the GUI driver level, there is always one active window at a time.

Specified by:

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

setDestroyingListener

public void setDestroyingListener(java.lang.Runnable run)

Sets the destroying listener. The passed in runnable is called when the window is being destroyed, i.e. at the beginning of the destroy process.

Parameters:

run - The callback reference.

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.

getClientContentPane

public Container<GuiOutputManager> getClientContentPane()

Returns the container where useful client content widgets are placed.

Specified by:

getClientContentPane in interface GuiWindow

Returns:

see above

isCloseOnWindowDeactivated

protected boolean isCloseOnWindowDeactivated()

Determines whether the window should be closed when it is deactivated.

Returns:

true if the window should be closed when deactivated, false otherwise.

getRelativeTo

public WidgetLocationRef getRelativeTo()

Returns the widget location relativity.

Specified by:

getRelativeTo in class TopLevelWindow<GuiOutputManager>

Returns:

See above.

setRelativeTo

public void setRelativeTo(WidgetLocationRef relativeTo)

Sets the widget location relativity.

Parameters:

relativeTo - New widget location relativity.