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

Class TransitionType

  • public class TransitionType
extends Object
     <?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">Defines a page transition for the full screen mode of the document.</p>

    Java class for TransitionType complex type

    .

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

    
 <complexType name="TransitionType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <attribute name="objectKey" type="{http://www.w3.org/2001/XMLSchema}string" default="" />
       <attribute name="page" default="0">
         <simpleType>
           <restriction base="{http://www.w3.org/2001/XMLSchema}int">
             <minInclusive value="0"/>
           </restriction>
         </simpleType>
       </attribute>
       <attribute name="autoScroll" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="flyScale" type="{http://www.w3.org/2001/XMLSchema}float" default="1" />
       <attribute name="flyAreaOpaque" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="duration" default="1">
         <simpleType>
           <restriction base="{http://www.w3.org/2001/XMLSchema}float">
             <minInclusive value="0"/>
           </restriction>
         </simpleType>
       </attribute>
       <attribute name="style" type="{http://schema.webpdf.de/1.0/extraction/info}TransitionStyleType" default="none" />
       <attribute name="direction" type="{http://schema.webpdf.de/1.0/extraction/info}TransitionDirection" default="none" />
     </restriction>
   </complexContent>
 </complexType>

    • Field Detail

      • objectKey

        protected String objectKey
         <?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 object ID of the transition definition.
 
                         <b>Info:</b>
                         A PDF object ID consists of two numbers, where the first number selects the object's number and the second the "generation" of the object. The object ID shall always be unique within the context of the document and can be used to select a specific object.
                     </p>

      • page

        protected Integer page
         <?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 page a transition shall be defined for.</p>

      • autoScroll

        protected Boolean autoScroll
         <?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">Whether or not the page is automatically flipped after a short period.</p>

      • flyScale

        protected Float flyScale
         <?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">For a fly animation, this determines the initial scale of the page, when flying in.</p>

      • flyAreaOpaque

        protected Boolean flyAreaOpaque
         <?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">For a fly animation, this determines whether or not the opacity shall stay constantly opaque during the animation.</p>

      • duration

        protected Float duration
         <?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">Selects the duration in seconds, that the animation shall be played for.</p>

      • style

        protected TransitionStyleType style
         <?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 style of transition animation.
                         <ul><li>blinds = Crossfades</li><li>box = Crossfades in a rectangular pattern</li><li>cover = Covers</li><li>dissolve = Dissolves</li><li>fade = Fades</li><li>fly = Page flies in</li><li>glitter = Page dissolves and is replaced</li><li>push = Page is pushed out</li><li>split = Splits page</li><li>uncover = Uncovers page</li><li>wipe = Wipes page</li><li>none = No special effect</li></ul></p>

      • direction

        protected TransitionDirection direction
         <?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 direction of the transition animation (provided that it can be applied to the animation).
                         <ul><li>leftToRight = From left to right</li><li>bottomToTop = From bottom to top</li><li>rightToLeft = From right to left</li><li>topToBottom = From top to bottom</li><li>topLeftToBottomRight = From top left to bottom right</li><li>none = Use the default value for the animation</li></ul></p>

    • Constructor Detail

      • TransitionType

        public TransitionType()

    • Method Detail

      • getObjectKey

        public String getObjectKey()
         <?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 object ID of the transition definition.
 
                         <b>Info:</b>
                         A PDF object ID consists of two numbers, where the first number selects the object's number and the second the "generation" of the object. The object ID shall always be unique within the context of the document and can be used to select a specific object.
                     </p>
        Returns:
        possible object is String

      • setObjectKey

        public void setObjectKey​(String value)
        Sets the value of the objectKey property.
        Parameters:
        value - allowed object is String
        See Also:
        getObjectKey()

      • getPage

        public int getPage()
         <?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 page a transition shall be defined for.</p>
        Returns:
        possible object is Integer

      • setPage

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

      • isAutoScroll

        public boolean isAutoScroll()
         <?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">Whether or not the page is automatically flipped after a short period.</p>
        Returns:
        possible object is Boolean

      • setAutoScroll

        public void setAutoScroll​(Boolean value)
        Sets the value of the autoScroll property.
        Parameters:
        value - allowed object is Boolean
        See Also:
        isAutoScroll()

      • getFlyScale

        public float getFlyScale()
         <?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">For a fly animation, this determines the initial scale of the page, when flying in.</p>
        Returns:
        possible object is Float

      • setFlyScale

        public void setFlyScale​(Float value)
        Sets the value of the flyScale property.
        Parameters:
        value - allowed object is Float
        See Also:
        getFlyScale()

      • isFlyAreaOpaque

        public boolean isFlyAreaOpaque()
         <?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">For a fly animation, this determines whether or not the opacity shall stay constantly opaque during the animation.</p>
        Returns:
        possible object is Boolean

      • setFlyAreaOpaque

        public void setFlyAreaOpaque​(Boolean value)
        Sets the value of the flyAreaOpaque property.
        Parameters:
        value - allowed object is Boolean
        See Also:
        isFlyAreaOpaque()

      • getDuration

        public float getDuration()
         <?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">Selects the duration in seconds, that the animation shall be played for.</p>
        Returns:
        possible object is Float

      • setDuration

        public void setDuration​(Float value)
        Sets the value of the duration property.
        Parameters:
        value - allowed object is Float
        See Also:
        getDuration()

      • getStyle

        public TransitionStyleType getStyle()
         <?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 style of transition animation.
                         <ul><li>blinds = Crossfades</li><li>box = Crossfades in a rectangular pattern</li><li>cover = Covers</li><li>dissolve = Dissolves</li><li>fade = Fades</li><li>fly = Page flies in</li><li>glitter = Page dissolves and is replaced</li><li>push = Page is pushed out</li><li>split = Splits page</li><li>uncover = Uncovers page</li><li>wipe = Wipes page</li><li>none = No special effect</li></ul></p>
        Returns:
        possible object is TransitionStyleType

      • getDirection

        public TransitionDirection getDirection()
         <?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 direction of the transition animation (provided that it can be applied to the animation).
                         <ul><li>leftToRight = From left to right</li><li>bottomToTop = From bottom to top</li><li>rightToLeft = From right to left</li><li>topToBottom = From top to bottom</li><li>topLeftToBottomRight = From top left to bottom right</li><li>none = Use the default value for the animation</li></ul></p>
        Returns:
        possible object is TransitionDirection