Package net.webpdf.wsclient.openapi

Class OperationTransitionActionSetTransition

  • public class OperationTransitionActionSetTransition
extends Object
    The setTransition action shows the changes that result from the actions with the use of the defined transition animation.

    • Constructor Detail

      • OperationTransitionActionSetTransition

        public OperationTransitionActionSetTransition()

    • Method Detail

      • getDirection

        @Nullable
public @Nullable OperationTransitionActionSetTransition.DirectionEnum getDirection()
        The direction of the transition animation (provided that it can be applied to the animation). * leftToRight = From left to right * bottomToTop = From bottom to top * rightToLeft = From right to left * topToBottom = From top to bottom * topLeftToBottomRight = From top left to bottom right * none = Use the default value for the animation
        Returns:
        direction

      • getDuration

        @Nullable
public @Nullable Float getDuration()
        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. minimum: 0
        Returns:
        duration

      • setDuration

        public void setDuration​(Float duration)

      • getEffectDimensionHorizontal

        @Nullable
public @Nullable Boolean getEffectDimensionHorizontal()
        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.
        Returns:
        effectDimensionHorizontal

      • setEffectDimensionHorizontal

        public void setEffectDimensionHorizontal​(Boolean effectDimensionHorizontal)

      • getFlyAreaOpaque

        @Nullable
public @Nullable Boolean getFlyAreaOpaque()
        Option for the \"fly\" animation style - used to define whether the page background for the page that flies in should be transparent initially.
        Returns:
        flyAreaOpaque

      • setFlyAreaOpaque

        public void setFlyAreaOpaque​(Boolean flyAreaOpaque)

      • getFlyScale

        @Nullable
public @Nullable Integer getFlyScale()
        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). minimum: 0 maximum: 6400
        Returns:
        flyScale

      • setFlyScale

        public void setFlyScale​(Integer flyScale)

      • getMotionInward

        @Nullable
public @Nullable Boolean getMotionInward()
        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).
        Returns:
        motionInward

      • setMotionInward

        public void setMotionInward​(Boolean motionInward)

      • getScaling

        @Nullable
public @Nullable Integer getScaling()
        Used to set the value for zooming (as a percentage). minimum: 0
        Returns:
        scaling

      • setScaling

        public void setScaling​(Integer scaling)

      • getStyle

        @Nullable
public @Nullable OperationTransitionActionSetTransition.StyleEnum getStyle()
        The style of transition animation. * blinds = Crossfades * box = Crossfades in a rectangular pattern * cover = Covers * dissolve = Dissolves * fade = Fades * fly = Page flies in * glitter = Page dissolves and is replaced * push = Page is pushed out * split = Splits page * uncover = Uncovers page * wipe = Wipes page * none = No special effect
        Returns:
        style

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object