Package net.webpdf.wsclient.openapi

Class OperationClearToolboxAnnotation

java.lang.Object

net.webpdf.wsclient.openapi.OperationClearToolboxAnnotation

public class OperationClearToolboxAnnotation
extends Object

Used to remove the annotations of the selected pages.

Field Summary

Fields

Modifier and Type	Field	Description
static String	JSON_PROPERTY_FLATTEN
static String	JSON_PROPERTY_PAGES

Constructor Summary

Constructors

Constructor	Description
OperationClearToolboxAnnotation()

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
OperationClearToolboxAnnotation	flatten(Boolean flatten)
@Nullable Boolean	getFlatten()	Set to true to flatten annotations of the selected pages.
@Nullable String	getPages()	Defines which page(s) annotations shall be removed from.
int	hashCode()
OperationClearToolboxAnnotation	pages(String pages)
void	setFlatten(Boolean flatten)
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_FLATTEN

public static final String JSON_PROPERTY_FLATTEN

See Also:

Constant Field Values

JSON_PROPERTY_PAGES

public static final String JSON_PROPERTY_PAGES

See Also:

Constant Field Values

Constructor Detail

OperationClearToolboxAnnotation

public OperationClearToolboxAnnotation()

Method Detail

flatten

public OperationClearToolboxAnnotation flatten(Boolean flatten)

getFlatten

@Nullable
public @Nullable Boolean getFlatten()

Set to true to flatten annotations of the selected pages. **Important:** flattening means, the interactive annotation objects will be removed and only their visual representation will remain in the page content of the resulting document.

Returns:

flatten

setFlatten

public void setFlatten(Boolean flatten)

pages

public OperationClearToolboxAnnotation pages(String pages)

getPages

@Nullable
public @Nullable String getPages()

Defines which page(s) annotations shall be removed from. 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