Classes | Public Member Functions | Static Public Attributes | Protected Member Functions | Static Protected Member Functions

cern.gp.explorer.MultiListExplorer Class Reference

Inherits org::openide::explorer::ExplorerPanel.

List of all members.

Classes

interface  ComponentCreator
class  ListExplorerPanel
class  ListSelectionListener
class  NextListSelectionListener
interface  SelectionListener

Public Member Functions

 MultiListExplorer ()
 MultiListExplorer (SelectionListener selectionListener, int listCount)
 MultiListExplorer (SelectionListener selectionListener, int width, int height)
 MultiListExplorer (SelectionListener selectionListener, int listCount, int width, int height, boolean twoRows)
void addNotify ()
void removeNotify ()
void setRootNode (GPNode node)
ComponentCreator getTopComponentCreator ()
void setTopComponentCreator (ComponentCreator componentCreator)
ComponentCreator getBottomComponentCreator ()
void setBottomComponentCreator (ComponentCreator componentCreator)
void setListCount (int listCount)
int getListCount ()
void setAutomaticSelection (boolean automaticSelection)
boolean getAutomaticSelection ()

Static Public Attributes

static final int DEFAULT_WIDTH = 600
static final int DEFAULT_HEIGHT = 400
static final int DEFAULT_LIST_COUNT = 4

Protected Member Functions

ExplorerManager getExplorerManager (int listIndex)

Static Protected Member Functions

static void selectNthChildren (ExplorerManager explorerManager, int n)

Detailed Description

MultiListExplorer is an explorer showing several lists linked together allowing to show several levels of depth at once. The first list shows the children of the root node, the second list shows the children of the selected node in the first list, and so on.

The number of lists is parameterizable.

It is possible to register a java.beans.PropertyChangeListener to be notified of the selection in the different list. The method getExplorerManager(int) allow to register such a listener on one particular list.

It is possible to customize the top and bottom component of each list by setting a ComponentCreator for top or bottom before adding the explorer to the gui.

Version:
Revision:
1.2
Date:
2006/09/25 08:52:36
Author:
Lionel Mestre

Constructor & Destructor Documentation

cern.gp.explorer.MultiListExplorer.MultiListExplorer (  ) 
cern.gp.explorer.MultiListExplorer.MultiListExplorer ( SelectionListener  selectionListener,
int  listCount 
)
cern.gp.explorer.MultiListExplorer.MultiListExplorer ( SelectionListener  selectionListener,
int  width,
int  height 
)
cern.gp.explorer.MultiListExplorer.MultiListExplorer ( SelectionListener  selectionListener,
int  listCount,
int  width,
int  height,
boolean  twoRows 
)

Member Function Documentation

void cern.gp.explorer.MultiListExplorer.addNotify (  ) 
boolean cern.gp.explorer.MultiListExplorer.getAutomaticSelection (  ) 

Returns if the selection in one list triggers the selection in the subsequent lists.

Returns:
if the selection in one list triggers the selection in the subsequent lists.
ComponentCreator cern.gp.explorer.MultiListExplorer.getBottomComponentCreator (  ) 

Returns the bottomComponentCreator that is used to create the top component of each list in the explorer or null if none is set.

Returns:
the current bottomComponentCreator or null
ExplorerManager cern.gp.explorer.MultiListExplorer.getExplorerManager ( int  listIndex  )  [protected]

Returns the explorer manager of the list of given index

Returns:
the explorer manager of the list of given index

Referenced by cern.gp.explorer.MultiListExplorer.addNotify(), and cern.gp.explorer.MultiListExplorer.setRootNode().

int cern.gp.explorer.MultiListExplorer.getListCount (  ) 

Returns the number of lists in the explorer.

Returns:
the number of lists in the explorer.
ComponentCreator cern.gp.explorer.MultiListExplorer.getTopComponentCreator (  ) 

Returns the topComponentCreator that is used to create the top component of each list in the explorer or null if none is set.

Returns:
the current topComponentCreator or null
void cern.gp.explorer.MultiListExplorer.removeNotify (  ) 
static void cern.gp.explorer.MultiListExplorer.selectNthChildren ( ExplorerManager  explorerManager,
int  n 
) [static, protected]
void cern.gp.explorer.MultiListExplorer.setAutomaticSelection ( boolean  automaticSelection  ) 

Sets if the selection in one list triggers the selection in the subsequent lists. This property is true by default.

Parameters:
automaticSelection whether the selection in one list cascade to the others
void cern.gp.explorer.MultiListExplorer.setBottomComponentCreator ( ComponentCreator  componentCreator  ) 

Sets the bottomComponentCreator that is used to create the top component of each list in the explorer. Null can be used to remove an existing creator. The bottomComponentCreator cannot be changed once the explorer has been included in a gui. It can only be changed after instantiation before adding the Explorer into a container.

Parameters:
componentCreator the componentCreator to use to create the bottom components
void cern.gp.explorer.MultiListExplorer.setListCount ( int  listCount  ) 

Sets the number of lists in the explorer. Cannot be inferior to 2. The number cannot be changed once the explorer has been included in a gui. The number can only be changed after instantiation before adding the Explorer into a container.

Parameters:
listCount the number of ilst in the explorer
void cern.gp.explorer.MultiListExplorer.setRootNode ( GPNode  node  ) 

set the root node of the hiearachy to be explored

References cern.gp.explorer.MultiListExplorer.getExplorerManager(), and cern.gp.nodes.GPNode.getPeerNode().

void cern.gp.explorer.MultiListExplorer.setTopComponentCreator ( ComponentCreator  componentCreator  ) 

Sets the topComponentCreator that is used to create the top component of each list in the explorer. Null can be used to remove an existing creator. The topComponentCreator cannot be changed once the explorer has been included in a gui. It can only be changed after instantiation before adding the Explorer into a container.

Parameters:
componentCreator the componentCreator to use to create the top components

Member Data Documentation


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Enumerations Properties