Class PdfCollectionItem

    • Method Detail

      • addItem

        public PdfCollectionItem addItem​(java.lang.String key,
                                         java.lang.String value)
        Sets the value of the collection item.
        Parameters:
        key - is a key with which the specified value is to be associated
        value - is a value to be associated with the specified key
        Returns:
        this instance to support fluent interface
      • addItem

        public void addItem​(java.lang.String key,
                            PdfDate date)
        Sets the date value of the collection item.
        Parameters:
        key - is a key with which the specified date value is to be associated
        date - is a PDF date value to be associated with the specified key
      • addItem

        public void addItem​(java.lang.String key,
                            PdfNumber number)
        Sets the number value of the collection item.
        Parameters:
        key - is a key with which the specified number value is to be associated
        number - is a PDF number value to be associated with the specified key
      • setPrefix

        public PdfCollectionItem setPrefix​(java.lang.String key,
                                           java.lang.String prefix)
        Adds a prefix for the Collection item. You can only use this method after you have set the value of the item.
        Parameters:
        key - is a key identifying the Collection item
        prefix - is a prefix to be added
        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.