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

```
public class OperationFileAnnotation
extends Object
```
Used to define the annotation element that should be linked to the file attachment. **Important:** If an \"annotation element\" is not defined for the \"file element,\" the attachment will be stored at the document level.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`OperationFileAnnotation.IconEnum`	If an attachment is embedded at the page level, this option can be used to specify the icon that should be used to show it: The value you use here will define which icon will be used, as well as the basic dimensions for the annotation generated in the PDF.

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`JSON_PROPERTY_COLOR`
`static String`	`JSON_PROPERTY_HEIGHT`
`static String`	`JSON_PROPERTY_ICON`
`static String`	`JSON_PROPERTY_LOCKED_POSITION`
`static String`	`JSON_PROPERTY_OPACITY`
`static String`	`JSON_PROPERTY_PAGE`
`static String`	`JSON_PROPERTY_POINT`
`static String`	`JSON_PROPERTY_POPUP_TEXT`
`static String`	`JSON_PROPERTY_WIDTH`

Constructor Summary

Constructors
Constructor Description

OperationFileAnnotation()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`OperationFileAnnotation`	`color(String color)`
`boolean`	`equals(Object o)`
`@Nullable String`	`getColor()`	The annotation colour will change the main colour of the attachment's icon.
`@Nullable Float`	`getHeight()`	If this value is positive, the annotation will be generated with a fixed height corresponding to the value instead of using the dimensions of the specified icon.
`@Nullable OperationFileAnnotation.IconEnum`	`getIcon()`	If an attachment is embedded at the page level, this option can be used to specify the icon that should be used to show it: The value you use here will define which icon will be used, as well as the basic dimensions for the annotation generated in the PDF.
`@Nullable Boolean`	`getLockedPosition()`	If this value is set to \"true\", the person viewing the document will not be allowed to move the icon for the file attached at the page level.
`@Nullable Integer`	`getOpacity()`	Used to set the opacity for the attachment's icon.
`@Nullable Integer`	`getPage()`	Used to define the page on which the annotation will be generated, i.e., the page where the attachment will be stored.
`@NotNull OperationPoint`	`getPoint()`	Get point
`@Nullable String`	`getPopupText()`	The text that should be displayed in the pop-up for the annotation.
`@Nullable Float`	`getWidth()`	If this value is positive, the annotation will be generated with a fixed width corresponding to the value instead of using the dimensions of the specified icon.
`int`	`hashCode()`
`OperationFileAnnotation`	`height(Float height)`
`OperationFileAnnotation`	`icon(OperationFileAnnotation.IconEnum icon)`
`OperationFileAnnotation`	`lockedPosition(Boolean lockedPosition)`
`OperationFileAnnotation`	`opacity(Integer opacity)`
`OperationFileAnnotation`	`page(Integer page)`
`OperationFileAnnotation`	`point(OperationPoint point)`
`OperationFileAnnotation`	`popupText(String popupText)`
`void`	`setColor(String color)`
`void`	`setHeight(Float height)`
`void`	`setIcon(OperationFileAnnotation.IconEnum icon)`
`void`	`setLockedPosition(Boolean lockedPosition)`
`void`	`setOpacity(Integer opacity)`
`void`	`setPage(Integer page)`
`void`	`setPoint(OperationPoint point)`
`void`	`setPopupText(String popupText)`
`void`	`setWidth(Float width)`
`String`	`toString()`
`OperationFileAnnotation`	`width(Float width)`

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

- Field Detail
  - JSON_PROPERTY_COLOR
```
public static final String JSON_PROPERTY_COLOR
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_HEIGHT
```
public static final String JSON_PROPERTY_HEIGHT
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_ICON
```
public static final String JSON_PROPERTY_ICON
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_LOCKED_POSITION
```
public static final String JSON_PROPERTY_LOCKED_POSITION
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_OPACITY
```
public static final String JSON_PROPERTY_OPACITY
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_PAGE
```
public static final String JSON_PROPERTY_PAGE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_POINT
```
public static final String JSON_PROPERTY_POINT
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_POPUP_TEXT
```
public static final String JSON_PROPERTY_POPUP_TEXT
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_WIDTH
```
public static final String JSON_PROPERTY_WIDTH
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - OperationFileAnnotation
```
public OperationFileAnnotation()
```
- Method Detail
  - color
```
public OperationFileAnnotation color(String color)
```
  - getColor
```
@Nullable
public @Nullable String getColor()
```
    The annotation colour will change the main colour of the attachment's icon. The colour needs to be specified as a hexadecimal RGB value with a number sign before it.
    
    Returns:
    
    color
  - setColor
```
public void setColor(String color)
```
  - height
```
public OperationFileAnnotation height(Float height)
```
  - getHeight
```
@Nullable
public @Nullable Float getHeight()
```
    If this value is positive, the annotation will be generated with a fixed height corresponding to the value instead of using the dimensions of the specified icon. minimum: 0
    
    Returns:
    
    height
  - setHeight
```
public void setHeight(Float height)
```
  - icon
```
public OperationFileAnnotation icon(OperationFileAnnotation.IconEnum icon)
```
  - getIcon
```
@Nullable
public @Nullable OperationFileAnnotation.IconEnum getIcon()
```
    If an attachment is embedded at the page level, this option can be used to specify the icon that should be used to show it: The value you use here will define which icon will be used, as well as the basic dimensions for the annotation generated in the PDF. If you use the \"None\" icon type, a predefined icon will not be used. Instead, this option will only use the dimensions specified in \"width\" and \"height\" to generate an annotation with a transparent selection box at the specified position. * graph = Diagram * paperclip = Paper clip * pushPin = Thumb tack * tag = Tag * none = Rectangular selection box
    
    Returns:
    
    icon
  - setIcon
```
public void setIcon(OperationFileAnnotation.IconEnum icon)
```
  - lockedPosition
```
public OperationFileAnnotation lockedPosition(Boolean lockedPosition)
```
  - getLockedPosition
```
@Nullable
public @Nullable Boolean getLockedPosition()
```
    If this value is set to \"true\", the person viewing the document will not be allowed to move the icon for the file attached at the page level.
    
    Returns:
    
    lockedPosition
  - setLockedPosition
```
public void setLockedPosition(Boolean lockedPosition)
```
  - opacity
```
public OperationFileAnnotation opacity(Integer opacity)
```
  - getOpacity
```
@Nullable
public @Nullable Integer getOpacity()
```
    Used to set the opacity for the attachment's icon. A percent value between 0 and 100 is allowed, whereby 0 equals the minimum opacity. The higher the value, the more the content of the PDF document will be covered over. minimum: 0 maximum: 100
    
    Returns:
    
    opacity
  - setOpacity
```
public void setOpacity(Integer opacity)
```
  - page
```
public OperationFileAnnotation page(Integer page)
```
  - getPage
```
@Nullable
public @Nullable Integer getPage()
```
    Used to define the page on which the annotation will be generated, i.e., the page where the attachment will be stored. minimum: 1
    
    Returns:
    
    page
  - setPage
```
public void setPage(Integer page)
```
  - point
```
public OperationFileAnnotation point(OperationPoint point)
```
  - getPoint
```
@NotNull
public @NotNull OperationPoint getPoint()
```
    Get point
    
    Returns:
    
    point
  - setPoint
```
public void setPoint(OperationPoint point)
```
  - popupText
```
public OperationFileAnnotation popupText(String popupText)
```
  - getPopupText
```
@Nullable
public @Nullable String getPopupText()
```
    The text that should be displayed in the pop-up for the annotation.
    
    Returns:
    
    popupText
  - setPopupText
```
public void setPopupText(String popupText)
```
  - width
```
public OperationFileAnnotation width(Float width)
```
  - getWidth
```
@Nullable
public @Nullable Float getWidth()
```
    If this value is positive, the annotation will be generated with a fixed width corresponding to the value instead of using the dimensions of the specified icon. minimum: 0
    
    Returns:
    
    width
  - setWidth
```
public void setWidth(Float width)
```
  - 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 OperationFileAnnotation

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

JSON_PROPERTY_COLOR

JSON_PROPERTY_HEIGHT

JSON_PROPERTY_ICON

JSON_PROPERTY_LOCKED_POSITION

JSON_PROPERTY_OPACITY

JSON_PROPERTY_PAGE

JSON_PROPERTY_POINT

JSON_PROPERTY_POPUP_TEXT

JSON_PROPERTY_WIDTH

Constructor Detail

OperationFileAnnotation

Method Detail

color

getColor

setColor

height

getHeight

setHeight

icon

getIcon

setIcon

lockedPosition

getLockedPosition

setLockedPosition

opacity

getOpacity

setOpacity

page

getPage

setPage

point

getPoint

setPoint

popupText

getPopupText

setPopupText

width

getWidth

setWidth

equals

hashCode

toString