jaxx.runtime.swing.navigation
Class NavigationTreeContextHelper

java.lang.Object
  jaxx.runtime.swing.navigation.NavigationTreeContextHelper

Direct Known Subclasses:

NavigationTreeHelper

public class NavigationTreeContextHelper
extends Object

To help getting and setting navigation tree objects from a JAXXContext.

There is seven types of data which can be hold in a context :

• tree : the tree
• tree-tablr : the jx tree table
• tree model : the navigation tree model
• tree handler : the navigation tree handler
• selected path : the navigation path of the selected node
• selected node : the selected node
• selected bean : the selected bean

To make possible the use of more than one navigation tree system in a same context, we MUST distinguish the context entries definition. For this purpose, entries definition are normalized and prefixed by a unique prefix.

Here is the keys mapping :

• tree : prefix + "-tree"
• tree-table : prefix + "-tree-table"
• tree model : prefix + "-tree-model"
• tree handler : prefix + "-tree-handler"
• selected path : prefix + "-selected-path"
• selected node : prefix + "-selected-node"
• selected bean : prefix + "-selected-bean"

Since:

1.7.2

Author:

chemit

Field Summary

protected JAXXContextEntryDef<NavigationTreeHandler>	handlerContextEntry
protected JAXXContextEntryDef<NavigationModel>	modelContextEntry
protected String	prefix
protected JAXXContextEntryDef<List<Object>>	selectedBeansContextEntry
protected JAXXContextEntryDef<List<NavigationTreeNode>>	selectedNodesContextEntry
protected JAXXContextEntryDef<List<String>>	selectedPathsContextEntry
protected JAXXContextEntryDef<JTree>	treeContextEntry
protected JAXXContextEntryDef<org.jdesktop.swingx.JXTreeTable>	treeTableContextEntry

Constructor Summary

NavigationTreeContextHelper(String prefix)

Method Summary

NavigationModel	getModel(JAXXContext context)
protected JAXXContextEntryDef<NavigationModel>	getModelContextEntry()
String	getPrefix()
Object	getSelectedBean(JAXXContext context)
protected JAXXContextEntryDef<List<Object>>	getSelectedBeanContextEntry()
List<Object>	getSelectedBeans(JAXXContext context)
NavigationTreeNode	getSelectedNode(JAXXContext context)
protected JAXXContextEntryDef<List<NavigationTreeNode>>	getSelectedNodeContextEntry()
List<NavigationTreeNode>	getSelectedNodes(JAXXContext context)
String	getSelectedPath(JAXXContext context)
protected JAXXContextEntryDef<List<String>>	getSelectedPathContextEntry()
List<String>	getSelectedPaths(JAXXContext context)
protected <T> T	getSelectedValue(JAXXContextEntryDef<List<T>> entry, JAXXContext context)
JTree	getTree(JAXXContext context)
protected JAXXContextEntryDef<JTree>	getTreeContextEntry()
NavigationTreeHandler	getTreeHandler(JAXXContext context)
protected JAXXContextEntryDef<NavigationTreeHandler>	getTreeHandlerContextEntry()
NavigationTreeModel	getTreeModel(JAXXContext context) Deprecated. since 2.0 please use getModel(JAXXContext), will be remove soon
org.jdesktop.swingx.JXTreeTable	getTreeTable(JAXXContext context)
protected JAXXContextEntryDef<org.jdesktop.swingx.JXTreeTable>	getTreeTableContextEntry()
void	setModel(JAXXContext context, NavigationModel model)
void	setSelectedBean(JAXXContext context, Object bean)
void	setSelectedBeans(JAXXContext context, List<Object> beans)
void	setSelectedNode(JAXXContext context, NavigationTreeNode node)
void	setSelectedNodes(JAXXContext context, List<NavigationTreeNode> nodes)
void	setSelectedPath(JAXXContext context, String path)
void	setSelectedPaths(JAXXContext context, List<String> paths)
protected <T> void	setSelectedValue(JAXXContextEntryDef<List<T>> entry, JAXXContext context, T value)
protected <T> void	setSelectedValues(JAXXContextEntryDef<List<T>> entry, JAXXContext context, List<T> values)
void	setTree(JAXXContext context, JTree tree)
void	setTreeHandler(JAXXContext context, NavigationTreeHandler handler)
void	setTreeModel(JAXXContext context, NavigationModel model) Deprecated. since 2.0 please use setModel(JAXXContext, NavigationModel), will be remove soon
void	setTreeTable(JAXXContext context, org.jdesktop.swingx.JXTreeTable treeTable)

Methods inherited from class java.lang.Object

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

Field Detail

prefix

protected final String prefix

selectedPathsContextEntry

protected JAXXContextEntryDef<List<String>> selectedPathsContextEntry

selectedBeansContextEntry

protected JAXXContextEntryDef<List<Object>> selectedBeansContextEntry

selectedNodesContextEntry

protected JAXXContextEntryDef<List<NavigationTreeNode>> selectedNodesContextEntry

modelContextEntry

protected JAXXContextEntryDef<NavigationModel> modelContextEntry

handlerContextEntry

protected JAXXContextEntryDef<NavigationTreeHandler> handlerContextEntry

treeContextEntry

protected JAXXContextEntryDef<JTree> treeContextEntry

treeTableContextEntry

protected JAXXContextEntryDef<org.jdesktop.swingx.JXTreeTable> treeTableContextEntry

Constructor Detail

NavigationTreeContextHelper

public NavigationTreeContextHelper(String prefix)

Method Detail

getPrefix

public String getPrefix()

getTree

public JTree getTree(JAXXContext context)

getTreeTable

public org.jdesktop.swingx.JXTreeTable getTreeTable(JAXXContext context)

getModel

public NavigationModel getModel(JAXXContext context)

getTreeModel

@Deprecated
public NavigationTreeModel getTreeModel(JAXXContext context)

Deprecated. since 2.0 please use getModel(JAXXContext), will be remove soon

Parameters:

context - where to find model

Returns:

the specific tree model

getTreeHandler

public NavigationTreeHandler getTreeHandler(JAXXContext context)

getSelectedPath

public String getSelectedPath(JAXXContext context)

getSelectedPaths

public List<String> getSelectedPaths(JAXXContext context)

getSelectedNode

public NavigationTreeNode getSelectedNode(JAXXContext context)

getSelectedNodes

public List<NavigationTreeNode> getSelectedNodes(JAXXContext context)

getSelectedBean

public Object getSelectedBean(JAXXContext context)

getSelectedBeans

public List<Object> getSelectedBeans(JAXXContext context)

setTreeModel

@Deprecated
public void setTreeModel(JAXXContext context,
                                    NavigationModel model)

Deprecated. since 2.0 please use setModel(JAXXContext, NavigationModel), will be remove soon

Parameters:

context - where to store model

model - model to store

setModel

public void setModel(JAXXContext context,
                     NavigationModel model)

setTree

public void setTree(JAXXContext context,
                    JTree tree)

setTreeTable

public void setTreeTable(JAXXContext context,
                         org.jdesktop.swingx.JXTreeTable treeTable)

setTreeHandler

public void setTreeHandler(JAXXContext context,
                           NavigationTreeHandler handler)

setSelectedPath

public void setSelectedPath(JAXXContext context,
                            String path)

setSelectedPaths

public void setSelectedPaths(JAXXContext context,
                             List<String> paths)

setSelectedNode

public void setSelectedNode(JAXXContext context,
                            NavigationTreeNode node)

setSelectedNodes

public void setSelectedNodes(JAXXContext context,
                             List<NavigationTreeNode> nodes)

setSelectedBean

public void setSelectedBean(JAXXContext context,
                            Object bean)

setSelectedBeans

public void setSelectedBeans(JAXXContext context,
                             List<Object> beans)

getModelContextEntry

protected JAXXContextEntryDef<NavigationModel> getModelContextEntry()

getTreeHandlerContextEntry

protected JAXXContextEntryDef<NavigationTreeHandler> getTreeHandlerContextEntry()

getSelectedBeanContextEntry

protected JAXXContextEntryDef<List<Object>> getSelectedBeanContextEntry()

getSelectedNodeContextEntry

protected JAXXContextEntryDef<List<NavigationTreeNode>> getSelectedNodeContextEntry()

getSelectedPathContextEntry

protected JAXXContextEntryDef<List<String>> getSelectedPathContextEntry()

getTreeContextEntry

protected JAXXContextEntryDef<JTree> getTreeContextEntry()

getTreeTableContextEntry

protected JAXXContextEntryDef<org.jdesktop.swingx.JXTreeTable> getTreeTableContextEntry()

getSelectedValue

protected <T> T getSelectedValue(JAXXContextEntryDef<List<T>> entry,
                                 JAXXContext context)

setSelectedValue

protected <T> void setSelectedValue(JAXXContextEntryDef<List<T>> entry,
                                    JAXXContext context,
                                    T value)

setSelectedValues

protected <T> void setSelectedValues(JAXXContextEntryDef<List<T>> entry,
                                     JAXXContext context,
                                     List<T> values)