fr.cnes.genius.lowLevel

Class GTree

java.lang.Object

fr.cnes.genius.main.GComponent

fr.cnes.genius.lowLevel.GTree

All Implemented Interfaces:

GDisplay, ActionListener, MouseListener, MouseWheelListener, EventListener, TreeSelectionListener

public class GTree
extends GComponent
implements GDisplay, TreeSelectionListener, MouseListener, ActionListener

Class to implement a GENIUS version of JTree.

Author:

fjammet

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GTree.GTreeNode

Nested classes/interfaces inherited from class fr.cnes.genius.main.GComponent

GComponent.CopyPasteOperation, GComponent.DisplayIndicatorStatus, GComponent.ItemType, GComponent.Operation

Field Summary

Fields inherited from class fr.cnes.genius.main.GComponent

NAME_ATTRIBUTE

Constructor Summary

Constructors

Constructor and Description
GTree(String rootName) Constructor to create a tree with a string label on it.
GTree(String widgetId, String rootName) Constructor to create a tree with a string label on it.

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(ActionEvent e)
void	addNode(GTree.GTreeNode parentNode, GComponent component) add a children with a given parent node
void	createNodes(List<GComponent> components) create nodes of the JTree
void	display() Called when the element is to be displayed, so it can perform the actions required for its display, and the display of its inmmediate descendants.
void	expandAll() expand all the nodes
void	expandAllNodes(int startingIndex, int rowCount) expand the nodes with children from starting index
Component	getComponent() Returns the low level Swing Component encapsulated by the class if any, otherwise returns null.
JMenuItem	getCopyItem() Return the JPopupMenu Swing component associated with the GPopupMenu.
GTree.GTreeNode	getGTreeNode(GTree.GTreeNode nodeParent, GComponent component) getter of node from a GComponent
JTree	getJTree() Get the Swing JTree encapsulated by the class.
GTree.GTreeNode	getRoot() getter for root
Object	getSelectedComponent()
boolean	isEnabled() Gets the enable status of the widget.
boolean	isExpanded(int row) checks by row if the jtree is expanded
void	mouseClicked(MouseEvent e)
void	mouseEntered(MouseEvent e)
void	mouseExited(MouseEvent e)
void	mousePressed(MouseEvent e)
void	mouseReleased(MouseEvent e)
void	removeChildrenNodes(DefaultMutableTreeNode parentNode) remove children associated with a given parent node
void	removeNode(GTree.GTreeNode node) remove a Tree Node associated with a given parent node
void	setEnabled(boolean flag) enable/disable the JTree
void	setVisible(boolean flag) visibility of the component
void	valueChanged(TreeSelectionEvent e) Redirection to a GENIUS event.

Methods inherited from class fr.cnes.genius.main.GComponent

activateConstraintsByType, attachCopyPasteMenu, attachCopyPasteMenu, beginOfElement, beginOfElement, beginOfElement, beginOfElement, clearAllInnerDescendantConstraint, clearConstraint, clearInnerDescendantContraint, composeWidgetId, doDisplay, endOfElement, getCommentInConfigFile, getConstraint, getCurrentOperation, getDisplayIndicatorStatus, getDisplayIsModifiedIndicator, getElement, getGClassName, getGPanel, getGParent, getGUnitInConfigFile, getInnerDescendantConstraint, getName, getNameInConfigFile, getOperationSaveValue, getPathInConfigFile, getSimpleWidgetId, getStatus, getStringConstraint, getSubComponent, getWidgetId, handleCopyPasteEvent, handleCopyPasteEvent, handleProcessEventException, isCopyPasteEvent, isForcedStatus, isModified, launchInvalidPositionException, mouseWheelMoved, parseSimpleConstraint, processGEvent, processMouseWheelEvent, setBusyCursor, setCommentInConfigFile, setConstraint, setCopyPasteMenuEnabled, setCurrentOperation, setDataForConstraintsByType, setDefaultConstraints, setDisplayIsModifiedIndicator, setElement, setForcedStatus, setGPanel, setGParent, setGUnitInConfigFile, setInnerDescendantConstraint, setName, setNameAndCommentInConfigFile, setNameInConfigFile, setPathInConfigFile, setStatus, setStringConstraint, setToolTipText, setWidgetId, setWidth, setWindowBusyCursor, updateIsModifiedIndicator, writeCollection, writeCollection, writeCollection, writeCollection, writeConfigItem, writeConfigItem, writeConfigItem, writeConfigItem, writeConfigItem

Methods inherited from class java.lang.Object

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

Constructor Detail

GTree

public GTree(String rootName)

Constructor to create a tree with a string label on it.

Parameters:

rootName - is the name of the root node

GTree

public GTree(String widgetId,
             String rootName)

Constructor to create a tree with a string label on it.

Parameters:

widgetId - id of the widget

rootName - name of the root to give a name for the tree.

Method Detail

getRoot

public GTree.GTreeNode getRoot()

getter for root

Returns:

root Node of the jtree

removeChildrenNodes

public void removeChildrenNodes(DefaultMutableTreeNode parentNode)

remove children associated with a given parent node

Parameters:

parentNode - DefaultMutableTreeNode

removeNode

public void removeNode(GTree.GTreeNode node)

remove a Tree Node associated with a given parent node

Parameters:

node - DefaultMutableTreeNode node to remove

addNode

public void addNode(GTree.GTreeNode parentNode,
                    GComponent component)

add a children with a given parent node

Parameters:

parentNode - DefaultMutableTreeNode

component - GComponent

createNodes

public void createNodes(List<GComponent> components)

create nodes of the JTree

Parameters:

components - list of GComponents to display in the JTree

display

public void display()

Called when the element is to be displayed, so it can perform the actions required for its display, and the display of its inmmediate descendants.

Specified by:

display in interface GDisplay

expandAll

public void expandAll()

expand all the nodes

expandAllNodes

public void expandAllNodes(int startingIndex,
                           int rowCount)

expand the nodes with children from starting index

Parameters:

startingIndex - first line to begin

rowCount - Number of rows to expand

getComponent

public Component getComponent()

Returns the low level Swing Component encapsulated by the class if any, otherwise returns null.

Overrides:

getComponent in class GComponent

Returns:

the Swing Component encapsulated by the class if any, otherwise returns null.

getGTreeNode

public GTree.GTreeNode getGTreeNode(GTree.GTreeNode nodeParent,
                                    GComponent component)

getter of node from a GComponent

Parameters:

nodeParent - to search inside the tree the node associated with the GComponent

component - the GComponent

Returns:

the node associated with the corresponding GComponent

getSelectedComponent

public Object getSelectedComponent()

Returns:

Object the selected object in the JTree

getCopyItem

public JMenuItem getCopyItem()

Return the JPopupMenu Swing component associated with the GPopupMenu.

Returns:

the JPopupMenu Swing component associated with the GPopupMenu.

getJTree

public JTree getJTree()

Get the Swing JTree encapsulated by the class.

Returns:

Swing JTree encapsulated by the class.

isEnabled

public boolean isEnabled()

Description copied from class: GComponent

Gets the enable status of the widget.

Overrides:

isEnabled in class GComponent

Returns:

true if the component is enabled, false otherwise.

isExpanded

public boolean isExpanded(int row)

checks by row if the jtree is expanded

Parameters:

row - integer

Returns:

true if the row of the jtree is expanded

setEnabled

public void setEnabled(boolean flag)

enable/disable the JTree

Overrides:

setEnabled in class GComponent

Parameters:

flag - new enable status of the component.

setVisible

public void setVisible(boolean flag)

visibility of the component

Parameters:

flag - boolean

valueChanged

public void valueChanged(TreeSelectionEvent e)

Redirection to a GENIUS event.

Specified by:

valueChanged in interface TreeSelectionListener

mouseClicked

public void mouseClicked(MouseEvent e)

Specified by:

mouseClicked in interface MouseListener

mousePressed

public void mousePressed(MouseEvent e)

Specified by:

mousePressed in interface MouseListener

mouseReleased

public void mouseReleased(MouseEvent e)

Specified by:

mouseReleased in interface MouseListener

mouseEntered

public void mouseEntered(MouseEvent e)

Specified by:

mouseEntered in interface MouseListener

mouseExited

public void mouseExited(MouseEvent e)

Specified by:

mouseExited in interface MouseListener

actionPerformed

public void actionPerformed(ActionEvent e)

Specified by:

actionPerformed in interface ActionListener