Package net.webpdf.wsclient.openapi

Class OperationBackgroundBaseSettings

java.lang.Object

net.webpdf.wsclient.openapi.OperationBackgroundBaseSettings

public class OperationBackgroundBaseSettings
extends Object

Defines basic configuration settings for generating background layers.

Field Summary

Fields

Modifier and Type	Field	Description
static String	JSON_PROPERTY_OPACITY
static String	JSON_PROPERTY_PAGES
static String	JSON_PROPERTY_POSITION
static String	JSON_PROPERTY_RELATIVE_TO_PAGE
static String	JSON_PROPERTY_REPLACE_EXISTING
static String	JSON_PROPERTY_ROTATION
static String	JSON_PROPERTY_SCALE
static String	JSON_PROPERTY_VISIBILITY

Constructor Summary

Constructors

Constructor	Description
OperationBackgroundBaseSettings()

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
@Nullable Integer	getOpacity()	A percentage value that is used to specify the background layer's transparency (100 percent means fully visible).
@Nullable OperationPagesBackgroundBaseSettings	getPages()	Get pages
@Nullable OperationPositionBackgroundBaseSettings	getPosition()	Get position
@Nullable Boolean	getRelativeToPage()	If true, the background layer will not be scaled relative to its own original size, but rather to the dimensions of the page containing it.
@Nullable Boolean	getReplaceExisting()	If true, an existing background layer will be automatically deleted and replaced with the new one.
@Nullable Integer	getRotation()	A value between 0 and 360 degrees that is used to specify the background layer's rotation.
@Nullable Integer	getScale()	A percentage value used to specify the scaling for the background layer.
@Nullable OperationVisibilityBackgroundBaseSettings	getVisibility()	Get visibility
int	hashCode()
OperationBackgroundBaseSettings	opacity(Integer opacity)
OperationBackgroundBaseSettings	pages(OperationPagesBackgroundBaseSettings pages)
OperationBackgroundBaseSettings	position(OperationPositionBackgroundBaseSettings position)
OperationBackgroundBaseSettings	relativeToPage(Boolean relativeToPage)
OperationBackgroundBaseSettings	replaceExisting(Boolean replaceExisting)
OperationBackgroundBaseSettings	rotation(Integer rotation)
OperationBackgroundBaseSettings	scale(Integer scale)
void	setOpacity(Integer opacity)
void	setPages(OperationPagesBackgroundBaseSettings pages)
void	setPosition(OperationPositionBackgroundBaseSettings position)
void	setRelativeToPage(Boolean relativeToPage)
void	setReplaceExisting(Boolean replaceExisting)
void	setRotation(Integer rotation)
void	setScale(Integer scale)
void	setVisibility(OperationVisibilityBackgroundBaseSettings visibility)
String	toString()
OperationBackgroundBaseSettings	visibility(OperationVisibilityBackgroundBaseSettings visibility)

Methods inherited from class java.lang.Object

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

Field Detail

JSON_PROPERTY_OPACITY

public static final String JSON_PROPERTY_OPACITY

See Also:

Constant Field Values

JSON_PROPERTY_PAGES

public static final String JSON_PROPERTY_PAGES

See Also:

Constant Field Values

JSON_PROPERTY_POSITION

public static final String JSON_PROPERTY_POSITION

See Also:

Constant Field Values

JSON_PROPERTY_RELATIVE_TO_PAGE

public static final String JSON_PROPERTY_RELATIVE_TO_PAGE

See Also:

Constant Field Values

JSON_PROPERTY_REPLACE_EXISTING

public static final String JSON_PROPERTY_REPLACE_EXISTING

See Also:

Constant Field Values

JSON_PROPERTY_ROTATION

public static final String JSON_PROPERTY_ROTATION

See Also:

Constant Field Values

JSON_PROPERTY_SCALE

public static final String JSON_PROPERTY_SCALE

See Also:

Constant Field Values

JSON_PROPERTY_VISIBILITY

public static final String JSON_PROPERTY_VISIBILITY

See Also:

Constant Field Values

Constructor Detail

OperationBackgroundBaseSettings

public OperationBackgroundBaseSettings()

Method Detail

opacity

public OperationBackgroundBaseSettings opacity(Integer opacity)

getOpacity

@Nullable
public @Nullable Integer getOpacity()

A percentage value that is used to specify the background layer's transparency (100 percent means fully visible). minimum: 0 maximum: 100

Returns:

opacity

setOpacity

public void setOpacity(Integer opacity)

pages

public OperationBackgroundBaseSettings pages(OperationPagesBackgroundBaseSettings pages)

getPages

@Nullable
public @Nullable OperationPagesBackgroundBaseSettings getPages()

Get pages

Returns:

pages

setPages

public void setPages(OperationPagesBackgroundBaseSettings pages)

position

public OperationBackgroundBaseSettings position(OperationPositionBackgroundBaseSettings position)

getPosition

@Nullable
public @Nullable OperationPositionBackgroundBaseSettings getPosition()

Get position

Returns:

position

setPosition

public void setPosition(OperationPositionBackgroundBaseSettings position)

relativeToPage

public OperationBackgroundBaseSettings relativeToPage(Boolean relativeToPage)

getRelativeToPage

@Nullable
public @Nullable Boolean getRelativeToPage()

If true, the background layer will not be scaled relative to its own original size, but rather to the dimensions of the page containing it.

Returns:

relativeToPage

setRelativeToPage

public void setRelativeToPage(Boolean relativeToPage)

replaceExisting

public OperationBackgroundBaseSettings replaceExisting(Boolean replaceExisting)

getReplaceExisting

@Nullable
public @Nullable Boolean getReplaceExisting()

If true, an existing background layer will be automatically deleted and replaced with the new one. If false, an existing background layer will cause the operation to be aborted.

Returns:

replaceExisting

setReplaceExisting

public void setReplaceExisting(Boolean replaceExisting)

rotation

public OperationBackgroundBaseSettings rotation(Integer rotation)

getRotation

@Nullable
public @Nullable Integer getRotation()

A value between 0 and 360 degrees that is used to specify the background layer's rotation. minimum: 0 maximum: 360

Returns:

rotation

setRotation

public void setRotation(Integer rotation)

scale

public OperationBackgroundBaseSettings scale(Integer scale)

getScale

@Nullable
public @Nullable Integer getScale()

A percentage value used to specify the scaling for the background layer. This scaling can either be relative to the background layer's original size or to the dimensions of the page containing it (depends on the \"relativeToPage\" parameter) minimum: 0

Returns:

scale

setScale

public void setScale(Integer scale)

visibility

public OperationBackgroundBaseSettings visibility(OperationVisibilityBackgroundBaseSettings visibility)

getVisibility

@Nullable
public @Nullable OperationVisibilityBackgroundBaseSettings getVisibility()

Get visibility

Returns:

visibility

setVisibility

public void setVisibility(OperationVisibilityBackgroundBaseSettings visibility)

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