com.goldencode.p2j.ui.client.gui

Class MessageAreaGuiImpl

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

com.goldencode.p2j.ui.client.gui.MessageAreaGuiImpl

All Implemented Interfaces:

ScrollListener, MessageArea<GuiOutputManager>, 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 MessageAreaGuiImpl
extends ScrollPaneGuiImpl
implements MessageArea<GuiOutputManager>

GUI message area is a scroll pane widget having a vertical scroll bar and a scrollable list which holds messages.

Nested Class Summary

Nested classes/interfaces inherited from class com.goldencode.p2j.ui.client.gui.ScrollPaneGuiImpl

ScrollPaneGuiImpl.ShowBars

Field Summary

Fields

Modifier and Type	Field and Description
private GuiDriver	gd Screen driver
private GuiFontResolver	gf Font resolver
private int	lines Message area lines
private ScrollableListGuiImpl	list Messages
private static int	MAX_LINES Maximum number of lines in message area
private int	maxTextWidth Message text maximum width in pixels
private Dimension	textDimChars Message text width and height in character units
private WindowGuiImpl	window Ancestor

Fields inherited from class com.goldencode.p2j.ui.client.gui.ScrollPaneGuiImpl

both, gc, intersectionPanel

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
MessageAreaGuiImpl(WidgetId id, int rows) Constructor.

Method Summary

Modifier and Type	Method and Description
private int	addItem(java.lang.String message) Add new item to message list.
private void	addMessage(java.lang.String message) Add a new message text to message area.
void	attach(Window<GuiOutputManager> window) Attach widget to window.
double	calculateMessageAreaHeight() Calculates the height of the Message Area in the characters units.
private void	clearMessages() Clear all messages.
void	clearMessagesNoPause() Clear the message content and make sure that the message area displays the cleared space without pausing.
void	doLayout() Lay out container.
void	draw() Widget drawing method.
boolean	focusTraversable() This component will not receive focus when Tab or Shift-Tab is pressed.
Color[]	getMessageColors() Get all the message colors in this message-area.
int	getMessageLines() Returns the number of screen lines available for message display.
java.lang.String[]	getMessageTexts() Get all the message texts in this message-area.
private int	getTextWidth(java.lang.String text) Get text width.
protected int[]	mouseActions() Determine the mouse actions processed by this widget.
void	setMessageText(java.lang.String[] message, Color[] cs) Shows the new message text.
void	setMessageText(java.lang.String[] msg, Color[] cs, boolean force) Set message main worker routine.
private int	split(java.lang.String text) Split message.

Methods inherited from class com.goldencode.p2j.ui.client.gui.ScrollPaneGuiImpl

adjustIntersectionPanel, adjustScrollLayout, adjustScrollLayoutImpl, afterConfigUpdate, barSize, barSizeNative, calcInitialViewportSize, calcViewportSizeWithoutScrollbars, draw, enforceDefaultMousePtr, getEffectiveMousePointer, getIntersectionRect, getLoadedMousePointer, getScrollBar, handleScrollEvent, hasIntersectionPanel, mouseClicked, mouseMoved, mouseReleased, mouseWheelMoved, setEnabled, setHorizBarQuirk, setIntersectionPanel, setScrollBarController, setScrollBars, setShowBars, supportsCustomMousePointer, topLevelWindow

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

calcHscroll, calcVscroll, config, 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, 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.MessageArea

forceVisibility

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

MAX_LINES

private static final int MAX_LINES

Maximum number of lines in message area

See Also:

Constant Field Values

window

private WindowGuiImpl window

Ancestor

gd

private GuiDriver gd

Screen driver

gf

private GuiFontResolver gf

Font resolver

list

private ScrollableListGuiImpl list

Messages

maxTextWidth

private int maxTextWidth

Message text maximum width in pixels

textDimChars

private Dimension textDimChars

Message text width and height in character units

lines

private int lines

Message area lines

Constructor Detail

MessageAreaGuiImpl

public MessageAreaGuiImpl(WidgetId id,
                          int rows)

Constructor.

Parameters:

rows - Number of visible rows.

Method Detail

draw

public void draw()

Widget drawing method.

Specified by:

draw in interface Widget<GuiOutputManager>

Overrides:

draw in class ScrollPaneGuiImpl

attach

public void attach(Window<GuiOutputManager> window)

Attach widget to window.

Specified by:

attach in interface MessageArea<GuiOutputManager>

Parameters:

window - parent window.

addMessage

private void addMessage(java.lang.String message)

Add a new message text to message area.

Parameters:

message - Message text.

addItem

private int addItem(java.lang.String message)

Add new item to message list. Delete old messages.

Parameters:

message - New message.

Returns:

First visible row. Could be negative.

clearMessages

private void clearMessages()

Clear all messages. This method corresponds to the Progress statement:

 HIDE MESSAGE
 

getMessageLines

public int getMessageLines()

Returns the number of screen lines available for message display.

This method corresponds to the Progress built-in function:

 MESSAGE-LINES
 

Returns:

The number of available lines in the message area.

doLayout

public void doLayout()

Lay out container.

Specified by:

doLayout in interface Container<GuiOutputManager>

Overrides:

doLayout in class ScrollPane<GuiOutputManager>

calculateMessageAreaHeight

public double calculateMessageAreaHeight()

Calculates the height of the Message Area in the characters units.

Returns:

The height of the Message Area in the characters units

getMessageTexts

public java.lang.String[] getMessageTexts()

Get all the message texts in this message-area.

Specified by:

getMessageTexts in interface MessageArea<GuiOutputManager>

Returns:

See above.

setMessageText

public void setMessageText(java.lang.String[] msg,
                           Color[] cs,
                           boolean force)

Set message main worker routine.

Specified by:

setMessageText in interface MessageArea<GuiOutputManager>

Parameters:

msg - Message text array.

cs - Message color array.

force - true means force redisplaying of messages even if message text is already null.

getMessageColors

public Color[] getMessageColors()

Get all the message colors in this message-area.

Specified by:

getMessageColors in interface MessageArea<GuiOutputManager>

Returns:

See above.

setMessageText

public void setMessageText(java.lang.String[] message,
                           Color[] cs)

Shows the new message text.

Specified by:

setMessageText in interface MessageArea<GuiOutputManager>

Parameters:

message - Array of two text message which need to be displayed inside the message area.

cs - Array of two color specifications.

clearMessagesNoPause

public void clearMessagesNoPause()

Clear the message content and make sure that the message area displays the cleared space without pausing.

In GUI, clearing the messages and repainting should be enough since this will not trigger any pausing.

Specified by:

clearMessagesNoPause in interface MessageArea<GuiOutputManager>

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

mouseActions

protected int[] mouseActions()

Determine the mouse actions processed by this widget.

Overrides:

mouseActions in class ScrollPaneGuiImpl

Returns:

See above.

split

private int split(java.lang.String text)

Split message. If message text is larger than message area width the message is split into multiple lines each one smaller or equal than message area width. The computation is done using native units (pixels). When proportional fonts are used the length in characters units could be different on each lines.

Parameters:

text - Text to split.

Returns:

split index inside text.

getTextWidth

private int getTextWidth(java.lang.String text)

Get text width.

Parameters:

text - String text.

Returns:

see above.