Class FitRectangleDestinationType


  • public class FitRectangleDestinationType
    extends DestinationEventType
     <?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 fitRectangle element is used to specify a location within the document. It will jump to a page in the document and set a zoom factor that will ensure, as far as possible, that a rectangle produced by the offsets from the page margins is displayed.</p>
     

    Java class for FitRectangleDestinationType complex type

    .

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

    
     <complexType name="FitRectangleDestinationType">
       <complexContent>
         <extension base="{http://schema.webpdf.de/1.0/operation}DestinationEventType">
           <attribute name="page" default="1">
             <simpleType>
               <restriction base="{http://www.w3.org/2001/XMLSchema}int">
                 <minInclusive value="1"/>
               </restriction>
             </simpleType>
           </attribute>
           <attribute name="leftOffset" default="0">
             <simpleType>
               <restriction base="{http://www.w3.org/2001/XMLSchema}int">
               </restriction>
             </simpleType>
           </attribute>
           <attribute name="bottomOffset" default="0">
             <simpleType>
               <restriction base="{http://www.w3.org/2001/XMLSchema}int">
               </restriction>
             </simpleType>
           </attribute>
           <attribute name="rightOffset" default="0">
             <simpleType>
               <restriction base="{http://www.w3.org/2001/XMLSchema}int">
               </restriction>
             </simpleType>
           </attribute>
           <attribute name="topOffset" default="0">
             <simpleType>
               <restriction base="{http://www.w3.org/2001/XMLSchema}int">
               </restriction>
             </simpleType>
           </attribute>
           <attribute name="metrics" type="{http://schema.webpdf.de/1.0/operation}MetricsType" default="px" />
         </extension>
       </complexContent>
     </complexType>
     
    • Field Detail

      • page

        protected Integer page
         <?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 document page to which the jump will be.</p>
         
      • leftOffset

        protected Integer leftOffset
         <?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 area's offset from the left page margin.</p>
         
      • bottomOffset

        protected Integer bottomOffset
         <?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 area's offset from the bottom page margin.</p>
         
      • rightOffset

        protected Integer rightOffset
         <?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 area's offset from the right page margin.</p>
         
      • topOffset

        protected Integer topOffset
         <?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 area's offset from the top page margin.</p>
         
      • metrics

        protected MetricsType metrics
         <?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">Used to specify the unit in which the maximum dimensions are specified.
                                         <ul><li>pt = Points(1/72 inch)</li><li>pc = Picas(12 points)</li><li>px = Pixels(1/96 inch)</li><li>mm = Millimeters</li><li>in = Inches</li></ul></p>
         
    • Constructor Detail

      • FitRectangleDestinationType

        public FitRectangleDestinationType()
    • Method Detail

      • getPage

        public int getPage()
         <?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 document page to which the jump will be.</p>
         
        Returns:
        possible object is Integer
      • setPage

        public void setPage​(int value)
        Sets the value of the page property.
        Parameters:
        value - allowed object is Integer
        See Also:
        getPage()
      • isSetPage

        public boolean isSetPage()
      • unsetPage

        public void unsetPage()
      • getLeftOffset

        public int getLeftOffset()
         <?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 area's offset from the left page margin.</p>
         
        Returns:
        possible object is Integer
      • setLeftOffset

        public void setLeftOffset​(int value)
        Sets the value of the leftOffset property.
        Parameters:
        value - allowed object is Integer
        See Also:
        getLeftOffset()
      • isSetLeftOffset

        public boolean isSetLeftOffset()
      • unsetLeftOffset

        public void unsetLeftOffset()
      • getBottomOffset

        public int getBottomOffset()
         <?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 area's offset from the bottom page margin.</p>
         
        Returns:
        possible object is Integer
      • setBottomOffset

        public void setBottomOffset​(int value)
        Sets the value of the bottomOffset property.
        Parameters:
        value - allowed object is Integer
        See Also:
        getBottomOffset()
      • isSetBottomOffset

        public boolean isSetBottomOffset()
      • unsetBottomOffset

        public void unsetBottomOffset()
      • getRightOffset

        public int getRightOffset()
         <?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 area's offset from the right page margin.</p>
         
        Returns:
        possible object is Integer
      • setRightOffset

        public void setRightOffset​(int value)
        Sets the value of the rightOffset property.
        Parameters:
        value - allowed object is Integer
        See Also:
        getRightOffset()
      • isSetRightOffset

        public boolean isSetRightOffset()
      • unsetRightOffset

        public void unsetRightOffset()
      • getTopOffset

        public int getTopOffset()
         <?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 area's offset from the top page margin.</p>
         
        Returns:
        possible object is Integer
      • setTopOffset

        public void setTopOffset​(int value)
        Sets the value of the topOffset property.
        Parameters:
        value - allowed object is Integer
        See Also:
        getTopOffset()
      • isSetTopOffset

        public boolean isSetTopOffset()
      • unsetTopOffset

        public void unsetTopOffset()
      • getMetrics

        public MetricsType getMetrics()
         <?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">Used to specify the unit in which the maximum dimensions are specified.
                                         <ul><li>pt = Points(1/72 inch)</li><li>pc = Picas(12 points)</li><li>px = Pixels(1/96 inch)</li><li>mm = Millimeters</li><li>in = Inches</li></ul></p>
         
        Returns:
        possible object is MetricsType
      • setMetrics

        public void setMetrics​(MetricsType value)
        Sets the value of the metrics property.
        Parameters:
        value - allowed object is MetricsType
        See Also:
        getMetrics()
      • isSetMetrics

        public boolean isSetMetrics()