TreeGuiImpl (P2J - Progress 4GL to Java Conversion and Runtime)

java.lang.Object
- com.goldencode.p2j.ui.client.widget.AbstractWidget<O>
- - com.goldencode.p2j.ui.client.widget.AbstractContainer<O>
  - - com.goldencode.p2j.ui.client.widget.BorderedPanel<GuiOutputManager>
    - - com.goldencode.p2j.ui.client.gui.BorderedPanelGuiImpl
      - com.goldencode.p2j.ui.client.gui.TreeGuiImpl

All Implemented Interfaces:

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

Direct Known Subclasses:

TreeListGuiImpl, TreeViewGuiImpl
```
public abstract class TreeGuiImpl
extends BorderedPanelGuiImpl
implements WidgetWithConfig<TreeConfig>, DataContainer
```
Base class for client-side implementations of TREEVIEW and TREELIST widgets.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected static class`	`TreeGuiImpl.TreeEditor` Represents the tree node editor.
`static class`	`TreeGuiImpl.TreeNode` The class represents one tree node.

Field Summary

Fields
Modifier and Type	Field and Description
`TreeBodyGuiImpl`	`body` Tree view body.
`protected TreeConfig`	`config` Associated config instance
`protected TreeGuiImpl.TreeNode`	`currentNode` Currently selected node
`protected TreeGuiImpl.TreeNode`	`dropHighlightNode` Current drop highlight node
`protected GuiColorResolver`	`gc` Color resolver
`protected GuiDriver<?,?>`	`gd` Screen driver
`protected GuiFontResolver`	`gf` Font resolver
`ScrollModel`	`hModel` Horizontal scroll model Note: this field is exposed to code external to FWD, so it should remain public.
`private WidgetId`	`id` Widget id
`private java.util.HashMap<java.lang.Integer,TreeGuiImpl.TreeNode>`	`idNodes` Map of node ids to nodes
`(package private) CentralLogger`	`LOGGER` Logger used to log all this treelist events
`TreeGuiImpl.TreeNode`	`rootNode` The root node.
`protected GenericContainer`	`scrollableContainer` The scrolling provider.
`protected TreeGuiImpl.TreeNode`	`topNode` The topmost node visible in the widget area
`protected TreeGuiImpl.TreeEditor`	`treeEditor` The tree label editor
`protected ScrollModel`	`vModel` Horizontal scroll model

Fields inherited from class com.goldencode.p2j.ui.client.widget.BorderedPanel
border

Fields inherited from class com.goldencode.p2j.ui.client.widget.AbstractWidget
listeners, location, mousePtr, nativeInsets, physicalLocation

Constructor Summary

Constructors
Constructor and Description

TreeGuiImpl(WidgetId id, TreeConfig cfg)
Constructor.

Constructors
Constructor and Description
`TreeGuiImpl(WidgetId id, TreeConfig cfg)` Constructor.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`acceptsEscAsAnyKey()` Flag indicating if this widget can accept ESC key for any key event.
`void`	`afterConfigUpdate(TreeConfig beforeUpdate)` The method is called after the configuration associated with the owner changes.
`protected void`	`buildTreeModel()` Builds tree model from the config's flat node entry list.
`TreeConfig`	`config()` Get externalizable widget config which can be used to restore widget state after via network.
`protected abstract TreeBodyGuiImpl`	`createBody()` Creates new body implementation.
`Widget<GuiOutputManager>`	`currentFocus()` Get the current focus.
`Widget<GuiOutputManager>`	`defaultFocus()` Get the default focus.
`(package private) void`	`drawEditor()` Draws the tree node editor.
`(package private) boolean`	`ensureVisible(TreeGuiImpl.TreeNode node)` When the supplied node is not visible in the current view, the view is scrolled so that the node becomes visible.
`private TreeGuiImpl.TreeNode`	`findFirstNodeWithText(java.lang.String nodeText)` Returns the first node that matches the provided node text.
`TreeGuiImpl.TreeNode`	`findNodeByChar(char firstLetter)` Locate a `TreeGuiImpl.TreeNode` instance by node first letter char.
`TreeGuiImpl.TreeNode`	`findNodeById(int nodeId)` Locate a `TreeGuiImpl.TreeNode` instance by node id.
`(package private) boolean`	`fireAfterLabelEdit(TreeGuiImpl.TreeNode node, java.lang.String newLabel)` Fires the after label edit event.
`private boolean`	`fireBeforeLabelEdit(TreeGuiImpl.TreeNode node)` Fires the before label edit event.
`private ThinClient.TriggerResult`	`fireNodeCheckEvent(TreeGuiImpl.TreeNode node)` Triggers NODE-CHECK event.
`protected boolean`	`fireNodeExpansionTrigger(TreeConfig cfgTree, int eventCode)` Firing the node expand/collapse trigger for tree node.
`void`	`firstFocus()` Don't change the the current focus.
`TreeGuiImpl.TreeNode`	`getCurrentNode()` Returns the current node.
`private java.lang.String`	`getCurrentNodeText()` Returns the text of the current node.
`(package private) TreeGuiImpl.TreeNode`	`getDropHighlightNode()` Returns the drop highlight node.
`WidgetId`	`getId()` Widget ID.
`ImageWrapper<?>`	`getNodeImage(TreeGuiImpl.TreeNode node, boolean nodeSelected)` Gets the image for the given node and its selected state.
`(package private) NativeRectangle`	`getNodeLabelBounds(TreeGuiImpl.TreeNode node)` Calculates the node label's bounds within its tree body.
`protected abstract java.lang.String`	`getNodeText(TreeGuiImpl.TreeNode node)` Returns the node text.
`java.lang.String`	`getText()` Get text representation of the selected value.
`BaseDataType`	`getValue()` Returns the BaseDataType instance representing the current value.
`(package private) int`	`getViewportFitRowCount()` Calculate the number of visible nodes that will at least partly fit in the widget's viewport.
`protected int`	`getVisibleNodeCount()` Get the total number of visible nodes in the tree.
`boolean`	`hasFocusable(Widget<GuiOutputManager> exclude)` Reports if there is at least 1 focusable widget that is not the given widget.
`java.lang.Integer`	`hitTest(int x, int y)` Get the TreeView node under mouse cursor.
`void`	`initialize(WidgetId id, TreeConfig 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`	`isEditorActivated()` Tests if the tree editor is activated.
`protected boolean`	`isLabelsEditingSupported()` Tests if label's editing is supported or not.
`boolean`	`isModified()` Getting the modification state of the widget.
`void`	`lastFocus()` Don't change the current focus.
`protected static void`	`makeNodeConfigDirty(TreeConfig cfgTree)` Making config dirty for nodes entries.
`protected abstract java.util.Comparator<TreeGuiImpl.TreeNode>`	`nodeComparator()` Create a comparator capable to compare nodes based on current sorting column.
`boolean`	`preventFocusWhenMouseDownEventDefined()` Test if this widget must prevent receiving focus on mouse-down event.
`void`	`processKeyEvent(KeyInput event)` Process key event.
`protected void`	`repaintTree()` Repaints the tree part of the widget.
`GuiFontResolver.FontCache`	`resolveFontCache()` Resolves the font cache to be used during widget drawing operations.
`(package private) void`	`setCurrentNode(TreeGuiImpl.TreeNode node)` Sets the current node.
`void`	`setCurrentNode(TreeGuiImpl.TreeNode node, boolean trigger, boolean direct)` Sets the current node.
`protected void`	`setNodeExpansion(TreeGuiImpl.TreeNode node, boolean expand)` Expands or collapses the supplied node.
`protected void`	`setNodeExpansion(TreeGuiImpl.TreeNode node, boolean expand, boolean allChildren)` Expands or collapses the supplied node.
`void`	`setValue(BaseDataType value)` Sets the BaseDataType instance representing the current value.
`protected static void`	`sortNodes(java.util.List<TreeGuiImpl.TreeNode> nodes, java.util.Comparator<TreeGuiImpl.TreeNode> comparator)` Sort nodes recursively using the provided comparator.
`boolean`	`systemFocusGrabbed()` Grabs the system focus iff the tree editor is active.
`(package private) void`	`toggleCurrentNodeExpansion()` Expands or collapses the current node.
`(package private) void`	`toggleNodeCheck(TreeGuiImpl.TreeNode node)` Toggles node's check state.
`(package private) void`	`toggleNodeExpansion(TreeGuiImpl.TreeNode node)` Expands or collapses the supplied node.
`protected java.lang.Iterable<TreeGuiImpl.TreeNode>`	`visibleNodes()` Iterable for all visible (not collapsed) nodes in the tree.

Methods inherited from class com.goldencode.p2j.ui.client.gui.BorderedPanelGuiImpl
draw, drawPanel, is3DBorder, isRMBEntrySupported, set3DBorder, setColorResolver, setCustomDraw, setId, setOptionalDraw

Methods inherited from class com.goldencode.p2j.ui.client.widget.BorderedPanel
border, insets, isTransparent, setBorder, setTransparent

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, focus, focusTraversable, focusWorker, formatDump, get, getAllSelectedWidgets, getClipRect, getEffectiveScrollableSize, getFocusInt, getIgnoreFocus, getLayout, getScrollableSize, getTabItemList, height, 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, 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, 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
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, isTabStop, isThreeD, isTotallyObscured, isVisible, isVisible, location, maySwitchFocus, moveToBottom, moveToTop, name, navigable, oleDrag, parent, parent, parent, parentObject, parentOrSelf, parentOrSelfObject, physicalBounds, physicalDimension, physicalLocation, postprocessConfig, 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, 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
  - body
```
public TreeBodyGuiImpl body
```
    Tree view body.
  - rootNode
```
public TreeGuiImpl.TreeNode rootNode
```
    The root node. Note: this field is exposed to code external to FWD, so it should remain public.
  - hModel
```
public final ScrollModel hModel
```
    Horizontal scroll model Note: this field is exposed to code external to FWD, so it should remain public.
  - treeEditor
```
protected TreeGuiImpl.TreeEditor treeEditor
```
    The tree label editor
  - config
```
protected TreeConfig config
```
    Associated config instance
  - currentNode
```
protected TreeGuiImpl.TreeNode currentNode
```
    Currently selected node
  - dropHighlightNode
```
protected TreeGuiImpl.TreeNode dropHighlightNode
```
    Current drop highlight node
  - gc
```
protected GuiColorResolver gc
```
    Color resolver
  - gd
```
protected final GuiDriver<?,?> gd
```
    Screen driver
  - gf
```
protected GuiFontResolver gf
```
    Font resolver
  - scrollableContainer
```
protected GenericContainer scrollableContainer
```
    The scrolling provider.
  - topNode
```
protected TreeGuiImpl.TreeNode topNode
```
    The topmost node visible in the widget area
  - vModel
```
protected final ScrollModel vModel
```
    Horizontal scroll model
  - LOGGER
```
final CentralLogger LOGGER
```
    Logger used to log all this treelist events
  - id
```
private WidgetId id
```
    Widget id
  - idNodes
```
private final java.util.HashMap<java.lang.Integer,TreeGuiImpl.TreeNode> idNodes
```
    Map of node ids to nodes
- Constructor Detail
  - TreeGuiImpl
```
public TreeGuiImpl(WidgetId id,
                   TreeConfig cfg)
```
    Constructor. Note: this constructor is exposed to code external to FWD, so it should remain public.
    
    Parameters:
    
    id - Widget id.
    
    cfg - Config instance.
- Method Detail
  - afterConfigUpdate
```
public void afterConfigUpdate(TreeConfig 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<TreeConfig>
    
    Parameters:
    
    beforeUpdate - Config reference capturing the config state before the owner's config was modified.
  - config
```
public TreeConfig 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<TreeConfig>
    
    Overrides:
    
    config in class AbstractWidget<GuiOutputManager>
    
    Returns:
    
    Reference to widget config.
  - currentFocus
```
public Widget<GuiOutputManager> currentFocus()
```
    Get the current focus.
    
    Specified by:
    
    currentFocus in interface Container<GuiOutputManager>
    
    Overrides:
    
    currentFocus in class AbstractContainer<GuiOutputManager>
    
    Returns:
    
    The current focus.
  - defaultFocus
```
public Widget<GuiOutputManager> defaultFocus()
```
    Get the default focus.
    
    Specified by:
    
    defaultFocus in interface Container<GuiOutputManager>
    
    Overrides:
    
    defaultFocus in class AbstractContainer<GuiOutputManager>
    
    Returns:
    
    The default focus.
  - firstFocus
```
public void firstFocus()
```
    Don't change the the current focus.
    
    Specified by:
    
    firstFocus in interface Container<GuiOutputManager>
    
    Overrides:
    
    firstFocus in class AbstractContainer<GuiOutputManager>
  - getCurrentNode
```
public final TreeGuiImpl.TreeNode getCurrentNode()
```
    Returns the current node. Note: this method is exposed to code external to FWD, so it should remain public.
    
    Returns:
    
    see above.
  - resolveFontCache
```
public final GuiFontResolver.FontCache resolveFontCache()
```
    Resolves the font cache to be used during widget drawing operations. Note: this method is exposed to code external to FWD, so it should remain public.
    
    Returns:
    
    a valid font cache.
  - getId
```
public WidgetId getId()
```
    Widget ID.
    
    Specified by:
    
    getId in interface Widget<GuiOutputManager>
    
    Overrides:
    
    getId in class BorderedPanelGuiImpl
    
    Returns:
    
    see above.
  - getNodeImage
```
public final ImageWrapper<?> getNodeImage(TreeGuiImpl.TreeNode node,
                                          boolean nodeSelected)
```
    Gets the image for the given node and its selected state.
    
    Parameters:
    
    node - The tree node
    
    nodeSelected - The node selected state
    
    Returns:
    
    The image
  - 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.
  - findNodeById
```
public final TreeGuiImpl.TreeNode findNodeById(int nodeId)
```
    Locate a TreeGuiImpl.TreeNode instance by node id. Note: this method is exposed to code external to FWD, so it should remain public.
    
    Parameters:
    
    nodeId - A node id.
    
    Returns:
    
    TreeGuiImpl.TreeNode or null when no node found.
  - findNodeByChar
```
public final TreeGuiImpl.TreeNode findNodeByChar(char firstLetter)
```
    Locate a TreeGuiImpl.TreeNode instance by node first letter char. Note: this method is exposed to code external to FWD, so it should remain public.
    
    Parameters:
    
    firstLetter - A node id.
    
    Returns:
    
    TreeGuiImpl.TreeNode or null when no node found.
  - 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.
  - 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.
  - hitTest
```
public final java.lang.Integer hitTest(int x,
                                       int y)
```
    Get the TreeView node under mouse cursor. If no node under cursor return null value.
    
    Parameters:
    
    x - Mouse cursor x position.
    
    y - Mouse cursor y position.
    
    Returns:
    
    TreeView node id under cursor or null if miss.
  - initialize
```
public void initialize(WidgetId id,
                       TreeConfig 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<TreeConfig>
    
    Parameters:
    
    id - The widget's ID.
    
    cfg - Config instance.
  - isEditorActivated
```
public final boolean isEditorActivated()
```
    Tests if the tree editor is activated.
    
    Returns:
    
    The value of the activated field.
  - 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.
  - lastFocus
```
public void lastFocus()
```
    Don't change the current focus.
    
    Specified by:
    
    lastFocus in interface Container<GuiOutputManager>
    
    Overrides:
    
    lastFocus in class AbstractContainer<GuiOutputManager>
  - preventFocusWhenMouseDownEventDefined
```
public boolean preventFocusWhenMouseDownEventDefined()
```
    Test if this widget must prevent receiving focus on mouse-down event. The default is true.
    
    Specified by:
    
    preventFocusWhenMouseDownEventDefined in interface Widget<GuiOutputManager>
    
    Overrides:
    
    preventFocusWhenMouseDownEventDefined in class AbstractWidget<GuiOutputManager>
    
    Returns:
    
    see above.
  - 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.
  - 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.
  - systemFocusGrabbed
```
public boolean systemFocusGrabbed()
```
    Grabs the system focus iff the tree editor is active.
    
    Specified by:
    
    systemFocusGrabbed in interface Widget<GuiOutputManager>
    
    Returns:
    
    True iff the tree editor is active.
  - acceptsEscAsAnyKey
```
public boolean acceptsEscAsAnyKey()
```
    Flag indicating if this widget can accept ESC key for any key event.
    
    Specified by:
    
    acceptsEscAsAnyKey in interface Widget<GuiOutputManager>
    
    Returns:
    
    Always false.
  - getViewportFitRowCount
```
final int getViewportFitRowCount()
```
    Calculate the number of visible nodes that will at least partly fit in the widget's viewport.
    
    Returns:
    
    see above.
  - toggleCurrentNodeExpansion
```
final void toggleCurrentNodeExpansion()
```
    Expands or collapses the current node.
  - toggleNodeExpansion
```
final void toggleNodeExpansion(TreeGuiImpl.TreeNode node)
```
    Expands or collapses the supplied node.
    
    Parameters:
    
    node - The node to expand or collapse, must not be null
  - getDropHighlightNode
```
final TreeGuiImpl.TreeNode getDropHighlightNode()
```
    Returns the drop highlight node.
    
    Returns:
    
    The drop highlight node.
  - drawEditor
```
final void drawEditor()
```
    Draws the tree node editor.
  - fireAfterLabelEdit
```
final boolean fireAfterLabelEdit(TreeGuiImpl.TreeNode node,
                                 java.lang.String newLabel)
```
    Fires the after label edit event.
    
    Parameters:
    
    node - The trigger node
    
    newLabel - The new label
    
    Returns:
    
    True if the trigger code returns NO-APPLY, otherwise false.
  - setCurrentNode
```
void setCurrentNode(TreeGuiImpl.TreeNode node)
```
    Sets the current node.
    
    Parameters:
    
    node - The node to set as current.
  - ensureVisible
```
final boolean ensureVisible(TreeGuiImpl.TreeNode node)
```
    When the supplied node is not visible in the current view, the view is scrolled so that the node becomes visible.
    
    Parameters:
    
    node - The node to make visible, must not be null
    
    Returns:
    
    true if this call resulted in any change
  - getNodeLabelBounds
```
final NativeRectangle getNodeLabelBounds(TreeGuiImpl.TreeNode node)
```
    Calculates the node label's bounds within its tree body.
    
    Parameters:
    
    node - The tree node
    
    Returns:
    
    The node label's bounds
  - toggleNodeCheck
```
void toggleNodeCheck(TreeGuiImpl.TreeNode node)
```
    Toggles node's check state.
    
    Parameters:
    
    node - The subjected node.
  - buildTreeModel
```
protected void buildTreeModel()
```
    Builds tree model from the config's flat node entry list.
  - createBody
```
protected abstract TreeBodyGuiImpl createBody()
```
    Creates new body implementation.
    
    Returns:
    
    valid body instance.
  - fireNodeExpansionTrigger
```
protected boolean fireNodeExpansionTrigger(TreeConfig cfgTree,
                                           int eventCode)
```
    Firing the node expand/collapse trigger for tree node.
    
    Parameters:
    
    cfgTree - The tree widget config.
    
    eventCode - The code of the particular event to trigger.
    
    Returns:
    
    TRUE if trigger result consumed, FALSE otherwise.
  - getNodeText
```
protected abstract java.lang.String getNodeText(TreeGuiImpl.TreeNode node)
```
    Returns the node text.
    
    Parameters:
    
    node - Tree node.
    
    Returns:
    
    the node text.
  - getVisibleNodeCount
```
protected final int getVisibleNodeCount()
```
    Get the total number of visible nodes in the tree.
    
    Returns:
    
    see above
  - isLabelsEditingSupported
```
protected boolean isLabelsEditingSupported()
```
    Tests if label's editing is supported or not. This method can be overridden in subclasses iff labels editing is supported.
    
    Returns:
    
    Boolean value that indicates label's editing is supported or not.
  - nodeComparator
```
protected abstract java.util.Comparator<TreeGuiImpl.TreeNode> nodeComparator()
```
    Create a comparator capable to compare nodes based on current sorting column.
    
    Returns:
    
    the comparator or null if no sorting column is set in the tree.
  - setNodeExpansion
```
protected void setNodeExpansion(TreeGuiImpl.TreeNode node,
                                boolean expand)
```
    Expands or collapses the supplied node.
    
    Parameters:
    
    node - The node to expand or collapse, must not be null
    
    expand - The desired expansion state.
  - setNodeExpansion
```
protected void setNodeExpansion(TreeGuiImpl.TreeNode node,
                                boolean expand,
                                boolean allChildren)
```
    Expands or collapses the supplied node.
    
    Parameters:
    
    node - The node to expand or collapse, must not be null
    
    expand - The desired expansion state.
    
    allChildren - Whether all child nodes to be expanded or collapsed.
  - visibleNodes
```
protected final java.lang.Iterable<TreeGuiImpl.TreeNode> visibleNodes()
```
    Iterable for all visible (not collapsed) nodes in the tree.
    
    Returns:
    
    see above
  - makeNodeConfigDirty
```
protected static void makeNodeConfigDirty(TreeConfig cfgTree)
```
    Making config dirty for nodes entries.
    
    Parameters:
    
    cfgTree - The tree widget config.
  - sortNodes
```
protected static final void sortNodes(java.util.List<TreeGuiImpl.TreeNode> nodes,
                                      java.util.Comparator<TreeGuiImpl.TreeNode> comparator)
```
    Sort nodes recursively using the provided comparator.
    
    Parameters:
    
    nodes - the nodes to sort.
    
    comparator - the comparator to use when sorting
  - fireBeforeLabelEdit
```
private final boolean fireBeforeLabelEdit(TreeGuiImpl.TreeNode node)
```
    Fires the before label edit event.
    
    Parameters:
    
    node - The trigger node
    
    Returns:
    
    True if the trigger code returns NO-APPLY, otherwise false.
  - findFirstNodeWithText
```
private final TreeGuiImpl.TreeNode findFirstNodeWithText(java.lang.String nodeText)
```
    Returns the first node that matches the provided node text.
    
    Parameters:
    
    nodeText - The node text to match.
    
    Returns:
    
    a tree node instance or null if no node found.
  - getCurrentNodeText
```
private final java.lang.String getCurrentNodeText()
```
    Returns the text of the current node.
    
    Returns:
    
    the current node text or null if no current node is selected
  - fireNodeCheckEvent
```
private ThinClient.TriggerResult fireNodeCheckEvent(TreeGuiImpl.TreeNode node)
```
    Triggers NODE-CHECK event.
    
    Parameters:
    
    node - The checked node.
    
    Returns:
    
    Result of the invoked trigger.
  - setCurrentNode
```
public void setCurrentNode(TreeGuiImpl.TreeNode node,
                           boolean trigger,
                           boolean direct)
```
    Sets the current node. Note: this method is exposed to code external to FWD, so it should remain public.
    
    Parameters:
    
    node - The node to set as current.
    
    trigger - If true, the method will post the input event Keyboard.SE_VALUE_CHANGED.
    
    direct - If true, the method will post the input event Keyboard.SE_CHANGE_NODE_DIRECT.
  - repaintTree
```
protected void repaintTree()
```
    Repaints the tree part of the widget. Can be used in external subclassed of this.

Class TreeGuiImpl

Nested Class Summary

Field Summary

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

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

Constructor Summary

Method Summary

Methods inherited from class com.goldencode.p2j.ui.client.gui.BorderedPanelGuiImpl

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

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

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

Methods inherited from class java.lang.Object

Methods inherited from interface com.goldencode.p2j.ui.client.DataContainer

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

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

Methods inherited from interface java.awt.event.MouseListener

Methods inherited from interface java.awt.event.MouseMotionListener

Methods inherited from interface java.awt.event.MouseWheelListener

Field Detail

body

rootNode

hModel

treeEditor

config

currentNode

dropHighlightNode

gc

gd

gf

scrollableContainer

topNode

vModel

LOGGER

id

idNodes

Constructor Detail

TreeGuiImpl

Method Detail

afterConfigUpdate

config

currentFocus

defaultFocus

firstFocus

getCurrentNode

resolveFontCache

getId

getNodeImage

getText

findNodeById

findNodeByChar

getValue

hasFocusable

hitTest

initialize

isEditorActivated

isModified

lastFocus

preventFocusWhenMouseDownEventDefined

processKeyEvent

setValue

systemFocusGrabbed

acceptsEscAsAnyKey

getViewportFitRowCount

toggleCurrentNodeExpansion

toggleNodeExpansion

getDropHighlightNode

drawEditor

fireAfterLabelEdit

setCurrentNode

ensureVisible

getNodeLabelBounds

toggleNodeCheck

buildTreeModel

createBody

fireNodeExpansionTrigger

getNodeText

getVisibleNodeCount

isLabelsEditingSupported

nodeComparator

setNodeExpansion