com.spss.psapi.extensions.common

Interface DocumentOutputManager



  • public interface DocumentOutputManager
    A document output manager contains all document outputs managed by the application session.
    Since:
    PSAPI 11.1
    Version:
    1.0
    Author:
    Julian Clinton
    • Method Detail

      • addDocumentOutput

        void addDocumentOutput(DocumentOutput documentOutput,
                             java.lang.Object source)
        Adds the supplied document output object to the manager.
        Parameters:
        documentOutput - the document output to be added
        source - the object that generated or supplied the document output (may be null
      • removeDocumentOutput

        void removeDocumentOutput(DocumentOutput documentOutput)
        Remove the supplied document output object from the manager.
        Parameters:
        documentOutput - the document output to be removed
      • addInteractiveOutput

        void addInteractiveOutput(InteractiveOutput interactiveOutput,
                                java.lang.Object source)
        Adds the supplied interactive output object to the manager.
        Parameters:
        interactiveOutput - the interactive output to be added
        source - the object that generated or supplied the interactive output (may be null)
      • removeInteractiveOutput

        void removeInteractiveOutput(InteractiveOutput interactiveOutput)
        Remove the supplied interactive output object from the manager.
        Parameters:
        interactiveOutput - the interactive output to be removed
      • getOutputCount

        int getOutputCount()
        Returns the number of outputs being managed.
        Returns:
        the number of outputs being managed
      • getOutputAt

        BuiltObject getOutputAt(int index)
        Returns the document or interactive output at the specified index.
        Parameters:
        index -
        Returns:
        the document or interactive output at the specified index
      • getOutputForID

        BuiltObject getOutputForID(java.lang.String id)
        Returns the document or interactive output with the specified ID or null if no such output can be found.
        Parameters:
        id - the output ID
        Returns:
        the document or interactive output or null
      • removeAll

        void removeAll()
        Removes all outputs from the manager. Any unsaved changes to the outputs will be lost.
        Since:
        PSAPI 17.0

(C) Copyright IBM Corp. 1994, 2015. All Rights Reserved.