com.goldencode.p2j.ui.client.gui

Class TreeBodyGuiImpl

java.lang.Object

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

com.goldencode.p2j.ui.client.gui.TreeBodyGuiImpl

All Implemented Interfaces:

TreeViewDelegate, ModelChangeListener, Scrollable2D, Viewport, Widget<GuiOutputManager>, java.awt.event.MouseListener, java.awt.event.MouseMotionListener, java.awt.event.MouseWheelListener, java.util.EventListener

Direct Known Subclasses:

TreeListBodyGuiImpl, TreeViewBodyGuiImpl

public abstract class TreeBodyGuiImpl
extends AbstractWidget<GuiOutputManager>
implements TreeViewDelegate, Scrollable2D, Viewport

Implementation of the tree view body, this is the part of the widget where the user input-output happens.

Field Summary

Fields

Modifier and Type	Field and Description
protected ColorRgb	disabledFore Disabled state text color
protected GuiColorResolver	gc Color resolver
protected GuiDriver<?,?>	gd Screen driver
protected GuiFontResolver	gf Font resolver
private WidgetId	id The widget Id.
protected ColorRgb	selectionBack Selected item box color
protected ColorRgb	selectionFore Selected item text color
protected ClassicTheme	theme The theme used for drawing
private TreeGuiImpl.TreeNode	tooltipNode The node with active tooltip
TreeGuiImpl	tree The owning tree view
private double	viewportHeight Viewport height
private double	viewportWidth Viewport width

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

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

Constructor Summary

Constructors

Constructor and Description
TreeBodyGuiImpl(TreeGuiImpl tree) Constructor.

Method Summary

Modifier and Type	Method and Description
protected int	calcNodeWidth(TreeGuiImpl.TreeNode node, int level) Calculates width of a single node.
protected void	deactivateTooltip() Deactivates an active tooltip.
Dimension	dimension() Get widget dimension.
abstract void	draw() Draws this component.
private void	fireChangeTopVisibleNode(int prevNodeId, int scrollNodeCount) Triggers CHANGE-TOP-VISIBLE-NODE.
private boolean	fireNodeClickEvent(TreeGuiImpl.TreeNode node) Fires the node click event.
protected TreeGuiImpl.TreeNode	getCheckBoxNode(NativePoint loc) Returns the node owning the checkbox at the supplied location.
WidgetId	getId() Widget Id is required to dispatch mouse events.
private TreeGuiImpl.TreeNode	getNodeAtLocation(NativePoint loc) Returns a tree node at the specified location or null if no node exists at the location.
protected int	getNodeHeight() Calculates the node height.
protected TreeGuiImpl.TreeNode	getNodeInView(int rowIndex) Returns the node at the specified in-view row index.
protected int	getNodesColumnWidth() The method returns the first nodes colum width.
protected double	getViewportWidth() Gets the current viewport width.
double	height() Get widget height.
java.lang.Integer	hitTest(int x, int y) Get the TreeView node under mouse cursor.
protected TreeGuiImpl.TreeNode	isExpandIconAtLocation(NativePoint location) The method returns the node at the specified location.
protected TreeGuiImpl.TreeNode	isNodeContentAtLocation(NativePoint loc) The method returns the node at the specified location.
Dimension	minimumSize() Get widget minimum size.
void	modelChanged(Model model) This procedure is called by the model after it was changed.
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	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 entered 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.
void	mouseWheelMoved(java.awt.event.MouseWheelEvent e) Notification of a mouse wheel moved event occurred for this widget.
protected void	move(TreeGuiImpl.TreeNode from, int key) Process keyboard commands, which change the selection.
protected java.lang.Iterable<TreeGuiImpl.TreeNode>	nodesInView() Get iterable for all nodes visible on screen.
protected void	oleDoDrop(java.awt.event.MouseEvent e) Called when an automatic Drop operation is ended.
protected void	oleDragging(java.awt.event.MouseEvent e) Called on OLE Dragging.
protected boolean	oleStartDragging(java.awt.event.MouseEvent e) Called when an automatic OLE Drag operation is started.
void	processKeyEvent(KeyInput event) Process key event.
private void	setMouseCursor(MousePointer cursor) Set mouse cursor.
void	setViewportHeight(double height) Set viewport height.
void	setViewportWidth(double width) Set viewport width.
private void	triggerDefaultAction(TreeGuiImpl.TreeNode node) Triggers DEFAULT-ACTION.
void	updateColors(TreeConfig c) Updates tree colors.
protected boolean	updateHScrollModel(int width) Helper method suitable for both tree view and tree list
boolean	updateVScrollModel() Update the vertical scrolling model based on this object geometry and contents.
double	width() Get widget 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, config, 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, mouseEntered, moveToBottom, moveToTop, name, navigable, oleDrag, onOleDragging, onOleDropEnd, parent, parent, parentObject, parentOrSelf, parentOrSelfObject, physicalBounds, physicalDimension, physicalLocation, postprocessConfig, prepParentLocation, preventFocusWhenMouseDownEventDefined, processDirectManipulationEvent, processEvent, processFocusEvent, 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.model.Scrollable2D

updateHScrollModel

Methods inherited from interface com.goldencode.p2j.ui.client.model.Viewport

setViewportDimensions

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

Field Detail

tree

public TreeGuiImpl tree

The owning tree view

disabledFore

protected ColorRgb disabledFore

Disabled state text color

gc

protected GuiColorResolver gc

Color resolver

gd

protected GuiDriver<?,?> gd

Screen driver

gf

protected GuiFontResolver gf

Font resolver

selectionBack

protected ColorRgb selectionBack

Selected item box color

selectionFore

protected ColorRgb selectionFore

Selected item text color

theme

protected final ClassicTheme theme

The theme used for drawing

id

private final WidgetId id

The widget Id. Holds the value returned by getId().

tooltipNode

private TreeGuiImpl.TreeNode tooltipNode

The node with active tooltip

viewportHeight

private double viewportHeight

Viewport height

viewportWidth

private double viewportWidth

Viewport width

Constructor Detail

TreeBodyGuiImpl

public TreeBodyGuiImpl(TreeGuiImpl tree)

Constructor.

Parameters:

tree - The owning tree view.

Method Detail

dimension

public Dimension dimension()

Get widget dimension.

Specified by:

dimension in interface Widget<GuiOutputManager>

Specified by:

dimension in class AbstractWidget<GuiOutputManager>

Returns:

widget dimension.

draw

public abstract void draw()

Draws this component. Overrides draw() in JList.

Specified by:

draw in interface Widget<GuiOutputManager>

Specified by:

draw in class AbstractWidget<GuiOutputManager>

getId

public final WidgetId getId()

Widget Id is required to dispatch mouse events.

Specified by:

getId in interface Widget<GuiOutputManager>

Overrides:

getId in class AbstractWidget<GuiOutputManager>

Returns:

see above.

height

public double height()

Get widget height.

Specified by:

height in interface Widget<GuiOutputManager>

Specified by:

height in class AbstractWidget<GuiOutputManager>

Returns:

widget height.

hitTest

public java.lang.Integer hitTest(int x,
                                 int y)

Get the TreeView node under mouse cursor. If no node under cursor return null value.

Specified by:

hitTest in interface TreeViewDelegate

Parameters:

x - Mouse cursor x position.

y - Mouse cursor y position.

Returns:

TreeView node id under cursor or null if miss.

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.

modelChanged

public void modelChanged(Model model)

This procedure is called by the model after it was changed.

Specified by:

modelChanged in interface ModelChangeListener

Parameters:

model - the model that was changed

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.

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.

mouseExited

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

Notification of a mouse exited event occurred for this widget. No-op by default.

Specified by:

mouseExited in interface java.awt.event.MouseListener

Overrides:

mouseExited in class AbstractWidget<GuiOutputManager>

Parameters:

e - The mouse event.

mouseMoved

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

Notification of a mouse entered event occurred for this widget. No-op by default.

Specified by:

mouseMoved in interface java.awt.event.MouseMotionListener

Overrides:

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

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.

Specified by:

mouseReleased in interface java.awt.event.MouseListener

Overrides:

mouseReleased in class AbstractWidget<GuiOutputManager>

Parameters:

e - The mouse event.

mouseWheelMoved

public void mouseWheelMoved(java.awt.event.MouseWheelEvent e)

Notification of a mouse wheel moved event occurred for this widget. No-op by default.

Specified by:

mouseWheelMoved in interface java.awt.event.MouseWheelListener

Overrides:

mouseWheelMoved in class AbstractWidget<GuiOutputManager>

Parameters:

e - The mouse event.

processKeyEvent

public void processKeyEvent(KeyInput event)

Process key event.

Specified by:

processKeyEvent in interface Widget<GuiOutputManager>

Overrides:

processKeyEvent in class AbstractWidget<GuiOutputManager>

Parameters:

event - Key event to process.

setViewportHeight

public void setViewportHeight(double height)

Set viewport height.

Specified by:

setViewportHeight in interface Viewport

Parameters:

height - the new viewport height

setViewportWidth

public void setViewportWidth(double width)

Set viewport width.

Specified by:

setViewportWidth in interface Viewport

Parameters:

width - the new viewport width

updateColors

public void updateColors(TreeConfig c)

Updates tree colors.

Parameters:

c - Tree config.

updateVScrollModel

public boolean updateVScrollModel()

Update the vertical scrolling model based on this object geometry and contents.

Specified by:

updateVScrollModel in interface Scrollable2D

Returns:

true if model was changed as the result of the call.

width

public double width()

Get widget width.

Specified by:

width in interface Widget<GuiOutputManager>

Specified by:

width in class AbstractWidget<GuiOutputManager>

Returns:

widget width.

getNodeHeight

protected int getNodeHeight()

Calculates the node height.

Returns:

the calculated height.

getNodeInView

protected final TreeGuiImpl.TreeNode getNodeInView(int rowIndex)

Returns the node at the specified in-view row index.

Parameters:

rowIndex - 0-based index.

Returns:

the found node or null if no node found.

getViewportWidth

protected double getViewportWidth()

Gets the current viewport width.

Returns:

the viewportwidth.

calcNodeWidth

protected int calcNodeWidth(TreeGuiImpl.TreeNode node,
                            int level)

Calculates width of a single node.

Parameters:

node - The node to calculate.

level - Node tree level.

Returns:

the calculated width.

mouseActions

protected int[] mouseActions()

Determine the mouse actions processed by this widget.

Overrides:

mouseActions in class AbstractWidget<GuiOutputManager>

Returns:

See above.

nodesInView

protected final java.lang.Iterable<TreeGuiImpl.TreeNode> nodesInView()

Get iterable for all nodes visible on screen.

Returns:

see above

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.

oleDragging

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

Called on OLE Dragging. Set the correct DRAGGED-OVER-NODE property so that the trigger will be fired with proper parameters.

Overrides:

oleDragging in class AbstractWidget<GuiOutputManager>

Parameters:

e - The mouse event.

oleStartDragging

protected boolean oleStartDragging(java.awt.event.MouseEvent e)

Called when an automatic OLE Drag operation is started.

Overrides:

oleStartDragging in class AbstractWidget<GuiOutputManager>

Parameters:

e - The mouse event.

Returns:

true if is a drag source has been selected.

updateHScrollModel

protected final boolean updateHScrollModel(int width)

Helper method suitable for both tree view and tree list

Parameters:

width - the widget width

Returns:

true is the horizontal scroll model was changed due to this call

deactivateTooltip

protected void deactivateTooltip()

Deactivates an active tooltip.

fireChangeTopVisibleNode

private void fireChangeTopVisibleNode(int prevNodeId,
                                      int scrollNodeCount)

Triggers CHANGE-TOP-VISIBLE-NODE.

Parameters:

prevNodeId - The node which was the previous top visible node.

scrollNodeCount - The number of nodes which were scrolled in order to change the top visible node. This can be either positive or negative.

fireNodeClickEvent

private boolean fireNodeClickEvent(TreeGuiImpl.TreeNode node)

Fires the node click event.

Parameters:

node - The trigger node

Returns:

True if the trigger code returns NO-APPLY, otherwise false.

isExpandIconAtLocation

protected final TreeGuiImpl.TreeNode isExpandIconAtLocation(NativePoint location)

The method returns the node at the specified location. Only the node's expand icon considered.

Parameters:

location - The location to test.

Returns:

the found node or null.

getNodesColumnWidth

protected int getNodesColumnWidth()

The method returns the first nodes colum width. We need to enumerate all nodes and find out maximum text width.

Returns:

The width required to display nodes text with maximal node width.

getNodeAtLocation

private TreeGuiImpl.TreeNode getNodeAtLocation(NativePoint loc)

Returns a tree node at the specified location or null if no node exists at the location.

Parameters:

loc - Location.

Returns:

See above.

isNodeContentAtLocation

protected final TreeGuiImpl.TreeNode isNodeContentAtLocation(NativePoint loc)

The method returns the node at the specified location. Only the node's content area is considered (i.e. the custom node if visible and the node text).

Parameters:

loc - The location to test.

Returns:

the found node or null.

getCheckBoxNode

protected TreeGuiImpl.TreeNode getCheckBoxNode(NativePoint loc)

Returns the node owning the checkbox at the supplied location. If the location doesn't contain a check box null is returned.

Parameters:

loc - The location to check.

Returns:

See above.

move

protected void move(TreeGuiImpl.TreeNode from,
                    int key)

Process keyboard commands, which change the selection.

Parameters:

from - the currently selected node

key - the keyboard event key

setMouseCursor

private void setMouseCursor(MousePointer cursor)

Set mouse cursor.

Parameters:

cursor - Mouse cursor

triggerDefaultAction

private void triggerDefaultAction(TreeGuiImpl.TreeNode node)

Triggers DEFAULT-ACTION.

Parameters:

node - The target node.