com.goldencode.p2j.ui.client.gui

Interface GuiWindow

All Superinterfaces:

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

All Known Implementing Classes:

AlertBoxGuiImpl, DialogBoxWindow, FrameOverlay, MenuOverlayWindow, ModalWindow, OverlayWindow, PrintSetupDialog, WindowGuiImpl

public interface GuiWindow
extends Widget<GuiOutputManager>

The interface provides an API for operations related to top level GUI windows.

Field Summary

Fields

Modifier and Type	Field and Description
static byte	ZSCORE_ALWAYS_ON_TOP Relative z-order of a top-level window with ALWAYS-ON-TOP set
static byte	ZSCORE_NORMAL Relative z-order of a regular top-level window
static byte	ZSCORE_TOP_ONLY Relative z-order of a top-level window with TOP-ONLY set

Method Summary

Modifier and Type	Method and Description
void	close() Close this window.
CoordinatesConversion	coordinates() Returns the output window's coordinates conversion service.
Border<GuiOutputManager>	getBorder() Returns the window's border implementation.
Container<GuiOutputManager>	getClientContentPane() Returns the container where useful client content widgets are placed.
default boolean	getFocusCreatedByKeyboard() Getter for the focusCreatedByKeyboard.
MessageAreaGuiImpl	getGuiMessageArea() Get the message area widget associated with this window.
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.
NativeDimension	getResizedSize() Determine the resized window size.
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.
default int	getZOrderScore() The method returns the window's relative z-order.
boolean	hasDecorations() Determine if this window can have decorations.
default void	iconify(boolean postEvent) Iconify the window.
default boolean	isDesktopMinimized() Returns true when the window is in the state "desktop-minimized", that is the window is minimized but its SHOW-IN-TASKBAR attribute is set to false.
boolean	isMaximized() Check if the window is already maximized - it can't be resized.
boolean	isMinimized() Check if the window is minimized.
boolean	isResizeWorkspace() Determine if this window workspace needs to be resized.
boolean	isResizing() Determine if this window is being resized.
default boolean	isShareActivationWithOwner() This method indicates whether the window shares its activation state with its owner.
boolean	loadWindowIcon(boolean small, java.lang.String name) Loads the new application icon for given window from the client side filesystem.
default void	maximize(boolean postEvent) Maximize this window.
void	resizeTo(NativePoint origin, NativeDimension size) Resize the widget to the specified dimensions.
void	resizeTo(NativePoint origin, NativeDimension size, boolean raise) Resize the widget to the specified dimensions.
int	resolveTitleFont() Resolve the font associated with the window's title.
default void	restore(boolean postEvent) Restore the window by raising the WINDOW-RESTORE event.
default void	setFocusCreatedByKeyboard(boolean focusCreatedByKeyboard) Setter for focusCreatedByKeyboard.
void	setLocation(double x, double y) Set window location.
void	setPhysicalLocation(int x, int y) Set window physical location.
void	setSize(double width, double height) Set window size.
boolean	setWindowIcon(byte[] newIcon) Sets the new application icon for given window on the client side.
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.

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, draw, 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, hide, highlighted, ignoreEnable, initialHeight, initialWidth, insets, 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, resolvePopupMenuId, screen, screenLocation, screenPhysicalLocation, setDirectManipulationActive, setEnabled, setHidden, setHighlighted, setLocation, setMousePointer, setMousePointer, setParent, setSensitiveForUIB, setState, setVisible, 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

ZSCORE_ALWAYS_ON_TOP

static final byte ZSCORE_ALWAYS_ON_TOP

Relative z-order of a top-level window with ALWAYS-ON-TOP set

See Also:

Constant Field Values

ZSCORE_TOP_ONLY

static final byte ZSCORE_TOP_ONLY

Relative z-order of a top-level window with TOP-ONLY set

See Also:

Constant Field Values

ZSCORE_NORMAL

static final byte ZSCORE_NORMAL

Relative z-order of a regular top-level window

See Also:

Constant Field Values

Method Detail

resolveTitleFont

int resolveTitleFont()

Resolve the font associated with the window's title.

Returns:

See above.

getGuiMessageArea

MessageAreaGuiImpl getGuiMessageArea()

Get the message area widget associated with this window.

Returns:

See above.

iconify

default void iconify(boolean postEvent)

Iconify the window.

Parameters:

postEvent - When true the method posts the WINDOW-MINIMIZED legacy event, false means no event is posted.

restore

default void restore(boolean postEvent)

Restore the window by raising the WINDOW-RESTORE event.

Parameters:

postEvent - When true the method posts the WINDOW-RESTORED legacy event, false means no event is posted.

maximize

default void maximize(boolean postEvent)

Maximize this window.

Parameters:

postEvent - When true the method posts the WINDOW-MAXIMIZED legacy event, false means no event is posted.

resizeTo

void resizeTo(NativePoint origin,
              NativeDimension size)

Resize the widget to the specified dimensions.

Parameters:

origin - The top-left window corner new position.

size - The new window size.

resizeTo

void resizeTo(NativePoint origin,
              NativeDimension size,
              boolean raise)

Resize the widget to the specified dimensions.

Specified by:

resizeTo in interface Widget<GuiOutputManager>

Parameters:

origin - The top-left window corner new position.

size - The new window size.

raise - Flag indicating if the 4GL WINDOW-RESIZED event needs to be raised.

setWindowIcon

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.

loadWindowIcon

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.

isMaximized

boolean isMaximized()

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

Returns:

If maximized returns true, false otherwise.

isMinimized

boolean isMinimized()

Check if the window is minimized.

Returns:

If minimized returns true, false otherwise.

isDesktopMinimized

default boolean isDesktopMinimized()

Returns true when the window is in the state "desktop-minimized", that is the window is minimized but its SHOW-IN-TASKBAR attribute is set to false.

Returns:

See above.

getFocusCreatedByKeyboard

default boolean getFocusCreatedByKeyboard()

Getter for the focusCreatedByKeyboard.

setFocusCreatedByKeyboard

default void setFocusCreatedByKeyboard(boolean focusCreatedByKeyboard)

Setter for focusCreatedByKeyboard.

Parameters:

focusCreatedByKeyboard - The new value of focusCreatedByKeyboard.

coordinates

CoordinatesConversion coordinates()

Returns the output window's coordinates conversion service.

Returns:

a reference to the CoordinatesConversion instance.

setSize

void setSize(double width,
             double height)

Set window size.

Parameters:

width - New width.

height - New height.

isResizing

boolean isResizing()

Determine if this window is being resized.

Returns:

If being resized returns true, false otherwise.

isResizeWorkspace

boolean isResizeWorkspace()

Determine if this window workspace needs to be resized.

Returns:

The state of the resizing flag.

getResizedSize

NativeDimension getResizedSize()

Determine the resized window size.

Returns:

The new size.

getTitleBar

WindowTitleBar getTitleBar()

Get the title bar widget associated witn this window.

Returns:

See above.

getStatusArea

StatusLine<GuiOutputManager> getStatusArea()

Get the status area widget associated with this window.

Returns:

See above.

getWorkspaceScreenLocation

NativePoint getWorkspaceScreenLocation()

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

Returns:

See above.

getWorkspaceNativeSize

NativeDimension getWorkspaceNativeSize()

Get the native size of the window workspace area.

Returns:

See above.

getMaxWorkspaceSize

Dimension getMaxWorkspaceSize()

Get the maximum size of the window workspace area.

Returns:

See above.

setWorkspaceNativeSize

void setWorkspaceNativeSize(int width,
                            int height)

Sets the native size of the window workspace area.

Parameters:

width - New workspace width.

height - New workspace height.

setWorkspaceLocation

void setWorkspaceLocation(int x,
                          int y)

Sets the window workspace location.

Parameters:

x - The x location.

y - The y location.

close

void close()

Close this window.

getMessageArea

MessageArea<GuiOutputManager> getMessageArea()

Get the message area widget associated with this window.

Returns:

See above.

setLocation

void setLocation(double x,
                 double y)

Set window location. The x value corresponds to COLUMN while y value corresponds to ROW 4GL attribute. Note however that the values are expected to be 0-based.

Specified by:

setLocation in interface Widget<GuiOutputManager>

Parameters:

x - Window COLUMN.

y - Window ROW.

setPhysicalLocation

void setPhysicalLocation(int x,
                         int y)

Set window physical location.

Specified by:

setPhysicalLocation in interface Widget<GuiOutputManager>

Parameters:

x - Widget physical X.

y - Widget physical Y.

getMinSize

NativeDimension getMinSize()

Returns the window minimum size.

Returns:

See above.

isShareActivationWithOwner

default boolean isShareActivationWithOwner()

This method indicates whether the window shares its activation state with its owner. This method allows multiple windows to be considered active simulteniously. 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 simulteniously, at the GUI driver level, there is always one active window at a time.

Returns:

See above.

getBorder

Border<GuiOutputManager> getBorder()

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

Returns:

A border implementation or null.

hasDecorations

boolean hasDecorations()

Determine if this window can have decorations.

Returns:

See above.

getZOrderScore

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

Returns:

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

getClientContentPane

Container<GuiOutputManager> getClientContentPane()

Returns the container where useful client content widgets are placed.

Returns:

see above