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

public class MetadataPieceInfoBackgroundContent
extends Object

Properties listed in the Adobe piece info.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`MetadataPieceInfoBackgroundContent.AlignmentEnum`	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_ABSOLUTE_SCALING`
`static String`	`JSON_PROPERTY_ALIGNMENT`
`static String`	`JSON_PROPERTY_COLOR`
`static String`	`JSON_PROPERTY_HORIZ_OFFSET`
`static String`	`JSON_PROPERTY_OPACITY`
`static String`	`JSON_PROPERTY_ROTATION`
`static String`	`JSON_PROPERTY_SCALE`
`static String`	`JSON_PROPERTY_UNIT`
`static String`	`JSON_PROPERTY_VERT_OFFSET`

Constructor Summary

Constructors
Constructor Description

MetadataPieceInfoBackgroundContent()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`MetadataPieceInfoBackgroundContent`	`absoluteScaling(Boolean absoluteScaling)`
`MetadataPieceInfoBackgroundContent`	`alignment(MetadataPieceInfoBackgroundContent.AlignmentEnum alignment)`
`MetadataPieceInfoBackgroundContent`	`color(String color)`
`boolean`	`equals(Object o)`
`@Nullable Boolean`	`getAbsoluteScaling()`	When set to true the page shall be scaled relative to it's own original dimensions, when set to false, it shall be scaled relative to the page dimensions.
`@Nullable MetadataPieceInfoBackgroundContent.AlignmentEnum`	`getAlignment()`	Uses one of multiple preset positions in order to position the background on the page
`@Nullable String`	`getColor()`	The color of a unicolor background.
`@Nullable Float`	`getHorizOffset()`	The horizontal offset in relation to the backgrounds bas position.
`@Nullable Float`	`getOpacity()`	The opacity of the background, as a percentage in the range 0.0 (fully transparent) to 1.0 (fully opaque).
`@Nullable Integer`	`getRotation()`	The rotation of the background.
`@Nullable Float`	`getScale()`	The scaling of the background.
`@Nullable String`	`getUnit()`	The Adobe unit used to display offsets in readers.
`@Nullable Float`	`getVertOffset()`	The vertical offset in relation to the backgrounds bas position.
`int`	`hashCode()`
`MetadataPieceInfoBackgroundContent`	`horizOffset(Float horizOffset)`
`MetadataPieceInfoBackgroundContent`	`opacity(Float opacity)`
`MetadataPieceInfoBackgroundContent`	`rotation(Integer rotation)`
`MetadataPieceInfoBackgroundContent`	`scale(Float scale)`
`void`	`setAbsoluteScaling(Boolean absoluteScaling)`
`void`	`setAlignment(MetadataPieceInfoBackgroundContent.AlignmentEnum alignment)`
`void`	`setColor(String color)`
`void`	`setHorizOffset(Float horizOffset)`
`void`	`setOpacity(Float opacity)`
`void`	`setRotation(Integer rotation)`
`void`	`setScale(Float scale)`
`void`	`setUnit(String unit)`
`void`	`setVertOffset(Float vertOffset)`
`String`	`toString()`
`MetadataPieceInfoBackgroundContent`	`unit(String unit)`
`MetadataPieceInfoBackgroundContent`	`vertOffset(Float vertOffset)`

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

- Field Detail
  - JSON_PROPERTY_ABSOLUTE_SCALING
```
public static final String JSON_PROPERTY_ABSOLUTE_SCALING
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_ALIGNMENT
```
public static final String JSON_PROPERTY_ALIGNMENT
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_COLOR
```
public static final String JSON_PROPERTY_COLOR
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_HORIZ_OFFSET
```
public static final String JSON_PROPERTY_HORIZ_OFFSET
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_OPACITY
```
public static final String JSON_PROPERTY_OPACITY
```
    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_UNIT
```
public static final String JSON_PROPERTY_UNIT
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_VERT_OFFSET
```
public static final String JSON_PROPERTY_VERT_OFFSET
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - MetadataPieceInfoBackgroundContent
```
public MetadataPieceInfoBackgroundContent()
```
- Method Detail
  - absoluteScaling
```
public MetadataPieceInfoBackgroundContent absoluteScaling(Boolean absoluteScaling)
```
  - getAbsoluteScaling
```
@Nullable
public @Nullable Boolean getAbsoluteScaling()
```
    When set to true the page shall be scaled relative to it's own original dimensions, when set to false, it shall be scaled relative to the page dimensions.
    
    Returns:
    
    absoluteScaling
  - setAbsoluteScaling
```
public void setAbsoluteScaling(Boolean absoluteScaling)
```
  - alignment
```
public MetadataPieceInfoBackgroundContent alignment(MetadataPieceInfoBackgroundContent.AlignmentEnum alignment)
```
  - getAlignment
```
@Nullable
public @Nullable MetadataPieceInfoBackgroundContent.AlignmentEnum getAlignment()
```
    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:
    
    alignment
  - setAlignment
```
public void setAlignment(MetadataPieceInfoBackgroundContent.AlignmentEnum alignment)
```
  - color
```
public MetadataPieceInfoBackgroundContent color(String color)
```
  - getColor
```
@Nullable
public @Nullable String getColor()
```
    The color of a unicolor background.
    
    Returns:
    
    color
  - setColor
```
public void setColor(String color)
```
  - horizOffset
```
public MetadataPieceInfoBackgroundContent horizOffset(Float horizOffset)
```
  - getHorizOffset
```
@Nullable
public @Nullable Float getHorizOffset()
```
    The horizontal offset in relation to the backgrounds bas position.
    
    Returns:
    
    horizOffset
  - setHorizOffset
```
public void setHorizOffset(Float horizOffset)
```
  - opacity
```
public MetadataPieceInfoBackgroundContent opacity(Float opacity)
```
  - getOpacity
```
@Nullable
public @Nullable Float getOpacity()
```
    The opacity of the background, as a percentage in the range 0.0 (fully transparent) to 1.0 (fully opaque). minimum: 0 maximum: 1
    
    Returns:
    
    opacity
  - setOpacity
```
public void setOpacity(Float opacity)
```
  - rotation
```
public MetadataPieceInfoBackgroundContent rotation(Integer rotation)
```
  - getRotation
```
@Nullable
public @Nullable Integer getRotation()
```
    The rotation of the background. minimum: 0 maximum: 360
    
    Returns:
    
    rotation
  - setRotation
```
public void setRotation(Integer rotation)
```
  - scale
```
public MetadataPieceInfoBackgroundContent scale(Float scale)
```
  - getScale
```
@Nullable
public @Nullable Float getScale()
```
    The scaling of the background. minimum: 0
    
    Returns:
    
    scale
  - setScale
```
public void setScale(Float scale)
```
  - unit
```
public MetadataPieceInfoBackgroundContent unit(String unit)
```
  - getUnit
```
@Nullable
public @Nullable String getUnit()
```
    The Adobe unit used to display offsets in readers. (millimeters, pica, point etc).
    
    Returns:
    
    unit
  - setUnit
```
public void setUnit(String unit)
```
  - vertOffset
```
public MetadataPieceInfoBackgroundContent vertOffset(Float vertOffset)
```
  - getVertOffset
```
@Nullable
public @Nullable Float getVertOffset()
```
    The vertical offset in relation to the backgrounds bas position.
    
    Returns:
    
    vertOffset
  - setVertOffset
```
public void setVertOffset(Float vertOffset)
```
  - 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 MetadataPieceInfoBackgroundContent

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

JSON_PROPERTY_ABSOLUTE_SCALING

JSON_PROPERTY_ALIGNMENT

JSON_PROPERTY_COLOR

JSON_PROPERTY_HORIZ_OFFSET

JSON_PROPERTY_OPACITY

JSON_PROPERTY_ROTATION

JSON_PROPERTY_SCALE

JSON_PROPERTY_UNIT

JSON_PROPERTY_VERT_OFFSET

Constructor Detail

MetadataPieceInfoBackgroundContent

Method Detail

absoluteScaling

getAbsoluteScaling

setAbsoluteScaling

alignment

getAlignment

setAlignment

color

getColor

setColor

horizOffset

getHorizOffset

setHorizOffset

opacity

getOpacity

setOpacity

rotation

getRotation

setRotation

scale

getScale

setScale

unit

getUnit

setUnit

vertOffset

getVertOffset

setVertOffset

equals

hashCode

toString