Package net.webpdf.wsclient.schema.operation

Class TransitionType

java.lang.Object

net.webpdf.wsclient.schema.operation.TransitionType

public class TransitionType
extends Object

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p416162_="https://jakarta.ee/xml/ns/jaxb" xmlns:p761379_="http://jaxb2-commons.dev.java.net/basic/simplify" xmlns:p931522_="http://jaxb2-commons.dev.java.net/basic/inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Creates a page transition animation for a PDF full screen presentation. It is possible to specify several transition elements for different page ranges.</p>
 

Java class for TransitionType complex type

.

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

 <complexType name="TransitionType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <attribute name="duration" default="1">
         <simpleType>
           <restriction base="{http://www.w3.org/2001/XMLSchema}float">
             <minInclusive value="0"/>
           </restriction>
         </simpleType>
       </attribute>
       <attribute name="style" type="{http://schema.webpdf.de/1.0/operation}TransitionStyleType" default="none" />
       <attribute name="direction" type="{http://schema.webpdf.de/1.0/operation}TransitionDirection" default="none" />
       <attribute name="pages" type="{http://www.w3.org/2001/XMLSchema}string" default="" />
       <attribute name="autoScrollTime" default="0">
         <simpleType>
           <restriction base="{http://www.w3.org/2001/XMLSchema}float">
             <minInclusive value="0"/>
           </restriction>
         </simpleType>
       </attribute>
       <attribute name="autoScroll" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="flyScale" type="{http://www.w3.org/2001/XMLSchema}float" default="1" />
       <attribute name="flyAreaOpaque" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
     </restriction>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field	Description
protected Boolean	autoScroll	<?
protected Float	autoScrollTime	<?
protected TransitionDirection	direction	<?
protected Float	duration	<?
protected Boolean	flyAreaOpaque	<?
protected Float	flyScale	<?
protected String	pages	<?
protected TransitionStyleType	style	<?

Constructor Summary

Constructors

Constructor	Description
TransitionType()

Method Summary

Modifier and Type	Method	Description
float	getAutoScrollTime()	<?
TransitionDirection	getDirection()	<?
float	getDuration()	<?
float	getFlyScale()	<?
String	getPages()	<?
TransitionStyleType	getStyle()	<?
boolean	isAutoScroll()	<?
boolean	isFlyAreaOpaque()	<?
boolean	isSetAutoScroll()
boolean	isSetAutoScrollTime()
boolean	isSetDirection()
boolean	isSetDuration()
boolean	isSetFlyAreaOpaque()
boolean	isSetFlyScale()
boolean	isSetPages()
boolean	isSetStyle()
void	setAutoScroll(boolean value)	Sets the value of the autoScroll property.
void	setAutoScrollTime(float value)	Sets the value of the autoScrollTime property.
void	setDirection(TransitionDirection value)	Sets the value of the direction property.
void	setDuration(float value)	Sets the value of the duration property.
void	setFlyAreaOpaque(boolean value)	Sets the value of the flyAreaOpaque property.
void	setFlyScale(float value)	Sets the value of the flyScale property.
void	setPages(String value)	Sets the value of the pages property.
void	setStyle(TransitionStyleType value)	Sets the value of the style property.
void	unsetAutoScroll()
void	unsetAutoScrollTime()
void	unsetDuration()
void	unsetFlyAreaOpaque()
void	unsetFlyScale()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

duration

protected Float duration

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p416162_="https://jakarta.ee/xml/ns/jaxb" xmlns:p761379_="http://jaxb2-commons.dev.java.net/basic/simplify" xmlns:p931522_="http://jaxb2-commons.dev.java.net/basic/inheritance" 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 recommendable.</p>
 

style

protected TransitionStyleType style

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p416162_="https://jakarta.ee/xml/ns/jaxb" xmlns:p761379_="http://jaxb2-commons.dev.java.net/basic/simplify" xmlns:p931522_="http://jaxb2-commons.dev.java.net/basic/inheritance" 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>
 

direction

protected TransitionDirection direction

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p416162_="https://jakarta.ee/xml/ns/jaxb" xmlns:p761379_="http://jaxb2-commons.dev.java.net/basic/simplify" xmlns:p931522_="http://jaxb2-commons.dev.java.net/basic/inheritance" 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>
 

pages

protected String pages

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p416162_="https://jakarta.ee/xml/ns/jaxb" xmlns:p761379_="http://jaxb2-commons.dev.java.net/basic/simplify" xmlns:p931522_="http://jaxb2-commons.dev.java.net/basic/inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Used to define the page number or page range (e.g., "1,5-6,9") to which the transition animation should be applied.</p>
 

autoScrollTime

protected Float autoScrollTime

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p416162_="https://jakarta.ee/xml/ns/jaxb" xmlns:p761379_="http://jaxb2-commons.dev.java.net/basic/simplify" xmlns:p931522_="http://jaxb2-commons.dev.java.net/basic/inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">The time it will take for the next page to be automatically shown completely in full screen presentation mode.</p>
 

autoScroll

protected Boolean autoScroll

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p416162_="https://jakarta.ee/xml/ns/jaxb" xmlns:p761379_="http://jaxb2-commons.dev.java.net/basic/simplify" xmlns:p931522_="http://jaxb2-commons.dev.java.net/basic/inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">If true, the next page to be automatically shown completely in full screen presentation mode after a specific time.</p>
 

flyScale

protected Float flyScale

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p416162_="https://jakarta.ee/xml/ns/jaxb" xmlns:p761379_="http://jaxb2-commons.dev.java.net/basic/simplify" xmlns:p931522_="http://jaxb2-commons.dev.java.net/basic/inheritance" 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.</p>
 

flyAreaOpaque

protected Boolean flyAreaOpaque

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p416162_="https://jakarta.ee/xml/ns/jaxb" xmlns:p761379_="http://jaxb2-commons.dev.java.net/basic/simplify" xmlns:p931522_="http://jaxb2-commons.dev.java.net/basic/inheritance" 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>
 

Constructor Detail

TransitionType

public TransitionType()

Method Detail

getDuration

public float getDuration()

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p416162_="https://jakarta.ee/xml/ns/jaxb" xmlns:p761379_="http://jaxb2-commons.dev.java.net/basic/simplify" xmlns:p931522_="http://jaxb2-commons.dev.java.net/basic/inheritance" 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 recommendable.</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()

getStyle

public TransitionStyleType getStyle()

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p416162_="https://jakarta.ee/xml/ns/jaxb" xmlns:p761379_="http://jaxb2-commons.dev.java.net/basic/simplify" xmlns:p931522_="http://jaxb2-commons.dev.java.net/basic/inheritance" 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 TransitionStyleType

setStyle

public void setStyle(TransitionStyleType value)

Sets the value of the style property.

Parameters:

value - allowed object is TransitionStyleType

See Also:

getStyle()

isSetStyle

public boolean isSetStyle()

getDirection

public TransitionDirection getDirection()

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p416162_="https://jakarta.ee/xml/ns/jaxb" xmlns:p761379_="http://jaxb2-commons.dev.java.net/basic/simplify" xmlns:p931522_="http://jaxb2-commons.dev.java.net/basic/inheritance" 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 TransitionDirection

setDirection

public void setDirection(TransitionDirection value)

Sets the value of the direction property.

Parameters:

value - allowed object is TransitionDirection

See Also:

getDirection()

isSetDirection

public boolean isSetDirection()

getPages

public String getPages()

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p416162_="https://jakarta.ee/xml/ns/jaxb" xmlns:p761379_="http://jaxb2-commons.dev.java.net/basic/simplify" xmlns:p931522_="http://jaxb2-commons.dev.java.net/basic/inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Used to define the page number or page range (e.g., "1,5-6,9") to which the transition animation should be applied.</p>
 

Returns:

possible object is String

setPages

public void setPages(String value)

Sets the value of the pages property.

Parameters:

value - allowed object is String

See Also:

getPages()

isSetPages

public boolean isSetPages()

getAutoScrollTime

public float getAutoScrollTime()

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p416162_="https://jakarta.ee/xml/ns/jaxb" xmlns:p761379_="http://jaxb2-commons.dev.java.net/basic/simplify" xmlns:p931522_="http://jaxb2-commons.dev.java.net/basic/inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">The time it will take for the next page to be automatically shown completely in full screen presentation mode.</p>
 

Returns:

possible object is Float

setAutoScrollTime

public void setAutoScrollTime(float value)

Sets the value of the autoScrollTime property.

Parameters:

value - allowed object is Float

See Also:

getAutoScrollTime()

isSetAutoScrollTime

public boolean isSetAutoScrollTime()

unsetAutoScrollTime

public void unsetAutoScrollTime()

isAutoScroll

public boolean isAutoScroll()

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p416162_="https://jakarta.ee/xml/ns/jaxb" xmlns:p761379_="http://jaxb2-commons.dev.java.net/basic/simplify" xmlns:p931522_="http://jaxb2-commons.dev.java.net/basic/inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">If true, the next page to be automatically shown completely in full screen presentation mode after a specific time.</p>
 

Returns:

possible object is Boolean

setAutoScroll

public void setAutoScroll(boolean value)

Sets the value of the autoScroll property.

Parameters:

value - allowed object is Boolean

See Also:

isAutoScroll()

isSetAutoScroll

public boolean isSetAutoScroll()

unsetAutoScroll

public void unsetAutoScroll()

getFlyScale

public float getFlyScale()

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p416162_="https://jakarta.ee/xml/ns/jaxb" xmlns:p761379_="http://jaxb2-commons.dev.java.net/basic/simplify" xmlns:p931522_="http://jaxb2-commons.dev.java.net/basic/inheritance" 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.</p>
 

Returns:

possible object is Float

setFlyScale

public void setFlyScale(float value)

Sets the value of the flyScale property.

Parameters:

value - allowed object is Float

See Also:

getFlyScale()

isSetFlyScale

public boolean isSetFlyScale()

unsetFlyScale

public void unsetFlyScale()

isFlyAreaOpaque

public boolean isFlyAreaOpaque()

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p416162_="https://jakarta.ee/xml/ns/jaxb" xmlns:p761379_="http://jaxb2-commons.dev.java.net/basic/simplify" xmlns:p931522_="http://jaxb2-commons.dev.java.net/basic/inheritance" 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()