com.goldencode.p2j.ui.client.gui

Class WindowTitleBar

java.lang.Object

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

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

com.goldencode.p2j.ui.client.gui.WindowTitleBar

All Implemented Interfaces:

Container<GuiOutputManager>, Widget<GuiOutputManager>, WidgetWithConfig<BaseConfig>, ConfigOwner<BaseConfig>, java.awt.event.MouseListener, java.awt.event.MouseMotionListener, java.awt.event.MouseWheelListener, java.util.EventListener

public class WindowTitleBar
extends AbstractContainer<GuiOutputManager>
implements WidgetWithConfig<BaseConfig>

Implementation of a GUI window title bar. This consists of (from left to right):

• an icon
• a title
• caption buttons

Each element is a specific widget instance.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) class	WindowTitleBar.WindowIcon The window's icon.
private class	WindowTitleBar.WindowTitle The window's title.

Field Summary

Fields

Modifier and Type	Field and Description
private CaptionButton[]	allButtons The full set of window caption buttons
private CaptionButton[]	buttons The displayed caption buttons.
private BaseConfig	config This widget configuration instance.
private boolean	disableSystemMenu When true, the window system menu activated by title right-click is disabled
private GuiDriver	gd The graphics driver.
private GuiFontResolver	gf Font resolver.
(package private) WindowTitleBar.WindowIcon	icon The window's icon.
(package private) WindowTitleBar.WindowTitle	title The window title.
private TitledWindow<?>	wndParent The ancestor window widget.

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

listeners, location, mousePtr, nativeInsets, physicalLocation

Constructor Summary

Constructors

Constructor and Description
WindowTitleBar(WidgetId id, boolean showWindowIcon, CaptionButtonType[] buttonTypes, java.lang.Boolean[] buttonEnabledStates, java.lang.String windowTitle, boolean disableSystemMenu) Custom c'tor.
WindowTitleBar(WidgetId id, java.lang.String windowTitle) Basic c'tor.

Method Summary

Modifier and Type	Method and Description
void	activateTooltips() Activates tooltips for caption buttons.
void	afterConfigUpdate(BaseConfig beforeUpdate) The method is called after the configuration associated with the implementor changes.
BaseConfig	config() Get the widget config.
void	destroy() Destroy this widget.
void	displayButtons(CaptionButtonType[] buttonTypes) Makes the specified buttons visible on the title bar.
void	doLayout() Layout the elements of this title.
void	draw() Draw the title's background.
Widget<GuiOutputManager>	findMouseSource(NativePoint p) Find the widget positioned just bellow the specified mouse position (in physical units).
boolean	focusTraversable() This component will not receive focus when Tab or Shift-Tab is pressed.
void	initialize(WidgetId id, BaseConfig cfg) Replacement API for the logic which should exist in the widget's c'tor, but the logic can't be executed as it depends on the widget being registered into the official registry.
private boolean	isActiveWindow() Determine if the window associated with this bar is the active window.
protected int[]	mouseActions() Determine the mouse actions processed by this widget.
void	mouseClicked(java.awt.event.MouseEvent e) Notification of a mouse clicked event occurred for this widget.
boolean	raiseLegacyMouseEvents() Check if the widget implementation can raise legacy, 4GL-style, mouse events.
(package private) void	registerWindowTitlePopup() Register widgets regions for a right mouse click action and a left mouse click action to open a window title popup widget.
void	setCaptionButtonEnabled(CaptionButtonType button, boolean enabled) Enabled or disables a caption button.
void	setClickHandler(CaptionButtonType button, java.lang.Runnable handler) Sets a click handler for any of the title bar buttons.
java.lang.String	toString() Returns a string representation of the object.
void	update(boolean showWindowIcon, CaptionButtonType[] buttons, java.lang.Boolean[] buttonStates, java.lang.String windowTitle, boolean disableSystemMenu) Modifies the title bar according to the parameters.

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, 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, processKeyEvent, 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, 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, getZOrderClass, hasFocus, hasTooltip, hidden, hide, highlighted, ignoreAction, initialHeight, initialWidth, isCurrent, isDirectManipulationActive, isDirectManipulationActiveOrInUIB, isDirectManipulationCapable, isDirectManipulationRequired, isDisplayed, isEnabled, isFocusable, isHeader, isMouseDrag, isRealized, isRepaintDisabled, isRMBEntrySupported, isScreenLocationCached, isTabStop, isThreeD, isTotallyObscured, isVisible, isVisible, location, manageSystemActions, 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, processEvent, processFocusEvent, processKeyEventForSelectableWidget, processKeyListeners, processMnemonic, processMnemonicImpl, processSystemKey, reflectSizeChanged, refresh, registerWidgetListener, repaint, repaint, requestSync, resetBitmap, resizeTo, resolveFont, resolvePopupMenuId, resolveTitleFont, screen, screenDimension, screenHeight, screenLocation, screenPhysicalLocation, screenWidth, setBitmap, setCachedScreenLocation, setCachedScreenPhysicalLocation, setDirectManipulationActive, setEnabled, setHidden, setHighlighted, setLocation, setLocation, setMousePointer, setMousePointer, setParent, setPhysicalLocation, setSensitiveForUIB, setState, setVisible, setWindow, show, 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

widgetsAsList

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

acceptsEscAsAnyKey, acceptTrigger, addFocusListener, addKeyListener, ancestor, ancestorId, bounds, canMovetoTop, clearWidget, completeTrigger, defaultMousePtr, displayPhysicalLocation, drawCaret, enclosingFrame, enforceDefaultMousePtr, forceCursorOnFocus, forceVisibility, getActualBounds, getCustomMousePointer, getEffectiveMousePointer, getId, getIdForTrigger, getLegacyWidget, getLoadedMousePointer, getMenuMouse, getMouseActions, getMousePosition, getSelectedText, getState, getTriggerWidget, getTriggerWidget, getVisiblePart, getZOrderClass, hasFocus, hasFocus, hasTooltip, hidden, hide, 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, moveToBottom, moveToTop, name, navigable, oleDrag, parent, parent, parent, parentObject, parentOrSelf, parentOrSelfObject, physicalBounds, physicalDimension, physicalLocation, postprocessConfig, preventFocusWhenMouseDownEventDefined, processDirectManipulationEvent, processEvent, processFocusEvent, processKeyListeners, processMnemonic, refreshWidget, registerWidgetListener, repaint, repaint, requestFocus, requestSync, resizeTo, resolvePopupMenuId, screen, screenLocation, screenPhysicalLocation, setDirectManipulationActive, setEnabled, setHidden, setHighlighted, setLocation, setLocation, setMousePointer, setMousePointer, setParent, setPhysicalLocation, setSensitiveForUIB, setState, setVisible, setWindow, show, startTrigger, supportsCustomMousePointer, systemFocusGrabbed, topLevelWindow, unregisterWidgetListener, validateDisplayValue, window

Methods inherited from interface java.awt.event.MouseListener

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

icon

WindowTitleBar.WindowIcon icon

The window's icon.

title

WindowTitleBar.WindowTitle title

The window title.

gd

private final GuiDriver gd

The graphics driver.

gf

private GuiFontResolver gf

Font resolver. Initialized on-demand

allButtons

private CaptionButton[] allButtons

The full set of window caption buttons

buttons

private CaptionButton[] buttons

The displayed caption buttons.

config

private BaseConfig config

This widget configuration instance.

disableSystemMenu

private boolean disableSystemMenu

When true, the window system menu activated by title right-click is disabled

wndParent

private TitledWindow<?> wndParent

The ancestor window widget.

Constructor Detail

WindowTitleBar

public WindowTitleBar(WidgetId id,
                      java.lang.String windowTitle)

Basic c'tor.

Parameters:

id - The widget's ID.

windowTitle - The window title.

WindowTitleBar

public WindowTitleBar(WidgetId id,
                      boolean showWindowIcon,
                      CaptionButtonType[] buttonTypes,
                      java.lang.Boolean[] buttonEnabledStates,
                      java.lang.String windowTitle,
                      boolean disableSystemMenu)

Custom c'tor.

Parameters:

id - The widget's ID.

showWindowIcon - If true the window's window icon will be shown.

buttonTypes - Array of button types to show on the bar.

buttonEnabledStates - The enabled state of each individual button. The order corresponds to the buttonTypes argument.

windowTitle - The window title.

disableSystemMenu - The system menu disable flag.

Method Detail

initialize

public void initialize(WidgetId id,
                       BaseConfig cfg)

Replacement API for the logic which should exist in the widget's c'tor, but the logic can't be executed as it depends on the widget being registered into the official registry.

This API is called after the widget is created and added to the registry.

Specified by:

initialize in interface WidgetWithConfig<BaseConfig>

Parameters:

id - The widget's ID.

cfg - The config used to initialize this widget.

config

public BaseConfig config()

Get the widget config.

Specified by:

config in interface Widget<GuiOutputManager>

Specified by:

config in interface ConfigOwner<BaseConfig>

Overrides:

config in class AbstractWidget<GuiOutputManager>

Returns:

See above.

afterConfigUpdate

public void afterConfigUpdate(BaseConfig beforeUpdate)

The method is called after the configuration associated with the implementor changes. The parameter points to a reference representing the original configuration state. This reference can be used to detect what configuration fields changed and so optimize any processing related to the configuration change.

Specified by:

afterConfigUpdate in interface ConfigOwner<BaseConfig>

Parameters:

beforeUpdate - Config reference capturing the config state before the owner's config was modified.

doLayout

public void doLayout()

Layout the elements of this title. Everything is done in pixel units.

Specified by:

doLayout in interface Container<GuiOutputManager>

Overrides:

doLayout in class AbstractContainer<GuiOutputManager>

displayButtons

public void displayButtons(CaptionButtonType[] buttonTypes)

Makes the specified buttons visible on the title bar. Any buttons already visible and not specified in the input array will be hidden.

Parameters:

buttonTypes - The buttons to make visible.

registerWindowTitlePopup

void registerWindowTitlePopup()

Register widgets regions for a right mouse click action and a left mouse click action to open a window title popup widget. For the Web client it adds required popupable mouse widgets regions and it does nothing for the Swing GUI client.

mouseClicked

public void mouseClicked(java.awt.event.MouseEvent e)

Notification of a mouse clicked event occurred for this widget.

If the widget is not already focused, it forces the focus to it. After the focus was received, it computes the caret location, based on the mouse position over the widget's content.

Specified by:

mouseClicked in interface java.awt.event.MouseListener

Overrides:

mouseClicked in class AbstractWidget<GuiOutputManager>

Parameters:

e - The mouse event.

findMouseSource

public Widget<GuiOutputManager> findMouseSource(NativePoint p)

Find the widget positioned just bellow the specified mouse position (in physical units).

Specified by:

findMouseSource in interface Widget<GuiOutputManager>

Overrides:

findMouseSource in class AbstractContainer<GuiOutputManager>

Parameters:

p - The mouse physical location.

Returns:

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

mouseActions

protected int[] mouseActions()

Determine the mouse actions processed by this widget.

Overrides:

mouseActions in class AbstractWidget<GuiOutputManager>

Returns:

See above.

draw

public void draw()

Draw the title's background.

Specified by:

draw in interface Widget<GuiOutputManager>

Overrides:

draw in class AbstractContainer<GuiOutputManager>

raiseLegacyMouseEvents

public boolean raiseLegacyMouseEvents()

Check if the widget implementation can raise legacy, 4GL-style, mouse events.

Specified by:

raiseLegacyMouseEvents in interface Widget<GuiOutputManager>

Overrides:

raiseLegacyMouseEvents in class AbstractWidget<GuiOutputManager>

Returns:

Always false.

destroy

public void destroy()

Destroy this widget. Notify all of its components that the widget has been destroyed.

Specified by:

destroy in interface Widget<GuiOutputManager>

Overrides:

destroy in class AbstractContainer<GuiOutputManager>

activateTooltips

public void activateTooltips()

Activates tooltips for caption buttons.

setCaptionButtonEnabled

public void setCaptionButtonEnabled(CaptionButtonType button,
                                    boolean enabled)

Enabled or disables a caption button.

Parameters:

button - The button to enable/disable.

enabled - The new enabled state.

setClickHandler

public void setClickHandler(CaptionButtonType button,
                            java.lang.Runnable handler)

Sets a click handler for any of the title bar buttons.

Parameters:

button - Button type.

handler - Click handler.

focusTraversable

public boolean focusTraversable()

This component will not receive focus when Tab or Shift-Tab is pressed.

Specified by:

focusTraversable in interface Widget<GuiOutputManager>

Overrides:

focusTraversable in class AbstractContainer<GuiOutputManager>

Returns:

false

update

public void update(boolean showWindowIcon,
                   CaptionButtonType[] buttons,
                   java.lang.Boolean[] buttonStates,
                   java.lang.String windowTitle,
                   boolean disableSystemMenu)

Modifies the title bar according to the parameters.

Parameters:

showWindowIcon - If true the window's window icon will be shown.

buttons - Array of button types to show on the bar.

buttonStates - The enabled state of each individual button. The order corresponds to the buttons argument.

windowTitle - The window title.

disableSystemMenu - The system menu disable flag.

toString

public java.lang.String toString()

Returns a string representation of the object.

Overrides:

toString in class AbstractWidget<GuiOutputManager>

Returns:

A string representation of the object.

isActiveWindow

private boolean isActiveWindow()

Determine if the window associated with this bar is the active window.

Returns:

See above.