Package net.webpdf.wsclient.schema.operation

Class TransitionActionType

  • public class TransitionActionType
extends ActionEventType
     <?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 setTransition action shows the changes that result from the actions with the use of the defined transition animation.</p>

    Java class for TransitionActionType complex type

    .

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

    
 <complexType name="TransitionActionType">
   <complexContent>
     <extension base="{http://schema.webpdf.de/1.0/operation}ActionEventType">
       <attribute name="scaling" default="100">
         <simpleType>
           <restriction base="{http://www.w3.org/2001/XMLSchema}int">
             <minInclusive value="0"/>
           </restriction>
         </simpleType>
       </attribute>
       <attribute name="effectDimensionHorizontal" type="{http://www.w3.org/2001/XMLSchema}boolean" default="true" />
       <attribute name="motionInward" type="{http://www.w3.org/2001/XMLSchema}boolean" default="true" />
       <attribute name="flyAreaOpaque" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="flyScale" default="100">
         <simpleType>
           <restriction base="{http://www.w3.org/2001/XMLSchema}int">
             <minInclusive value="0"/>
             <maxInclusive value="6400"/>
           </restriction>
         </simpleType>
       </attribute>
       <attribute name="direction" type="{http://schema.webpdf.de/1.0/operation}OutlineTransitionDirectionType" default="leftToRight" />
       <attribute name="style" type="{http://schema.webpdf.de/1.0/operation}OutlineTransitionStyleType" default="none" />
       <attribute name="duration" default="1">
         <simpleType>
           <restriction base="{http://www.w3.org/2001/XMLSchema}float">
             <minInclusive value="0"/>
           </restriction>
         </simpleType>
       </attribute>
     </extension>
   </complexContent>
 </complexType>

    • Field Detail

      • scaling

        protected Integer scaling
         <?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 set the value for zooming (as a percentage).</p>

      • effectDimensionHorizontal

        protected Boolean effectDimensionHorizontal
         <?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">Option for the split and blinds animation styles - used to define the axis along which the effect should happen. true corresponds to the horizontal axis; false to the vertical one.</p>

      • motionInward

        protected Boolean motionInward
         <?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">Option for the split, box, and fly animation styles - defines whether the animation direction will be from the edges of the page towards the centre (true) or from the centre towards the edges (false).</p>

      • flyAreaOpaque

        protected Boolean flyAreaOpaque
         <?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">Option for the "fly" animation style - used to define whether the page background for the page that flies in should be transparent initially.</p>

      • flyScale

        protected Integer flyScale
         <?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">Option for the "fly" animation style - used to define the starting scale for the page that flies in. The page will smoothly be scaled from this starting scale all the way to the size of the page being displayed (defined as a percentage).</p>

      • direction

        protected OutlineTransitionDirectionType direction
         <?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 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>

      • style

        protected OutlineTransitionStyleType style
         <?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 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>

      • duration

        protected Float duration
         <?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 page transition animation's duration, in seconds. Make sure to avoid excessively high values, as certain reader programs will force the entire animation to be displayed without any option for interrupting it. Moreover, an excessively long animation can result in display and execution errors in the reader program. Values under 10 seconds are recommended.</p>

    • Constructor Detail

      • TransitionActionType

        public TransitionActionType()

    • Method Detail

      • getScaling

        public int getScaling()
         <?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 set the value for zooming (as a percentage).</p>
        Returns:
        possible object is Integer

      • setScaling

        public void setScaling​(int value)
        Sets the value of the scaling property.
        Parameters:
        value - allowed object is Integer
        See Also:
        getScaling()

      • isSetScaling

        public boolean isSetScaling()

      • unsetScaling

        public void unsetScaling()

      • isEffectDimensionHorizontal

        public boolean isEffectDimensionHorizontal()
         <?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">Option for the split and blinds animation styles - used to define the axis along which the effect should happen. true corresponds to the horizontal axis; false to the vertical one.</p>
        Returns:
        possible object is Boolean

      • setEffectDimensionHorizontal

        public void setEffectDimensionHorizontal​(boolean value)
        Sets the value of the effectDimensionHorizontal property.
        Parameters:
        value - allowed object is Boolean
        See Also:
        isEffectDimensionHorizontal()

      • isSetEffectDimensionHorizontal

        public boolean isSetEffectDimensionHorizontal()

      • unsetEffectDimensionHorizontal

        public void unsetEffectDimensionHorizontal()

      • isMotionInward

        public boolean isMotionInward()
         <?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">Option for the split, box, and fly animation styles - defines whether the animation direction will be from the edges of the page towards the centre (true) or from the centre towards the edges (false).</p>
        Returns:
        possible object is Boolean

      • setMotionInward

        public void setMotionInward​(boolean value)
        Sets the value of the motionInward property.
        Parameters:
        value - allowed object is Boolean
        See Also:
        isMotionInward()

      • isSetMotionInward

        public boolean isSetMotionInward()

      • unsetMotionInward

        public void unsetMotionInward()

      • isFlyAreaOpaque

        public boolean isFlyAreaOpaque()
         <?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">Option for the "fly" animation style - used to define whether the page background for the page that flies in should be transparent initially.</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()

      • isSetFlyAreaOpaque

        public boolean isSetFlyAreaOpaque()

      • unsetFlyAreaOpaque

        public void unsetFlyAreaOpaque()

      • getFlyScale

        public int getFlyScale()
         <?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">Option for the "fly" animation style - used to define the starting scale for the page that flies in. The page will smoothly be scaled from this starting scale all the way to the size of the page being displayed (defined as a percentage).</p>
        Returns:
        possible object is Integer

      • setFlyScale

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

      • isSetFlyScale

        public boolean isSetFlyScale()

      • unsetFlyScale

        public void unsetFlyScale()

      • getDirection

        public OutlineTransitionDirectionType getDirection()
         <?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 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 OutlineTransitionDirectionType

      • isSetDirection

        public boolean isSetDirection()

      • getStyle

        public OutlineTransitionStyleType getStyle()
         <?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 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 OutlineTransitionStyleType

      • isSetStyle

        public boolean isSetStyle()

      • getDuration

        public float getDuration()
         <?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 page transition animation's duration, in seconds. Make sure to avoid excessively high values, as certain reader programs will force the entire animation to be displayed without any option for interrupting it. Moreover, an excessively long animation can result in display and execution errors in the reader program. Values under 10 seconds are recommended.</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()

      • isSetDuration

        public boolean isSetDuration()

      • unsetDuration

        public void unsetDuration()