All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.ibm.as400.vaccess.AS400ExplorerPane

java.lang.Object
   |
   +----java.awt.Component
           |
           +----java.awt.Container
                   |
                   +----com.sun.java.swing.JComponent
                           |
                           +----com.ibm.as400.vaccess.AS400ExplorerPane

public class AS400ExplorerPane
extends JComponent
implements Serializable
The AS400ExplorerPane class represents a graphical user interface that is useful for working with the hierarchy of objects rooted at an AS/400 resource. The graphical user interface presents a tree on the left side and the details of the selected resource in the right side. You must explicitly call load() to load the information from the AS/400.

AS400ExplorerPane objects generate the following events:

The following example creates an explorer pane filled with the contents of a directory in the integrated file system of an AS/400.

// Set up the explorer pane.
AS400 system = new AS400 ("MySystem", "Userid", "Password");
VIFSDirectory directory = new VIFSDirectory (system, "/myDirectory");
AS400ExplorerPane explorerPane = new AS400ExplorerPane (directory);
explorerPane.load ();

// Add the explorer pane to a frame. JFrame frame = new JFrame ("My Window"); frame.getContentPane().add (explorerPane);

See Also:
AS400DetailsPane, AS400TreePane

Constructor Index

 o AS400ExplorerPane()
Constructs an AS400ExplorerPane object.
 o AS400ExplorerPane(VNode)
Constructs an AS400ExplorerPane object.

Method Index

 o addErrorListener(ErrorListener)
Adds a listener to be notified when an error occurs.
 o addListSelectionListener(ListSelectionListener)
Adds a listener to be notified when a list selection occurs in the details pane.
 o addPropertyChangeListener(PropertyChangeListener)
Adds a listener to be notified when the value of any bound property changes.
 o addTreeSelectionListener(TreeSelectionListener)
Adds a listener to be notified when a tree selection occurs.
 o addVetoableChangeListener(VetoableChangeListener)
Adds a listener to be notified when the value of any constrained property changes.
 o collapse(VNode)
Collapses the specified object in the tree.
 o expand(VNode)
Expands the specified object in the tree.
 o getActionContext()
Returns the context in which actions will be performed.
 o getAllowActions()
Indicates if actions can be invoked on objects.
 o getConfirm()
Indicates if certain actions are confirmed with the user.
 o getDetailsColumnModel()
Returns the column model that is used to maintain the columns of the details.
 o getDetailsModel()
Returns the details model.
 o getDetailsRoot()
Returns the root of the details pane.
 o getDetailsSelectionModel()
Returns the selection model that is used to maintain selection state in the details.
 o getPath(VNode)
Returns the path from the root to get to this object in the tree hierarchy.
 o getRoot()
Returns the root, or the AS/400 resource, from which all information for the model is gathered.
 o getSelectedObject()
Returns the first selected object.
 o getSelectedObjects()
Returns the selected objects.
 o getTreeModel()
Returns the tree model.
 o getTreeSelectionModel()
Returns the selection model that is used to maintain selection state in the tree.
 o isCollapsed(VNode)
Indicates if the object in the tree is currently collapsed.
 o isExpanded(VNode)
Indicates if the object in the tree is currently expanded.
 o isSelected(VObject)
Indicates if the object in the tree or the details is selected.
 o isVisible(VNode)
Indicates if the object in the tree is currently visible in the tree.
 o load()
Loads the objects from the AS/400.
 o makeVisible(VNode)
Makes the object visible in the tree by expanding its parent objects as needed.
 o removeErrorListener(ErrorListener)
Removes an error listener.
 o removeListSelectionListener(ListSelectionListener)
Removes a list selection listener.
 o removePropertyChangeListener(PropertyChangeListener)
Removes a property change listener.
 o removeTreeSelectionListener(TreeSelectionListener)
Removes a tree selection listener.
 o removeVetoableChangeListener(VetoableChangeListener)
Removes a vetoable change listener.
 o setAllowActions(boolean)
Sets whether actions are allowed.
 o setConfirm(boolean)
Sets whether certain actions are confirmed with the user.
 o setDetailsSelectionModel(ListSelectionModel)
Sets the selection model that is used to maintain selection state in the details.
 o setRoot(VNode)
Sets the root, or the AS/400 resource, from which all information for the model is gathered.
 o setTreeSelectionModel(TreeSelectionModel)
Sets the selection model that is used to maintain selection state in the tree.
 o sort(Object[], boolean[])
Sorts the contents.

Constructors

 o AS400ExplorerPane
 public AS400ExplorerPane()
Constructs an AS400ExplorerPane object.

 o AS400ExplorerPane
 public AS400ExplorerPane(VNode root)
Constructs an AS400ExplorerPane object.

Parameters:
root - The root, or the AS/400 resource, from which all information for the model is gathered.

Methods

 o addErrorListener
 public void addErrorListener(ErrorListener listener)
Adds a listener to be notified when an error occurs.

Parameters:
listener - The listener.
 o addListSelectionListener
 public void addListSelectionListener(ListSelectionListener listener)
Adds a listener to be notified when a list selection occurs in the details pane.

Parameters:
listener - The listener.
 o addPropertyChangeListener
 public void addPropertyChangeListener(PropertyChangeListener listener)
Adds a listener to be notified when the value of any bound property changes.

Parameters:
listener - The listener.
Overrides:
addPropertyChangeListener in class JComponent
 o addTreeSelectionListener
 public void addTreeSelectionListener(TreeSelectionListener listener)
Adds a listener to be notified when a tree selection occurs.

Parameters:
listener - The listener.
 o addVetoableChangeListener
 public void addVetoableChangeListener(VetoableChangeListener listener)
Adds a listener to be notified when the value of any constrained property changes.

Parameters:
listener - The listener.
Overrides:
addVetoableChangeListener in class JComponent
 o collapse
 public void collapse(VNode object)
Collapses the specified object in the tree.

Parameters:
object - The object in the tree.
 o expand
 public void expand(VNode object)
Expands the specified object in the tree.

Parameters:
object - The object in the tree.
 o getActionContext
 public VActionContext getActionContext()
Returns the context in which actions will be performed.

Returns:
The action context.
 o getAllowActions
 public boolean getAllowActions()
Indicates if actions can be invoked on objects.

Returns:
true if a actions can be invoked; false otherwise.
 o getConfirm
 public boolean getConfirm()
Indicates if certain actions are confirmed with the user.

Returns:
true if certain actions are confirmed with the user; false otherwise.
 o getDetailsColumnModel
 public TableColumnModel getDetailsColumnModel()
Returns the column model that is used to maintain the columns of the details. This provides the ability to programmatically add and remove columns.

Returns:
The column model.
 o getDetailsModel
 public TableModel getDetailsModel()
Returns the details model.

Returns:
The details model.
 o getDetailsRoot
 public VNode getDetailsRoot()
Returns the root of the details pane.

Returns:
The root the details pane, or null if there is none.
 o getDetailsSelectionModel
 public ListSelectionModel getDetailsSelectionModel()
Returns the selection model that is used to maintain selection state in the details. This provides the ability to programmatically select and deselect objects.

Returns:
The selection model, or null if selections are not allowed.
 o getPath
 public TreePath getPath(VNode object)
Returns the path from the root to get to this object in the tree hierarchy. The last element in the path will be this object.

Parameters:
object - The object.
Returns:
The path, or null if the object is not a valid object.
 o getRoot
 public VNode getRoot()
Returns the root, or the AS/400 resource, from which all information for the model is gathered.

Returns:
The root, or the AS/400 resource, from which all information for the model is gathered. It will be null if none has been set.
 o getSelectedObject
 public VObject getSelectedObject()
Returns the first selected object. This is the first selected object in the details pane. If no objects are selected in the details pane, then this is the object selected in the tree pane.

Returns:
The first selected object, or null if none are selected.
 o getSelectedObjects
 public VObject[] getSelectedObjects()
Returns the selected objects. These are the selected objects in the details pane. If no objects are selected in the details pane, then this is the object selected in the tree pane.

Returns:
The selected objects.
 o getTreeModel
 public TreeModel getTreeModel()
Returns the tree model.

Returns:
The tree model.
 o getTreeSelectionModel
 public TreeSelectionModel getTreeSelectionModel()
Returns the selection model that is used to maintain selection state in the tree. This provides the ability to programmatically select and deselect objects.

Returns:
The selection model, or null if selections are not allowed.
 o isCollapsed
 public boolean isCollapsed(VNode object)
Indicates if the object in the tree is currently collapsed.

Parameters:
object - The object in the tree.
Returns:
true if the object is collapsed; false otherwise.
 o isExpanded
 public boolean isExpanded(VNode object)
Indicates if the object in the tree is currently expanded.

Parameters:
object - The object in the tree.
Returns:
true if the object is expanded; false otherwise.
 o isSelected
 public boolean isSelected(VObject object)
Indicates if the object in the tree or the details is selected.

Parameters:
object - The object in the tree or the details.
Returns:
true if the object is selected, false otherwise.
 o isVisible
 public boolean isVisible(VNode object)
Indicates if the object in the tree is currently visible in the tree.

Parameters:
object - The object in the tree.
Returns:
true if the object is visible; false otherwise.
 o load
 public void load()
Loads the objects from the AS/400.

 o makeVisible
 public void makeVisible(VNode object)
Makes the object visible in the tree by expanding its parent objects as needed.

Parameters:
object - The object.
 o removeErrorListener
 public void removeErrorListener(ErrorListener listener)
Removes an error listener.

Parameters:
listener - The listener.
 o removeListSelectionListener
 public void removeListSelectionListener(ListSelectionListener listener)
Removes a list selection listener.

Parameters:
listener - The listener.
 o removePropertyChangeListener
 public void removePropertyChangeListener(PropertyChangeListener listener)
Removes a property change listener.

Parameters:
listener - The listener.
Overrides:
removePropertyChangeListener in class JComponent
 o removeTreeSelectionListener
 public void removeTreeSelectionListener(TreeSelectionListener listener)
Removes a tree selection listener.

Parameters:
listener - The listener.
 o removeVetoableChangeListener
 public void removeVetoableChangeListener(VetoableChangeListener listener)
Removes a vetoable change listener.

Parameters:
listener - The listener.
Overrides:
removeVetoableChangeListener in class JComponent
 o setAllowActions
 public void setAllowActions(boolean allowActions)
Sets whether actions are allowed. The following are enabled only when actions are allowed:

The default is true.

Parameters:
allowActions - true if actions are allowed; false otherwise.
 o setConfirm
 public void setConfirm(boolean confirm)
Sets whether certain actions are confirmed with the user. The default is true.

Parameters:
confirm - true if certain actions are confirmed with the user; false otherwise.
 o setDetailsSelectionModel
 public void setDetailsSelectionModel(ListSelectionModel selectionModel)
Sets the selection model that is used to maintain selection state in the details. This provides the ability to programmatically select and deselect objects.

Parameters:
selectionModel - The selection model, or null if selections are not allowed.
 o setRoot
 public void setRoot(VNode root) throws PropertyVetoException
Sets the root, or the AS/400 resource, from which all information for the model is gathered. It will not take effect until load() is done.

Parameters:
root - The root, or the AS/400 resource, from which all information for the model is gathered.
Throws: PropertyVetoException
It the change is vetoed.
 o setTreeSelectionModel
 public void setTreeSelectionModel(TreeSelectionModel selectionModel)
Sets the selection model that is used to maintain selection state in the tree. This provides the ability to programmatically select and deselect objects.

Parameters:
selectionModel - The selection model, or null if selections are not allowed.
 o sort
 public void sort(Object propertyIdentifiers[],
                  boolean orders[])
Sorts the contents. The propertyIdentifer[0], orders[0] combination is used to do the sort. If the values are equal, propertyIdentifier[1], orders[1] is used to break the tie, and so forth.

Parameters:
propertyIdentifiers - The property identifiers. If any of the property identifiers are null, it means to sort using the string representation of the object.
orders - The sort orders for each property identifier, true for ascending order, false for descending order.

All Packages  Class Hierarchy  This Package  Previous  Next  Index