Package net.webpdf.wsclient.openapi

Class OperationSelectionBox

java.lang.Object

net.webpdf.wsclient.openapi.OperationSelectionBox

public class OperationSelectionBox
extends Object

Selects a specific box of a given page range of a PDF document.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OperationSelectionBox.BoxEnum	Used to select the box that should be scaled

Field Summary

Fields

Modifier and Type	Field	Description
static String	JSON_PROPERTY_BOX
static String	JSON_PROPERTY_PAGES

Constructor Summary

Constructors

Constructor	Description
OperationSelectionBox()

Method Summary

Modifier and Type	Method	Description
OperationSelectionBox	box(OperationSelectionBox.BoxEnum box)
boolean	equals(Object o)
@Nullable OperationSelectionBox.BoxEnum	getBox()	Used to select the box that should be scaled
@Nullable String	getPages()	Used to define the page(s) from which boxes should be removed.
int	hashCode()
OperationSelectionBox	pages(String pages)
void	setBox(OperationSelectionBox.BoxEnum box)
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_BOX

public static final String JSON_PROPERTY_BOX

See Also:

Constant Field Values

JSON_PROPERTY_PAGES

public static final String JSON_PROPERTY_PAGES

See Also:

Constant Field Values

Constructor Detail

OperationSelectionBox

public OperationSelectionBox()

Method Detail

box

public OperationSelectionBox box(OperationSelectionBox.BoxEnum box)

getBox

@Nullable
public @Nullable OperationSelectionBox.BoxEnum getBox()

Used to select the box that should be scaled. * media\\_box = The page's physical dimensions. * crop\\_box = The visible (printable) page area. * bleed\\_box = Untrimmed content position on the page (content dimensions plus trim box). * trim\\_box = Trimmed content position on the page (final content dimensions). * art\\_box = Position for special page content (images).

Returns:

box

setBox

public void setBox(OperationSelectionBox.BoxEnum box)

pages

public OperationSelectionBox pages(String pages)

getPages

@Nullable
public @Nullable String getPages()

Used to define the page(s) from which boxes should be removed. 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