com.sibvisions.rad.ui.swing.ext
Class JVxTree

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JScrollPane
                  com.sibvisions.rad.ui.swing.ext.JVxScrollPane
                      com.sibvisions.rad.ui.swing.ext.JVxTree

All Implemented Interfaces:

ICellFormatterEditorListener, java.awt.event.MouseListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.lang.Runnable, java.util.EventListener, javax.accessibility.Accessible, ICellEditorListener, IControl, ITranslatable, ITreeControl, ITranslator, javax.swing.event.TreeSelectionListener, javax.swing.ScrollPaneConstants

public class JVxTree
extends JVxScrollPane
implements ITreeControl, ICellFormatterEditorListener, java.lang.Runnable, javax.swing.event.TreeSelectionListener

The JVxTree is a scrollable JTree that implements ITreeControl interface.

See Also:

Serialized Form

Nested Class Summary

static class	JVxTree.DataPageNode The DataPageNode implements MutableTreeNode.
class	JVxTree.DataRowTreeCellEditor The DataRowTreeCellRenderer handles editing.
class	JVxTree.DataRowTreeCellRenderer The DataRowTreeCellRenderer renders the tree columns.

Nested classes/interfaces inherited from class javax.swing.JScrollPane

javax.swing.JScrollPane.AccessibleJScrollPane, javax.swing.JScrollPane.ScrollBar

Nested classes/interfaces inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields inherited from class javax.swing.JScrollPane

columnHeader, horizontalScrollBar, horizontalScrollBarPolicy, lowerLeft, lowerRight, rowHeader, upperLeft, upperRight, verticalScrollBar, verticalScrollBarPolicy, viewport

Fields inherited from class javax.swing.JComponent

accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface javax.rad.model.ui.ICellEditorListener

ACTION_KEY, ENTER_KEY, ESCAPE_KEY, FOCUS_LOST, SHIFT_ENTER_KEY, SHIFT_TAB_KEY, TAB_KEY

Fields inherited from interface javax.swing.ScrollPaneConstants

COLUMN_HEADER, HORIZONTAL_SCROLLBAR, HORIZONTAL_SCROLLBAR_ALWAYS, HORIZONTAL_SCROLLBAR_AS_NEEDED, HORIZONTAL_SCROLLBAR_NEVER, HORIZONTAL_SCROLLBAR_POLICY, LOWER_LEADING_CORNER, LOWER_LEFT_CORNER, LOWER_RIGHT_CORNER, LOWER_TRAILING_CORNER, ROW_HEADER, UPPER_LEADING_CORNER, UPPER_LEFT_CORNER, UPPER_RIGHT_CORNER, UPPER_TRAILING_CORNER, VERTICAL_SCROLLBAR, VERTICAL_SCROLLBAR_ALWAYS, VERTICAL_SCROLLBAR_AS_NEEDED, VERTICAL_SCROLLBAR_NEVER, VERTICAL_SCROLLBAR_POLICY, VIEWPORT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

JVxTree()
Constructs a JVxTable.

Method Summary

void	addNotify()
void	cancelEditing() Informs the GUI control, that the last edit should be canceled(restored) the correct value is in the DataBook.
void	editingComplete(java.lang.String pCompleteType) Informs the ICellEditorListener that the editing is completed.
void	editingStarted() Informs the ICellEditorListener that the editing has started.
IDataBook	getActiveDataBook() Gets the active data book.
ICellFormatter	getCellFormatter() Gets the CellFormatter.
IControl	getControl() Get's the control corresponding to this cell editor listener.
IDataBook[]	getDataBooks() Returns the DataBooks displayed by this control.
INodeFormatter	getNodeFormatter() Gets the node formatter.
TranslationMap	getTranslation() Gets the possible translation mapping.
boolean	isDetectEndNode() Gets whether end node detection is enabled.
boolean	isEditable() Gets whether this tree is editable.
boolean	isMouseEventOnSelectedCell() Gets whether mouse event on selected cell is enabled.
boolean	isSavingImmediate() Tells whether the CellEditor should save immediate.
boolean	isTranslationEnabled() Gets whether the translation is en- or disabled.
void	mousePressed(java.awt.event.MouseEvent pMouseEvent)
void	mouseReleased(java.awt.event.MouseEvent pMouseEvent)
void	notifyRepaint() The control need to check if the part is visible and then repaint the part.
void	removeNotify()
void	run()
void	saveEditing() Informs the GUI control, that the last edit should be set into the IDataBook or IDataRow.
void	setCellFormatter(ICellFormatter pCellFormatter) Sets the cell formatter.
void	setDataBooks(IDataBook... pDataBooks) Sets the DataBooks displayed by this control.
void	setDetectEndNode(boolean pDetectEndNode) Sets end node detection en- or disabled.
void	setEditable(boolean pEditable) Sets this tree editable or not editable.
void	setNodeFormatter(INodeFormatter pNodeFormatter) Sets the node formatter.
void	setTranslation(TranslationMap pTranslation) Sets the possible translations.
void	setTranslationEnabled(boolean pEnabled) Sets the translation en- or disabled.
void	startEditing() Informs the GUI control, that the editor should be opened.
java.lang.String	translate(java.lang.String pText) Method to translate a given text.
void	valueChanged(javax.swing.event.TreeSelectionEvent pTreeSelectionEvent)

Methods inherited from class com.sibvisions.rad.ui.swing.ext.JVxScrollPane

getPreferredComponentSize, getPreferredSize, getViewportView, mouseClicked, mouseEntered, mouseExited, setViewport

Methods inherited from class javax.swing.JScrollPane

createHorizontalScrollBar, createVerticalScrollBar, createViewport, getAccessibleContext, getColumnHeader, getCorner, getHorizontalScrollBar, getHorizontalScrollBarPolicy, getRowHeader, getUI, getUIClassID, getVerticalScrollBar, getVerticalScrollBarPolicy, getViewport, getViewportBorder, getViewportBorderBounds, isValidateRoot, isWheelScrollingEnabled, paramString, setColumnHeader, setColumnHeaderView, setComponentOrientation, setCorner, setHorizontalScrollBar, setHorizontalScrollBarPolicy, setLayout, setRowHeader, setRowHeaderView, setUI, setVerticalScrollBar, setVerticalScrollBarPolicy, setViewportBorder, setViewportView, setWheelScrollingEnabled, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, transferFocusBackward, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

JVxTree

public JVxTree()

Constructs a JVxTable.

Method Detail

addNotify

public void addNotify()

Overrides:

addNotify in class javax.swing.JComponent

removeNotify

public void removeNotify()

Overrides:

removeNotify in class javax.swing.JComponent

getCellFormatter

public ICellFormatter getCellFormatter()

Gets the CellFormatter.

Specified by:

getCellFormatter in interface ICellFormatterEditorListener

Returns:

the CellFormatter.

mousePressed

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

Specified by:

mousePressed in interface java.awt.event.MouseListener

Overrides:

mousePressed in class JVxScrollPane

mouseReleased

public void mouseReleased(java.awt.event.MouseEvent pMouseEvent)

Specified by:

mouseReleased in interface java.awt.event.MouseListener

Overrides:

mouseReleased in class JVxScrollPane

valueChanged

public void valueChanged(javax.swing.event.TreeSelectionEvent pTreeSelectionEvent)

Specified by:

valueChanged in interface javax.swing.event.TreeSelectionListener

getActiveDataBook

public IDataBook getActiveDataBook()

Gets the active data book.

Specified by:

getActiveDataBook in interface ITreeControl

Returns:

the active data book.

notifyRepaint

public void notifyRepaint()

The control need to check if the part is visible and then repaint the part. Notify repaint is called on every change. The IControl has to catch the change, and return immediate. The change analysis and display has to be done with invoke later by the control.

Specified by:

notifyRepaint in interface IControl

startEditing

public void startEditing()

Informs the GUI control, that the editor should be opened.

Specified by:

startEditing in interface ITreeControl

saveEditing

public void saveEditing()
                 throws ModelException

Informs the GUI control, that the last edit should be set into the IDataBook or IDataRow.

Specified by:

saveEditing in interface IControl

Throws:

ModelException - if the value can not be stored.

cancelEditing

public void cancelEditing()

Informs the GUI control, that the last edit should be canceled(restored) the correct value is in the DataBook.

Specified by:

cancelEditing in interface IControl

editingComplete

public void editingComplete(java.lang.String pCompleteType)

Informs the ICellEditorListener that the editing is completed.

Specified by:

editingComplete in interface ICellEditorListener

Parameters:

pCompleteType - the type of completion.

editingStarted

public void editingStarted()

Informs the ICellEditorListener that the editing has started.

Specified by:

editingStarted in interface ICellEditorListener

isSavingImmediate

public boolean isSavingImmediate()

Tells whether the CellEditor should save immediate.

Specified by:

isSavingImmediate in interface ICellEditorListener

Returns:

whether the CellEditor should save immediate.

getControl

public IControl getControl()

Get's the control corresponding to this cell editor listener.

Specified by:

getControl in interface ICellEditorListener

Returns:

the control corresponding to this cell editor listener.

setTranslation

public void setTranslation(TranslationMap pTranslation)

Sets the possible translations.

Specified by:

setTranslation in interface ITranslatable

Parameters:

pTranslation - the translation mapping

getTranslation

public TranslationMap getTranslation()

Gets the possible translation mapping.

Specified by:

getTranslation in interface ITranslatable

Returns:

the translation mapping

setTranslationEnabled

public void setTranslationEnabled(boolean pEnabled)

Sets the translation en- or disabled.

Specified by:

setTranslationEnabled in interface ITranslatable

Parameters:

pEnabled - true to enable the translation, false to disable

isTranslationEnabled

public boolean isTranslationEnabled()

Gets whether the translation is en- or disabled.

Specified by:

isTranslationEnabled in interface ITranslatable

Returns:

true if translation is performed, false otherwise

translate

public java.lang.String translate(java.lang.String pText)

Method to translate a given text.

Specified by:

translate in interface ITranslator

Parameters:

pText - the text to translate.

Returns:

the translated text.

run

public void run()

Specified by:

run in interface java.lang.Runnable

getDataBooks

public IDataBook[] getDataBooks()

Returns the DataBooks displayed by this control.

Specified by:

getDataBooks in interface ITreeControl

Returns:

the DataBooks.

See Also:

setDataBooks(javax.rad.model.IDataBook...)

setDataBooks

public void setDataBooks(IDataBook... pDataBooks)

Sets the DataBooks displayed by this control.

Specified by:

setDataBooks in interface ITreeControl

Parameters:

pDataBooks - the DataBooks

See Also:

getDataBooks()

getNodeFormatter

public INodeFormatter getNodeFormatter()

Gets the node formatter.

Returns:

the node formatter

isDetectEndNode

public boolean isDetectEndNode()

Gets whether end node detection is enabled.

Returns:

true if end node detection is enabled, false otherwise

setDetectEndNode

public void setDetectEndNode(boolean pDetectEndNode)

Sets end node detection en- or disabled.

Parameters:

pDetectEndNode - true to enable end node detection, false to disable

isEditable

public boolean isEditable()

Gets whether this tree is editable.

Returns:

true if editable, false otherwise

setEditable

public void setEditable(boolean pEditable)

Sets this tree editable or not editable.

Parameters:

pEditable - true to enable editing, false otherwise

setCellFormatter

public void setCellFormatter(ICellFormatter pCellFormatter)

Sets the cell formatter.

Parameters:

pCellFormatter - the formatter

setNodeFormatter

public void setNodeFormatter(INodeFormatter pNodeFormatter)

Sets the node formatter.

Parameters:

pNodeFormatter - the node formatter

isMouseEventOnSelectedCell

public boolean isMouseEventOnSelectedCell()

Gets whether mouse event on selected cell is enabled.

Returns:

true if mouse event is enabled, false if event is disabled