Package net.webpdf.wsclient.schema.operation

Class ScaleType.ScalePages

  • Enclosing class:
    ScaleType
    public static class ScaleType.ScalePages
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">
       <choice>
         <element name="dimensions" type="{http://schema.webpdf.de/1.0/operation}PaddedRectangleType" minOccurs="0"/>
       </choice>
       <attGroup ref="{http://schema.webpdf.de/1.0/operation}AlignmentGroup"/>
       <attribute name="pages" type="{http://www.w3.org/2001/XMLSchema}string" default="" />
       <attribute name="scaleBoxes" type="{http://www.w3.org/2001/XMLSchema}boolean" default="true" />
       <attribute name="preserveAspectRatio" type="{http://www.w3.org/2001/XMLSchema}boolean" default="true" />
     </restriction>
   </complexContent>
 </complexType>

    • Field Detail

      • dimensions

        protected PaddedRectangleType dimensions
         <?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">Care should be taken when applying these parameter: When a padding is set, the page contents will be moved from their original position, which could also mean moving elements into the visible area that were previously hidden by the CropBox.</p>

      • pages

        protected String pages
         <?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">Specifies which page(s) should be scaled. The page number can be either a single page, a range of pages or a list (separated by commas) (e.g. "1.5-6.9"). The specification of all pages is done with "*".</p>

      • scaleBoxes

        protected Boolean scaleBoxes
         <?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">Specifies whether the scaling of the page should also affect the boxes (Mediabox, Cropbox, etc.) of a page. If this is not the case (false), the actual page dimensions, crop boxes, etc. remain as they were originally and only page contents are scaled.
                                             The content can become much smaller or larger than the containing page in this way, which can lead to either large blank areas or overflow of the page content.
                                         </p>

      • preserveAspectRatio

        protected Boolean preserveAspectRatio
         <?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">Specifies whether the ratio of the page dimensions to each other should be maintained when scaling the page. This may result in deviations from the given target height or width (depending on requirements).</p>

      • horizontalAlignment

        protected String horizontalAlignment
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p689949_="https://jakarta.ee/xml/ns/jaxb" xmlns:p832256_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">If margins are created when the page is scaled or if the page content must be positioned relative to a context (for example, the crop box), this value specifies how margins are to be split and how overall page content is to be positioned on the page.
                         <ul><li>left = Contents are to be arranged left-justified.</li><li>center = Content should be centered.</li><li>right = Contents should be arranged right-justified.</li></ul></p>

      • verticalAlignment

        protected String verticalAlignment
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p689949_="https://jakarta.ee/xml/ns/jaxb" xmlns:p832256_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">If margins are created when the page is scaled or if the page content must be positioned relative to a context (for example, the crop box), this value specifies how margins are to be split and how overall page content is to be positioned on the page.
                         <ul><li>top = Content should be positioned at the top of the page.</li><li>center = Content should be centered.</li><li>bottom = content should be positioned at the bottom.</li></ul></p>

    • Constructor Detail

      • ScalePages

        public ScalePages()

    • Method Detail

      • getDimensions

        public PaddedRectangleType getDimensions()
         <?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">Care should be taken when applying these parameter: When a padding is set, the page contents will be moved from their original position, which could also mean moving elements into the visible area that were previously hidden by the CropBox.</p>
        Returns:
        possible object is PaddedRectangleType

      • isSetDimensions

        public boolean isSetDimensions()

      • getPages

        public String getPages()
         <?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">Specifies which page(s) should be scaled. The page number can be either a single page, a range of pages or a list (separated by commas) (e.g. "1.5-6.9"). The specification of all pages is done with "*".</p>
        Returns:
        possible object is String

      • setPages

        public void setPages​(String value)
        Sets the value of the pages property.
        Parameters:
        value - allowed object is String
        See Also:
        getPages()

      • isSetPages

        public boolean isSetPages()

      • isScaleBoxes

        public boolean isScaleBoxes()
         <?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">Specifies whether the scaling of the page should also affect the boxes (Mediabox, Cropbox, etc.) of a page. If this is not the case (false), the actual page dimensions, crop boxes, etc. remain as they were originally and only page contents are scaled.
                                             The content can become much smaller or larger than the containing page in this way, which can lead to either large blank areas or overflow of the page content.
                                         </p>
        Returns:
        possible object is Boolean

      • setScaleBoxes

        public void setScaleBoxes​(boolean value)
        Sets the value of the scaleBoxes property.
        Parameters:
        value - allowed object is Boolean
        See Also:
        isScaleBoxes()

      • isSetScaleBoxes

        public boolean isSetScaleBoxes()

      • unsetScaleBoxes

        public void unsetScaleBoxes()

      • isPreserveAspectRatio

        public boolean isPreserveAspectRatio()
         <?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">Specifies whether the ratio of the page dimensions to each other should be maintained when scaling the page. This may result in deviations from the given target height or width (depending on requirements).</p>
        Returns:
        possible object is Boolean

      • setPreserveAspectRatio

        public void setPreserveAspectRatio​(boolean value)
        Sets the value of the preserveAspectRatio property.
        Parameters:
        value - allowed object is Boolean
        See Also:
        isPreserveAspectRatio()

      • isSetPreserveAspectRatio

        public boolean isSetPreserveAspectRatio()

      • unsetPreserveAspectRatio

        public void unsetPreserveAspectRatio()

      • getHorizontalAlignment

        public String getHorizontalAlignment()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p689949_="https://jakarta.ee/xml/ns/jaxb" xmlns:p832256_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">If margins are created when the page is scaled or if the page content must be positioned relative to a context (for example, the crop box), this value specifies how margins are to be split and how overall page content is to be positioned on the page.
                         <ul><li>left = Contents are to be arranged left-justified.</li><li>center = Content should be centered.</li><li>right = Contents should be arranged right-justified.</li></ul></p>
        Returns:
        possible object is String

      • setHorizontalAlignment

        public void setHorizontalAlignment​(String value)
        Sets the value of the horizontalAlignment property.
        Parameters:
        value - allowed object is String
        See Also:
        getHorizontalAlignment()

      • isSetHorizontalAlignment

        public boolean isSetHorizontalAlignment()

      • getVerticalAlignment

        public String getVerticalAlignment()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p689949_="https://jakarta.ee/xml/ns/jaxb" xmlns:p832256_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">If margins are created when the page is scaled or if the page content must be positioned relative to a context (for example, the crop box), this value specifies how margins are to be split and how overall page content is to be positioned on the page.
                         <ul><li>top = Content should be positioned at the top of the page.</li><li>center = Content should be centered.</li><li>bottom = content should be positioned at the bottom.</li></ul></p>
        Returns:
        possible object is String

      • setVerticalAlignment

        public void setVerticalAlignment​(String value)
        Sets the value of the verticalAlignment property.
        Parameters:
        value - allowed object is String
        See Also:
        getVerticalAlignment()

      • isSetVerticalAlignment

        public boolean isSetVerticalAlignment()