Package net.webpdf.wsclient.openapi

Class OperationToolboxRotateRotate

java.lang.Object

net.webpdf.wsclient.openapi.OperationToolboxRotateRotate

public class OperationToolboxRotateRotate
extends Object

The rotate operation element can be used to rotate pages in the document.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OperationToolboxRotateRotate.OrientationDetectModeEnum	Selects which criteria to use to determine the orientation (portrait/landscape) of pages (see also \"pageOrientation\"): * value = Based solely on the page rotation value entered in the PDF. * dimensions = Based on the ratio of the page dimensions to each other.
static class	OperationToolboxRotateRotate.PageGroupEnum	Used to select pages based on their page number within the specified page range: * all = All pages * even = All pages with an even page number * odd = All pages with an odd page number
static class	OperationToolboxRotateRotate.PageOrientationEnum	Used to select pages based on their orientation within the specified page range: * any = All pages * portrait = All pages in portrait format * landscape = All pages in landscape format

Field Summary

Fields

Modifier and Type	Field	Description
static String	JSON_PROPERTY_DEGREES
static String	JSON_PROPERTY_ORIENTATION_DETECT_MODE
static String	JSON_PROPERTY_PAGE_GROUP
static String	JSON_PROPERTY_PAGE_ORIENTATION
static String	JSON_PROPERTY_PAGES

Constructor Summary

Constructors

Constructor	Description
OperationToolboxRotateRotate()

Method Summary

Modifier and Type	Method	Description
OperationToolboxRotateRotate	degrees(Integer degrees)
boolean	equals(Object o)
@Nullable Integer	getDegrees()	Used to specify the clockwise rotation in degrees.
@Nullable OperationToolboxRotateRotate.OrientationDetectModeEnum	getOrientationDetectMode()	Selects which criteria to use to determine the orientation (portrait/landscape) of pages (see also \"pageOrientation\"): * value = Based solely on the page rotation value entered in the PDF. * dimensions = Based on the ratio of the page dimensions to each other.
@Nullable OperationToolboxRotateRotate.PageGroupEnum	getPageGroup()	Used to select pages based on their page number within the specified page range: * all = All pages * even = All pages with an even page number * odd = All pages with an odd page number
@Nullable OperationToolboxRotateRotate.PageOrientationEnum	getPageOrientation()	Used to select pages based on their orientation within the specified page range: * any = All pages * portrait = All pages in portrait format * landscape = All pages in landscape format
@Nullable String	getPages()	Defines which page(s) should be rotated.
int	hashCode()
OperationToolboxRotateRotate	orientationDetectMode(OperationToolboxRotateRotate.OrientationDetectModeEnum orientationDetectMode)
OperationToolboxRotateRotate	pageGroup(OperationToolboxRotateRotate.PageGroupEnum pageGroup)
OperationToolboxRotateRotate	pageOrientation(OperationToolboxRotateRotate.PageOrientationEnum pageOrientation)
OperationToolboxRotateRotate	pages(String pages)
void	setDegrees(Integer degrees)
void	setOrientationDetectMode(OperationToolboxRotateRotate.OrientationDetectModeEnum orientationDetectMode)
void	setPageGroup(OperationToolboxRotateRotate.PageGroupEnum pageGroup)
void	setPageOrientation(OperationToolboxRotateRotate.PageOrientationEnum pageOrientation)
void	setPages(String pages)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

JSON_PROPERTY_DEGREES

public static final String JSON_PROPERTY_DEGREES

See Also:

Constant Field Values

JSON_PROPERTY_ORIENTATION_DETECT_MODE

public static final String JSON_PROPERTY_ORIENTATION_DETECT_MODE

See Also:

Constant Field Values

JSON_PROPERTY_PAGE_GROUP

public static final String JSON_PROPERTY_PAGE_GROUP

See Also:

Constant Field Values

JSON_PROPERTY_PAGE_ORIENTATION

public static final String JSON_PROPERTY_PAGE_ORIENTATION

See Also:

Constant Field Values

JSON_PROPERTY_PAGES

public static final String JSON_PROPERTY_PAGES

See Also:

Constant Field Values

Constructor Detail

OperationToolboxRotateRotate

public OperationToolboxRotateRotate()

Method Detail

degrees

public OperationToolboxRotateRotate degrees(Integer degrees)

getDegrees

@Nullable
public @Nullable Integer getDegrees()

Used to specify the clockwise rotation in degrees. The rotation is always in 90-degree increments (0, 90, 180, 270, 360). Deviating values will always be rounded down to the next lower increment (e.g.: 32 degrees will become 0 degrees and 101 degrees will become 90 degrees). Once the rotation is completed, the new value will be normalized to a range of 0 to 359 degrees. If the page being rotated has an impermissible value (e.g. 112 degrees), this value will be adjusted before the rotation operation as well (112 degrees will become 90 degrees). minimum: 0 maximum: 360

Returns:

degrees

setDegrees

public void setDegrees(Integer degrees)

orientationDetectMode

public OperationToolboxRotateRotate orientationDetectMode(OperationToolboxRotateRotate.OrientationDetectModeEnum orientationDetectMode)

getOrientationDetectMode

@Nullable
public @Nullable OperationToolboxRotateRotate.OrientationDetectModeEnum getOrientationDetectMode()

Selects which criteria to use to determine the orientation (portrait/landscape) of pages (see also \"pageOrientation\"): * value = Based solely on the page rotation value entered in the PDF. * dimensions = Based on the ratio of the page dimensions to each other.

Returns:

orientationDetectMode

setOrientationDetectMode

public void setOrientationDetectMode(OperationToolboxRotateRotate.OrientationDetectModeEnum orientationDetectMode)

pageGroup

public OperationToolboxRotateRotate pageGroup(OperationToolboxRotateRotate.PageGroupEnum pageGroup)

getPageGroup

@Nullable
public @Nullable OperationToolboxRotateRotate.PageGroupEnum getPageGroup()

Used to select pages based on their page number within the specified page range: * all = All pages * even = All pages with an even page number * odd = All pages with an odd page number

Returns:

pageGroup

setPageGroup

public void setPageGroup(OperationToolboxRotateRotate.PageGroupEnum pageGroup)

pageOrientation

public OperationToolboxRotateRotate pageOrientation(OperationToolboxRotateRotate.PageOrientationEnum pageOrientation)

getPageOrientation

@Nullable
public @Nullable OperationToolboxRotateRotate.PageOrientationEnum getPageOrientation()

Used to select pages based on their orientation within the specified page range: * any = All pages * portrait = All pages in portrait format * landscape = All pages in landscape format

Returns:

pageOrientation

setPageOrientation

public void setPageOrientation(OperationToolboxRotateRotate.PageOrientationEnum pageOrientation)

pages

public OperationToolboxRotateRotate pages(String pages)

getPages

@Nullable
public @Nullable String getPages()

Defines which page(s) should be rotated. The page number can be an individual page, a page range, or a list (separated with commas) (e.g., \"1,5-6,9\"). To specify \"all pages,\" use an asterisk (\"\\*\").

Returns:

pages

setPages

public void setPages(String pages)

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