com.ibm.as400.access

Class PrintObjectList

  • java.lang.Object
    • com.ibm.as400.access.PrintObjectList
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      void addPrintObjectListListener(PrintObjectListListener listener)
      Adds the specified PrintObjectList listener to receive PrintObjectList events from this print object list.
      void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
      Adds the specified PropertyChange listener to receive PropertyChange events from this print object list.
      void addVetoableChangeListener(java.beans.VetoableChangeListener listener)
      Adds the specified VetoableChange listener to receive VetoableChange events from this print object list.
      void close()
      Closes the list so that objects in the list can be garbage collected.
      PrintObject getObject(int index)
      Returns one object from the list.
      java.util.Enumeration getObjects()
      Returns an enumeration of the PrintObjects in the list.
      AS400 getSystem()
      Returns the system name.
      boolean isCompleted()
      Checks if a list that was opened asynchronously has completed.
      void openAsynchronously()
      Builds the list asynchronously.
      void openSynchronously()
      Builds the list synchronously.
      void removePrintObjectListListener(PrintObjectListListener listener)
      Removes the specified PrintObjectList listener so that it no longer receives PrintObjectList events from this print object list.
      void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
      Removes the specified PropertyChange listener so that it no longer receives PropertyChange events from this print object list.
      void removeVetoableChangeListener(java.beans.VetoableChangeListener listener)
      Removes the specified VetoableChange listener so that it no longer receives VetoableChange events from this print object list.
      void resetAttributesToRetrieve()
      Resets the list of object attributes to retrieve.
      void resetFilter()
      Resets the list filter back to default values.
      void setAttributesToRetrieve(int[] attributes)
      Sets the attributes of the object that should be returned in the list.
      void setCache(boolean setting)
      Sets whether or not to internally maintain a cache of objects returned by this list.
      void setSystem(AS400 system)
      Sets the system name.
      int size()
      Returns the current size of the list.
      void waitForItem(int itemNumber)
      Blocks until the number of requested items are done being built.
      void waitForListToComplete()
      Blocks until the list is done being built.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • >
    • Method Detail

      • setCache

        public void setCache(boolean setting)
        Sets whether or not to internally maintain a cache of objects returned by this list. By default, caching is on, so that the Enumeration returned by getObjects() is populated. Under normal circumstances, code should not need to call this method.

        However, if code wishes to open the list asynchronously and use a PrintObjectListListener to receive listObjectAdded() events, the objects in the list are returned on those events. So, in some cases, there is no need for this PrintObjectList to maintain a reference to all of the objects returned, since they can be processed individually by the listener. Calling this method with a value of true will save memory in these cases, but the getObjectList() method will return an empty Enumeration, so this method only becomes useful if code has registered a PrintObjectListListener with this PrintObjectList.

        Parameters:
        setting - true to enable caching; false to disable caching
        See Also:
        addPrintObjectListListener(com.ibm.as400.access.PrintObjectListListener), getObjects(), PrintObjectListEvent.getObject(), PrintObjectListListener.listObjectAdded(com.ibm.as400.access.PrintObjectListEvent)
      • addPropertyChangeListener

        public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
        Adds the specified PropertyChange listener to receive PropertyChange events from this print object list.
        Parameters:
        listener - The PropertyChange listener.
        See Also:
        removePropertyChangeListener(java.beans.PropertyChangeListener)
      • addVetoableChangeListener

        public void addVetoableChangeListener(java.beans.VetoableChangeListener listener)
        Adds the specified VetoableChange listener to receive VetoableChange events from this print object list.
        Parameters:
        listener - The VetoableChange listener.
        See Also:
        removeVetoableChangeListener(java.beans.VetoableChangeListener)
      • close

        public void close()
        Closes the list so that objects in the list can be garbage collected.
      • getObject

        public PrintObject getObject(int index)
        Returns one object from the list.
        Parameters:
        index - The index of the desired object.
        Returns:
        PrintObject
        Throws:
        java.lang.ArrayIndexOutOfBoundsException - If an invalid index is given.
      • getObjects

        public java.util.Enumeration getObjects()
        Returns an enumeration of the PrintObjects in the list.
        Returns:
        Enumeration
      • getSystem

        public final AS400 getSystem()
        Returns the system name. This method is primarily provided for visual application builders that support JavaBeans.
        Returns:
        The system on which the objects in the list exist.
      • openAsynchronously

        public void openAsynchronously()
        Builds the list asynchronously. This method starts a thread to build the list and then returns. The caller may register listeners to obtain status about the list, or call isCompleted(), waitForItem(), or waitForListToComplete().
      • removePropertyChangeListener

        public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
        Removes the specified PropertyChange listener so that it no longer receives PropertyChange events from this print object list.
        Parameters:
        listener - The PropertyChange listener.
        See Also:
        addPropertyChangeListener(java.beans.PropertyChangeListener)
      • removeVetoableChangeListener

        public void removeVetoableChangeListener(java.beans.VetoableChangeListener listener)
        Removes the specified VetoableChange listener so that it no longer receives VetoableChange events from this print object list.
        Parameters:
        listener - The VetoableChange listener.
        See Also:
        addVetoableChangeListener(java.beans.VetoableChangeListener)
      • resetAttributesToRetrieve

        public void resetAttributesToRetrieve()
        Resets the list of object attributes to retrieve.
      • resetFilter

        public void resetFilter()
        Resets the list filter back to default values.
      • setAttributesToRetrieve

        public void setAttributesToRetrieve(int[] attributes)
        Sets the attributes of the object that should be returned in the list. This method can be used to speed up the listing if only interested in a few attributes for each item in the list.
        Parameters:
        attributes - An array of attribute IDs that define which object attributes will be retrieved for each item in the list when the list is opened.
        See Also:
        PrintObject
      • setSystem

        public final void setSystem(AS400 system)
                             throws java.beans.PropertyVetoException
        Sets the system name. This method is primarily provided for visual application builders that support JavaBeans. Application programmers should specify the system in the constructor for the specific network print object list. For example, SpooledFileList myList = new SpooledFileList(mySystem).
        Parameters:
        system - The system name.
        Throws:
        java.beans.PropertyVetoException - If the change is vetoed.
      • size

        public int size()
        Returns the current size of the list.
        Returns:
        size