com.goldencode.p2j.ui.client.gui

Class ProgressBarGuiImpl

java.lang.Object

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

com.goldencode.p2j.ui.client.gui.ProgressBarGuiImpl

All Implemented Interfaces:

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

public class ProgressBarGuiImpl
extends AbstractWidget<GuiOutputManager>
implements ProgressBarGui

PROGRESS-BAR widget client-side implementation.

Field Summary

Fields

Modifier and Type	Field and Description
private ProgressBarConfig	config Associated config instance
private GuiColorResolver	gc Color resolver
private GuiDriver	gd Screen driver
private GuiFontResolver	gf Font resolver
private WidgetId	id Widget ID
private GuiOutputManager	screen Output manager.

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

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

Fields inherited from interface com.goldencode.p2j.ui.client.gui.ProgressBarGui

CC_3D, CC_FIXED_SINGLE, CC_FLAT, CC_NONE, CC_ORIENTATION_HORIZONTAL, CC_ORIENTATION_VERTICAL, CC_SCROLLING_SMOOTH, CC_SCROLLING_STANDARD

Constructor Summary

Constructors

Constructor and Description
ProgressBarGuiImpl(WidgetId id, ProgressBarConfig cfg) Constructor.

Method Summary

Modifier and Type	Method and Description
void	afterConfigUpdate(ProgressBarConfig beforeUpdate) Before update handler.
ProgressBarConfig	config() Get externalizable widget config which can be used to restore widget state after via network.
Dimension	dimension() Get widget dimension.
void	draw() Draw the widget.
WidgetId	getId() Widget ID.
double	height() Get widget height.
void	initialize(WidgetId id, ProgressBarConfig 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.
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	mouseDragged(java.awt.event.MouseEvent e) Notification of a mouse dragged event occurred for this widget.
void	mouseEntered(java.awt.event.MouseEvent e) Notification of a mouse entered event occurred for this widget.
void	mouseExited(java.awt.event.MouseEvent e) Notification of a mouse exited event occurred for this widget.
void	mouseMoved(java.awt.event.MouseEvent e) Notification of a mouse moved event occurred for this widget.
void	mousePressed(java.awt.event.MouseEvent e) Notification of a mouse pressed event occurred for this widget.
void	mouseReleased(java.awt.event.MouseEvent e) Notification of a mouse released event occurred for this widget.
protected void	oleDoDrop(java.awt.event.MouseEvent e) Called when an automatic Drop operation is ended.
void	refreshWidget() Refresh widget.
private void	setMouseCursor(int mousePointer) Set mouse pointer for this widget when the mouse cursor is over widget.
boolean	supportsCustomMousePointer() Check if the widget supports custom mouse pointer.
double	width() Calculate the width of this widget.

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, focusTraversable, forceCursorOnFocus, forceVisibility, getActualBounds, getAndResetBitmap, getAndSetBitmap, getBitmapCopy, getCachedScreenLocation, getCachedScreenPhysicalLocation, getCustomMousePointer, getDefaultEvent, getEffectiveMousePointer, 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, mouseWheelMoved, moveToBottom, moveToTop, name, navigable, oleDrag, oleDragging, oleStartDragging, onOleDragging, onOleDropEnd, parent, parent, parentObject, parentOrSelf, parentOrSelfObject, physicalBounds, physicalDimension, physicalLocation, postprocessConfig, prepParentLocation, preventFocusWhenMouseDownEventDefined, processDirectManipulationEvent, processEvent, processFocusEvent, processKeyEvent, 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, 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.gui.ProgressBarGui

is3D, isFixedSingle, isHorizontal, isOLEDropModeNone, isScrolingSmooth, max, min, value

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, requestFocus, requestFocus, startTrigger, systemFocusGrabbed, validateDisplayValue

Field Detail

id

private WidgetId id

Widget ID

config

private ProgressBarConfig config

Associated config instance

gd

private GuiDriver gd

Screen driver

gf

private GuiFontResolver gf

Font resolver

gc

private GuiColorResolver gc

Color resolver

screen

private GuiOutputManager screen

Output manager.

Constructor Detail

ProgressBarGuiImpl

public ProgressBarGuiImpl(WidgetId id,
                          ProgressBarConfig cfg)

Constructor.

Parameters:

id - Widget id.

cfg - Config instance.

Method Detail

initialize

public void initialize(WidgetId id,
                       ProgressBarConfig 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<ProgressBarConfig>

Parameters:

id - The widget's ID.

cfg - Config instance.

getId

public WidgetId getId()

Widget ID.

Specified by:

getId in interface Widget<GuiOutputManager>

Overrides:

getId in class AbstractWidget<GuiOutputManager>

Returns:

see above.

config

public ProgressBarConfig config()

Get externalizable widget config which can be used to restore widget state after via network.

Note that only very limited set of widgets actually have config. By default widget has no config.

Specified by:

config in interface Widget<GuiOutputManager>

Specified by:

config in interface ConfigOwner<ProgressBarConfig>

Overrides:

config in class AbstractWidget<GuiOutputManager>

Returns:

Reference to widget config.

draw

public void draw()

Draw the widget.

Specified by:

draw in interface Widget<GuiOutputManager>

Specified by:

draw in class AbstractWidget<GuiOutputManager>

height

public double height()

Get widget height.

Specified by:

height in interface Widget<GuiOutputManager>

Specified by:

height in class AbstractWidget<GuiOutputManager>

Returns:

widget height.

minimumSize

public Dimension minimumSize()

Get widget minimum size.

Specified by:

minimumSize in interface Widget<GuiOutputManager>

Specified by:

minimumSize in class AbstractWidget<GuiOutputManager>

Returns:

widget minimum size.

width

public double width()

Calculate the width of this widget.

Specified by:

width in interface Widget<GuiOutputManager>

Specified by:

width in class AbstractWidget<GuiOutputManager>

Returns:

The width in characters.

dimension

public Dimension dimension()

Get widget dimension.

Specified by:

dimension in interface Widget<GuiOutputManager>

Specified by:

dimension in class AbstractWidget<GuiOutputManager>

Returns:

widget dimension.

afterConfigUpdate

public void afterConfigUpdate(ProgressBarConfig beforeUpdate)

Before update handler.

Specified by:

afterConfigUpdate in interface ConfigOwner<ProgressBarConfig>

Parameters:

beforeUpdate - Configuration before update

refreshWidget

public void refreshWidget()

Refresh widget.

Specified by:

refreshWidget in interface Widget<GuiOutputManager>

mouseActions

protected int[] mouseActions()

Determine the mouse actions processed by this widget.

Overrides:

mouseActions in class AbstractWidget<GuiOutputManager>

Returns:

See above.

mouseDragged

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

Notification of a mouse dragged event occurred for this widget.

Specified by:

mouseDragged in interface java.awt.event.MouseMotionListener

Overrides:

mouseDragged in class AbstractWidget<GuiOutputManager>

Parameters:

e - The mouse event.

mouseEntered

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

Notification of a mouse entered event occurred for this widget. Set custom mouse cursor if no default cursor.

Specified by:

mouseEntered in interface java.awt.event.MouseListener

Overrides:

mouseEntered in class AbstractWidget<GuiOutputManager>

Parameters:

e - The mouse event.

mouseExited

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

Notification of a mouse exited event occurred for this widget. Set mouse cursor to default.

Specified by:

mouseExited in interface java.awt.event.MouseListener

Overrides:

mouseExited 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. Invoke server side trigger if is already registered.

Specified by:

mouseClicked in interface java.awt.event.MouseListener

Overrides:

mouseClicked in class AbstractWidget<GuiOutputManager>

Parameters:

e - The mouse event.

mousePressed

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

Notification of a mouse pressed event occurred for this widget. Invoke server side trigger if is already registered.

Specified by:

mousePressed in interface java.awt.event.MouseListener

Overrides:

mousePressed in class AbstractWidget<GuiOutputManager>

Parameters:

e - The mouse event.

mouseReleased

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

Notification of a mouse released event occurred for this widget. Invoke server side trigger if is already registered.

Specified by:

mouseReleased in interface java.awt.event.MouseListener

Overrides:

mouseReleased 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. Invoke server side trigger if is already registered.

Specified by:

mouseMoved in interface java.awt.event.MouseMotionListener

Overrides:

mouseMoved in class AbstractWidget<GuiOutputManager>

Parameters:

e - The mouse event.

supportsCustomMousePointer

public boolean supportsCustomMousePointer()

Check if the widget supports custom mouse pointer.

Specified by:

supportsCustomMousePointer in interface Widget<GuiOutputManager>

Overrides:

supportsCustomMousePointer in class AbstractWidget<GuiOutputManager>

Returns:

true if the widget supports custom mouse pointer.

setMouseCursor

private void setMouseCursor(int mousePointer)

Set mouse pointer for this widget when the mouse cursor is over widget. If a user defined mouse icon is defined, then set mouse pointer that image, otherwise set the provided mouse pointer.

Parameters:

mousePointer - mouse pointer value

oleDoDrop

protected void oleDoDrop(java.awt.event.MouseEvent e)

Called when an automatic Drop operation is ended.

Overrides:

oleDoDrop in class AbstractWidget<GuiOutputManager>

Parameters:

e - The mouse event.