java.lang.Object
- net.webpdf.wsclient.openapi.OperationPositionBackgroundBaseSettings

public class OperationPositionBackgroundBaseSettings
extends Object

Used to define the position of the background layer.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`OperationPositionBackgroundBaseSettings.MetricsEnum`	Unit for the X-axis/Y-axis position and signature field height and width arguments: * pt = Points(1/72 inch) * pc = Picas(12 points) * px = Pixels(1/96 inch) * mm = Millimeters * in = Inches
`static class`	`OperationPositionBackgroundBaseSettings.PositionEnum`	Uses one of multiple preset positions in order to position the background on the page

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`JSON_PROPERTY_METRICS`
`static String`	`JSON_PROPERTY_POSITION`
`static String`	`JSON_PROPERTY_X`
`static String`	`JSON_PROPERTY_Y`

Constructor Summary

Constructors
Constructor Description

OperationPositionBackgroundBaseSettings()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`equals(Object o)`
`@Nullable OperationPositionBackgroundBaseSettings.MetricsEnum`	`getMetrics()`	Unit for the X-axis/Y-axis position and signature field height and width arguments: * pt = Points(1/72 inch) * pc = Picas(12 points) * px = Pixels(1/96 inch) * mm = Millimeters * in = Inches
`@Nullable OperationPositionBackgroundBaseSettings.PositionEnum`	`getPosition()`	Uses one of multiple preset positions in order to position the background on the page
`@Nullable Float`	`getX()`	X-axis position of rectangle.
`@Nullable Float`	`getY()`	Y-axis position of rectangle.
`int`	`hashCode()`
`OperationPositionBackgroundBaseSettings`	`metrics(OperationPositionBackgroundBaseSettings.MetricsEnum metrics)`
`OperationPositionBackgroundBaseSettings`	`position(OperationPositionBackgroundBaseSettings.PositionEnum position)`
`void`	`setMetrics(OperationPositionBackgroundBaseSettings.MetricsEnum metrics)`
`void`	`setPosition(OperationPositionBackgroundBaseSettings.PositionEnum position)`
`void`	`setX(Float x)`
`void`	`setY(Float y)`
`String`	`toString()`
`OperationPositionBackgroundBaseSettings`	`x(Float x)`
`OperationPositionBackgroundBaseSettings`	`y(Float y)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - JSON_PROPERTY_METRICS
```
public static final String JSON_PROPERTY_METRICS
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_POSITION
```
public static final String JSON_PROPERTY_POSITION
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_X
```
public static final String JSON_PROPERTY_X
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_Y
```
public static final String JSON_PROPERTY_Y
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - OperationPositionBackgroundBaseSettings
```
public OperationPositionBackgroundBaseSettings()
```
- Method Detail
  - metrics
```
public OperationPositionBackgroundBaseSettings metrics(OperationPositionBackgroundBaseSettings.MetricsEnum metrics)
```
  - getMetrics
```
@Nullable
public @Nullable OperationPositionBackgroundBaseSettings.MetricsEnum getMetrics()
```
    Unit for the X-axis/Y-axis position and signature field height and width arguments: * pt = Points(1/72 inch) * pc = Picas(12 points) * px = Pixels(1/96 inch) * mm = Millimeters * in = Inches
    
    Returns:
    
    metrics
  - setMetrics
```
public void setMetrics(OperationPositionBackgroundBaseSettings.MetricsEnum metrics)
```
  - position
```
public OperationPositionBackgroundBaseSettings position(OperationPositionBackgroundBaseSettings.PositionEnum position)
```
  - getPosition
```
@Nullable
public @Nullable OperationPositionBackgroundBaseSettings.PositionEnum getPosition()
```
    Uses one of multiple preset positions in order to position the background on the page. * custom = Disable the use of a preset position. * top\\_left = Positions the background in the top left corner. * top\\_center = Positions the background in the centre on the top margin. * top\\_right = Positions the background in the top right corner. * center\\_left = Positions the background at the centre of the page, to the left. * center\\_center = Positions the background at the centre of the page. * center\\_right = Positions the background at the centre of the page, to the right. * bottom\\_left = Positions the background in the bottom left corner. * bottom\\_center = Positions the background in the centre on the bottom margin. * bottom\\_right = Positions the background in the bottom right corner.
    
    Returns:
    
    position
  - setPosition
```
public void setPosition(OperationPositionBackgroundBaseSettings.PositionEnum position)
```
  - x
```
public OperationPositionBackgroundBaseSettings x(Float x)
```
  - getX
```
@Nullable
public @Nullable Float getX()
```
    X-axis position of rectangle. minimum: 0
    
    Returns:
    
    x
  - setX
```
public void setX(Float x)
```
  - y
```
public OperationPositionBackgroundBaseSettings y(Float y)
```
  - getY
```
@Nullable
public @Nullable Float getY()
```
    Y-axis position of rectangle. minimum: 0
    
    Returns:
    
    y
  - setY
```
public void setY(Float y)
```
  - 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

Class OperationPositionBackgroundBaseSettings

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

JSON_PROPERTY_METRICS

JSON_PROPERTY_POSITION

JSON_PROPERTY_X

JSON_PROPERTY_Y

Constructor Detail

OperationPositionBackgroundBaseSettings

Method Detail

metrics

getMetrics

setMetrics

position

getPosition

setPosition

x

getX

setX

y

getY

setY

equals

hashCode

toString