com.goldencode.p2j.ui.client

Class TopLevelWindow<O extends OutputManager<?>>

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

Type Parameters:

O - the type of output manager

All Implemented Interfaces:

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

Direct Known Subclasses:

ModalWindow, OverlayWindow, Window

public abstract class TopLevelWindow<O extends OutputManager<?>>
extends OuterFrame<O>

The class represents a top-level window, that is a window that sits at the top of widget hierarchy (it has no parent), has its own independent screen, a possible window caption, etc.

A top level window may exist on a "desktop" spanning multiple physical screen devices. These screen devices form a virtual device and common coordinate system with origin at top-left corner of the primary screen. Depending on the location of the primary screen in the virtual device, negative coordinates are possible.

To determine bounds of the physical screen a window is positioned on call GuiDriver.getDisplayBounds(int). These bounds are needed for example when positioning the window relative to the top-left corner of the physical screen.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TopLevelWindow.IconDataType Data type passing as initial window icon.

Field Summary

Fields

Modifier and Type	Field and Description
private static byte[]	iconDef Default window icon.
private boolean	lastLeaveResult LEAVE event result after window deactivated.
private java.util.Optional<TopLevelWindow<O>>	owner The owner of this window.
private FramePlacementManager	placementManager Frame placement manager.

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

listeners, location, mousePtr, nativeInsets, physicalLocation

Constructor Summary

Constructors

Constructor and Description
TopLevelWindow() Default constructor.
TopLevelWindow(java.lang.String title) Constructs a window widget with title.

Method Summary

Modifier and Type	Method and Description
void	addFrame(Widget<O> widget, double row, double column) Adds the frame to the window at the specified position.
TitledWindow<O>	ancestor() Get ancestor window for this widget.This method must be called only for widgets that are already attached to Window.
Rectangle	bounds() Get widget bounding rectangle.
protected NativeRectangle	clipRectangle() Build widget clipped rectangle.
void	close() The method hides the window if visible and then destroys it by the means of calling TitledWindow.destroy() method.
Widget<O>	defaultFocus() Replacement method for AbstractContainer.defaultFocus() implementation which takes into account that frames are listed in reverse order by the means of Z-order (i.e. topmost window is last in the list).
void	findFrames(java.util.List<Frame<?>> list, Rectangle rect, boolean full, boolean redirected) Collect all frames which are intersected with specified rectangle into provided list.
void	findFrames(java.util.List<Frame<?>> list, Rectangle rect, boolean full, boolean redirected, boolean special) Collect all frames which are intersected with specified rectangle into provided list.
abstract Container<O>	getContentPane() Get window content pane.
Frame<?>	getFirstVisibleFrame() Gets the first frame from the list of currently displayed frames.
java.util.List<Frame<O>>	getFrames() Returns the frames contained in this top-level window.
Frame<?>	getNextEnabledFrame(Frame<?> frame) Get the first enabled, visible frame, in z-order, after the specified frame.
Frame<?>	getNextVisibleFrame(Frame<?> frame) Gets the frame from the list of currently displayed frames that immediately follows the specified frame.
TopLevelWindow<O>	getOwner() Returns the owner.
java.util.Optional<TopLevelWindow<O>>	getOwnerOpt() Returns the owner as Optional.
FramePlacementManager	getPlacementManager() Get the FramePlacementManager associated with this window.
Frame<?>	getPrevEnabledFrame(Frame<?> frame) Get the first enabled, visible frame, in z-order, before the specified frame.
abstract WidgetLocationRef	getRelativeTo() Returns the widget location relativity.
abstract Dimension	getScreenDimension() Get dimension of screen area available for the placement of frames.
WindowTitleBar	getTitleBar() Get the title bar widget associated witn this window.
Frame<?>	getTopFrame(boolean ignoreState) Returns the frame that is on top of the Z-order or null if no such frame present.
Frame<?>	getTopVisibleFrame() Get top visible frame.
static byte[]	getWindowDefaultIcon() Sets the default window icon for all new windows on the client side.
boolean	isFocusable() Checks whether this attribute container can receive focus generally.
boolean	isLastLeaveResult() Check the window's lastLeaveResult state.
boolean	isMaximized() Check if the window is already maximized - it can't be resized.
boolean	isMinimized() Check if the window is minimized.
boolean	loadWindowIcon(boolean small, java.lang.String name) Loads the new application icon for given window from the client side filesystem.
boolean	parentOrSelfHidden() Check if the current window or one of its ancestors is hidden.
NativeRectangle	physicalBounds() Determine the physical bounds, relative to screen, expressed in units native to UI type.
void	processFocusEvent(FocusEvent event) Process focus event.
void	reflectLocationChanged() Called when the widget's location changes.
void	repaint() For windows, repaint must use the window's top-left corner (0,0) as origin, not the screen's.
void	repaintDecorations() Repaints window's decorations (titlebar with its components and window's border).
void	resetMousePointer() Reset the custom mouse pointer.
int	resolveTitleFont() Resolve the font associated with the window's title.
Point	screenLocation() Get absolute location of widget in screen coordinates.
NativePoint	screenPhysicalLocation() Get absolute location of widget in screen coordinates.
void	setLastLeaveResult(boolean lastLeaveResult) Set the window's lastLeaveResult state.
protected void	setOwner(TopLevelWindow<O> owner) Sets the owner window.
static boolean	setWindowDefaultIcon(TopLevelWindow.IconDataType type, java.lang.Object data) Sets the default window icon for all new windows on the client side.
boolean	setWindowIcon(boolean small, byte[] newIcon) Sets the new application icon for given window on the client side.
boolean	setWindowIcon(byte[] newIcon) Sets the new application icon for given window on the client side.
Window<O>	window() Get ancestor Window for this widget.

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

draw, drawInt

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

destroy, destroyWidgets, findMouseSource, focusTraversable, getWorkspaceSize, getZOrderClass, hasFocus, hasTitle, hasTitlebar, hide, isDisplayed, isModal, processEvent, processKeyEvent, 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, 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, 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, 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, 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, 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.widget.Container

widgetsAsList

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

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

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

iconDef

private static byte[] iconDef

Default window icon.

owner

private java.util.Optional<TopLevelWindow<O extends OutputManager<?>>> owner

The owner of this window.

lastLeaveResult

private boolean lastLeaveResult

LEAVE event result after window deactivated.

placementManager

private FramePlacementManager placementManager

Frame placement manager.

Constructor Detail

TopLevelWindow

public TopLevelWindow()

Default constructor.

TopLevelWindow

public TopLevelWindow(java.lang.String title)

Constructs a window widget with title.

Parameters:

title - Window title.

Method Detail

getOwner

public TopLevelWindow<O> getOwner()

Returns the owner.

Returns:

See above.

getOwnerOpt

public java.util.Optional<TopLevelWindow<O>> getOwnerOpt()

Returns the owner as Optional.

Returns:

See above.

getRelativeTo

public abstract WidgetLocationRef getRelativeTo()

Returns the widget location relativity.

Returns:

See above.

getTitleBar

public WindowTitleBar getTitleBar()

Get the title bar widget associated witn this window.

Returns:

See above.

setWindowDefaultIcon

public static boolean setWindowDefaultIcon(TopLevelWindow.IconDataType type,
                                           java.lang.Object data)

Sets the default window icon for all new windows on the client side.

Parameters:

type - Data type for second parameter.

data - Data to create new icon on client side. Can be the byte array, filename string or nothing for predefined icon from p2j.jar client side file.

Returns:

TRUE if operation successful FALSE otherwise.

screenLocation

public Point screenLocation()

Get absolute location of widget in screen coordinates.

Specified by:

screenLocation in interface Widget<O extends OutputManager<?>>

Overrides:

screenLocation in class TitledWindow<O extends OutputManager<?>>

Returns:

absolute widget location.

screenPhysicalLocation

public NativePoint screenPhysicalLocation()

Get absolute location of widget in screen coordinates. The result is in native units.

Specified by:

screenPhysicalLocation in interface Widget<O extends OutputManager<?>>

Overrides:

screenPhysicalLocation in class AbstractWidget<O extends OutputManager<?>>

Returns:

absolute widget location.

bounds

public Rectangle bounds()

Get widget bounding rectangle.

For windows, the boundary starts from (0,0) regardless where is placed on screen.

Specified by:

bounds in interface Widget<O extends OutputManager<?>>

Overrides:

bounds in class AbstractWidget<O extends OutputManager<?>>

Returns:

bounding rectangle.

physicalBounds

public NativeRectangle physicalBounds()

Determine the physical bounds, relative to screen, expressed in units native to UI type.

For windows, the boundary starts from (0,0) regardless where is placed on screen.

Specified by:

physicalBounds in interface Widget<O extends OutputManager<?>>

Overrides:

physicalBounds in class AbstractWidget<O extends OutputManager<?>>

Returns:

See above.

resetMousePointer

public void resetMousePointer()

Reset the custom mouse pointer. Simulates the native win32 WM_SETCURSOR message processing.

repaintDecorations

public void repaintDecorations()

Repaints window's decorations (titlebar with its components and window's border).

getContentPane

public abstract Container<O> getContentPane()

Get window content pane.

Returns:

content pane.

addFrame

public void addFrame(Widget<O> widget,
                     double row,
                     double column)

Adds the frame to the window at the specified position.

Parameters:

widget - The handle of the frame to be added to the window.

row - The row number for the upper-left frame corner.

column - The column number for the upper-left frame corner.

getScreenDimension

public abstract Dimension getScreenDimension()

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

Returns:

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

getFrames

public java.util.List<Frame<O>> getFrames()

Returns the frames contained in this top-level window. If no frames then the result is an empty list.

Returns:

See above.

getNextVisibleFrame

public Frame<?> getNextVisibleFrame(Frame<?> frame)

Gets the frame from the list of currently displayed frames that immediately follows the specified frame.

Parameters:

frame - frame that designates the starting point

Returns:

the next frame in the list or null

getFirstVisibleFrame

public Frame<?> getFirstVisibleFrame()

Gets the first frame from the list of currently displayed frames.

Returns:

the first frame in the list or null

getTopFrame

public Frame<?> getTopFrame(boolean ignoreState)

Returns the frame that is on top of the Z-order or null if no such frame present. If requested method also can filter out all invisible, disabled and out of scope frames.

Parameters:

ignoreState - if true then ignore frame state during search.

Returns:

The topmost active frame or null.

getNextEnabledFrame

public Frame<?> getNextEnabledFrame(Frame<?> frame)

Get the first enabled, visible frame, in z-order, after the specified frame. The found frame must have at least one enabled, visible widget.

If no frame is specified, it will get the bottommost enabled and visible frame.

Parameters:

frame - Reference frame. When null, it will return the bottommost enabled and visible frame.

Returns:

Next enabled frame, above this frame, in z-order, or null if no such frame exists.

getPrevEnabledFrame

public Frame<?> getPrevEnabledFrame(Frame<?> frame)

Get the first enabled, visible frame, in z-order, before the specified frame. The found frame must have at least one enabled, visible widget.

If no frame is specified, it will get the bottommost enabled and visible frame.

Parameters:

frame - Reference frame. When null, it will return the topmost enabled and visible frame.

Returns:

Previous enabled frame, below this frame, in z-order, or null if no such frame exists.

getTopVisibleFrame

public Frame<?> getTopVisibleFrame()

Get top visible frame.

Returns:

reference to top visible frame or null if there is no such frame.

setWindowIcon

public boolean setWindowIcon(byte[] newIcon)

Sets the new application icon for given window on the client side.

Parameters:

newIcon - A new icon image array data.

Returns:

TRUE if operation successful FALSE otherwise.

setWindowIcon

public boolean setWindowIcon(boolean small,
                             byte[] newIcon)

Sets the new application icon for given window on the client side.

Parameters:

small - Flag indicating usage of the small icon case(16x16 in size).

newIcon - A new icon image array data.

Returns:

TRUE if operation successful FALSE otherwise.

loadWindowIcon

public boolean loadWindowIcon(boolean small,
                              java.lang.String name)

Loads the new application icon for given window from the client side filesystem.

Parameters:

small - Flag indicating usage of the small icon case(16x16 in size).

name - The fully qualified file name for the icon to be loaded.

Returns:

TRUE if operation successful FALSE otherwise.

getWindowDefaultIcon

public static byte[] getWindowDefaultIcon()

Sets the default window icon for all new windows on the client side.

Returns:

The byte array to construct the default window icon.

isMaximized

public boolean isMaximized()

Check if the window is already maximized - it can't be resized.

Returns:

This implementation always returns false.

isMinimized

public boolean isMinimized()

Check if the window is minimized.

Returns:

If minimized returns true, false otherwise.

resolveTitleFont

public int resolveTitleFont()

Resolve the font associated with the window's title.

Overrides:

resolveTitleFont in class AbstractWidget<O extends OutputManager<?>>

Returns:

See above.

window

public Window<O> window()

Get ancestor Window for this widget. This method must be called only for widgets that are already attached to Window.

Specified by:

window in interface Widget<O extends OutputManager<?>>

Overrides:

window in class AbstractWidget<O extends OutputManager<?>>

Returns:

ancestor Window.

Throws:

java.lang.IllegalStateException - When this widget is not attached to window.

ancestor

public TitledWindow<O> ancestor()

Get ancestor window for this widget.This method must be called only for widgets that are already attached to Window.

Specified by:

ancestor in interface Widget<O extends OutputManager<?>>

Overrides:

ancestor in class AbstractWidget<O extends OutputManager<?>>

Returns:

ancestor Window.

Throws:

java.lang.IllegalStateException - When this widget is not attached to window.

repaint

public void repaint()

For windows, repaint must use the window's top-left corner (0,0) as origin, not the screen's.

Specified by:

repaint in interface Widget<O extends OutputManager<?>>

Overrides:

repaint in class AbstractContainer<O extends OutputManager<?>>

defaultFocus

public Widget<O> defaultFocus()

Replacement method for AbstractContainer.defaultFocus() implementation which takes into account that frames are listed in reverse order by the means of Z-order (i.e. topmost window is last in the list).

Specified by:

defaultFocus in interface Container<O extends OutputManager<?>>

Overrides:

defaultFocus in class AbstractContainer<O extends OutputManager<?>>

Returns:

default focusable widget.

isFocusable

public boolean isFocusable()

Checks whether this attribute container can receive focus generally.

Specified by:

isFocusable in interface Widget<O extends OutputManager<?>>

Overrides:

isFocusable in class AbstractWidget<O extends OutputManager<?>>

Returns:

true if this container can be focused under certain conditions. false if, and only if, this attribute container can never receive focus.

parentOrSelfHidden

public boolean parentOrSelfHidden()

Check if the current window or one of its ancestors is hidden.

Returns:

true if this window or one of its ancestors is hidden.

close

public void close()

The method hides the window if visible and then destroys it by the means of calling TitledWindow.destroy() method. Both operations are enqueued on the OS event queue, this allows all pending events to be processed before the window is closed.

processFocusEvent

public void processFocusEvent(FocusEvent event)

Process focus event.

Specified by:

processFocusEvent in interface Widget<O extends OutputManager<?>>

Overrides:

processFocusEvent in class AbstractWidget<O extends OutputManager<?>>

Parameters:

event - Event to process.

findFrames

public void findFrames(java.util.List<Frame<?>> list,
                       Rectangle rect,
                       boolean full,
                       boolean redirected)

Collect all frames which are intersected with specified rectangle into provided list.

Parameters:

list - List where frames will be stored.

rect - Bounding rectangle.

full - If true collect all frames. Otherwise frames with OVERLAY option are excluded.

redirected - If in redirected mode, return only redirected frames. Else, return only the interactive frames.

findFrames

public void findFrames(java.util.List<Frame<?>> list,
                       Rectangle rect,
                       boolean full,
                       boolean redirected,
                       boolean special)

Collect all frames which are intersected with specified rectangle into provided list.

Parameters:

list - List where frames will be stored.

rect - Bounding rectangle.

full - If true collect all frames. Otherwise frames with OVERLAY option are excluded.

redirected - If in redirected mode, return only redirected frames. Else, return only the interactive frames.

special - Enable special handling of empty NO-BOX frames.

getPlacementManager

public FramePlacementManager getPlacementManager()

Get the FramePlacementManager associated with this window.

Returns:

The placementManager.

isLastLeaveResult

public boolean isLastLeaveResult()

Check the window's lastLeaveResult state.

Returns:

See above.

setLastLeaveResult

public void setLastLeaveResult(boolean lastLeaveResult)

Set the window's lastLeaveResult state.

Parameters:

lastLeaveResult - The flag's state.

reflectLocationChanged

public void reflectLocationChanged()

Called when the widget's location changes. This allows the subclasses to react on this, for example by notifying the driver.

Overrides:

reflectLocationChanged in class AbstractContainer<O extends OutputManager<?>>

setOwner

protected void setOwner(TopLevelWindow<O> owner)

Sets the owner window.

Parameters:

owner - Reference to the owner window.

clipRectangle

protected NativeRectangle clipRectangle()

Build widget clipped rectangle.

For top-level windows, their boundary always starts from (0,0), and not their physical location on screen.

Overrides:

clipRectangle in class AbstractWidget<O extends OutputManager<?>>

Returns:

see above.