Package net.webpdf.parameter.schema.extraction.info

Class BackgroundContentType.PieceInfo

  • Enclosing class:
    BackgroundContentType
    public static class BackgroundContentType.PieceInfo
extends Object

    Java class for anonymous complex type

    .

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

    
 <complexType>
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <attribute name="absoluteScaling" type="{http://www.w3.org/2001/XMLSchema}boolean" default="true" />
       <attribute name="scale" default="1">
         <simpleType>
           <restriction base="{http://www.w3.org/2001/XMLSchema}float">
             <minInclusive value="0"/>
           </restriction>
         </simpleType>
       </attribute>
       <attribute name="rotation" default="0">
         <simpleType>
           <restriction base="{http://www.w3.org/2001/XMLSchema}int">
             <minInclusive value="0"/>
             <maxInclusive value="360"/>
           </restriction>
         </simpleType>
       </attribute>
       <attribute name="opacity" default="1.0">
         <simpleType>
           <restriction base="{http://www.w3.org/2001/XMLSchema}float">
             <minInclusive value="0"/>
             <maxInclusive value="1"/>
           </restriction>
         </simpleType>
       </attribute>
       <attribute name="color" type="{http://schema.webpdf.de/1.0/extraction/info}RgbColorType" default="#FFFFFF" />
       <attribute name="alignment" type="{http://schema.webpdf.de/1.0/extraction/info}Alignment" default="top_left" />
       <attribute name="horizOffset" type="{http://www.w3.org/2001/XMLSchema}float" default="0.0" />
       <attribute name="vertOffset" type="{http://www.w3.org/2001/XMLSchema}float" default="0.0" />
       <attribute name="unit" type="{http://www.w3.org/2001/XMLSchema}string" default="" />
     </restriction>
   </complexContent>
 </complexType>

    • Field Detail

      • absoluteScaling

        protected Boolean absoluteScaling
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">When set to true the page shall be scaled relative to it's own original dimensions, when set to false, it shall be scaled relative to the page dimensions.</p>

      • scale

        protected Float scale
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The scaling of the background.</p>

      • rotation

        protected Integer rotation
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The rotation of the background.</p>

      • opacity

        protected Float opacity
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The opacity of the background, as a percentage in the range 0.0 (fully transparent) to 1.0 (fully opaque).</p>

      • color

        protected String color
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The color of a unicolor background.</p>

      • alignment

        protected Alignment alignment
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">Uses one of multiple preset positions in order to position the background on the page.
                                     <ul><li>custom = Disable the use of a preset position.</li><li>top_left = Positions the background in the top left corner.</li><li>top_center = Positions the background in the centre on the top margin.</li><li>top_right = Positions the background in the top right corner.</li><li>center_left = Positions the background at the centre of the page, to the left.</li><li>center_center = Positions the background at the centre of the page.</li><li>center_right = Positions the background at the centre of the page, to the right.</li><li>bottom_left = Positions the background in the bottom left corner.</li><li>bottom_center = Positions the background in the centre on the bottom margin.</li><li>bottom_right = Positions the background in the bottom right corner.</li></ul></p>

      • horizOffset

        protected Float horizOffset
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The horizontal offset in relation to the backgrounds bas position.</p>

      • vertOffset

        protected Float vertOffset
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The vertical offset in relation to the backgrounds bas position.</p>

      • unit

        protected String unit
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The Adobe unit used to display offsets in readers. (millimeters, pica, point etc).</p>

    • Constructor Detail

      • PieceInfo

        public PieceInfo()

    • Method Detail

      • isAbsoluteScaling

        public boolean isAbsoluteScaling()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">When set to true the page shall be scaled relative to it's own original dimensions, when set to false, it shall be scaled relative to the page dimensions.</p>
        Returns:
        possible object is Boolean

      • setAbsoluteScaling

        public void setAbsoluteScaling​(Boolean value)
        Sets the value of the absoluteScaling property.
        Parameters:
        value - allowed object is Boolean
        See Also:
        isAbsoluteScaling()

      • getScale

        public float getScale()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The scaling of the background.</p>
        Returns:
        possible object is Float

      • setScale

        public void setScale​(Float value)
        Sets the value of the scale property.
        Parameters:
        value - allowed object is Float
        See Also:
        getScale()

      • getRotation

        public int getRotation()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The rotation of the background.</p>
        Returns:
        possible object is Integer

      • setRotation

        public void setRotation​(Integer value)
        Sets the value of the rotation property.
        Parameters:
        value - allowed object is Integer
        See Also:
        getRotation()

      • getOpacity

        public float getOpacity()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The opacity of the background, as a percentage in the range 0.0 (fully transparent) to 1.0 (fully opaque).</p>
        Returns:
        possible object is Float

      • setOpacity

        public void setOpacity​(Float value)
        Sets the value of the opacity property.
        Parameters:
        value - allowed object is Float
        See Also:
        getOpacity()

      • getColor

        public String getColor()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The color of a unicolor background.</p>
        Returns:
        possible object is String

      • setColor

        public void setColor​(String value)
        Sets the value of the color property.
        Parameters:
        value - allowed object is String
        See Also:
        getColor()

      • getAlignment

        public Alignment getAlignment()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">Uses one of multiple preset positions in order to position the background on the page.
                                     <ul><li>custom = Disable the use of a preset position.</li><li>top_left = Positions the background in the top left corner.</li><li>top_center = Positions the background in the centre on the top margin.</li><li>top_right = Positions the background in the top right corner.</li><li>center_left = Positions the background at the centre of the page, to the left.</li><li>center_center = Positions the background at the centre of the page.</li><li>center_right = Positions the background at the centre of the page, to the right.</li><li>bottom_left = Positions the background in the bottom left corner.</li><li>bottom_center = Positions the background in the centre on the bottom margin.</li><li>bottom_right = Positions the background in the bottom right corner.</li></ul></p>
        Returns:
        possible object is Alignment

      • setAlignment

        public void setAlignment​(Alignment value)
        Sets the value of the alignment property.
        Parameters:
        value - allowed object is Alignment
        See Also:
        getAlignment()

      • getHorizOffset

        public float getHorizOffset()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The horizontal offset in relation to the backgrounds bas position.</p>
        Returns:
        possible object is Float

      • setHorizOffset

        public void setHorizOffset​(Float value)
        Sets the value of the horizOffset property.
        Parameters:
        value - allowed object is Float
        See Also:
        getHorizOffset()

      • getVertOffset

        public float getVertOffset()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The vertical offset in relation to the backgrounds bas position.</p>
        Returns:
        possible object is Float

      • setVertOffset

        public void setVertOffset​(Float value)
        Sets the value of the vertOffset property.
        Parameters:
        value - allowed object is Float
        See Also:
        getVertOffset()

      • getUnit

        public String getUnit()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The Adobe unit used to display offsets in readers. (millimeters, pica, point etc).</p>
        Returns:
        possible object is String

      • setUnit

        public void setUnit​(String value)
        Sets the value of the unit property.
        Parameters:
        value - allowed object is String
        See Also:
        getUnit()