com.ibm.as400.vaccess

Class VPrinter

  • java.lang.Object
    • com.ibm.as400.vaccess.VPrinter
  • All Implemented Interfaces:
    VNode, VObject, java.io.Serializable, javax.swing.tree.TreeNode

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

    public class VPrinter
    extends java.lang.Object
    implements VNode, java.io.Serializable
    The VPrinter class defines the representation of a system 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:

    • ErrorEvent
    • PropertyChangeEvent
    • VObjectEvent
    • WorkingEvent
    See Also:
    Printer, Serialized Form
    • Constructor Summary

      Constructors 
      Constructor and Description
      VPrinter()
      Deprecated. 
      Constructs a VPrinter object.
      VPrinter(Printer printer)
      Deprecated. 
      Constructs a VPrinter object.
      VPrinter(VNode parent, Printer printer)
      Deprecated. 
      Constructs a VPrinter object.
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      void addErrorListener(ErrorListener listener)
      Deprecated. 
      Adds a listener to be notified when an error occurs.
      void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
      Deprecated. 
      Adds a listener to be notified when the value of any bound property changes.
      void addVetoableChangeListener(java.beans.VetoableChangeListener listener)
      Deprecated. 
      Adds a listener to be notified when the value of any constrained property changes.
      void addVObjectListener(VObjectListener listener)
      Deprecated. 
      Adds a listener to be notified when a VObject is changed, created, or deleted.
      void addWorkingListener(WorkingListener listener)
      Deprecated. 
      Adds a listener to be notified when work starts and stops on potentially long-running operations.
      java.util.Enumeration children()
      Deprecated. 
      Returns the children of the node.
      VAction[] getActions()
      Deprecated. 
      Returns the list of actions that can be performed.
      boolean getAllowsChildren()
      Deprecated. 
      Indiciates if the node allows children.
      javax.swing.tree.TreeNode getChildAt(int index)
      Deprecated. 
      Returns the child node at the specified index.
      int getChildCount()
      Deprecated. 
      Returns the number of children.
      VAction getDefaultAction()
      Deprecated. 
      Returns the default action.
      VObject getDetailsChildAt(int index)
      Deprecated. 
      Returns the child for the details at the specified index.
      int getDetailsChildCount()
      Deprecated. 
      Returns the number of children for the details.
      javax.swing.table.TableColumnModel getDetailsColumnModel()
      Deprecated. 
      Returns the table column model to use in the details when representing the children.
      int getDetailsIndex(VObject child)
      Deprecated. 
      Returns the index of the specified child for the details.
      javax.swing.Icon getIcon(int size, boolean open)
      Deprecated. 
      Returns the icon.
      int getIndex(javax.swing.tree.TreeNode child)
      Deprecated. 
      Returns the index of the specified child.
      javax.swing.tree.TreeNode getParent()
      Deprecated. 
      Returns the parent node.
      Printer getPrinter()
      Deprecated. 
      Returns the printer associated with this object.
      VPropertiesPane getPropertiesPane()
      Deprecated. 
      Returns the properties pane.
      java.lang.Object getPropertyValue(java.lang.Object propertyIdentifier)
      Deprecated. 
      Returns a property value.
      java.lang.String getText()
      Deprecated. 
      Returns the text.
      boolean isLeaf()
      Deprecated. 
      Indicates if the node is a leaf.
      boolean isSortable()
      Deprecated. 
      Indicates if the details children are sortable.
      void load()
      Deprecated. 
      Loads information about the object from the system.
      void removeErrorListener(ErrorListener listener)
      Deprecated. 
      Removes an error listener.
      void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
      Deprecated. 
      Removes a property change listener.
      void removeVetoableChangeListener(java.beans.VetoableChangeListener listener)
      Deprecated. 
      Removes a vetoable change listener.
      void removeVObjectListener(VObjectListener listener)
      Deprecated. 
      Removes a VObjectListener.
      void removeWorkingListener(WorkingListener listener)
      Deprecated. 
      Removes a working listener.
      void setPrinter(Printer printer)
      Deprecated. 
      Sets the printer.
      void sortDetailsChildren(java.lang.Object[] propertyIdentifiers, boolean[] orders)
      Deprecated. 
      Sorts the children for the details.
      java.lang.String toString()
      Deprecated. 
      Returns the string representation.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Field Detail

      • OUTPUTQUEUE_PROPERTY

        public static final java.lang.Object OUTPUTQUEUE_PROPERTY
        Deprecated. 
        Property identifier for the output queue.
      • PRINTER_PROPERTY

        public static final java.lang.Object PRINTER_PROPERTY
        Deprecated. 
        Property identifier for the printer name.
      • STATUS_PROPERTY

        public static final java.lang.Object STATUS_PROPERTY
        Deprecated. 
        Property identifier for the status.
    • Constructor Detail

      • VPrinter

        public VPrinter()
        Deprecated. 
        Constructs a VPrinter object.
      • VPrinter

        public VPrinter(Printer printer)
        Deprecated. 
        Constructs a VPrinter object.
        Parameters:
        printer - The printer.
      • VPrinter

        public VPrinter(VNode parent,
                Printer printer)
        Deprecated. 
        Constructs a VPrinter object.
        Parameters:
        parent - The parent.
        printer - The printer.
    >
    • Method Detail

      • addErrorListener

        public void addErrorListener(ErrorListener listener)
        Deprecated. 
        Adds a listener to be notified when an error occurs.
        Specified by:
        addErrorListener in interface VObject
        Parameters:
        listener - The listener.
      • addPropertyChangeListener

        public void addPropertyChangeListener(java.beans.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(java.beans.VetoableChangeListener listener)
        Deprecated. 
        Adds a listener to be notified when the value of any constrained property changes.
        Parameters:
        listener - The listener.
      • addVObjectListener

        public void addVObjectListener(VObjectListener listener)
        Deprecated. 
        Adds a listener to be notified when a VObject is changed, created, or deleted.
        Specified by:
        addVObjectListener in interface VObject
        Parameters:
        listener - The listener.
      • addWorkingListener

        public void addWorkingListener(WorkingListener listener)
        Deprecated. 
        Adds a listener to be notified when work starts and stops on potentially long-running operations.
        Specified by:
        addWorkingListener in interface VObject
        Parameters:
        listener - The listener.
      • children

        public java.util.Enumeration children()
        Deprecated. 
        Returns the children of the node.
        Specified by:
        children in interface javax.swing.tree.TreeNode
        Returns:
        An empty enumeration.
      • getActions

        public VAction[] getActions()
        Deprecated. 
        Returns the list of actions that can be performed.
        • hold
        • release
        • start
        • stop
        • make available
        • make unavailable
        Specified by:
        getActions in interface VObject
        Returns:
        The actions.
      • getAllowsChildren

        public boolean getAllowsChildren()
        Deprecated. 
        Indiciates if the node allows children.
        Specified by:
        getAllowsChildren in interface javax.swing.tree.TreeNode
        Returns:
        Always false.
      • getChildAt

        public javax.swing.tree.TreeNode getChildAt(int index)
        Deprecated. 
        Returns the child node at the specified index.
        Specified by:
        getChildAt in interface javax.swing.tree.TreeNode
        Parameters:
        index - The index.
        Returns:
        Always null.
      • getChildCount

        public int getChildCount()
        Deprecated. 
        Returns the number of children.
        Specified by:
        getChildCount in interface javax.swing.tree.TreeNode
        Returns:
        Always 0.
      • getDefaultAction

        public VAction getDefaultAction()
        Deprecated. 
        Returns the default action.
        Specified by:
        getDefaultAction in interface VObject
        Returns:
        Always null. There is no default action.
      • getDetailsChildAt

        public VObject getDetailsChildAt(int index)
        Deprecated. 
        Returns the child for the details at the specified index. The details children are the spooled files (VOutput objects) on the printer.
        Specified by:
        getDetailsChildAt in interface VNode
        Parameters:
        index - The index.
        Returns:
        The child, or null if the index is not valid.
      • getDetailsChildCount

        public int getDetailsChildCount()
        Deprecated. 
        Returns the number of children for the details. The details children are the spooled files (VOutput objects) on the printer.
        Specified by:
        getDetailsChildCount in interface VNode
        Returns:
        The number of children for the details.
      • getDetailsColumnModel

        public javax.swing.table.TableColumnModel getDetailsColumnModel()
        Deprecated. 
        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.
        Specified by:
        getDetailsColumnModel in interface VNode
        Returns:
        The details column model.
        See Also:
        VObject.getPropertyValue(java.lang.Object)
      • getDetailsIndex

        public int getDetailsIndex(VObject child)
        Deprecated. 
        Returns the index of the specified child for the details. The details children are the spooled files (VOutput objects) on the printer.
        Specified by:
        getDetailsIndex in interface VNode
        Parameters:
        child - The details child.
        Returns:
        The index, or -1 if the child is not found in the details.
      • getIcon

        public javax.swing.Icon getIcon(int size,
                               boolean open)
        Deprecated. 
        Returns the icon.
        Specified by:
        getIcon in interface VObject
        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.
      • getIndex

        public int getIndex(javax.swing.tree.TreeNode child)
        Deprecated. 
        Returns the index of the specified child.
        Specified by:
        getIndex in interface javax.swing.tree.TreeNode
        Parameters:
        child - The child.
        Returns:
        Always -1.
      • getParent

        public javax.swing.tree.TreeNode getParent()
        Deprecated. 
        Returns the parent node.
        Specified by:
        getParent in interface javax.swing.tree.TreeNode
        Returns:
        The parent node, or null if there is no parent.
      • getPrinter

        public Printer getPrinter()
        Deprecated. 
        Returns the printer associated with this object.
        Returns:
        The Printer class that is associated with this object.
      • getPropertyValue

        public java.lang.Object getPropertyValue(java.lang.Object propertyIdentifier)
        Deprecated. 
        Returns a property value.
        Specified by:
        getPropertyValue in interface VObject
        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.
      • getText

        public java.lang.String getText()
        Deprecated. 
        Returns the text. This is the name of the printer.
        Specified by:
        getText in interface VObject
        Returns:
        The text.
      • isLeaf

        public boolean isLeaf()
        Deprecated. 
        Indicates if the node is a leaf.
        Specified by:
        isLeaf in interface javax.swing.tree.TreeNode
        Returns:
        Always true.
      • isSortable

        public boolean isSortable()
        Deprecated. 
        Indicates if the details children are sortable.
        Specified by:
        isSortable in interface VNode
        Returns:
        Always true.
      • load

        public void load()
        Deprecated. 
        Loads information about the object from the system. A printer must be specified either on construction or from a call to setPrinter() inorder to get information about the object from the system.
        Specified by:
        load in interface VObject
      • removeErrorListener

        public void removeErrorListener(ErrorListener listener)
        Deprecated. 
        Removes an error listener.
        Specified by:
        removeErrorListener in interface VObject
        Parameters:
        listener - The listener.
      • removePropertyChangeListener

        public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
        Deprecated. 
        Removes a property change listener.
        Parameters:
        listener - The listener.
      • removeVetoableChangeListener

        public void removeVetoableChangeListener(java.beans.VetoableChangeListener listener)
        Deprecated. 
        Removes a vetoable change listener.
        Parameters:
        listener - The listener.
      • removeVObjectListener

        public void removeVObjectListener(VObjectListener listener)
        Deprecated. 
        Removes a VObjectListener.
        Specified by:
        removeVObjectListener in interface VObject
        Parameters:
        listener - The listener.
      • removeWorkingListener

        public void removeWorkingListener(WorkingListener listener)
        Deprecated. 
        Removes a working listener.
        Specified by:
        removeWorkingListener in interface VObject
        Parameters:
        listener - The listener.
      • setPrinter

        public void setPrinter(Printer printer)
                        throws java.beans.PropertyVetoException
        Deprecated. 
        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:
        java.beans.PropertyVetoException - If the change is vetoed.
      • sortDetailsChildren

        public void sortDetailsChildren(java.lang.Object[] propertyIdentifiers,
                               boolean[] orders)
        Deprecated. 
        Sorts the children for the details.
        Specified by:
        sortDetailsChildren in interface VNode
        Parameters:
        propertyIdentifiers - The property identifiers.
        orders - The sort orders for each property identifier, true for ascending order, false for descending order.
      • toString

        public java.lang.String toString()
        Deprecated. 
        Returns the string representation. This is the name of the printer.
        Overrides:
        toString in class java.lang.Object
        Returns:
        The string representation.