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

public class OperationTextAnnotation
extends Object

An annotation that adds a note icon to a page.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`OperationTextAnnotation.AppearanceGenerationEnum`	Determines for which named annotations appearance streams shall be generated.
`static class`	`OperationTextAnnotation.IconEnum`	Used to specify the icon that should be displayed for the note on the page.

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`JSON_PROPERTY_APPEARANCE_GENERATION`
`static String`	`JSON_PROPERTY_COLOR`
`static String`	`JSON_PROPERTY_CONTENTS`
`static String`	`JSON_PROPERTY_CREATOR`
`static String`	`JSON_PROPERTY_CUSTOM_ICON_NAME`
`static String`	`JSON_PROPERTY_HIDDEN`
`static String`	`JSON_PROPERTY_ICON`
`static String`	`JSON_PROPERTY_INITIAL_OPEN`
`static String`	`JSON_PROPERTY_INTENTS`
`static String`	`JSON_PROPERTY_INVISIBLE`
`static String`	`JSON_PROPERTY_LOCKED`
`static String`	`JSON_PROPERTY_NAME`
`static String`	`JSON_PROPERTY_NORMAL_APPEARANCE`
`static String`	`JSON_PROPERTY_OPACITY`
`static String`	`JSON_PROPERTY_PAGE`
`static String`	`JSON_PROPERTY_POSITION`
`static String`	`JSON_PROPERTY_PRINTABLE`
`static String`	`JSON_PROPERTY_ROTATABLE`
`static String`	`JSON_PROPERTY_SUBJECT`
`static String`	`JSON_PROPERTY_VIEWABLE`
`static String`	`JSON_PROPERTY_WRITABLE`
`static String`	`JSON_PROPERTY_ZOOMABLE`

Constructor Summary

Constructors
Constructor Description

OperationTextAnnotation()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`OperationTextAnnotation`	`appearanceGeneration(OperationTextAnnotation.AppearanceGenerationEnum appearanceGeneration)`
`OperationTextAnnotation`	`color(String color)`
`OperationTextAnnotation`	`contents(String contents)`
`OperationTextAnnotation`	`creator(String creator)`
`OperationTextAnnotation`	`customIconName(String customIconName)`
`boolean`	`equals(Object o)`
`@Nullable OperationTextAnnotation.AppearanceGenerationEnum`	`getAppearanceGeneration()`	Determines for which named annotations appearance streams shall be generated.
`@Nullable String`	`getColor()`	The annotation color will change the main color of visible annotations.
`@Nullable String`	`getContents()`	This value is used to configure the text content of the annotation, with the way in which it is displayed depending heavily on the specific annotation type (for example, in the case of a text note, this would be the text content of the annotation's popup).
`@Nullable String`	`getCreator()`	Used to specify the author of the annotation.
`@Nullable String`	`getCustomIconName()`	Sets a custom icon name for this annotation.
`@Nullable Boolean`	`getHidden()`	If this value is set to true, the annotation will not be shown on the page and will not be printed either.
`@Nullable OperationTextAnnotation.IconEnum`	`getIcon()`	Used to specify the icon that should be displayed for the note on the page.
`@Nullable Boolean`	`getInitialOpen()`	If this value is set to \"true,\" the popup for the corresponding \"note\" annotation will be opened as soon as the corresponding document page is viewed.
`@Nullable String`	`getIntents()`	Used to set the intention of the annotation.
`@Nullable Boolean`	`getInvisible()`	If this value is set to true, the annotation will be visible on the page only when printed, and provided it is a PDF standard annotation.
`@Nullable Boolean`	`getLocked()`	If this value is set to true, the annotation will be locked so that no changes can be made to it.
`@Nullable String`	`getName()`	Used to specify the name of the annotation.
`@Nullable OperationAppearanceSource`	`getNormalAppearance()`	Get normalAppearance
`@Nullable Integer`	`getOpacity()`	This percentage value is used to set the annotation's transparency.
`@Nullable Integer`	`getPage()`	Set the number of the page, the annotation shall be placed on.
`@Nullable OperationRectangle`	`getPosition()`	Get position
`@Nullable Boolean`	`getPrintable()`	If this value is set to true, the annotation will be included when the page is printed out.
`@Nullable Boolean`	`getRotatable()`	If this value is set to true, the annotation shall be rotatable according to the displayed page rotation.
`@Nullable String`	`getSubject()`	Used to specify the subject of the annotation.
`@Nullable Boolean`	`getViewable()`	If this value is set to true, the annotation will be shown on the document's page.
`@Nullable Boolean`	`getWritable()`	If this value is set to true, it will be possible to change the annotation's contents later on.
`@Nullable Boolean`	`getZoomable()`	If this value is set to true, the annotation will adjust its own zoom factor as required for the page in order to always be clearly readable / recognizable.
`int`	`hashCode()`
`OperationTextAnnotation`	`hidden(Boolean hidden)`
`OperationTextAnnotation`	`icon(OperationTextAnnotation.IconEnum icon)`
`OperationTextAnnotation`	`initialOpen(Boolean initialOpen)`
`OperationTextAnnotation`	`intents(String intents)`
`OperationTextAnnotation`	`invisible(Boolean invisible)`
`OperationTextAnnotation`	`locked(Boolean locked)`
`OperationTextAnnotation`	`name(String name)`
`OperationTextAnnotation`	`normalAppearance(OperationAppearanceSource normalAppearance)`
`OperationTextAnnotation`	`opacity(Integer opacity)`
`OperationTextAnnotation`	`page(Integer page)`
`OperationTextAnnotation`	`position(OperationRectangle position)`
`OperationTextAnnotation`	`printable(Boolean printable)`
`OperationTextAnnotation`	`rotatable(Boolean rotatable)`
`void`	`setAppearanceGeneration(OperationTextAnnotation.AppearanceGenerationEnum appearanceGeneration)`
`void`	`setColor(String color)`
`void`	`setContents(String contents)`
`void`	`setCreator(String creator)`
`void`	`setCustomIconName(String customIconName)`
`void`	`setHidden(Boolean hidden)`
`void`	`setIcon(OperationTextAnnotation.IconEnum icon)`
`void`	`setInitialOpen(Boolean initialOpen)`
`void`	`setIntents(String intents)`
`void`	`setInvisible(Boolean invisible)`
`void`	`setLocked(Boolean locked)`
`void`	`setName(String name)`
`void`	`setNormalAppearance(OperationAppearanceSource normalAppearance)`
`void`	`setOpacity(Integer opacity)`
`void`	`setPage(Integer page)`
`void`	`setPosition(OperationRectangle position)`
`void`	`setPrintable(Boolean printable)`
`void`	`setRotatable(Boolean rotatable)`
`void`	`setSubject(String subject)`
`void`	`setViewable(Boolean viewable)`
`void`	`setWritable(Boolean writable)`
`void`	`setZoomable(Boolean zoomable)`
`OperationTextAnnotation`	`subject(String subject)`
`String`	`toString()`
`OperationTextAnnotation`	`viewable(Boolean viewable)`
`OperationTextAnnotation`	`writable(Boolean writable)`
`OperationTextAnnotation`	`zoomable(Boolean zoomable)`

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

- Field Detail
  - JSON_PROPERTY_APPEARANCE_GENERATION
```
public static final String JSON_PROPERTY_APPEARANCE_GENERATION
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_COLOR
```
public static final String JSON_PROPERTY_COLOR
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_CONTENTS
```
public static final String JSON_PROPERTY_CONTENTS
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_CREATOR
```
public static final String JSON_PROPERTY_CREATOR
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_CUSTOM_ICON_NAME
```
public static final String JSON_PROPERTY_CUSTOM_ICON_NAME
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_HIDDEN
```
public static final String JSON_PROPERTY_HIDDEN
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_ICON
```
public static final String JSON_PROPERTY_ICON
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_INITIAL_OPEN
```
public static final String JSON_PROPERTY_INITIAL_OPEN
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_INTENTS
```
public static final String JSON_PROPERTY_INTENTS
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_INVISIBLE
```
public static final String JSON_PROPERTY_INVISIBLE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_LOCKED
```
public static final String JSON_PROPERTY_LOCKED
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_NAME
```
public static final String JSON_PROPERTY_NAME
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_NORMAL_APPEARANCE
```
public static final String JSON_PROPERTY_NORMAL_APPEARANCE
```
    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_POSITION
```
public static final String JSON_PROPERTY_POSITION
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_PRINTABLE
```
public static final String JSON_PROPERTY_PRINTABLE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_ROTATABLE
```
public static final String JSON_PROPERTY_ROTATABLE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_SUBJECT
```
public static final String JSON_PROPERTY_SUBJECT
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_VIEWABLE
```
public static final String JSON_PROPERTY_VIEWABLE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_WRITABLE
```
public static final String JSON_PROPERTY_WRITABLE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_ZOOMABLE
```
public static final String JSON_PROPERTY_ZOOMABLE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - OperationTextAnnotation
```
public OperationTextAnnotation()
```
- Method Detail
  - appearanceGeneration
```
public OperationTextAnnotation appearanceGeneration(OperationTextAnnotation.AppearanceGenerationEnum appearanceGeneration)
```
  - getAppearanceGeneration
```
@Nullable
public @Nullable OperationTextAnnotation.AppearanceGenerationEnum getAppearanceGeneration()
```
    Determines for which named annotations appearance streams shall be generated. **Important:** Per definition some named annotations are defined as standard names and PDF readers shall provide the means to draw those. * always = An appearance stream shall be prepared for all created named annotations. * never = Don't provide appearance streams and rely on PDF readers to dynamically generate a proper representation of named annotations. * nonStandard = Only provide appearance streams for non-standard annotations.
    
    Returns:
    
    appearanceGeneration
  - setAppearanceGeneration
```
public void setAppearanceGeneration(OperationTextAnnotation.AppearanceGenerationEnum appearanceGeneration)
```
  - color
```
public OperationTextAnnotation color(String color)
```
  - getColor
```
@Nullable
public @Nullable String getColor()
```
    The annotation color will change the main color of visible annotations. The color needs to be specified as a hexadecimal RGB value with a number sign before it.
    
    Returns:
    
    color
  - setColor
```
public void setColor(String color)
```
  - contents
```
public OperationTextAnnotation contents(String contents)
```
  - getContents
```
@Nullable
public @Nullable String getContents()
```
    This value is used to configure the text content of the annotation, with the way in which it is displayed depending heavily on the specific annotation type (for example, in the case of a text note, this would be the text content of the annotation's popup).
    
    Returns:
    
    contents
  - setContents
```
public void setContents(String contents)
```
  - creator
```
public OperationTextAnnotation creator(String creator)
```
  - getCreator
```
@Nullable
public @Nullable String getCreator()
```
    Used to specify the author of the annotation.
    
    Returns:
    
    creator
  - setCreator
```
public void setCreator(String creator)
```
  - customIconName
```
public OperationTextAnnotation customIconName(String customIconName)
```
  - getCustomIconName
```
@Nullable
public @Nullable String getCustomIconName()
```
    Sets a custom icon name for this annotation. **Important:** This name shall always take precedence over possibly set standard names. (icon)
    
    Returns:
    
    customIconName
  - setCustomIconName
```
public void setCustomIconName(String customIconName)
```
  - hidden
```
public OperationTextAnnotation hidden(Boolean hidden)
```
  - getHidden
```
@Nullable
public @Nullable Boolean getHidden()
```
    If this value is set to true, the annotation will not be shown on the page and will not be printed either.
    
    Returns:
    
    hidden
  - setHidden
```
public void setHidden(Boolean hidden)
```
  - icon
```
public OperationTextAnnotation icon(OperationTextAnnotation.IconEnum icon)
```
  - getIcon
```
@Nullable
public @Nullable OperationTextAnnotation.IconEnum getIcon()
```
    Used to specify the icon that should be displayed for the note on the page. The following values are available: * check = The text annotation approves the content. * checkmark = The text annotation adds a gray checkmark to the content. * circle = The text annotation is a comment on the circled content. * comment = The text annotation is a comment to the marked contents. * cross = The text annotation marks the content or crosses it out. * crossHair = The text annotation targets the content in the crosshair. * insert = The text annotation is suggesting inserting some content. * key = The text annotation marks or contains a key content/information. * note = The text annotation is a mere note concerning the marked content. * help = The text annotation provides helpful information concerning the marked content. * newParagraph = The text annotation suggests adding a new Paragraph at a specific point. * paragraph = The text annotation is concerning the whole paragraph. * rightArrow = The text annotation is concerning the content to the right. * rightPointer = The text annotation is concerning the content to the right. * star = The text annotation marks content as especially important. * upArrow = The text annotation is concerning the content at the top. * upLeftArrow = The text annotation is concerning the content at the top left. * unnamed = The text annotation shall not provide a predefined name.
    
    Returns:
    
    icon
  - setIcon
```
public void setIcon(OperationTextAnnotation.IconEnum icon)
```
  - initialOpen
```
public OperationTextAnnotation initialOpen(Boolean initialOpen)
```
  - getInitialOpen
```
@Nullable
public @Nullable Boolean getInitialOpen()
```
    If this value is set to \"true,\" the popup for the corresponding \"note\" annotation will be opened as soon as the corresponding document page is viewed.
    
    Returns:
    
    initialOpen
  - setInitialOpen
```
public void setInitialOpen(Boolean initialOpen)
```
  - intents
```
public OperationTextAnnotation intents(String intents)
```
  - getIntents
```
@Nullable
public @Nullable String getIntents()
```
    Used to set the intention of the annotation. **Important:** The intention of an annotation can directly influence it's behaviour and may serve different purposes for different annotation types. Only set this directly, if you know it is necessary and possible to do so.
    
    Returns:
    
    intents
  - setIntents
```
public void setIntents(String intents)
```
  - invisible
```
public OperationTextAnnotation invisible(Boolean invisible)
```
  - getInvisible
```
@Nullable
public @Nullable Boolean getInvisible()
```
    If this value is set to true, the annotation will be visible on the page only when printed, and provided it is a PDF standard annotation.
    
    Returns:
    
    invisible
  - setInvisible
```
public void setInvisible(Boolean invisible)
```
  - locked
```
public OperationTextAnnotation locked(Boolean locked)
```
  - getLocked
```
@Nullable
public @Nullable Boolean getLocked()
```
    If this value is set to true, the annotation will be locked so that no changes can be made to it.
    
    Returns:
    
    locked
  - setLocked
```
public void setLocked(Boolean locked)
```
  - name
```
public OperationTextAnnotation name(String name)
```
  - getName
```
@Nullable
public @Nullable String getName()
```
    Used to specify the name of the annotation.
    
    Returns:
    
    name
  - setName
```
public void setName(String name)
```
  - normalAppearance
```
public OperationTextAnnotation normalAppearance(OperationAppearanceSource normalAppearance)
```
  - getNormalAppearance
```
@Nullable
public @Nullable OperationAppearanceSource getNormalAppearance()
```
    Get normalAppearance
    
    Returns:
    
    normalAppearance
  - setNormalAppearance
```
public void setNormalAppearance(OperationAppearanceSource normalAppearance)
```
  - opacity
```
public OperationTextAnnotation opacity(Integer opacity)
```
  - getOpacity
```
@Nullable
public @Nullable Integer getOpacity()
```
    This percentage value is used to set the annotation's transparency. minimum: 0 maximum: 100
    
    Returns:
    
    opacity
  - setOpacity
```
public void setOpacity(Integer opacity)
```
  - page
```
public OperationTextAnnotation page(Integer page)
```
  - getPage
```
@Nullable
public @Nullable Integer getPage()
```
    Set the number of the page, the annotation shall be placed on. minimum: 1
    
    Returns:
    
    page
  - setPage
```
public void setPage(Integer page)
```
  - position
```
public OperationTextAnnotation position(OperationRectangle position)
```
  - getPosition
```
@Nullable
public @Nullable OperationRectangle getPosition()
```
    Get position
    
    Returns:
    
    position
  - setPosition
```
public void setPosition(OperationRectangle position)
```
  - printable
```
public OperationTextAnnotation printable(Boolean printable)
```
  - getPrintable
```
@Nullable
public @Nullable Boolean getPrintable()
```
    If this value is set to true, the annotation will be included when the page is printed out.
    
    Returns:
    
    printable
  - setPrintable
```
public void setPrintable(Boolean printable)
```
  - rotatable
```
public OperationTextAnnotation rotatable(Boolean rotatable)
```
  - getRotatable
```
@Nullable
public @Nullable Boolean getRotatable()
```
    If this value is set to true, the annotation shall be rotatable according to the displayed page rotation.
    
    Returns:
    
    rotatable
  - setRotatable
```
public void setRotatable(Boolean rotatable)
```
  - subject
```
public OperationTextAnnotation subject(String subject)
```
  - getSubject
```
@Nullable
public @Nullable String getSubject()
```
    Used to specify the subject of the annotation.
    
    Returns:
    
    subject
  - setSubject
```
public void setSubject(String subject)
```
  - viewable
```
public OperationTextAnnotation viewable(Boolean viewable)
```
  - getViewable
```
@Nullable
public @Nullable Boolean getViewable()
```
    If this value is set to true, the annotation will be shown on the document's page.
    
    Returns:
    
    viewable
  - setViewable
```
public void setViewable(Boolean viewable)
```
  - writable
```
public OperationTextAnnotation writable(Boolean writable)
```
  - getWritable
```
@Nullable
public @Nullable Boolean getWritable()
```
    If this value is set to true, it will be possible to change the annotation's contents later on.
    
    Returns:
    
    writable
  - setWritable
```
public void setWritable(Boolean writable)
```
  - zoomable
```
public OperationTextAnnotation zoomable(Boolean zoomable)
```
  - getZoomable
```
@Nullable
public @Nullable Boolean getZoomable()
```
    If this value is set to true, the annotation will adjust its own zoom factor as required for the page in order to always be clearly readable / recognizable.
    
    Returns:
    
    zoomable
  - setZoomable
```
public void setZoomable(Boolean zoomable)
```
  - 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 OperationTextAnnotation

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

JSON_PROPERTY_APPEARANCE_GENERATION

JSON_PROPERTY_COLOR

JSON_PROPERTY_CONTENTS

JSON_PROPERTY_CREATOR

JSON_PROPERTY_CUSTOM_ICON_NAME

JSON_PROPERTY_HIDDEN

JSON_PROPERTY_ICON

JSON_PROPERTY_INITIAL_OPEN

JSON_PROPERTY_INTENTS

JSON_PROPERTY_INVISIBLE

JSON_PROPERTY_LOCKED

JSON_PROPERTY_NAME

JSON_PROPERTY_NORMAL_APPEARANCE

JSON_PROPERTY_OPACITY

JSON_PROPERTY_PAGE

JSON_PROPERTY_POSITION

JSON_PROPERTY_PRINTABLE

JSON_PROPERTY_ROTATABLE

JSON_PROPERTY_SUBJECT

JSON_PROPERTY_VIEWABLE

JSON_PROPERTY_WRITABLE

JSON_PROPERTY_ZOOMABLE

Constructor Detail

OperationTextAnnotation

Method Detail

appearanceGeneration

getAppearanceGeneration

setAppearanceGeneration

color

getColor

setColor

contents

getContents

setContents

creator

getCreator

setCreator

customIconName

getCustomIconName

setCustomIconName

hidden

getHidden

setHidden

icon

getIcon

setIcon

initialOpen

getInitialOpen

setInitialOpen

intents

getIntents

setIntents

invisible

getInvisible

setInvisible

locked

getLocked

setLocked

name

getName

setName

normalAppearance

getNormalAppearance

setNormalAppearance

opacity

getOpacity

setOpacity

page

getPage

setPage

position

getPosition

setPosition