Class PdfCollectionSort

    • Constructor Detail

      • PdfCollectionSort

        public PdfCollectionSort​(PdfDictionary pdfObject)
      • PdfCollectionSort

        public PdfCollectionSort​(java.lang.String key)
        Constructs a PDF Collection Sort Dictionary.
        Parameters:
        key - the key of the field that will be used to sort entries
      • PdfCollectionSort

        public PdfCollectionSort​(java.lang.String[] keys)
        Constructs a PDF Collection Sort Dictionary.
        Parameters:
        keys - the keys of the fields that will be used to sort entries
    • Method Detail

      • setSortOrder

        public PdfCollectionSort setSortOrder​(boolean ascending)
        Defines the sort order of the field (ascending or descending).
        Parameters:
        ascending - true is the default, use false for descending order
        Returns:
        this instance to support fluent interface
      • setSortOrder

        public PdfCollectionSort setSortOrder​(boolean[] ascending)
        Defines the sort order of the field (ascending or descending).
        Parameters:
        ascending - an array with every element corresponding with a name of a field.
        Returns:
        this instance to support fluent interface
      • isWrappedObjectMustBeIndirect

        protected boolean isWrappedObjectMustBeIndirect()
        Description copied from class: PdfObjectWrapper
        Defines if the object behind this wrapper must be an indirect object in the resultant document.

        If this method returns true it doesn't necessarily mean that object must be in the indirect state at any moment, but rather defines that when the object will be written to the document it will be transformed into indirect object if it's not indirect yet.

        Return value of this method shouldn't depend on any logic, it should return always true or false.
        Specified by:
        isWrappedObjectMustBeIndirect in class PdfObjectWrapper<PdfDictionary>
        Returns:
        true if in the resultant document the object behind the wrapper must be indirect, otherwise false.