com.goldencode.p2j.ui.client.gui

Class TabSetGuiImpl

java.lang.Object

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

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

com.goldencode.p2j.ui.client.gui.TabSetGuiImpl

All Implemented Interfaces:

DataContainer, Container<GuiOutputManager>, Widget<GuiOutputManager>, WidgetWithConfig<TabSetConfig>, ConfigOwner<TabSetConfig>, java.awt.event.MouseListener, java.awt.event.MouseMotionListener, java.awt.event.MouseWheelListener, java.util.EventListener

public class TabSetGuiImpl
extends AbstractContainer<GuiOutputManager>
implements WidgetWithConfig<TabSetConfig>, DataContainer

TABSET widget client-side implementation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	TabSetGuiImpl.TabSetItem Class describing functionality of each single item in TABSET widget.

Field Summary

Fields

Modifier and Type	Field and Description
private TabSetConfig	config Associated config instance
protected GuiColorResolver	gc Color resolver
private GuiDriver	gd Screen driver
private GuiFontResolver	gf Font resolver
private WidgetId	id Widget id
private java.util.ArrayList<TabSetGuiImpl.TabSetItem>	items The set of the ordered 1-based horizontal tab items.
private int	lines Keeping track of number of lines.
private static int	MIN_TEXT_WIDTH minimum text size used for tab width
private boolean	selecting Selection in progress flag.
private static int	TAB_HEIGHT_EXTRA_SPACE extra space for tab height
private static int	TAB_WIDTH_EXTRA_SPACE_PAGE extra space for tab width - tab page
private static int	TAB_WIDTH_EXTRA_SPACE_TAB extra space for tab width - tab bar
private int	toolTipIndex Keeping track of tooltip text index for tab items that is currently in use.

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

listeners, location, mousePtr, nativeInsets, physicalLocation

Constructor Summary

Constructors

Constructor and Description
TabSetGuiImpl(WidgetId id, TabSetConfig cfg) Constructor.

Method Summary

Modifier and Type	Method and Description
void	afterConfigUpdate(TabSetConfig beforeUpdate) The method is called after the configuration associated with the owner changes.
TabSetConfig	config() Get externalizable widget config which can be used to restore widget state after via network.
Widget<GuiOutputManager>	currentFocus() Get widget which is in focus.
Widget<GuiOutputManager>	defaultFocus() Get default focusable widget.
void	draw() Draw the widget.
private TabSetGuiImpl.TabSetItem	findTab(int tabIdx) Find Tab by index.
WidgetId	getId() Widget ID.
private java.util.List<TabSetConfig.TabItem>	getLineItems(int startingIndex, int itemsAmount, java.util.List<TabSetConfig.TabItem> configItems, FontDetails<?> font, double tsTotalWidth) Find how many tabs fit in a line.
private double	getTabHeight() Get Tab height.
int	getTabsAreaHeight() Calculate Tabs area height according to the number of lines.
private int	getTabSetItemIndex(java.awt.event.MouseEvent mEvt) Locates the TABSET item index for the given mouse event coordinates inside TABSET.
private double	getTabWidth(java.lang.String text, FontDetails<?> font) Get Tab width.
java.lang.String	getText() Get text representation of the selected value.
int	getTextStart() Gets the starting point from left edge of the item to draw the text.
private java.lang.String	getTooltip(int tabIdx) Get Tab tooltip string.
private double	getTotalWidthItems(java.util.List<TabSetConfig.TabItem> configItems, FontDetails<?> font) Calculate total width of tabs.
BaseDataType	getValue() Returns the BaseDataType instance representing the current value.
boolean	hasFocusable(Widget<GuiOutputManager> exclude) Reports if there is at least 1 focusable widget that is not the given widget.
private boolean	ignoreMouseEvent(java.awt.event.MouseEvent e) Checks if we need to ignore this mouse event.
private boolean	ignoreMouseMoveEvent(java.awt.event.MouseEvent e) Checks if we need to ignore this mouse move class event.
void	initialize(WidgetId id, TabSetConfig 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	isModified() Getting the modification state of the widget.
private boolean	isTabBar() Check if the widget behaves like a tab bar (single page).
private void	layoutTabs() Adjust Tabs position, only for multi-line if a tab from a different line was selected
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	mouseExited(java.awt.event.MouseEvent e) Notification of a mouse moved 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	processKeyEvent(KeyInput event) Process key event.
private void	refreshTabItems() Update position and size of the TABSET items.
void	setValue(BaseDataType value) Sets the BaseDataType instance representing the current value.

Methods inherited from class com.goldencode.p2j.ui.client.widget.AbstractContainer

add, add, add, addContainerStateListener, addDirectly, belongsTo, checkWidget, childrenLocation, clipping, clipRectangle, copyState, currentFocus, cycleFocus, deregisterSelectedWidget, destroy, detach, dimension, doLayout, dumpCurrentWidgets, dumpWidgets, endSizeChange, findMouseSource, firstFocus, focus, focusTraversable, focusWorker, formatDump, get, getAllSelectedWidgets, getClipRect, getEffectiveScrollableSize, getFocusInt, getIgnoreFocus, getLayout, getScrollableSize, getTabItemList, height, insets, lastFocus, minimumSize, moveAfterTabItem, moveBeforeTabItem, moveToBottom, moveToBottomInClass, moveToTop, moveToTopInClass, moveToZpos, nextFocus, normalizeZOrder, onWidgetAdded, onWidgetRemoved, paintOnTop, parentOf, prepareWidgets, prevFocus, 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, 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, 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, isCurrent, isDirectManipulationActive, isDirectManipulationActiveOrInUIB, isDirectManipulationCapable, isDirectManipulationRequired, isDisplayed, isEnabled, isFocusable, isHeader, isMouseDrag, isRealized, isRepaintDisabled, isRMBEntrySupported, isScreenLocationCached, isTabStop, isThreeD, isTotallyObscured, isVisible, isVisible, location, manageSystemActions, mouseDragged, mouseEntered, 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, 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, acceptTrigger, addFocusListener, addKeyListener, ancestor, ancestorId, bounds, canMovetoTop, clearWidget, completeTrigger, defaultMousePtr, displayPhysicalLocation, drawCaret, enclosingFrame, enforceDefaultMousePtr, forceCursorOnFocus, forceVisibility, getActualBounds, getCustomMousePointer, getEffectiveMousePointer, getIdForTrigger, getLegacyWidget, getLoadedMousePointer, 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, isFocusable, 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, setEnabled, setHidden, setHighlighted, setLocation, setLocation, setMousePointer, setMousePointer, setParent, setPhysicalLocation, setSensitiveForUIB, setState, setVisible, setWindow, show, startTrigger, supportsCustomMousePointer, systemFocusGrabbed, topLevelWindow, unregisterWidgetListener, validateDisplayValue, window

Methods inherited from interface java.awt.event.MouseListener

mouseEntered, mouseReleased

Methods inherited from interface java.awt.event.MouseMotionListener

mouseDragged

Methods inherited from interface java.awt.event.MouseWheelListener

mouseWheelMoved

Field Detail

TAB_HEIGHT_EXTRA_SPACE

private static final int TAB_HEIGHT_EXTRA_SPACE

extra space for tab height

See Also:

Constant Field Values

TAB_WIDTH_EXTRA_SPACE_PAGE

private static final int TAB_WIDTH_EXTRA_SPACE_PAGE

extra space for tab width - tab page

See Also:

Constant Field Values

TAB_WIDTH_EXTRA_SPACE_TAB

private static final int TAB_WIDTH_EXTRA_SPACE_TAB

extra space for tab width - tab bar

See Also:

Constant Field Values

MIN_TEXT_WIDTH

private static final int MIN_TEXT_WIDTH

minimum text size used for tab width

See Also:

Constant Field Values

id

private WidgetId id

Widget id

config

private TabSetConfig config

Associated config instance

gd

private GuiDriver gd

Screen driver

gf

private GuiFontResolver gf

Font resolver

gc

protected GuiColorResolver gc

Color resolver

items

private java.util.ArrayList<TabSetGuiImpl.TabSetItem> items

The set of the ordered 1-based horizontal tab items.

selecting

private boolean selecting

Selection in progress flag.

toolTipIndex

private int toolTipIndex

Keeping track of tooltip text index for tab items that is currently in use.

lines

private int lines

Keeping track of number of lines.

Constructor Detail

TabSetGuiImpl

public TabSetGuiImpl(WidgetId id,
                     TabSetConfig cfg)

Constructor.

Parameters:

id - Widget id.

cfg - Config instance.

Method Detail

initialize

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

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 TabSetConfig 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<TabSetConfig>

Overrides:

config in class AbstractWidget<GuiOutputManager>

Returns:

Reference to widget config.

afterConfigUpdate

public void afterConfigUpdate(TabSetConfig beforeUpdate)

The method is called after the configuration associated with the owner 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 change.

The implemented logic must be idempotent - the method must produce the same results if executed once or multiple times not relying on any particular call sequence or related state. This is necessary so that the method can be repeated or retried as often as necessary without causing unintended effects

Specified by:

afterConfigUpdate in interface ConfigOwner<TabSetConfig>

Parameters:

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

draw

public void draw()

Draw the widget.

Specified by:

draw in interface Widget<GuiOutputManager>

Overrides:

draw in class AbstractContainer<GuiOutputManager>

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.

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.

getText

public java.lang.String getText()

Get text representation of the selected value. It can be screen value (for FillIn, for example) or label (for the RadioButton, for example).

Specified by:

getText in interface DataContainer

Returns:

The screen representation of the value.

isModified

public boolean isModified()

Getting the modification state of the widget.

Specified by:

isModified in interface DataContainer

Returns:

true if the widget value was modified, false otherwise.

processKeyEvent

public void processKeyEvent(KeyInput event)

Process key event.

Specified by:

processKeyEvent in interface Widget<GuiOutputManager>

Overrides:

processKeyEvent in class AbstractContainer<GuiOutputManager>

Parameters:

event - Key event to process.

defaultFocus

public Widget<GuiOutputManager> defaultFocus()

Get default focusable widget.

Specified by:

defaultFocus in interface Container<GuiOutputManager>

Overrides:

defaultFocus in class AbstractContainer<GuiOutputManager>

Returns:

default focusable widget.

currentFocus

public Widget<GuiOutputManager> currentFocus()

Get widget which is in focus.

Specified by:

currentFocus in interface Container<GuiOutputManager>

Overrides:

currentFocus in class AbstractContainer<GuiOutputManager>

Returns:

focused widget.

hasFocusable

public boolean hasFocusable(Widget<GuiOutputManager> exclude)

Reports if there is at least 1 focusable widget that is not the given widget.

Specified by:

hasFocusable in interface Container<GuiOutputManager>

Overrides:

hasFocusable in class AbstractContainer<GuiOutputManager>

Parameters:

exclude - A widget to ignore or null if any focusable widget will do.

Returns:

true if there is at least one other widget that can be focused.

mousePressed

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

Notification of a mouse pressed event occurred for this widget.

Specified by:

mousePressed in interface java.awt.event.MouseListener

Overrides:

mousePressed 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.

Specified by:

mouseClicked in interface java.awt.event.MouseListener

Overrides:

mouseClicked 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.

Specified by:

mouseMoved in interface java.awt.event.MouseMotionListener

Overrides:

mouseMoved in class AbstractWidget<GuiOutputManager>

Parameters:

e - The mouse event.

mouseExited

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

Notification of a mouse moved event occurred for this widget.

Specified by:

mouseExited in interface java.awt.event.MouseListener

Overrides:

mouseExited in class AbstractWidget<GuiOutputManager>

Parameters:

e - The mouse event.

getTextStart

public int getTextStart()

Gets the starting point from left edge of the item to draw the text.

Returns:

See above.

getTabsAreaHeight

public int getTabsAreaHeight()

Calculate Tabs area height according to the number of lines.

Returns:

Tabs size area.

mouseActions

protected int[] mouseActions()

Determine the mouse actions processed by this widget.

Overrides:

mouseActions in class AbstractWidget<GuiOutputManager>

Returns:

See above.

refreshTabItems

private final void refreshTabItems()

Update position and size of the TABSET items.

getLineItems

private java.util.List<TabSetConfig.TabItem> getLineItems(int startingIndex,
                                                          int itemsAmount,
                                                          java.util.List<TabSetConfig.TabItem> configItems,
                                                          FontDetails<?> font,
                                                          double tsTotalWidth)

Find how many tabs fit in a line.

Parameters:

startingIndex - Index where we start in list.

itemsAmount - Number of tabs in the list.

configItems - List of items.

font - Font of the text in tabs.

tsTotalWidth - Width of the line.

Returns:

A list of tabs that fit in a line.

getTotalWidthItems

private double getTotalWidthItems(java.util.List<TabSetConfig.TabItem> configItems,
                                  FontDetails<?> font)

Calculate total width of tabs.

Parameters:

configItems - List of items.

font - Font of the text in tabs.

Returns:

Total width of tabs in given list.

layoutTabs

private void layoutTabs()

Adjust Tabs position, only for multi-line if a tab from a different line was selected

getTabHeight

private double getTabHeight()

Get Tab height.

Returns:

Tab height in chars units.

getTabWidth

private double getTabWidth(java.lang.String text,
                           FontDetails<?> font)

Get Tab width.

Parameters:

text - Label text.

font -

Returns:

Tab width in chars units.

ignoreMouseEvent

private boolean ignoreMouseEvent(java.awt.event.MouseEvent e)

Checks if we need to ignore this mouse event.

Parameters:

e - The mouse event.

Returns:

TRUE if event should be ignored, FALSE otherwise.

ignoreMouseMoveEvent

private boolean ignoreMouseMoveEvent(java.awt.event.MouseEvent e)

Checks if we need to ignore this mouse move class event.

Parameters:

e - The mouse event.

Returns:

TRUE if event should be ignored, FALSE otherwise.

getTabSetItemIndex

private int getTabSetItemIndex(java.awt.event.MouseEvent mEvt)

Locates the TABSET item index for the given mouse event coordinates inside TABSET.

Parameters:

mEvt - The mouse event to be checked.

Returns:

The 1 based TABSET item that contains the point with given X,Y or 0 if none.

getTooltip

private java.lang.String getTooltip(int tabIdx)

Get Tab tooltip string.

Parameters:

tabIdx - Tab index.

Returns:

tooltip string if found or empty string if not found.

findTab

private TabSetGuiImpl.TabSetItem findTab(int tabIdx)

Find Tab by index.

Parameters:

tabIdx - Tab index.

Returns:

TabSetItem if found null if not found.

isTabBar

private boolean isTabBar()

Check if the widget behaves like a tab bar (single page).

Returns:

true if widget is a tab bar