com.goldencode.p2j.ui.client

Class StatusLine<O extends OutputManager<?>>

java.lang.Object

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

com.goldencode.p2j.ui.client.StatusLine<O>

All Implemented Interfaces:

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

Direct Known Subclasses:

StatusLineGuiImpl, StatusLineImpl

public abstract class StatusLine<O extends OutputManager<?>>
extends AbstractWidget<O>
implements WidgetWithConfig<BaseConfig>

Status line widget.

Version:

1.0.0

Author:

NVS

Field Summary

Fields

Modifier and Type	Field and Description
protected Color	color Label color
protected BaseConfig	config The widget config.
protected boolean	isNull Track virtual null text.
protected java.lang.String	labelText Label text.
protected int	maxLen Maximal length of the text
private double	width Label width.

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

insets, listeners, location, LOG, mousePtr, nativeInsets, physicalLocation

Constructor Summary

Constructors

Constructor and Description
StatusLine(WidgetId id) Construct an empty message line.

Method Summary

Modifier and Type	Method and Description
void	afterConfigUpdate(BaseConfig beforeUpdate) The method is called after the configuration associated with the implementor changes.
abstract void	attach(Window<O> window) Attach this widget to the specified window.
BaseConfig	config() Get the widget config.
Dimension	dimension() Get widget dimension.
abstract void	draw() Widget drawing method.
boolean	focusTraversable() This component will not receive focus when Tab or Shift-Tab is pressed.
Color	getColor() Get current color used for displaying.
java.lang.String	getLabelText() Get label text.
int	getMaxLen() Return maximal length of the text.
java.lang.String	getText() Get label text.
double	height() Get widget height.
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.
Dimension	minimumSize() Get widget minimum size.
void	processKeyEvent(KeyInput ke) This component ignores key events.
void	requestFocus() This component never gets the keyboard input focus.
void	setColor(Color color) Set color specification.
void	setLength(double width) Set component occupied length.
void	setMaxLen(int maxLen) Set maximal label length.
void	setText(java.lang.String text) Set label text.
double	width() Get widget 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, copyState, createMouseHoverAction, deactivateDirectManipulation, debug, destroy, disable, disableTooltip, displayPhysicalLocation, drawCaret, enable, enableTooltip, enclosingFrame, findMouseSource, 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, insets, isCurrent, isDirectManipulationActive, isDirectManipulationActiveOrInUIB, isDirectManipulationCapable, isDirectManipulationRequired, isDisplayed, isEnabled, isFocusable, 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, physicalBounds, physicalDimension, physicalLocation, postprocessConfig, prepParentLocation, preventFocusWhenMouseDownEventDefined, processDirectManipulationEvent, processEvent, processFocusEvent, processKeyEventForSelectableWidget, processKeyListeners, processMnemonic, processMnemonicImpl, processSystemKey, raiseLegacyMouseEvents, reflectAncestorChange, reflectLocationChanged, reflectSizeChanged, refresh, registerWidgetListener, repaint, repaint, repaint, requestFocus, requestSync, resetBitmap, resizeTo, resolveFont, resolvePopupMenuId, resolveTitleFont, screen, screenDimension, screenHeight, screenLocation, screenPhysicalLocation, screenWidth, setBitmap, setCachedScreenLocation, setCachedScreenPhysicalLocation, setDirectManipulationActive, setEnabled, setHidden, setHighlighted, setLocation, setLocation, setMousePointer, setMousePointer, setParent, setPhysicalDimensionInt, setPhysicalLocation, setSensitiveForUIB, setState, setVisible, setWindow, show, showPopupMenu, supportsCustomMousePointer, sync, topLevelWindow, toString, translate, triggerLocationChanged, unrealize, unregisterWidgetListener, updateSizeWorker, updateSystemParent, widgetRealized, widgetStateChanged, 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.Widget

acceptsEscAsAnyKey, acceptTrigger, canMovetoTop, completeTrigger, defaultMousePtr, enforceDefaultMousePtr, getIdForTrigger, getLegacyWidget, getTriggerWidget, getTriggerWidget, hasFocus, ignoreEnable, isCurrent, isDirectManipulable, isDroppable, isInitialValueLayout, isLegacyFocus, isProcessProgressEvent, maySwitchFocus, parent, refreshWidget, requestFocus, startTrigger, systemFocusGrabbed, validateDisplayValue

Field Detail

color

protected Color color

Label color

maxLen

protected int maxLen

Maximal length of the text

isNull

protected boolean isNull

Track virtual null text.

labelText

protected java.lang.String labelText

Label text.

width

private double width

Label width.

config

protected BaseConfig config

The widget config.

Constructor Detail

StatusLine

public StatusLine(WidgetId id)

Construct an empty message line.

Parameters:

id - The widget's ID.

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<O extends OutputManager<?>>

Specified by:

config in interface ConfigOwner<BaseConfig>

Overrides:

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

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.

attach

public abstract void attach(Window<O> window)

Attach this widget to the specified window.

Parameters:

window - The parent window.

draw

public abstract void draw()

Widget drawing method.

Specified by:

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

Specified by:

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

setColor

public void setColor(Color color)

Set color specification.

Parameters:

color - Color specification.

getMaxLen

public int getMaxLen()

Return maximal length of the text. Negative value means no limits.

Returns:

Returns the maximal label length.

setMaxLen

public void setMaxLen(int maxLen)

Set maximal label length.

Parameters:

maxLen - The new maximal length.

getColor

public Color getColor()

Get current color used for displaying.

Returns:

Current color.

setText

public void setText(java.lang.String text)

Set label text.

Parameters:

text - Label text.

getText

public java.lang.String getText()

Get label text.

Returns:

label text.

minimumSize

public Dimension minimumSize()

Description copied from class: AbstractWidget

Get widget minimum size.

Specified by:

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

Specified by:

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

Returns:

widget minimum size.

See Also:

Widget.minimumSize()

dimension

public Dimension dimension()

Description copied from class: AbstractWidget

Get widget dimension.

Specified by:

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

Specified by:

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

Returns:

widget dimension.

See Also:

Widget.dimension()

width

public double width()

Description copied from class: AbstractWidget

Get widget width.

Specified by:

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

Specified by:

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

Returns:

widget width.

See Also:

Widget.width()

height

public double height()

Description copied from class: AbstractWidget

Get widget height.

Specified by:

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

Specified by:

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

Returns:

widget height.

See Also:

Widget.height()

focusTraversable

public boolean focusTraversable()

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

Specified by:

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

Overrides:

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

Returns:

false

processKeyEvent

public void processKeyEvent(KeyInput ke)

This component ignores key events.

Specified by:

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

Overrides:

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

Parameters:

ke -

requestFocus

public void requestFocus()

This component never gets the keyboard input focus.

Specified by:

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

setLength

public void setLength(double width)

Set component occupied length.

Parameters:

width -

getLabelText

public java.lang.String getLabelText()

Get label text.

Returns:

label text.