Class OperationTransition


  • public class OperationTransition
    extends Object
    Creates a page transition animation for a PDF full screen presentation. It is possible to specify several transition elements for different page ranges.
    • Constructor Detail

      • OperationTransition

        public OperationTransition()
    • Method Detail

      • getAutoScroll

        @Nullable
        public @Nullable Boolean getAutoScroll()
        If true, the next page to be automatically shown completely in full screen presentation mode after a specific time.
        Returns:
        autoScroll
      • setAutoScroll

        public void setAutoScroll​(Boolean autoScroll)
      • getAutoScrollTime

        @Nullable
        public @Nullable Float getAutoScrollTime()
        The time it will take for the next page to be automatically shown completely in full screen presentation mode. minimum: 0
        Returns:
        autoScrollTime
      • setAutoScrollTime

        public void setAutoScrollTime​(Float autoScrollTime)
      • getDirection

        @Nullable
        public @Nullable OperationTransition.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 recommendable. minimum: 0
        Returns:
        duration
      • setDuration

        public void setDuration​(Float duration)
      • 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 Float 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.
        Returns:
        flyScale
      • setFlyScale

        public void setFlyScale​(Float flyScale)
      • getPages

        @Nullable
        public @Nullable String getPages()
        Used to define the page number or page range (e.g., \"1,5-6,9\") to which the transition animation should be applied.
        Returns:
        pages
      • setPages

        public void setPages​(String pages)
      • getStyle

        @Nullable
        public @Nullable OperationTransition.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