Package com.inductiveautomation.snap.swing.helpers

Class JTreeHpr<T extends javax.swing.JTree>

java.lang.Object

com.inductiveautomation.snap.ui.UIHelper<T>

com.inductiveautomation.snap.swing.SwingHelper<T>

com.inductiveautomation.snap.swing.helpers.JComponentHpr<T>

com.inductiveautomation.snap.swing.helpers.JTreeHpr<T>

public class JTreeHpr<T extends javax.swing.JTree>
extends JComponentHpr<T>

This class is a simple JTree subclass to support Ribs archival and to support Ribs unified accessor model.

Constructor Summary

Constructors

Constructor	Description
JTreeHpr()

Method Summary

Modifier and Type	Method	Description
static void	expandAll(javax.swing.JTree aTree, boolean expand)	If expand is true, expands all nodes in the tree.
protected static java.util.List	findTreeObjectPath(javax.swing.tree.TreeModel aModel, java.lang.Object aNode, java.lang.Object aValue)	Finds a tree object.
int	getChildCount(T anObj)	Override to suppress children.
RJTreeModel	getRibsModel(javax.swing.JTree aTree)	Returns a Ribs tree model for a given tree, if available.
int	getSelectedIndex(T aTree)	Returns the selected index property of given object.
java.lang.Object	getSelectedItem(T aTree)	Returns the selected object property of given object.
protected static java.lang.Object	getTreeNodeObject(java.lang.Object aNode)	Returns a value for a tree node.
java.lang.Object	getValue(T aTree, java.lang.String aPropertyName)	Returns a component's value as a string.
void	initUI(T aTree, UIOwner anOwner)	Override to install TreeSelectionListener.
static void	reloadTree(javax.swing.JTree aTree, boolean doPreserveSelection, boolean doPreserveExpanded)	Reloads tree.
void	setSelectedIndex(T aTree, int aValue)	Sets the selected index property of given object to given value.
void	setSelectedItem(T aTree, java.lang.Object aValue)	Sets the selected object property of given object to given value.

Methods inherited from class com.inductiveautomation.snap.swing.helpers.JComponentHpr

addBinding, createEventAdapter, getAutosizing, getBinding, getBindingCount, getBindings, getChangeListener, getChild, getConstraints, getEventAdapter, getName, getOwner, getParent, getPropertyNamesImpl, getSendActionOnFocusLost, getSendActionOnFocusLostDefault, isEnabled, removeBinding, setConstraints, setEnabled, setOwner, setSendActionOnFocusLost

Methods inherited from class com.inductiveautomation.snap.swing.SwingHelper

getHelper, getSwingHelper, getSwingHelper

Methods inherited from class com.inductiveautomation.snap.ui.UIHelper

enableEvents, getAction, getBinding, getChild, getItemDisplayKey, getItems, getKeyValue, getPropertyNameMapped, getPropertyNames, getSelectedIndexes, getSelectedIndexs, getText, initUIDeep, isEnabled, isPropertyName, isValueAdjusting, removeBinding, setAction, setEnabled, setItemDisplayKey, setItems, setItems, setKeyValue, setSelectedIndexes, setText, setValue

Methods inherited from class java.lang.Object

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

Constructor Detail

JTreeHpr

public JTreeHpr()

Method Detail

getChildCount

public int getChildCount(T anObj)

Override to suppress children.

Overrides:

getChildCount in class JComponentHpr<T extends javax.swing.JTree>

initUI

public void initUI(T aTree,
                   UIOwner anOwner)

Override to install TreeSelectionListener.

Overrides:

initUI in class JComponentHpr<T extends javax.swing.JTree>

getValue

public java.lang.Object getValue(T aTree,
                                 java.lang.String aPropertyName)

Returns a component's value as a string.

Overrides:

getValue in class UIHelper<T extends javax.swing.JTree>

getRibsModel

public RJTreeModel getRibsModel(javax.swing.JTree aTree)

Returns a Ribs tree model for a given tree, if available.

reloadTree

public static void reloadTree(javax.swing.JTree aTree,
                              boolean doPreserveSelection,
                              boolean doPreserveExpanded)

Reloads tree.

expandAll

public static void expandAll(javax.swing.JTree aTree,
                             boolean expand)

If expand is true, expands all nodes in the tree. Otherwise, collapses all nodes in the tree.

getSelectedIndex

public int getSelectedIndex(T aTree)

Returns the selected index property of given object.

Overrides:

getSelectedIndex in class UIHelper<T extends javax.swing.JTree>

setSelectedIndex

public void setSelectedIndex(T aTree,
                             int aValue)

Sets the selected index property of given object to given value.

Overrides:

setSelectedIndex in class UIHelper<T extends javax.swing.JTree>

getSelectedItem

public java.lang.Object getSelectedItem(T aTree)

Returns the selected object property of given object.

Overrides:

getSelectedItem in class UIHelper<T extends javax.swing.JTree>

setSelectedItem

public void setSelectedItem(T aTree,
                            java.lang.Object aValue)

Sets the selected object property of given object to given value.

Overrides:

setSelectedItem in class UIHelper<T extends javax.swing.JTree>

findTreeObjectPath

protected static java.util.List findTreeObjectPath(javax.swing.tree.TreeModel aModel,
                                                   java.lang.Object aNode,
                                                   java.lang.Object aValue)

Finds a tree object.

getTreeNodeObject

protected static java.lang.Object getTreeNodeObject(java.lang.Object aNode)

Returns a value for a tree node.