java.lang.Object
- net.webpdf.wsclient.openapi.MetadataTransition

```
public class MetadataTransition
extends Object
```
Defines a page transition for the full screen mode of the document.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`MetadataTransition.DirectionEnum`	The direction of the transition animation (provided that it can be applied to the animation)
`static class`	`MetadataTransition.StyleEnum`	The style of transition animation

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`JSON_PROPERTY_AUTO_SCROLL`
`static String`	`JSON_PROPERTY_DIRECTION`
`static String`	`JSON_PROPERTY_DURATION`
`static String`	`JSON_PROPERTY_FLY_AREA_OPAQUE`
`static String`	`JSON_PROPERTY_FLY_SCALE`
`static String`	`JSON_PROPERTY_OBJECT_KEY`
`static String`	`JSON_PROPERTY_PAGE`
`static String`	`JSON_PROPERTY_STYLE`

Constructor Summary

Constructors
Constructor Description

MetadataTransition()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`MetadataTransition`	`autoScroll(Boolean autoScroll)`
`MetadataTransition`	`direction(MetadataTransition.DirectionEnum direction)`
`MetadataTransition`	`duration(Float duration)`
`boolean`	`equals(Object o)`
`MetadataTransition`	`flyAreaOpaque(Boolean flyAreaOpaque)`
`MetadataTransition`	`flyScale(Float flyScale)`
`@Nullable Boolean`	`getAutoScroll()`	Whether or not the page is automatically flipped after a short period.
`@Nullable MetadataTransition.DirectionEnum`	`getDirection()`	The direction of the transition animation (provided that it can be applied to the animation)
`@Nullable Float`	`getDuration()`	Selects the duration in seconds, that the animation shall be played for.
`@Nullable Boolean`	`getFlyAreaOpaque()`	For a fly animation, this determines whether or not the opacity shall stay constantly opaque during the animation.
`@Nullable Float`	`getFlyScale()`	For a fly animation, this determines the initial scale of the page, when flying in.
`@Nullable String`	`getObjectKey()`	The object ID of the transition definition.
`@Nullable Integer`	`getPage()`	The page a transition shall be defined for.
`@Nullable MetadataTransition.StyleEnum`	`getStyle()`	The style of transition animation
`int`	`hashCode()`
`MetadataTransition`	`objectKey(String objectKey)`
`MetadataTransition`	`page(Integer page)`
`void`	`setAutoScroll(Boolean autoScroll)`
`void`	`setDirection(MetadataTransition.DirectionEnum direction)`
`void`	`setDuration(Float duration)`
`void`	`setFlyAreaOpaque(Boolean flyAreaOpaque)`
`void`	`setFlyScale(Float flyScale)`
`void`	`setObjectKey(String objectKey)`
`void`	`setPage(Integer page)`
`void`	`setStyle(MetadataTransition.StyleEnum style)`
`MetadataTransition`	`style(MetadataTransition.StyleEnum style)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - JSON_PROPERTY_AUTO_SCROLL
```
public static final String JSON_PROPERTY_AUTO_SCROLL
```
    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_OBJECT_KEY
```
public static final String JSON_PROPERTY_OBJECT_KEY
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_PAGE
```
public static final String JSON_PROPERTY_PAGE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_STYLE
```
public static final String JSON_PROPERTY_STYLE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - MetadataTransition
```
public MetadataTransition()
```
- Method Detail
  - autoScroll
```
public MetadataTransition autoScroll(Boolean autoScroll)
```
  - getAutoScroll
```
@Nullable
public @Nullable Boolean getAutoScroll()
```
    Whether or not the page is automatically flipped after a short period.
    
    Returns:
    
    autoScroll
  - setAutoScroll
```
public void setAutoScroll(Boolean autoScroll)
```
  - direction
```
public MetadataTransition direction(MetadataTransition.DirectionEnum direction)
```
  - getDirection
```
@Nullable
public @Nullable MetadataTransition.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(MetadataTransition.DirectionEnum direction)
```
  - duration
```
public MetadataTransition duration(Float duration)
```
  - getDuration
```
@Nullable
public @Nullable Float getDuration()
```
    Selects the duration in seconds, that the animation shall be played for. minimum: 0
    
    Returns:
    
    duration
  - setDuration
```
public void setDuration(Float duration)
```
  - flyAreaOpaque
```
public MetadataTransition flyAreaOpaque(Boolean flyAreaOpaque)
```
  - getFlyAreaOpaque
```
@Nullable
public @Nullable Boolean getFlyAreaOpaque()
```
    For a fly animation, this determines whether or not the opacity shall stay constantly opaque during the animation.
    
    Returns:
    
    flyAreaOpaque
  - setFlyAreaOpaque
```
public void setFlyAreaOpaque(Boolean flyAreaOpaque)
```
  - flyScale
```
public MetadataTransition flyScale(Float flyScale)
```
  - getFlyScale
```
@Nullable
public @Nullable Float getFlyScale()
```
    For a fly animation, this determines the initial scale of the page, when flying in.
    
    Returns:
    
    flyScale
  - setFlyScale
```
public void setFlyScale(Float flyScale)
```
  - objectKey
```
public MetadataTransition objectKey(String objectKey)
```
  - getObjectKey
```
@Nullable
public @Nullable String getObjectKey()
```
    The object ID of the transition definition. **Info:** 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.
    
    Returns:
    
    objectKey
  - setObjectKey
```
public void setObjectKey(String objectKey)
```
  - page
```
public MetadataTransition page(Integer page)
```
  - getPage
```
@Nullable
public @Nullable Integer getPage()
```
    The page a transition shall be defined for. minimum: 0
    
    Returns:
    
    page
  - setPage
```
public void setPage(Integer page)
```
  - style
```
public MetadataTransition style(MetadataTransition.StyleEnum style)
```
  - getStyle
```
@Nullable
public @Nullable MetadataTransition.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(MetadataTransition.StyleEnum style)
```
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class MetadataTransition

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

JSON_PROPERTY_AUTO_SCROLL

JSON_PROPERTY_DIRECTION

JSON_PROPERTY_DURATION

JSON_PROPERTY_FLY_AREA_OPAQUE

JSON_PROPERTY_FLY_SCALE

JSON_PROPERTY_OBJECT_KEY

JSON_PROPERTY_PAGE

JSON_PROPERTY_STYLE

Constructor Detail

MetadataTransition

Method Detail

autoScroll

getAutoScroll

setAutoScroll

direction

getDirection

setDirection

duration

getDuration

setDuration

flyAreaOpaque

getFlyAreaOpaque

setFlyAreaOpaque

flyScale

getFlyScale

setFlyScale

objectKey

getObjectKey

setObjectKey

page

getPage

setPage

style

getStyle

setStyle

equals

hashCode

toString