Package net.webpdf.wsclient.openapi
Class OperationTransition
- java.lang.Object
-
- net.webpdf.wsclient.openapi.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.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classOperationTransition.DirectionEnumThe direction of the transition animation (provided that it can be applied to the animation)static classOperationTransition.StyleEnumThe style of transition animation
-
Field Summary
Fields Modifier and Type Field Description static StringJSON_PROPERTY_AUTO_SCROLLstatic StringJSON_PROPERTY_AUTO_SCROLL_TIMEstatic StringJSON_PROPERTY_DIRECTIONstatic StringJSON_PROPERTY_DURATIONstatic StringJSON_PROPERTY_FLY_AREA_OPAQUEstatic StringJSON_PROPERTY_FLY_SCALEstatic StringJSON_PROPERTY_PAGESstatic StringJSON_PROPERTY_STYLE
-
Constructor Summary
Constructors Constructor Description OperationTransition()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description OperationTransitionautoScroll(Boolean autoScroll)OperationTransitionautoScrollTime(Float autoScrollTime)OperationTransitiondirection(OperationTransition.DirectionEnum direction)OperationTransitionduration(Float duration)booleanequals(Object o)OperationTransitionflyAreaOpaque(Boolean flyAreaOpaque)OperationTransitionflyScale(Float flyScale)@Nullable BooleangetAutoScroll()If true, the next page to be automatically shown completely in full screen presentation mode after a specific time.@Nullable FloatgetAutoScrollTime()The time it will take for the next page to be automatically shown completely in full screen presentation mode.@Nullable OperationTransition.DirectionEnumgetDirection()The direction of the transition animation (provided that it can be applied to the animation)@Nullable FloatgetDuration()The page transition animation's duration, in seconds.@Nullable BooleangetFlyAreaOpaque()Option for the \"fly\" animation style - used to define whether the page background for the page that flies in should be transparent initially.@Nullable FloatgetFlyScale()Option for the \"fly\" animation style - used to define the starting scale for the page that flies in.@Nullable StringgetPages()Used to define the page number or page range (e.g., \"1,5-6,9\") to which the transition animation should be applied.@Nullable OperationTransition.StyleEnumgetStyle()The style of transition animationinthashCode()OperationTransitionpages(String pages)voidsetAutoScroll(Boolean autoScroll)voidsetAutoScrollTime(Float autoScrollTime)voidsetDirection(OperationTransition.DirectionEnum direction)voidsetDuration(Float duration)voidsetFlyAreaOpaque(Boolean flyAreaOpaque)voidsetFlyScale(Float flyScale)voidsetPages(String pages)voidsetStyle(OperationTransition.StyleEnum style)OperationTransitionstyle(OperationTransition.StyleEnum style)StringtoString()
-
-
-
Field Detail
-
JSON_PROPERTY_AUTO_SCROLL
public static final String JSON_PROPERTY_AUTO_SCROLL
- See Also:
- Constant Field Values
-
JSON_PROPERTY_AUTO_SCROLL_TIME
public static final String JSON_PROPERTY_AUTO_SCROLL_TIME
- See Also:
- Constant Field Values
-
JSON_PROPERTY_DIRECTION
public static final String JSON_PROPERTY_DIRECTION
- See Also:
- Constant Field Values
-
JSON_PROPERTY_DURATION
public static final String JSON_PROPERTY_DURATION
- See Also:
- Constant Field Values
-
JSON_PROPERTY_FLY_AREA_OPAQUE
public static final String JSON_PROPERTY_FLY_AREA_OPAQUE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_FLY_SCALE
public static final String JSON_PROPERTY_FLY_SCALE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_PAGES
public static final String JSON_PROPERTY_PAGES
- See Also:
- Constant Field Values
-
JSON_PROPERTY_STYLE
public static final String JSON_PROPERTY_STYLE
- See Also:
- Constant Field Values
-
-
Method Detail
-
autoScroll
public OperationTransition autoScroll(Boolean autoScroll)
-
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)
-
autoScrollTime
public OperationTransition autoScrollTime(Float autoScrollTime)
-
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)
-
direction
public OperationTransition direction(OperationTransition.DirectionEnum direction)
-
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
-
setDirection
public void setDirection(OperationTransition.DirectionEnum direction)
-
duration
public OperationTransition duration(Float duration)
-
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)
-
flyAreaOpaque
public OperationTransition flyAreaOpaque(Boolean flyAreaOpaque)
-
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)
-
flyScale
public OperationTransition flyScale(Float flyScale)
-
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)
-
pages
public OperationTransition pages(String pages)
-
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)
-
style
public OperationTransition style(OperationTransition.StyleEnum style)
-
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
-
setStyle
public void setStyle(OperationTransition.StyleEnum style)
-
-