Package net.webpdf.wsclient.schema.operation

Class OutlineType

  • All Implemented Interfaces:
    ParameterInterface
    public class OutlineType
extends BaseToolboxType
     <?xml version="1.0" encoding="UTF-8"?><p xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">The outline operation element can be used to change the outline in the document.</p>

    Java class for OutlineType complex type

    .

    The following schema fragment specifies the expected content contained within this class.

    
 <complexType name="OutlineType">
   <complexContent>
     <extension base="{http://schema.webpdf.de/1.0/operation}BaseToolboxType">
       <choice>
         <element name="add">
           <complexType>
             <complexContent>
               <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
                 <choice maxOccurs="unbounded">
                   <element name="item" type="{http://schema.webpdf.de/1.0/operation}ItemType"/>
                 </choice>
               </restriction>
             </complexContent>
           </complexType>
         </element>
         <element name="remove">
           <complexType>
             <complexContent>
               <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
                 <choice maxOccurs="unbounded">
                   <element name="item" type="{http://schema.webpdf.de/1.0/operation}ItemReferenceType"/>
                 </choice>
               </restriction>
             </complexContent>
           </complexType>
         </element>
         <element name="clear" type="{http://schema.webpdf.de/1.0/operation}ClearType"/>
       </choice>
     </extension>
   </complexContent>
 </complexType>

    • Field Detail

      • add

        protected OutlineType.Add add
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Can be used to add entries to the content structure of a PDF document (its bookmarks/outline).
 
                                     The entries need to be specified as a flat list without any nesting.
                                     The expected tree structure is produced when the paths specified in the "item" elements are resolved. The entries will be generated in line with their order in the "add" element. Parent elements that are specified in the path but are not yet found in the content structure will also be added automatically. Nodes already found in the content structure will be updated with the values contained here.
                                     The "add" element adds new elements to an existing content structure; it does not create an entirely new structure. Accordingly, it is not necessary to specify the existing entries that should not be edited.
                                     The element paths are made of the visible names of the entries in the content structure separated with forward slashes (/).
                                     If the document does not have a content structure yet, it will be generated with the specified content.
 
                                     This element can have any number of "item" elements you want.
                                 </p>

      • remove

        protected OutlineType.Remove remove
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Selects outline entries for removal.</p>

      • clear

        protected ClearType clear
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Removes the whole outline tree from the document.</p>

    • Constructor Detail

      • OutlineType

        public OutlineType()

    • Method Detail

      • getAdd

        public OutlineType.Add getAdd()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Can be used to add entries to the content structure of a PDF document (its bookmarks/outline).
 
                                     The entries need to be specified as a flat list without any nesting.
                                     The expected tree structure is produced when the paths specified in the "item" elements are resolved. The entries will be generated in line with their order in the "add" element. Parent elements that are specified in the path but are not yet found in the content structure will also be added automatically. Nodes already found in the content structure will be updated with the values contained here.
                                     The "add" element adds new elements to an existing content structure; it does not create an entirely new structure. Accordingly, it is not necessary to specify the existing entries that should not be edited.
                                     The element paths are made of the visible names of the entries in the content structure separated with forward slashes (/).
                                     If the document does not have a content structure yet, it will be generated with the specified content.
 
                                     This element can have any number of "item" elements you want.
                                 </p>
        Returns:
        possible object is OutlineType.Add

      • isSetAdd

        public boolean isSetAdd()

      • getRemove

        public OutlineType.Remove getRemove()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Selects outline entries for removal.</p>
        Returns:
        possible object is OutlineType.Remove

      • isSetRemove

        public boolean isSetRemove()

      • getClear

        public ClearType getClear()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Removes the whole outline tree from the document.</p>
        Returns:
        possible object is ClearType

      • setClear

        public void setClear​(ClearType value)
        Sets the value of the clear property.
        Parameters:
        value - allowed object is ClearType
        See Also:
        getClear()

      • isSetClear

        public boolean isSetClear()