com.goldencode.p2j.ui.client.gui

Class ScrollPaneGuiImpl

java.lang.Object

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

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

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

com.goldencode.p2j.ui.client.gui.ScrollPaneGuiImpl

All Implemented Interfaces:

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

Direct Known Subclasses:

BrowseGuiImpl.ColumnsScrollPane, MessageAreaGuiImpl, WindowWorkSpace

public class ScrollPaneGuiImpl
extends ScrollPane<GuiOutputManager>

A GUI scroll pane implementation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ScrollPaneGuiImpl.ShowBars Container show bars options: AS_NEEDED - Only when needed.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) boolean	both True when have both horizontal and vertical scroll bars
protected GuiColorResolver	gc Color resolver
private GuiDriver	gd Screen driver
private ScrollBarGuiImpl	hBar Horizontal scroll bar
private boolean	horizBarQuirk Flag which activates a 4GL bug, which will not show the horizontal scrollbar, even if forced.
protected Container	intersectionPanel Panel which is drawn in bottom-right corner when at least one scrollbar is visible.
private ScrollPaneGuiImpl.ShowBars	showBars Scroll bars show policy
private ScrollBarGuiImpl	vBar Vertical scroll bar
private Widget	widget child widget
private java.util.Optional<java.util.function.Supplier<TopLevelWindow<GuiOutputManager>>>	wnd top level window supplier

Fields inherited from class com.goldencode.p2j.ui.client.ScrollPane

config, rootPanel

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

listeners, location, mousePtr, nativeInsets, physicalLocation

Constructor Summary

Constructors

Constructor and Description
ScrollPaneGuiImpl(ScrollableWidget<GuiOutputManager> widget) Constructor.
ScrollPaneGuiImpl(ScrollableWidget<GuiOutputManager> widget, java.util.function.Supplier<TopLevelWindow<GuiOutputManager>> wnd) Constructor.

Method Summary

Modifier and Type	Method and Description
protected void	adjustIntersectionPanel() Adjust the size and location of the intersection panel in regard to the visible scroll-bars.
private void	adjustScrollBar(ScrollBar.Orientation orientation, int max, boolean visible) Adjust scroll bar max value.
void	adjustScrollLayout() Adjust the scroll layout for this pane, as scrollbars may have been added/removed.
protected void	adjustScrollLayoutImpl() Adjusts viewport size, scroll bar visibility and positions.
void	afterConfigUpdate(BaseConfig beforeUpdate) The method is called after the configuration associated with the implementor changes.
double	barSize(ScrollBar.Orientation orientation) Get scroll bar size in characters.
int	barSizeNative(ScrollBar.Orientation orientation) Get scroll bar size in pixel units.
Dimension	calcInitialViewportSize() Calculates and returns initial viewport size.
Dimension	calcViewportSizeWithoutScrollbars() Calculates and returns initial viewport size taking into account that scrollbars occupy extra space.
private ScrollBarGuiImpl	createScrollBar(ScrollBar.Orientation orientation) Create scroll bar.
private void	createScrollBars(ScrollBar.Bars bars) Create and attach container scroll bars.
void	draw() Widget drawing method.
void	draw(Widget<GuiOutputManager>[] list) The secondary renderer for this container.
boolean	enforceDefaultMousePtr() Check if the default mouse pointer should be used regardless of the parent settings
MousePtrWrapper	getEffectiveMousePointer() Get the current effective custom mouse pointer
(package private) NativeRectangle	getIntersectionRect() Retrieve the rectangle which should be placed in the bottom-right corner.
java.util.Optional<MousePtrWrapper>	getLoadedMousePointer() Get the Loaded custom mouse pointer if it is set
ScrollBarGuiImpl	getScrollBar(ScrollBar.Orientation orientation) Get the vertical or horizontal scroll bar controlled by this pane.
void	handleScrollEvent(ScrollEvent event) This method is invoked when scroll pane is scrolled.
protected boolean	hasIntersectionPanel() Helper to identify if a custom intersection panel is set.
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.
void	mouseMoved(java.awt.event.MouseEvent e) Notification of a mouse moved event occurred for this widget.
void	mouseReleased(java.awt.event.MouseEvent e) Notification of a mouse released event occurred for this widget.
void	mouseWheelMoved(java.awt.event.MouseWheelEvent e) Notification of a mouse wheel moved event occurred for this widget.
void	setEnabled(boolean enabled) Enable/disable widget.
(package private) void	setHorizBarQuirk(boolean quirk) Flag which activates a 4GL bug, which will not show the horizontal scrollbar, even if forced.
(package private) void	setIntersectionPanel(Container panel) Setter for the intersection panel which is drawn in the bottom-right corner when at least one scroll-bar is visible.
void	setScrollBarController(ScrollBar.Orientation orientation, ScrollBarControllerGuiImpl controller) Set custom controller for one of the scroll bars.
void	setScrollBars(ScrollBar.Bars bars) Set container scroll bars.
void	setShowBars(ScrollPaneGuiImpl.ShowBars showBars) Set show bars policy.
boolean	supportsCustomMousePointer() Check if the widget supports LOAD-MOUSE-POINTER() method
TopLevelWindow<GuiOutputManager>	topLevelWindow() Get ancestor TopLevelWindow for this widget.

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

calcHscroll, calcVscroll, config, doLayout, getBorder, getChild, getRootPanel, initialize, isFocusable, minimumSize, setBorder, setLocation, setSize, viewport

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, destroy, detach, dimension, dumpCurrentWidgets, dumpWidgets, endSizeChange, findMouseSource, firstFocus, focus, focusTraversable, focusWorker, formatDump, get, getAllSelectedWidgets, getClipRect, getEffectiveScrollableSize, getFocusInt, getIgnoreFocus, getLayout, getScrollableSize, getTabItemList, hasFocusable, height, insets, lastFocus, 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, 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, getId, 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, isHeader, isMouseDrag, isRealized, isRepaintDisabled, isRMBEntrySupported, isScreenLocationCached, isTabStop, isThreeD, isTotallyObscured, isVisible, isVisible, location, manageSystemActions, mouseDragged, mouseEntered, mouseExited, mousePressed, 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, raiseLegacyMouseEvents, reflectSizeChanged, refresh, registerWidgetListener, repaint, repaint, requestSync, resetBitmap, resizeTo, resolveFont, resolvePopupMenuId, resolveTitleFont, screen, screenDimension, screenHeight, screenLocation, screenPhysicalLocation, screenWidth, setBitmap, setCachedScreenLocation, setCachedScreenPhysicalLocation, setDirectManipulationActive, setHidden, setHighlighted, setLocation, setMousePointer, setMousePointer, setParent, setPhysicalLocation, setSensitiveForUIB, setState, setVisible, setWindow, show, showPopupMenu, sync, toString, 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, forceCursorOnFocus, forceVisibility, getActualBounds, getCustomMousePointer, getId, getIdForTrigger, getLegacyWidget, 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, 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, raiseLegacyMouseEvents, refreshWidget, registerWidgetListener, repaint, repaint, requestFocus, requestSync, resizeTo, resolvePopupMenuId, screen, screenLocation, screenPhysicalLocation, setDirectManipulationActive, setHidden, setHighlighted, setLocation, setMousePointer, setMousePointer, setParent, setPhysicalLocation, setSensitiveForUIB, setState, setVisible, setWindow, show, startTrigger, systemFocusGrabbed, unregisterWidgetListener, validateDisplayValue, window

Methods inherited from interface java.awt.event.MouseListener

mouseEntered, mouseExited, mousePressed

Methods inherited from interface java.awt.event.MouseMotionListener

mouseDragged

Field Detail

gd

private GuiDriver gd

Screen driver

gc

protected GuiColorResolver gc

Color resolver

hBar

private ScrollBarGuiImpl hBar

Horizontal scroll bar

vBar

private ScrollBarGuiImpl vBar

Vertical scroll bar

showBars

private ScrollPaneGuiImpl.ShowBars showBars

Scroll bars show policy

intersectionPanel

protected Container intersectionPanel

Panel which is drawn in bottom-right corner when at least one scrollbar is visible.

both

boolean both

True when have both horizontal and vertical scroll bars

widget

private final Widget widget

child widget

wnd

private final java.util.Optional<java.util.function.Supplier<TopLevelWindow<GuiOutputManager>>> wnd

top level window supplier

horizBarQuirk

private boolean horizBarQuirk

Flag which activates a 4GL bug, which will not show the horizontal scrollbar, even if forced.

Constructor Detail

ScrollPaneGuiImpl

public ScrollPaneGuiImpl(ScrollableWidget<GuiOutputManager> widget)

Constructor.

Parameters:

widget - Child widget.

ScrollPaneGuiImpl

public ScrollPaneGuiImpl(ScrollableWidget<GuiOutputManager> widget,
                         java.util.function.Supplier<TopLevelWindow<GuiOutputManager>> wnd)

Constructor.

Parameters:

widget - Child widget.

wnd - TopLevelWindow supplier

Method Detail

adjustScrollLayout

public void adjustScrollLayout()

Adjust the scroll layout for this pane, as scrollbars may have been added/removed. All repaint events will be discarded.

draw

public void draw()

Widget drawing method.

Specified by:

draw in interface Widget<GuiOutputManager>

Specified by:

draw in class ScrollPane<GuiOutputManager>

getScrollBar

public ScrollBarGuiImpl getScrollBar(ScrollBar.Orientation orientation)

Get the vertical or horizontal scroll bar controlled by this pane.

Parameters:

orientation - Which scroll bar to get.

Returns:

requested scroll bar.

setScrollBarController

public void setScrollBarController(ScrollBar.Orientation orientation,
                                   ScrollBarControllerGuiImpl controller)

Set custom controller for one of the scroll bars.

Parameters:

orientation - Orientation of the target scroll bar.

controller - Custom controller for the scroll bar.

draw

public void draw(Widget<GuiOutputManager>[] list)

The secondary renderer for this container. Draws the child container. Note that this routine assumes that it is invoked from Frame class.

Specified by:

draw in class ScrollPane<GuiOutputManager>

Parameters:

list - Array of components to draw.

setEnabled

public void setEnabled(boolean enabled)

Enable/disable widget.

Specified by:

setEnabled in interface Widget<GuiOutputManager>

Overrides:

setEnabled in class AbstractWidget<GuiOutputManager>

Parameters:

enabled - New enabled state.

setScrollBars

public void setScrollBars(ScrollBar.Bars bars)

Set container scroll bars.

Overrides:

setScrollBars in class ScrollPane<GuiOutputManager>

Parameters:

bars - Scroll bars.

setShowBars

public void setShowBars(ScrollPaneGuiImpl.ShowBars showBars)

Set show bars policy.

Parameters:

showBars - Show bars policy.

mouseReleased

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

Notification of a mouse released event occurred for this widget. No-op by default.

Specified by:

mouseReleased in interface java.awt.event.MouseListener

Overrides:

mouseReleased in class AbstractWidget<GuiOutputManager>

Parameters:

e - The mouse event.

mouseClicked

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

Notification of a mouse clicked event occurred for this widget. No-op by default.

Specified by:

mouseClicked in interface java.awt.event.MouseListener

Overrides:

mouseClicked in class AbstractWidget<GuiOutputManager>

Parameters:

e - The mouse event.

mouseMoved

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

Notification of a mouse moved event occurred for this widget.

Specified by:

mouseMoved in interface java.awt.event.MouseMotionListener

Overrides:

mouseMoved in class AbstractWidget<GuiOutputManager>

Parameters:

e - The mouse event.

mouseWheelMoved

public void mouseWheelMoved(java.awt.event.MouseWheelEvent e)

Notification of a mouse wheel moved event occurred for this widget. No-op by default.

Specified by:

mouseWheelMoved in interface java.awt.event.MouseWheelListener

Overrides:

mouseWheelMoved in class AbstractWidget<GuiOutputManager>

Parameters:

e - The mouse event.

getEffectiveMousePointer

public MousePtrWrapper getEffectiveMousePointer()

Get the current effective custom mouse pointer

Specified by:

getEffectiveMousePointer in interface Widget<GuiOutputManager>

Overrides:

getEffectiveMousePointer in class AbstractWidget<GuiOutputManager>

Returns:

the current effective custom mouse pointer

getLoadedMousePointer

public java.util.Optional<MousePtrWrapper> getLoadedMousePointer()

Get the Loaded custom mouse pointer if it is set

Specified by:

getLoadedMousePointer in interface Widget<GuiOutputManager>

Overrides:

getLoadedMousePointer in class AbstractWidget<GuiOutputManager>

Returns:

the loaded custom mouse pointer if it is set

enforceDefaultMousePtr

public boolean enforceDefaultMousePtr()

Check if the default mouse pointer should be used regardless of the parent settings

Returns:

true if the default mouse pointer should always be used

supportsCustomMousePointer

public boolean supportsCustomMousePointer()

Check if the widget supports LOAD-MOUSE-POINTER() method

Specified by:

supportsCustomMousePointer in interface Widget<GuiOutputManager>

Overrides:

supportsCustomMousePointer in class AbstractWidget<GuiOutputManager>

Returns:

true if the widget supports LOAD-MOUSE-POINTER() method

topLevelWindow

public TopLevelWindow<GuiOutputManager> topLevelWindow()

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

Specified by:

topLevelWindow in interface Widget<GuiOutputManager>

Overrides:

topLevelWindow in class AbstractWidget<GuiOutputManager>

Returns:

ancestor TopLevelWindow.

Throws:

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

afterConfigUpdate

public void afterConfigUpdate(BaseConfig beforeUpdate)

The method is called after the configuration associated with the implementor changes. If the parent of this widget is an instance of SelectionListGuiImpl, then activate/deactivate direct manipulation. Otherwise call the default method from superclass.

Specified by:

afterConfigUpdate in interface ConfigOwner<BaseConfig>

Overrides:

afterConfigUpdate in class ScrollPane<GuiOutputManager>

Parameters:

beforeUpdate - Configuration before update

mouseActions

protected int[] mouseActions()

Determine the mouse actions processed by this widget.

Overrides:

mouseActions in class AbstractWidget<GuiOutputManager>

Returns:

See above.

handleScrollEvent

public void handleScrollEvent(ScrollEvent event)

This method is invoked when scroll pane is scrolled.

Specified by:

handleScrollEvent in interface ScrollListener

Overrides:

handleScrollEvent in class ScrollPane<GuiOutputManager>

Parameters:

event - Event which triggered this call.

calcInitialViewportSize

public Dimension calcInitialViewportSize()

Calculates and returns initial viewport size. The method doesn't consider scroll bars and always returns the full viewport size.

Overrides:

calcInitialViewportSize in class ScrollPane<GuiOutputManager>

Returns:

Initial viewport dimension.

calcViewportSizeWithoutScrollbars

public Dimension calcViewportSizeWithoutScrollbars()

Calculates and returns initial viewport size taking into account that scrollbars occupy extra space.

Returns:

The viewport dimension without scrollbars.

barSizeNative

public int barSizeNative(ScrollBar.Orientation orientation)

Get scroll bar size in pixel units.

Parameters:

orientation - Scroll bar orientation.

Returns:

see above

adjustScrollLayoutImpl

protected void adjustScrollLayoutImpl()

Adjusts viewport size, scroll bar visibility and positions.

setHorizBarQuirk

void setHorizBarQuirk(boolean quirk)

Flag which activates a 4GL bug, which will not show the horizontal scrollbar, even if forced.

Parameters:

quirk - The bug's state.

setIntersectionPanel

void setIntersectionPanel(Container panel)

Setter for the intersection panel which is drawn in the bottom-right corner when at least one scroll-bar is visible.

Parameters:

panel - The panel widget to be drawn in the bottom-right corner.

hasIntersectionPanel

protected boolean hasIntersectionPanel()

Helper to identify if a custom intersection panel is set.

Returns:

true if an intersection panel was set.

getIntersectionRect

NativeRectangle getIntersectionRect()

Retrieve the rectangle which should be placed in the bottom-right corner. This rectangle is either the empty space generated at the intersection of the two scrollbars or a custom panel set to be drawn when one scrollbar is visible.

Returns:

A rectangle which holds the dimension of the intersection or null if no space should be reserved in the bottom-right corner.

adjustScrollBar

private void adjustScrollBar(ScrollBar.Orientation orientation,
                             int max,
                             boolean visible)

Adjust scroll bar max value.

Parameters:

orientation - Scroll bar orientation.

max - Max value.

visible - The new visibility state.

barSize

public double barSize(ScrollBar.Orientation orientation)

Get scroll bar size in characters.

Parameters:

orientation - Scroll bar orientation.

Returns:

see above

adjustIntersectionPanel

protected void adjustIntersectionPanel()

Adjust the size and location of the intersection panel in regard to the visible scroll-bars.

createScrollBars

private void createScrollBars(ScrollBar.Bars bars)

Create and attach container scroll bars.

Parameters:

bars - Scroll bars.

createScrollBar

private ScrollBarGuiImpl createScrollBar(ScrollBar.Orientation orientation)

Create scroll bar.

Parameters:

orientation - Scroll bar orientation.

Returns:

Scroll bar.