com.goldencode.p2j.ui.client

Class Space<O extends OutputManager<?>>

java.lang.Object

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

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

All Implemented Interfaces:

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

public class Space<O extends OutputManager<?>>
extends AbstractWidget<O>
implements WidgetWithConfig<SkipConfig>, StreamableWidget

The virtual invisible widget to represent the space(n) keyword feature for the CHUI frames. Used to simulate the additional empty columns between widgets in a frames or dialog boxes.

NOTE: it is expected that widget will be UI-neutral.

Field Summary

Fields

Modifier and Type	Field and Description
protected SkipConfig	config Component attribute container

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

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

Constructor Summary

Constructors

Constructor and Description
Space(WidgetId id) Constructs the skipping to the next column.
Space(WidgetId id, double columnsToSkip) Constructs the space object with the given number of the gap columns.
Space(WidgetId id, SkipConfig cfg) Special constructor used to restore component using given configuration.

Method Summary

Modifier and Type	Method and Description
void	afterConfigUpdate(SkipConfig beforeUpdate) The method is called after the configuration associated with the implementor changes.
SkipConfig	config() Provide access to the attributes stored in the widget.
Widget<?>	convertToStreamable() Convert this widget instance to its streamable equivalent.
protected void	copyState(Widget<?> w) Copy the widget state from the specified source widget to this instance.
Dimension	dimension() Getting the size of the space object.
void	draw() Draw method, does nothing.
boolean	focusTraversable() This component will not receive an input focus when Tab or Shift-Tab is pressed.
double	height() Returns the current height of the component.
void	initialize(WidgetId id, SkipConfig 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.
boolean	isDirectManipulable() Check the direct manipulation capability of the widget.
boolean	isFocusable() Checks whether this attribute container can receive focus generally.
Dimension	minimumSize() The same as the getSize() method.
double	width() Returns the current width of the object.

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, 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, 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, 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, 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.StreamableWidget

convertToStreamable

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

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

Field Detail

config

protected SkipConfig config

Component attribute container

Constructor Detail

Space

public Space(WidgetId id)

Constructs the skipping to the next column.

Parameters:

id - The widget's ID.

Space

public Space(WidgetId id,
             double columnsToSkip)

Constructs the space object with the given number of the gap columns.

Parameters:

id - The widget's ID.

columnsToSkip - The number of the columns to be skipped.

Space

public Space(WidgetId id,
             SkipConfig cfg)

Special constructor used to restore component using given configuration.

Call initialize(com.goldencode.p2j.ui.WidgetId, com.goldencode.p2j.ui.SkipConfig) to finish the widget initialization.

Parameters:

id - The widget's ID.

cfg - Configuration data.

Method Detail

convertToStreamable

public Widget<?> convertToStreamable()

Convert this widget instance to its streamable equivalent.

Specified by:

convertToStreamable in interface StreamableWidget

Returns:

This widget's streamable equivalent.

initialize

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

Parameters:

id - The widget's ID.

cfg - The config used to initialize this widget.

config

public SkipConfig config()

Provide access to the attributes stored in the widget.

Specified by:

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

Specified by:

config in interface ConfigOwner<SkipConfig>

Overrides:

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

Returns:

Reference to attribute container.

afterConfigUpdate

public void afterConfigUpdate(SkipConfig 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<SkipConfig>

Parameters:

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

width

public double width()

Returns the current width of the object.

Specified by:

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

Specified by:

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

Returns:

The horizontal size of the space object.

height

public double height()

Returns the current height of the component.

Specified by:

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

Specified by:

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

Returns:

Always zero.

dimension

public Dimension dimension()

Getting the size of the space object. This is the implementation of the abstract methods for the CHARVA Component.

Specified by:

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

Specified by:

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

Returns:

The size of the space object, zero height.

minimumSize

public Dimension minimumSize()

The same as the getSize() method. This is the implementation of the abstract methods for the CHARVA Component.

Specified by:

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

Specified by:

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

Returns:

The size of the space object, zero width.

draw

public void draw()

Draw method, does nothing. This is the implementation of the abstract methods for the CHARVA Component.

Specified by:

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

Specified by:

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

focusTraversable

public boolean focusTraversable()

This component will not receive an input 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:

Always false.

isFocusable

public boolean isFocusable()

Checks whether this attribute container can receive focus generally.

Specified by:

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

Overrides:

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

Returns:

true if this container can be focused under certain conditions. false if, and only if, this attribute container can never receive focus.

isDirectManipulable

public boolean isDirectManipulable()

Check the direct manipulation capability of the widget. SPACE widget does not allow direct manipulation.

Specified by:

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

Returns:

TRUE if the widget is able to be directly manipulated, FALSE otherwise.

copyState

protected void copyState(Widget<?> w)

Copy the widget state from the specified source widget to this instance.

Overrides:

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

Parameters:

w - The source widget which state needs to be copied.