cern.gp.explorer

Class ListTableExplorer

java.lang.Object

ExplorerPanel

cern.gp.explorer.GPListExplorerPanel

cern.gp.explorer.ListTableExplorer

All Implemented Interfaces:

TablePropertyHolder

public class ListTableExplorer
extends GPListExplorerPanel
implements TablePropertyHolder

A GUI component that combines a List with a Table, with the List on the left side and the Table on the right. Each node of the list corresponds to a row in the table. It can be used to explore JavaBeans in the Tree and show ther properties in the Table. This class shall simplify the task of creating and parametrizing this type of explorer. As the other Explorers provided by the GP project, it is strongly based on JavaBeans: The nodes in the List contain JavaBeans-compliant objects ("domain beans"), and the rows in the Table display the properties of these domain beans.

The implementation enables the developer to create a Explorer that s/he can easily place into a NetBeans Mode. It has methods to easily configure the colums of the Table. It is recommended that the developer uses the NodeFactory to create the Node hierarchy to be explored.

Author:

Vito Baggiolini

Constructor Summary

Constructors

Modifier	Constructor and Description
	ListTableExplorer() create a ListTableExplorer with the default view and model.
	ListTableExplorer(java.lang.Class viewableBeanClass) Deprecated. this method is only used for a real SortableTreeTableExplorer
	ListTableExplorer(java.lang.Class[] viewableBeanClasses) Deprecated. this method is only used for a real SortableTreeTableExplorer
	ListTableExplorer(GPNode[] nodes) create a ListTableExplorer and set the nodes to display
protected	ListTableExplorer(TreeTableViewTableAccess view)

Method Summary

Modifier and Type	Method and Description
java.lang.String[]	getTableColumnNames() Accessor method, the counterpart to setTableColumns(String[])
TreeTableViewTableAccess	getTreeTableAccess() Getter Method
void	setListNodes(GPNode[] nodes) set the nodes to be displayed in the table.
void	setPreferredSize(java.awt.Dimension dim) set the preferred size of the TableExplorer
void	setProperties(Node.Property[] props, boolean[] sortable)
void	setRootNode(GPNode node) set the parent node of the list of nodes to be explored.
void	setTableColumnPreferredWidth(int index, int width) set the preferred width of the specified column
void	setTableColumns(java.lang.Class beanClass) Deprecated. use setTableColumns(Object) or setTableColumns(GPBean, String[]) instead
void	setTableColumns(java.lang.Class[] propTypes, java.lang.String[] propNames) Sets the colums of the Table.
void	setTableColumns(java.lang.Class[] propTypes, java.lang.String[] propNames, boolean[] sortable)
void	setTableColumns(java.lang.Class beanClass, java.lang.String[] propNames) Deprecated. use setTableColumns(Object, String[]) or setTableColumns(GPBean, String[]) instead
void	setTableColumns(GPNode node, java.lang.String[] propNames) Sets the columns of the Table.
void	setTableColumns(GPNode node, java.lang.String[] propNames, boolean[] sortable)
void	setTableColumns(java.lang.Object bean) Sets the columns of the Table.
void	setTableColumns(java.lang.Object bean, java.lang.String[] propNames) Sets the columns of the Table.
void	setTableColumns(java.lang.Object bean, java.lang.String[] propNames, boolean[] sortable)
void	setTableColumns(java.lang.String[] propNames) set the columns to be displayed.
void	setTreePreferredWidth(int width) set the preferred width of the whole TableExplorer

Methods inherited from class cern.gp.explorer.GPListExplorerPanel

createRootNode, getListNodes, getRootBean, getRootNode, setName, setRootBean

Methods inherited from class java.lang.Object

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

Constructor Detail

ListTableExplorer

public ListTableExplorer()

create a ListTableExplorer with the default view and model.

ListTableExplorer

public ListTableExplorer(GPNode[] nodes)

create a ListTableExplorer and set the nodes to display

Parameters:

nodes - the nodes to display

ListTableExplorer

protected ListTableExplorer(TreeTableViewTableAccess view)

ListTableExplorer

public ListTableExplorer(java.lang.Class viewableBeanClass)

Deprecated. this method is only used for a real SortableTreeTableExplorer

create a TreeTableExplorer and specify the class of the bean from which the Table rows shall be inferred. This constructor works if you want to display the properties of only one Bean in the Table. Otherwise use another constructor.

Parameters:

viewableBeanClass - the bean class whose properties shall be displayed in the Table

ListTableExplorer

public ListTableExplorer(java.lang.Class[] viewableBeanClasses)

Deprecated. this method is only used for a real SortableTreeTableExplorer

create a TreeTableExplorer and specify which beans shall be visible in the Table part of the TreeTable. Only Bean classes that equal or inherit from one of the classes passed to this constructor will have their properties displayed in the Table. The others table cells will be empty.

Parameters:

viewableBeanClass - the bean classes whose properties shall be displayed in the Table

Method Detail

getTreeTableAccess

public TreeTableViewTableAccess getTreeTableAccess()

Getter Method

Returns:

the TreeTableView of this TreeTableExplorer

setListNodes

public final void setListNodes(GPNode[] nodes)

set the nodes to be displayed in the table.

Specified by:

setListNodes in class GPListExplorerPanel

Parameters:

nodes - an array of nodes each associated with a Bean.

setRootNode

public void setRootNode(GPNode node)

set the parent node of the list of nodes to be explored. The parent node is not displayed, only its children nodes. Use this method

• if you already have a root node whose children you want to display
• if you want to control the nodes with your own ChildrenManager as shown below

Otherwise, you should use setListNodes(GPNode[])

Overrides:

setRootNode in class GPListExplorerPanel

Parameters:

parentNode - the parent of the nodes to be displayed in the List

setPreferredSize

public void setPreferredSize(java.awt.Dimension dim)

set the preferred size of the TableExplorer

setTreePreferredWidth

public void setTreePreferredWidth(int width)

set the preferred width of the whole TableExplorer

setTableColumnPreferredWidth

public void setTableColumnPreferredWidth(int index,
                                         int width)

set the preferred width of the specified column

setTableColumns

public void setTableColumns(java.lang.String[] propNames)
                     throws java.beans.IntrospectionException

set the columns to be displayed. Note that before this method is called you must have called setListNodes(GPNode[])

Throws:

java.beans.IntrospectionException

getTableColumnNames

public java.lang.String[] getTableColumnNames()

Accessor method, the counterpart to setTableColumns(String[])

Returns:

the names of the currently accessed table colums

setTableColumns

public void setTableColumns(GPNode node,
                            java.lang.String[] propNames)

Sets the columns of the Table. This method determines the type of the method by using the information contained in the GPNode. It also takes into account the additional info specified using the BeanSupport.getPropertyInfo() method. Beware: all properties passed in the propNames argument must also be present in the beanClass represented by this node. If you don't have a suitable GPNode, please use the {#setTableColumns(Class[], String[])} method.

propNames - the properties to be displayed as columns in the table

setTableColumns

public void setTableColumns(java.lang.Object bean)
                     throws java.beans.IntrospectionException

Sets the columns of the Table. This method determines the type of the properties by doing reflection on the beanClass. It also takes into account info specified in the method BeanSupport.getPropertyInfo() All non-hidden properties of the bean will be displayed as columns in the Table

Throws:

java.beans.IntrospectionException

setTableColumns

public void setTableColumns(java.lang.Object bean,
                            java.lang.String[] propNames)
                     throws java.beans.IntrospectionException

Sets the columns of the Table. This method determines the type of the method by doing reflection on the Bean. It also takes into account the additional info specified in BeanSupport.getPropertyInfo().

Beware: all properties passed in the propNames argument must also be present in the beanClass. If you already have created a GPNode for this bean, you should use setTableColumns(GPNode, String[]) because this is more efficient.
If you don't have such a bean, please use the {#setTableColumns(Class[], String[])} method.

Parameters:

bean - the bean displayed in the table

propNames - the properties to be displayed as columns in the table

Throws:

java.beans.IntrospectionException - if something goes wrong while introspecting the bean

setTableColumns

public void setTableColumns(java.lang.Class[] propTypes,
                            java.lang.String[] propNames)

Sets the colums of the Table. The colums are identified by their name and their type. Please make sure that the two arrays passed as arguments correspond. Cautiondo not use this with beans that implement the BeanSupport.getPropertyInfo() method to customize settings for properties. For such beans use {{#setTableColumns(Object, String[])} instead.

Parameters:

propTypes - the types of the properties corresponding to the names

propNames - the names of the properties to be displayed

setTableColumns

public void setTableColumns(java.lang.Class[] propTypes,
                            java.lang.String[] propNames,
                            boolean[] sortable)

Since:

2.0.6

setTableColumns

public void setTableColumns(GPNode node,
                            java.lang.String[] propNames,
                            boolean[] sortable)

Since:

2.0.6

setTableColumns

public void setTableColumns(java.lang.Object bean,
                            java.lang.String[] propNames,
                            boolean[] sortable)
                     throws java.beans.IntrospectionException

Throws:

java.beans.IntrospectionException

Since:

2.0.6

setTableColumns

public void setTableColumns(java.lang.Class beanClass)
                     throws java.beans.IntrospectionException

Deprecated. use setTableColumns(Object) or setTableColumns(GPBean, String[]) instead

Sets the columns of the Table. This method determines the type of the properties by doing reflection on the beanClass. As a result all properties of the bean will be displayed as columns in the Table

Throws:

java.beans.IntrospectionException

setTableColumns

public void setTableColumns(java.lang.Class beanClass,
                            java.lang.String[] propNames)
                     throws java.beans.IntrospectionException

Deprecated. use setTableColumns(Object, String[]) or setTableColumns(GPBean, String[]) instead

Sets the columns of the Table. This method determines the type of the properties by doing reflection on the beanClass. Beware: all properties passed in the propNames argument must also be present in the beanClass. If you don't have such a bean, please use the other setTableColums() method.

Parameters:

beanClass - the class of one of the beans that shall be displayed. It must have all properties mentioned in the propNames argument

propNames - the name of the properties to be displayed

Throws:

java.beans.IntrospectionException - if a property is not found in the beanClass

See Also:

setTableColumns(Class[], String[])

setProperties

public void setProperties(Node.Property[] props,
                          boolean[] sortable)

Specified by:

setProperties in interface TablePropertyHolder