com.ibm.as400.vaccess
Class AS400ListPane

java.lang.Object
  extended byjava.awt.Component
      extended byjava.awt.Container
          extended byjavax.swing.JComponent
              extended bycom.ibm.as400.vaccess.AS400ListPane
All Implemented Interfaces:
ImageObserver, MenuContainer, Serializable

Deprecated. Use Java Swing instead, along with the classes in package com.ibm.as400.access

public class AS400ListPane
extends JComponent
implements Serializable

The AS400ListPane class represents a graphical user interface that presents a list of the contents of a server resource, known as the root. You must explicitly call load() to load the information from the server.

Most errors are reported as ErrorEvents rather than throwing exceptions. Users should listen for ErrorEvents in order to diagnose and recover from error conditions.

AS400ListPane objects generate the following events:

The following example creates a list pane filled with the list of printers on a server.

// Set up the list pane.
AS400 system = new AS400 ("MySystem", "Userid", "Password");
VPrinters printers = new VPrinters (system);
AS400ListPane listPane = new AS400ListPane (printers);
listPane.load ();

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

See Also:
AS400ListModel, Serialized Form

Nested Class Summary
 
Nested classes inherited from class javax.swing.JComponent
JComponent.AccessibleJComponent
 
Nested classes inherited from class java.awt.Container
Container.AccessibleAWTContainer
 
Nested classes inherited from class java.awt.Component
Component.AccessibleAWTComponent, Component.BltBufferStrategy, Component.FlipBufferStrategy
 
Field Summary
 
Fields inherited from class javax.swing.JComponent
accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
 
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
 
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
 
Constructor Summary
AS400ListPane()
          Deprecated. Constructs an AS400ListPane object.
AS400ListPane(VNode root)
          Deprecated. Constructs an AS400ListPane object.
 
Method Summary
 void addErrorListener(ErrorListener listener)
          Deprecated. Adds a listener to be notified when an error occurs.
 void addListSelectionListener(ListSelectionListener listener)
          Deprecated. Adds a listener to be notified when a list selection occurs.
 void addPropertyChangeListener(PropertyChangeListener listener)
          Deprecated. Adds a listener to be notified when the value of any bound property changes.
 void addVetoableChangeListener(VetoableChangeListener listener)
          Deprecated. Adds a listener to be notified when the value of any constrained property changes.
 VActionContext getActionContext()
          Deprecated. Returns the context in which actions will be performed.
 boolean getAllowActions()
          Deprecated. Indicates if actions can be invoked on objects.
 boolean getConfirm()
          Deprecated. Indicates if certain actions are confirmed with the user.
 ListModel getModel()
          Deprecated. Returns the list model.
 VNode getRoot()
          Deprecated. Returns the root, or the server resource, from which all information for the model is gathered.
 VObject getSelectedObject()
          Deprecated. Returns the first selected object.
 VObject[] getSelectedObjects()
          Deprecated. Returns the selected objects.
 ListSelectionModel getSelectionModel()
          Deprecated. Returns the selection model that is used to maintain selection state.
 int getVisibleRowCount()
          Deprecated. Returns the preferred number of visible rows.
 boolean isSelected(VObject object)
          Deprecated. Indicates if the object is selected.
 void load()
          Deprecated. Loads the information from the server.
 void removeErrorListener(ErrorListener listener)
          Deprecated. Removes an error listener.
 void removeListSelectionListener(ListSelectionListener listener)
          Deprecated. Removes a list selection listener.
 void removePropertyChangeListener(PropertyChangeListener listener)
          Deprecated. Removes a property change listener.
 void removeVetoableChangeListener(VetoableChangeListener listener)
          Deprecated. Removes a vetoable change listener.
 void setAllowActions(boolean allowActions)
          Deprecated. Sets whether actions are allowed.
 void setConfirm(boolean confirm)
          Deprecated. Sets whether certain actions are confirmed with the user.
 void setRoot(VNode root)
          Deprecated. Sets the root, or the server resource, from which all information for the model is gathered.
 void setSelectionModel(ListSelectionModel selectionModel)
          Deprecated. Sets the selection model that is used to maintain selection state.
 void setVisibleRowCount(int visibleRowCount)
          Deprecated. Sets the preferred number of visible rows.
 void sort(Object[] propertyIdentifiers, boolean[] orders)
          Deprecated. Sorts the contents.
 
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addPropertyChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getAccessibleContext, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, paramString, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFont, setForeground, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update, updateUI
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addImpl, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setLayout, transferFocusBackward, transferFocusDownCycle, validate, validateTree
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

AS400ListPane

public AS400ListPane()
Deprecated. 
Constructs an AS400ListPane object.


AS400ListPane

public AS400ListPane(VNode root)
Deprecated. 
Constructs an AS400ListPane object.

Parameters:
root - The root, or the server resource, from which all information for the model is gathered.
Method Detail

addErrorListener

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

Parameters:
listener - The listener.

addListSelectionListener

public void addListSelectionListener(ListSelectionListener listener)
Deprecated. 
Adds a listener to be notified when a list selection occurs.

Parameters:
listener - The listener.

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener listener)
Deprecated. 
Adds a listener to be notified when the value of any bound property changes.

Parameters:
listener - The listener.

addVetoableChangeListener

public void addVetoableChangeListener(VetoableChangeListener listener)
Deprecated. 
Adds a listener to be notified when the value of any constrained property changes.

Parameters:
listener - The listener.

getActionContext

public VActionContext getActionContext()
Deprecated. 
Returns the context in which actions will be performed.

Returns:
The action context.

getAllowActions

public boolean getAllowActions()
Deprecated. 
Indicates if actions can be invoked on objects.

Returns:
true if actions can be invoked; false otherwise.

getConfirm

public boolean getConfirm()
Deprecated. 
Indicates if certain actions are confirmed with the user.

Returns:
true if certain actions are confirmed with the user; false otherwise.

getModel

public ListModel getModel()
Deprecated. 
Returns the list model.

Returns:
The list model.

getRoot

public VNode getRoot()
Deprecated. 
Returns the root, or the server resource, from which all information for the model is gathered.

Returns:
The root, or the server resource, from which all information for the model is gathered. It will be null if none has been set.

getSelectedObject

public VObject getSelectedObject()
Deprecated. 
Returns the first selected object.

Returns:
The first selected object, or null if none are selected.

getSelectedObjects

public VObject[] getSelectedObjects()
Deprecated. 
Returns the selected objects.

Returns:
The selected objects.

getSelectionModel

public ListSelectionModel getSelectionModel()
Deprecated. 
Returns the selection model that is used to maintain selection state. This provides the ability to programmatically select and deselect objects.

Returns:
The selection model.

getVisibleRowCount

public int getVisibleRowCount()
Deprecated. 
Returns the preferred number of visible rows.

Returns:
The preferred number of visible rows.

isSelected

public boolean isSelected(VObject object)
Deprecated. 
Indicates if the object is selected.

Parameters:
object - The object.
Returns:
true if the object is selected; false otherwise.

load

public void load()
Deprecated. 
Loads the information from the server.


removeErrorListener

public void removeErrorListener(ErrorListener listener)
Deprecated. 
Removes an error listener.

Parameters:
listener - The listener.

removeListSelectionListener

public void removeListSelectionListener(ListSelectionListener listener)
Deprecated. 
Removes a list selection listener.

Parameters:
listener - The listener.

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener listener)
Deprecated. 
Removes a property change listener.

Parameters:
listener - The listener.

removeVetoableChangeListener

public void removeVetoableChangeListener(VetoableChangeListener listener)
Deprecated. 
Removes a vetoable change listener.

Parameters:
listener - The listener.

setAllowActions

public void setAllowActions(boolean allowActions)
Deprecated. 
Sets whether actions are allowed. The following are enabled only when actions are allowed:

The default is false.

Parameters:
allowActions - true if actions are allowed; false otherwise.

setConfirm

public void setConfirm(boolean confirm)
Deprecated. 
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.

setRoot

public void setRoot(VNode root)
             throws PropertyVetoException
Deprecated. 
Sets the root, or the server 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 server resource, from which all information for the model is gathered.
Throws:
PropertyVetoException - If the change is vetoed.

setSelectionModel

public void setSelectionModel(ListSelectionModel selectionModel)
Deprecated. 
Sets the selection model that is used to maintain selection state. This provides the ability to programmatically select and deselect objects.

Parameters:
selectionModel - The selection model.

setVisibleRowCount

public void setVisibleRowCount(int visibleRowCount)
Deprecated. 
Sets the preferred number of visible rows.

Parameters:
visibleRowCount - The preferred number of visible rows.

sort

public void sort(Object[] propertyIdentifiers,
                 boolean[] orders)
Deprecated. 
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.