Package net.webpdf.wsclient.openapi

Class OperationFreeTextAnnotation

java.lang.Object

net.webpdf.wsclient.openapi.OperationFreeTextAnnotation

public class OperationFreeTextAnnotation
extends Object

An annotation that adds a textual comment directly to a page.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OperationFreeTextAnnotation.JustificationEnum	Selects the horizontal justification/alignment/orientation of elements

Field Summary

Fields

Modifier and Type	Field	Description
static String	JSON_PROPERTY_COLOR
static String	JSON_PROPERTY_CONTENTS
static String	JSON_PROPERTY_CREATOR
static String	JSON_PROPERTY_FONT
static String	JSON_PROPERTY_HIDDEN
static String	JSON_PROPERTY_INTENTS
static String	JSON_PROPERTY_INVISIBLE
static String	JSON_PROPERTY_JUSTIFICATION
static String	JSON_PROPERTY_LOCKED
static String	JSON_PROPERTY_NAME
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
OperationFreeTextAnnotation()

Method Summary

Modifier and Type	Method	Description
OperationFreeTextAnnotation	color(String color)
OperationFreeTextAnnotation	contents(String contents)
OperationFreeTextAnnotation	creator(String creator)
boolean	equals(Object o)
OperationFreeTextAnnotation	font(OperationFreeTextFont font)
@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 OperationFreeTextFont	getFont()	Get font
@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 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 OperationFreeTextAnnotation.JustificationEnum	getJustification()	Selects the horizontal justification/alignment/orientation of elements
@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 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 OperationPositionFreeTextAnnotation	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()
OperationFreeTextAnnotation	hidden(Boolean hidden)
OperationFreeTextAnnotation	intents(String intents)
OperationFreeTextAnnotation	invisible(Boolean invisible)
OperationFreeTextAnnotation	justification(OperationFreeTextAnnotation.JustificationEnum justification)
OperationFreeTextAnnotation	locked(Boolean locked)
OperationFreeTextAnnotation	name(String name)
OperationFreeTextAnnotation	opacity(Integer opacity)
OperationFreeTextAnnotation	page(Integer page)
OperationFreeTextAnnotation	position(OperationPositionFreeTextAnnotation position)
OperationFreeTextAnnotation	printable(Boolean printable)
OperationFreeTextAnnotation	rotatable(Boolean rotatable)
void	setColor(String color)
void	setContents(String contents)
void	setCreator(String creator)
void	setFont(OperationFreeTextFont font)
void	setHidden(Boolean hidden)
void	setIntents(String intents)
void	setInvisible(Boolean invisible)
void	setJustification(OperationFreeTextAnnotation.JustificationEnum justification)
void	setLocked(Boolean locked)
void	setName(String name)
void	setOpacity(Integer opacity)
void	setPage(Integer page)
void	setPosition(OperationPositionFreeTextAnnotation 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)
OperationFreeTextAnnotation	subject(String subject)
String	toString()
OperationFreeTextAnnotation	viewable(Boolean viewable)
OperationFreeTextAnnotation	writable(Boolean writable)
OperationFreeTextAnnotation	zoomable(Boolean zoomable)

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_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_FONT

public static final String JSON_PROPERTY_FONT

See Also:

Constant Field Values

JSON_PROPERTY_HIDDEN

public static final String JSON_PROPERTY_HIDDEN

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_JUSTIFICATION

public static final String JSON_PROPERTY_JUSTIFICATION

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_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

OperationFreeTextAnnotation

public OperationFreeTextAnnotation()

Method Detail

color

public OperationFreeTextAnnotation 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 OperationFreeTextAnnotation 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 OperationFreeTextAnnotation 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)

font

public OperationFreeTextAnnotation font(OperationFreeTextFont font)

getFont

@Nullable
public @Nullable OperationFreeTextFont getFont()

Get font

Returns:

font

setFont

public void setFont(OperationFreeTextFont font)

hidden

public OperationFreeTextAnnotation 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)

intents

public OperationFreeTextAnnotation 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 OperationFreeTextAnnotation 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)

justification

public OperationFreeTextAnnotation justification(OperationFreeTextAnnotation.JustificationEnum justification)

getJustification

@Nullable
public @Nullable OperationFreeTextAnnotation.JustificationEnum getJustification()

Selects the horizontal justification/alignment/orientation of elements. * leftJustified = All elements shall be oriented to the left. * centered = All elements shall be placed in the center of the container. * rightJustified = All elements shall be oriented to the right.

Returns:

justification

setJustification

public void setJustification(OperationFreeTextAnnotation.JustificationEnum justification)

locked

public OperationFreeTextAnnotation 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 OperationFreeTextAnnotation 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)

opacity

public OperationFreeTextAnnotation 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 OperationFreeTextAnnotation 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 OperationFreeTextAnnotation position(OperationPositionFreeTextAnnotation position)

getPosition

@Nullable
public @Nullable OperationPositionFreeTextAnnotation getPosition()

Get position

Returns:

position

setPosition

public void setPosition(OperationPositionFreeTextAnnotation position)

printable

public OperationFreeTextAnnotation 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 OperationFreeTextAnnotation 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 OperationFreeTextAnnotation 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 OperationFreeTextAnnotation 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 OperationFreeTextAnnotation 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 OperationFreeTextAnnotation 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