com.ibm.as400.vaccess

Class VPrinterOutput

  • java.lang.Object
    • com.ibm.as400.vaccess.VPrinterOutput
  • 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 VPrinterOutput
    extends java.lang.Object
    implements VNode, java.io.Serializable
    The VPrinterOutput class defines the representation of a list of spooled files on a system for use in various models and panes in this package.

    A VPrinterOutput object has no children. Its details children are the spooled files (VOutput objects) in this list.

    You must explicitly call load() to load the information from the system.

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

    VPrinterOutput objects generate the following events:

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

      Constructors 
      Constructor and Description
      VPrinterOutput()
      Deprecated. 
      Constructs a VPrinterOutput object.
      VPrinterOutput(AS400 system)
      Deprecated. 
      Constructs a VPrinterOutput object.
      VPrinterOutput(VNode parent, AS400 system)
      Deprecated. 
      Constructs a VPrinterOutput 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.
      java.lang.String getFormTypeFilter()
      Deprecated. 
      Returns the form type filter for the list.
      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.
      VPropertiesPane getPropertiesPane()
      Deprecated. 
      Returns the properties pane.
      java.lang.Object getPropertyValue(java.lang.Object propertyIdentifier)
      Deprecated. 
      Returns a property value.
      java.lang.String getQueueFilter()
      Deprecated. 
      Returns the output queue list filter.
      AS400 getSystem()
      Deprecated. 
      Returns the system on which the output resides.
      java.lang.String getText()
      Deprecated. 
      Returns the text.
      java.lang.String getUserDataFilter()
      Deprecated. 
      Returns the user data list filter.
      java.lang.String getUserFilter()
      Deprecated. 
      Returns the user ID list filter.
      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 setFormTypeFilter(java.lang.String formTypeFilter)
      Deprecated. 
      Sets the form type filter for the list.
      void setQueueFilter(java.lang.String queueFilter)
      Deprecated. 
      Sets the output queue filter.
      void setSystem(AS400 system)
      Deprecated. 
      Sets the system on which the output resides.
      void setUserDataFilter(java.lang.String userDataFilter)
      Deprecated. 
      Sets the user data list filter.
      void setUserFilter(java.lang.String userFilter)
      Deprecated. 
      Sets the user ID list filter.
      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
    • Constructor Detail

      • VPrinterOutput

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

        public VPrinterOutput(AS400 system)
        Deprecated. 
        Constructs a VPrinterOutput object.
        Parameters:
        system - The system on which the output resides.
      • VPrinterOutput

        public VPrinterOutput(VNode parent,
                      AS400 system)
        Deprecated. 
        Constructs a VPrinterOutput object.
        Parameters:
        parent - The parent.
        system - The system on which the output resides.
    >
    • 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.
        Specified by:
        getActions in interface VObject
        Returns:
        Always null. There are no 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 child is a spooled file (VOutput object) in this list.
        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) in this list.
        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) in this list.
        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 child is a spooled file (VOutput object) in this list.
        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.
      • getFormTypeFilter

        public java.lang.String getFormTypeFilter()
        Deprecated. 
        Returns the form type filter for the list. The filter contains the form type a spooled file must be to be included in the list.
        Returns:
        The form type filter.
      • 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.
      • 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 NAME_PROPERTY or DESCRIPTION_PROPERTY.
        Returns:
        The property value, or null if the property identifier is not recognized.
      • getQueueFilter

        public java.lang.String getQueueFilter()
        Deprecated. 
        Returns the output queue list filter.
        Returns:
        The output queue filter.
      • getSystem

        public AS400 getSystem()
        Deprecated. 
        Returns the system on which the output resides.
        Returns:
        The system on which the output resides.
      • getText

        public java.lang.String getText()
        Deprecated. 
        Returns the text. This is a constant string which identifies this object as a list of printer output.
        Specified by:
        getText in interface VObject
        Returns:
        The text.
      • getUserDataFilter

        public java.lang.String getUserDataFilter()
        Deprecated. 
        Returns the user data list filter.
        Returns:
        The user data filter.
      • getUserFilter

        public java.lang.String getUserFilter()
        Deprecated. 
        Returns the user ID list filter.
        Returns:
        The user ID filter.
      • 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.
        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.
      • setFormTypeFilter

        public void setFormTypeFilter(java.lang.String formTypeFilter)
                               throws java.beans.PropertyVetoException
        Deprecated. 
        Sets the form type filter for the list. A call to load() must be done after calling this funtion inorder to update the details children.
        Parameters:
        formTypeFilter - The form type the spooled file must be to be included in the list. It cannot be greater than 10 characters. The value can be any specific value or any of these special values:
        • *ALL - Spooled files with any form type will be included in the list.
        • *STD - Spooled files with the form type *STD will be included in the list.
        The default is *ALL.
        Throws:
        java.beans.PropertyVetoException - If the change is vetoed.
      • setQueueFilter

        public void setQueueFilter(java.lang.String queueFilter)
                            throws java.beans.PropertyVetoException
        Deprecated. 
        Sets the output queue filter. A call to load() must be done after calling this funtion inorder to update the details children.
        Parameters:
        queueFilter - The library and output queues on which to list spooled files. The format of the queueFilter string must be in the format of /QSYS.LIB/libname.LIB/queuename.OUTQ where
        libname is the library name that contains the queues to search. It can be a specific name or one of these special values:
        • %LIBL% - The server job's library list.
        • %ALL% - All libraries are searched. This value is only valid if the queuename is %ALL%.
        queuename is the name of the output queues to search. It can be a specific name or the special value %ALL%. If it is %ALL%, then the libname must also be %ALL%.
        Throws:
        java.beans.PropertyVetoException - If the change is vetoed.
      • setSystem

        public void setSystem(AS400 system)
                       throws java.beans.PropertyVetoException
        Deprecated. 
        Sets the system on which the output resides. A call to load() must be done after calling this funtion inorder to update the details children.
        Parameters:
        system - The system on which the output resides.
        Throws:
        java.beans.PropertyVetoException - If the change is vetoed.
      • setUserDataFilter

        public void setUserDataFilter(java.lang.String userDataFilter)
                               throws java.beans.PropertyVetoException
        Deprecated. 
        Sets the user data list filter. A call to load() must be done after calling this funtion inorder to update the details children.
        Parameters:
        userDataFilter - The user data the spooled file must have for it to be included in the list. The value can be any specific value or the special value *ALL. The value cannot be greater than 10 characters. The default is *ALL.
        Throws:
        java.beans.PropertyVetoException - If the change is vetoed.
      • setUserFilter

        public void setUserFilter(java.lang.String userFilter)
                           throws java.beans.PropertyVetoException
        Deprecated. 
        Sets the user ID list filter. A call to load() must be done after calling this funtion inorder to update the details children.
        Parameters:
        userFilter - The user or users for which to list spooled files. The value cannot be greater than 10 characters. The value can be any specific user ID or any of these special values:
        • *ALL - Spooled files created by all users will be included in the list.
        • *CURRENT - Spooled files created by the current user only will be in the list.
        The default is *CURRENT.
        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. 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.
        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 a constant string which identifies this object as a list of printer output.
        Overrides:
        toString in class java.lang.Object
        Returns:
        The string representation.