com.goldencode.p2j.ui.client

Class BrowseColumn<O extends OutputManager<?>>

java.lang.Object

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

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

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

All Implemented Interfaces:

DataContainer, FocusListener, Container<O>, Widget<O>, WidgetWithConfig<BrowseColumnConfig>, ConfigOwner<BrowseColumnConfig>, java.awt.event.MouseListener, java.awt.event.MouseMotionListener, java.awt.event.MouseWheelListener, java.util.EventListener

Direct Known Subclasses:

BrowseColumnGuiImpl

public class BrowseColumn<O extends OutputManager<?>>
extends AbstractContainer<O>
implements DataContainer, WidgetWithConfig<BrowseColumnConfig>, FocusListener

Information about column in BROWSE widget. This is not a real widget, just a container.

Field Summary

Fields

Modifier and Type	Field and Description
protected Browse<O>	browse Link to the browse widget.
protected BrowseColumnConfig	config Component attribute container.

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

listeners, location, mousePtr, nativeInsets, physicalLocation

Constructor Summary

Constructors

Constructor and Description
BrowseColumn(WidgetId id) Constructor which creates default config.
BrowseColumn(WidgetId id, BrowseColumnConfig cfg) Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	acceptTrigger(int eventCode) Tests if the target event can be triggered or not.
void	afterConfigUpdate(BrowseColumnConfig beforeUpdate) The method is called after the configuration associated with the implementor changes.
void	completeTrigger(int eventCode) Manages the internal state after the trigger is finished.
BrowseColumnConfig	config() Provide access to the attributes stored in the widget.
Dimension	dimension() Dummy implementation of the missing method.
void	draw() Dummy implementation of the missing method.
Browse<O>	getBrowse() Obtain the Browse this column is part of.
java.lang.String	getText() Get text representation of the selected value.
BaseDataType	getValue() Returns the BaseDataType instance representing the current value.
double	height() Dummy implementation of the missing method.
boolean	hidden() Get current hidden state.
void	initialize(WidgetId id, BrowseColumnConfig 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	isFocusable() Checks whether this attribute container can receive focus generally.
boolean	isModified() Getting the modification state of the widget.
boolean	isVisible() Check if widget is visible.
Dimension	minimumSize() Dummy implementation of the missing method.
void	onFocusGained(FocusEvent event) Handle situation when the browse column widget gains focus.
void	onFocusLost(FocusEvent event) Handle situation when the browse column widget loses the focus.
void	processEvent(Event evt) Intercept special events.
void	setBrowse(Browse<O> browse) Link column to owning frame.
void	setValue(BaseDataType value) Sets the BaseDataType instance representing the current value.
void	setValue(BaseDataType value, java.lang.String fmt) Sets the BaseDataType instance representing the current value formatted under a given format.
void	startTrigger(int eventCode) Manages the internal state before the trigger is started.
double	width() Dummy implementation of the missing method.

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, doLayout, dumpCurrentWidgets, dumpWidgets, endSizeChange, findMouseSource, firstFocus, focus, focusTraversable, focusWorker, formatDump, get, getAllSelectedWidgets, getClipRect, getEffectiveScrollableSize, getFocusInt, getIgnoreFocus, getLayout, getScrollableSize, getTabItemList, hasFocusable, 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, setSize, setTabItemList, setWidth, startSizeChange, swap, triggerContainerStateRedrawEnabled, unrealize, updateSizeWorker, widgets, widgetsAsList, widgetStateChanged

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, getEffectiveMousePointer, getId, getLoadedMousePointer, getMenuMouse, getMouseActions, getMousePosition, getPortableMouseEventCoordinates, getSelectedText, getState, getTextHeight, getTextHeightNative, getTextHeightNative, getTextWidth, getTextWidth, getTextWidthNative, getTextWidthNative, getVisiblePart, getZOrderClass, hasFocus, hasTooltip, hide, highlighted, ignoreAction, initialHeight, initialWidth, isCurrent, isDirectManipulationActive, isDirectManipulationActiveOrInUIB, isDirectManipulationCapable, isDirectManipulationRequired, isDisplayed, isEnabled, isHeader, isMouseDrag, isRealized, isRepaintDisabled, isRMBEntrySupported, isScreenLocationCached, isTabStop, isThreeD, isTotallyObscured, 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, 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, setEnabled, setHidden, setHighlighted, setLocation, setLocation, setMousePointer, setMousePointer, setParent, setPhysicalLocation, setSensitiveForUIB, setState, setVisible, setWindow, show, showPopupMenu, supportsCustomMousePointer, sync, topLevelWindow, 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.DataContainer

getChangedValue

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

widgetsAsList

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

acceptsEscAsAnyKey, addFocusListener, addKeyListener, ancestor, ancestorId, bounds, canMovetoTop, clearWidget, defaultMousePtr, displayPhysicalLocation, drawCaret, enclosingFrame, enforceDefaultMousePtr, forceCursorOnFocus, forceVisibility, getActualBounds, getCustomMousePointer, getEffectiveMousePointer, getId, getIdForTrigger, getLegacyWidget, getLoadedMousePointer, getMenuMouse, getMouseActions, getMousePosition, getSelectedText, getState, getTriggerWidget, getTriggerWidget, getVisiblePart, getZOrderClass, hasFocus, hasFocus, hasTooltip, hide, highlighted, ignoreEnable, initialHeight, initialWidth, isCurrent, isCurrent, isDirectManipulable, isDirectManipulationActive, isDirectManipulationActiveOrInUIB, isDisplayed, isDroppable, isEnabled, isHeader, isInitialValueLayout, isLegacyFocus, isProcessProgressEvent, isRealized, isRepaintDisabled, isRMBEntrySupported, isTabStop, isThreeD, isTotallyObscured, isVisible, location, maySwitchFocus, moveToBottom, moveToTop, name, navigable, oleDrag, parent, parent, parent, parentObject, parentOrSelf, parentOrSelfObject, physicalBounds, physicalDimension, physicalLocation, postprocessConfig, preventFocusWhenMouseDownEventDefined, processDirectManipulationEvent, processFocusEvent, processKeyListeners, processMnemonic, raiseLegacyMouseEvents, refreshWidget, registerWidgetListener, repaint, repaint, requestFocus, requestSync, resizeTo, resolvePopupMenuId, screen, screenLocation, screenPhysicalLocation, setDirectManipulationActive, setEnabled, setHidden, setHighlighted, setLocation, setLocation, setMousePointer, setMousePointer, setParent, setPhysicalLocation, setSensitiveForUIB, setState, setVisible, setWindow, show, supportsCustomMousePointer, systemFocusGrabbed, topLevelWindow, unregisterWidgetListener, validateDisplayValue, window

Methods inherited from interface java.awt.event.MouseListener

mouseClicked, mouseEntered, mouseExited, mousePressed, mouseReleased

Methods inherited from interface java.awt.event.MouseMotionListener

mouseDragged, mouseMoved

Methods inherited from interface java.awt.event.MouseWheelListener

mouseWheelMoved

Field Detail

browse

protected Browse<O extends OutputManager<?>> browse

Link to the browse widget.

config

protected BrowseColumnConfig config

Component attribute container.

Constructor Detail

BrowseColumn

public BrowseColumn(WidgetId id,
                    BrowseColumnConfig cfg)

Constructor.

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

Parameters:

id - The widget's ID.

cfg - Configuration data.

BrowseColumn

public BrowseColumn(WidgetId id)

Constructor which creates default config.

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

Parameters:

id - The widget's ID.

Method Detail

initialize

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

Parameters:

id - The widget's ID.

cfg - The config used to initialize this widget.

setBrowse

public void setBrowse(Browse<O> browse)

Link column to owning frame.

Parameters:

browse - Browse instance to link with.

config

public BrowseColumnConfig 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<BrowseColumnConfig>

Overrides:

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

Returns:

Reference to attribute container.

afterConfigUpdate

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

Parameters:

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

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.

getText

public java.lang.String getText()

Get text representation of the selected value.

Specified by:

getText in interface DataContainer

Returns:

The screen representation of the value.

getValue

public BaseDataType getValue()

Returns the BaseDataType instance representing the current value.

Specified by:

getValue in interface DataContainer

Returns:

The value representing the current widget value.

isModified

public boolean isModified()

Getting the modification state of the widget.

Specified by:

isModified in interface DataContainer

Returns:

always returns false and is never called.

setValue

public void setValue(BaseDataType value)

Sets the BaseDataType instance representing the current value.

Specified by:

setValue in interface DataContainer

Parameters:

value - The value representing the current widget value.

setValue

public void setValue(BaseDataType value,
                     java.lang.String fmt)

Sets the BaseDataType instance representing the current value formatted under a given format.

Parameters:

value - The value representing the current widget value.

fmt - The format under which the value should be formatted.

draw

public void draw()

Dummy implementation of the missing method.

Specified by:

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

Overrides:

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

height

public double height()

Dummy implementation of the missing method.

Specified by:

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

Overrides:

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

Returns:

0

dimension

public Dimension dimension()

Dummy implementation of the missing method.

Specified by:

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

Overrides:

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

Returns:

zero-sized area.

width

public double width()

Dummy implementation of the missing method.

Specified by:

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

Overrides:

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

Returns:

0

minimumSize

public Dimension minimumSize()

Dummy implementation of the missing method.

Specified by:

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

Overrides:

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

Returns:

zero-sized area.

isVisible

public boolean isVisible()

Check if widget is visible.

Specified by:

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

Overrides:

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

Returns:

true if widget is visible.

hidden

public boolean hidden()

Get current hidden state.

Specified by:

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

Overrides:

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

Returns:

hidden state.

processEvent

public void processEvent(Event evt)

Intercept special events. Using regular keyTyped/keyPressed may not work if component is not in focus.

Specified by:

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

Overrides:

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

Parameters:

evt - Event to process.

onFocusLost

public void onFocusLost(FocusEvent event)

Handle situation when the browse column widget loses the focus. Delegates the call to Browse.onFocusLost(com.goldencode.p2j.ui.client.event.FocusEvent).

Specified by:

onFocusLost in interface FocusListener

Parameters:

event - Reference to the event.

onFocusGained

public void onFocusGained(FocusEvent event)

Handle situation when the browse column widget gains focus. Delegates the call to Browse.onFocusGained(com.goldencode.p2j.ui.client.event.FocusEvent).

Specified by:

onFocusGained in interface FocusListener

Parameters:

event - Reference to the event.

getBrowse

public Browse<O> getBrowse()

Obtain the Browse this column is part of.

Returns:

the parent Browse widget.

startTrigger

public void startTrigger(int eventCode)

Manages the internal state before the trigger is started.

Specified by:

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

Parameters:

eventCode - The event code

completeTrigger

public void completeTrigger(int eventCode)

Manages the internal state after the trigger is finished.

Specified by:

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

Parameters:

eventCode - The event code

acceptTrigger

public boolean acceptTrigger(int eventCode)

Tests if the target event can be triggered or not.

Specified by:

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

Parameters:

eventCode - The target events code

Returns:

True if the target event can be triggered, otherwise false.