All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.ibm.as400.vaccess.VPrinter

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

public class VPrinter
extends Object
implements VNode, Serializable
The VPrinter class defines the representation of an AS/400 printer for use in various models and panes in this package.

A VPrinter object has no children. Its details children are the spooled files (VOutput objects) on the printer.

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

VPrinter objects generate the following events:

See Also:
Printer

Variable Index

 o OUTPUTQUEUE_PROPERTY
Property identifier for the output queue.
 o PRINTER_PROPERTY
Property identifier for the printer name.
 o STATUS_PROPERTY
Property identifier for the status.

Constructor Index

 o VPrinter()
Constructs a VPrinter object.
 o VPrinter(Printer)
Constructs a VPrinter object.
 o VPrinter(VNode, Printer)
Constructs a VPrinter 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 getPrinter()
Returns the printer associated with this object.
 o getPropertiesPane()
Returns the properties pane.
 o getPropertyValue(Object)
Returns a property value.
 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 setPrinter(Printer)
Sets the printer.
 o sortDetailsChildren(Object[], boolean[])
Sorts the children for the details.
 o toString()
Returns the string representation.

Variables

 o OUTPUTQUEUE_PROPERTY
 public static final Object OUTPUTQUEUE_PROPERTY
Property identifier for the output queue.

 o PRINTER_PROPERTY
 public static final Object PRINTER_PROPERTY
Property identifier for the printer name.

 o STATUS_PROPERTY
 public static final Object STATUS_PROPERTY
Property identifier for the status.

Constructors

 o VPrinter
 public VPrinter()
Constructs a VPrinter object.

 o VPrinter
 public VPrinter(Printer printer)
Constructs a VPrinter object.

Parameters:
printer - The printer.
 o VPrinter
 public VPrinter(VNode parent,
                 Printer printer)
Constructs a VPrinter object.

Parameters:
parent - The parent.
printer - The printer.

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.

Returns:
An empty enumeration.
 o getActions
 public VAction[] getActions()
Returns the list of actions that can be performed.

Returns:
The actions.
 o getAllowsChildren
 public boolean getAllowsChildren()
Indiciates if the node allows children.

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

Parameters:
index - The index.
Returns:
Always null.
 o getChildCount
 public int getChildCount()
Returns the number of children.

Returns:
Always 0.
 o getDefaultAction
 public VAction getDefaultAction()
Returns the default action.

Returns:
Always null. There is no default action.
 o getDetailsChildAt
 public VObject getDetailsChildAt(int index)
Returns the child for the details at the specified index. The details children are the spooled files (VOutput objects) on the printer.

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. The details children are the spooled files (VOutput objects) on the printer.

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. The details children are the spooled files (VOutput objects) on the printer.

Returns:
The details column model.
 o getDetailsIndex
 public int getDetailsIndex(VObject child)
Returns the index of the specified child for the details. The details children are the spooled files (VOutput objects) on the printer.

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 int getIndex(TreeNode child)
Returns the index of the specified child.

Parameters:
child - The child.
Returns:
Always -1.
 o getParent
 public TreeNode getParent()
Returns the parent node.

Returns:
The parent node, or null if there is no parent.
 o getPrinter
 public Printer getPrinter()
Returns the printer associated with this object.

Returns:
The Printer class that is associated with this object.
 o getPropertiesPane
 public VPropertiesPane getPropertiesPane()
Returns the properties pane.

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

Parameters:
propertyIdentifier - The property identifier. The choices are
  • PRINTER_PROPERTY
  • STATUS_PROPERTY
  • DESCRIPTION_PROPERTY
  • OUTPUTQUEUE_PROPERTY
Returns:
The property value, or null if the property identifier is not recognized.
 o getText
 public String getText()
Returns the text. This is the name of the printer.

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

Returns:
Always true.
 o isSortable
 public boolean isSortable()
Indicates if the details children are sortable.

Returns:
Always true.
 o load
 public void load()
Loads information about the object from the AS/400. A printer must be specified either on construction or from a call to setPrinter() inorder to get 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 setPrinter
 public void setPrinter(Printer printer) throws PropertyVetoException
Sets the printer. A call to load() must be done after calling this funtion inorder to update the details children.

Parameters:
printer - The printer.
Throws: PropertyVetoException
If the change is vetoed.
 o sortDetailsChildren
 public void sortDetailsChildren(Object propertyIdentifiers[],
                                 boolean orders[])
Sorts the children for the details.

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 the name of the printer.

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

All Packages  Class Hierarchy  This Package  Previous  Next  Index