All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.ibm.as400.vaccess.VPrinters

java.lang.Object
   |
   +----com.ibm.as400.vaccess.VPrinters

public class VPrinters
extends Object
implements VNode, Serializable
The VPrinters class represents a list of AS/400 printers for use in various models and panes in this package.

Both the children and details children of a VPrinters object are the printers (VPrinter objects) in this list.

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

VPrinters objects generate the following events:


Constructor Index

 o VPrinters()
Constructs a VPrinters object.
 o VPrinters(AS400)
Constructs a VPrinters object.
 o VPrinters(VNode, AS400)
Constructs a VPrinters object.

Method Index

 o addErrorListener(ErrorListener)
Adds a listener to be notified when an error occurs.
 o addPropertyChangeListener(PropertyChangeListener)
Adds a listener to be notified when the value of any bound property changes.
 o addVetoableChangeListener(VetoableChangeListener)
Adds a listener to be notified when the value of any constrained property changes.
 o addVObjectListener(VObjectListener)
Adds a listener to be notified when a VObject is changed, created, or deleted.
 o addWorkingListener(WorkingListener)
Adds a listener to be notified when work starts and stops on potentially long-running operations.
 o children()
Returns the children of the node.
 o getActions()
Returns the list of actions that can be performed.
 o getAllowsChildren()
Indiciates if the node allows children.
 o getChildAt(int)
Returns the child node at the specified index.
 o getChildCount()
Returns the number of children.
 o getDefaultAction()
Returns the default action.
 o getDetailsChildAt(int)
Returns the child for the details at the specified index.
 o getDetailsChildCount()
Returns the number of children for the details.
 o getDetailsColumnModel()
Returns the table column model to use in the details when representing the children.
 o getDetailsIndex(VObject)
Returns the index of the specified child for the details.
 o getIcon(int, boolean)
Returns the icon.
 o getIndex(TreeNode)
Returns the index of the specified child.
 o getParent()
Returns the parent node.
 o getPrinterFilter()
Returns the printer list filter.
 o getPropertiesPane()
Returns the properties pane.
 o getPropertyValue(Object)
Returns a property value.
 o getSystem()
Returns the AS/400 from which the list will be retrieved.
 o getText()
Returns the text.
 o isLeaf()
Indicates if the node is a leaf.
 o isSortable()
Indicates if the details children are sortable.
 o load()
Loads information about the object from the AS/400.
 o removeErrorListener(ErrorListener)
Removes an error listener.
 o removePropertyChangeListener(PropertyChangeListener)
Removes a property change listener.
 o removeVetoableChangeListener(VetoableChangeListener)
Removes a vetoable change listener.
 o removeVObjectListener(VObjectListener)
Removes a VObjectListener.
 o removeWorkingListener(WorkingListener)
Removes a working listener.
 o setPrinterFilter(String)
Sets printer list filter.
 o setSystem(AS400)
Sets the AS/400 from which the list will be retrieved.
 o sortDetailsChildren(Object[], boolean[])
Sorts the children for the details.
 o toString()
Returns the string representation.

Constructors

 o VPrinters
 public VPrinters()
Constructs a VPrinters object.

 o VPrinters
 public VPrinters(AS400 system)
Constructs a VPrinters object.

Parameters:
system - The AS/400 from which the list will be retrieved.
 o VPrinters
 public VPrinters(VNode parent,
                  AS400 system)
Constructs a VPrinters object.

Parameters:
parent - The parent.
system - The AS/400 from which the list will be retrieved.

Methods

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

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.
 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.
 o addVObjectListener
 public void addVObjectListener(VObjectListener listener)
Adds a listener to be notified when a VObject is changed, created, or deleted.

Parameters:
listener - The listener.
 o addWorkingListener
 public void addWorkingListener(WorkingListener listener)
Adds a listener to be notified when work starts and stops on potentially long-running operations.

Parameters:
listener - The listener.
 o children
 public Enumeration children()
Returns the children of the node. The children are the printers.

Returns:
The children.
 o getActions
 public VAction[] getActions()
Returns the list of actions that can be performed.

Returns:
Always null. There are no actions.
 o getAllowsChildren
 public boolean getAllowsChildren()
Indiciates if the node allows children.

Returns:
Always true.
 o getChildAt
 public synchronized TreeNode getChildAt(int index)
Returns the child node at the specified index.

Parameters:
index - The index.
Returns:
The child node, or null if the index is not valid.
 o getChildCount
 public synchronized int getChildCount()
Returns the number of children. This is the number of printers.

Returns:
The number of children.
 o getDefaultAction
 public VAction getDefaultAction()
Returns the default action.

Returns:
Always null. There is no default action.
 o getDetailsChildAt
 public synchronized VObject getDetailsChildAt(int index)
Returns the child for the details at the specified index.

Parameters:
index - The index.
Returns:
The child, or null if the index is not valid.
 o getDetailsChildCount
 public int getDetailsChildCount()
Returns the number of children for the details.

Returns:
The number of children for the details.
 o getDetailsColumnModel
 public TableColumnModel getDetailsColumnModel()
Returns the table column model to use in the details when representing the children. This column model describes the details values for the children.

Returns:
The details column model.
 o getDetailsIndex
 public synchronized int getDetailsIndex(VObject detailsChild)
Returns the index of the specified child for the details.

Parameters:
detailsChild - The details child.
Returns:
The index, or -1 if the child is not found in the details.
 o getIcon
 public Icon getIcon(int size,
                     boolean open)
Returns the icon.

Parameters:
size - The icon size, either 16 or 32. If any other value is given, then return the default of 16.
open - This parameter has no effect.
Returns:
The icon.
 o getIndex
 public synchronized int getIndex(TreeNode child)
Returns the index of the specified child.

Parameters:
child - The child.
Returns:
The index, or -1 if the child is not found.
 o getParent
 public TreeNode getParent()
Returns the parent node.

Returns:
The parent node, or null if there is no parent.
 o getPrinterFilter
 public String getPrinterFilter()
Returns the printer list filter.

Returns:
The printer filter.
 o getPropertiesPane
 public VPropertiesPane getPropertiesPane()
Returns the properties pane.

Returns:
The properties pane.
 o getPropertyValue
 public synchronized Object getPropertyValue(Object propertyIdentifier)
Returns a property value.

Parameters:
propertyIdentifier - The property identifier. The choices are
  • NAME_PROPERTY
  • DESCRIPTION_PROPERTY
Returns:
The property value, or null if the property identifier is not recognized.
 o getSystem
 public AS400 getSystem()
Returns the AS/400 from which the list will be retrieved.

Returns:
The AS/400 from which the list will be retrieved.
 o getText
 public String getText()
Returns the text. This is a constant string which identifies this object as a list of printers.

Returns:
The text.
 o isLeaf
 public boolean isLeaf()
Indicates if the node is a leaf.

Returns:
true if the node if a leaf; false otherwise.
 o isSortable
 public boolean isSortable()
Indicates if the details children are sortable.

Returns:
Always false.
 o load
 public void load()
Loads information about the object from the AS/400.

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

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

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

Parameters:
listener - The listener.
 o removeVObjectListener
 public void removeVObjectListener(VObjectListener listener)
Removes a VObjectListener.

Parameters:
listener - The listener.
 o removeWorkingListener
 public void removeWorkingListener(WorkingListener listener)
Removes a working listener.

Parameters:
listener - The listener.
 o setPrinterFilter
 public void setPrinterFilter(String printerFilter) throws PropertyVetoException
Sets printer list filter. A call to load() must be done after calling this funtion inorder to update the details and tree children.

Parameters:
printerFilter - The name of the printers to list. It cannot be greater than 10 characters in length. It can be a specific name, a generic name, or the special value *ALL. The default for the printerFilter is *ALL.
Throws: PropertyVetoException
If the change is vetoed.
 o setSystem
 public void setSystem(AS400 system) throws PropertyVetoException
Sets the AS/400 from which the list will be retrieved. A call to load() must be done after calling this funtion inorder to update the details and tree children.

Parameters:
system - The AS/400 from which the list will be retrieved.
Throws: PropertyVetoException
If the change is vetoed.
 o sortDetailsChildren
 public void sortDetailsChildren(Object propertyIdentifiers[],
                                 boolean orders[])
Sorts the children for the details. Since sorting is not supported, this method does nothing.

Parameters:
propertyIdentifiers - The property identifiers.
orders - The sort orders for each property identifier; true for ascending order, false for descending order.
 o toString
 public String toString()
Returns the string representation. This is a constant string which identifies this object as a list of printers.

Returns:
The string representation.
Overrides:
toString in class Object

All Packages  Class Hierarchy  This Package  Previous  Next  Index