Package org.apache.fop.apps

Class FormattingResults

  • @Deprecated
public class FormattingResults
extends java.lang.Object
    Deprecated.
    Please avoid using package provided OOTB and/or migrate code to provide for this package in the custom code
    Class for reporting back formatting results to the calling application.

    • Constructor Summary

      Constructors 
      Constructor Description
      FormattingResults()
      Deprecated.
      Constructor for the FormattingResults object

    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      int getPageCount()
      Deprecated.
      Gets the number of pages rendered
      java.util.List getPageSequences()
      Deprecated.
      Gets the results for the individual page-sequences.
      void haveFormattedPageSequence​(org.apache.fop.fo.pagination.AbstractPageSequence pageSequence, int pageCount)
      Deprecated.
      Reports the result of one page sequence rendering back into this object.
      void reset()
      Deprecated.
      Resets this object

      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • FormattingResults

        public FormattingResults()
        Deprecated.
        Constructor for the FormattingResults object

    • Method Detail

      • getPageCount

        public int getPageCount()
        Deprecated.
        Gets the number of pages rendered
        Returns:
        The number of pages overall

      • getPageSequences

        public java.util.List getPageSequences()
        Deprecated.
        Gets the results for the individual page-sequences.
        Returns:
        A List with PageSequenceResults objects

      • reset

        public void reset()
        Deprecated.
        Resets this object

      • haveFormattedPageSequence

        public void haveFormattedPageSequence​(org.apache.fop.fo.pagination.AbstractPageSequence pageSequence,
                                      int pageCount)
        Deprecated.
        Reports the result of one page sequence rendering back into this object.
        Parameters:
        pageSequence - the page sequence which just completed rendering
        pageCount - the number of pages rendered for that PageSequence