com.itextpdf.kernel.pdf.annot.da

Class AnnotationDefaultAppearance

java.lang.Object

com.itextpdf.kernel.pdf.annot.da.AnnotationDefaultAppearance

public class AnnotationDefaultAppearance
extends Object

Helper class for setting annotation default appearance. The class provides setters for font color, font size and font itself.

Note that only standard font names that do not require font resources are supported.

Note that it is possible to create annotation with custom font name in DA, but this require manual resource modifications (you have to put font in DR of AcroForm and use its resource name in DA) and only Acrobat supports that workflow.

Constructor Summary

Constructors

Constructor and Description
AnnotationDefaultAppearance() Creates the default instance of AnnotationDefaultAppearance.

Method Summary

Modifier and Type	Method and Description
AnnotationDefaultAppearance	setColor(DeviceCmyk cmykColor) Sets the AnnotationDefaultAppearance's default font color.
AnnotationDefaultAppearance	setColor(DeviceGray grayColor) Sets the AnnotationDefaultAppearance's default font color.
AnnotationDefaultAppearance	setColor(DeviceRgb rgbColor) Sets the AnnotationDefaultAppearance's default font color.
AnnotationDefaultAppearance	setFont(ExtendedAnnotationFont font) Sets the AnnotationDefaultAppearance's default font.
AnnotationDefaultAppearance	setFont(StandardAnnotationFont font) Sets the AnnotationDefaultAppearance's default font.
AnnotationDefaultAppearance	setFontSize(float fontSize) Sets the AnnotationDefaultAppearance's default font size.
PdfString	toPdfString() Gets the AnnotationDefaultAppearance's representation as PdfString.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AnnotationDefaultAppearance

public AnnotationDefaultAppearance()

Creates the default instance of AnnotationDefaultAppearance.

The default font is StandardAnnotationFont.Helvetica. The default font size is 12.

Method Detail

setFont

public AnnotationDefaultAppearance setFont(StandardAnnotationFont font)

Sets the AnnotationDefaultAppearance's default font.

Parameters:

font - one of standard annotation fonts to be set as the default one for this AnnotationDefaultAppearance

Returns:

this AnnotationDefaultAppearance

setFont

public AnnotationDefaultAppearance setFont(ExtendedAnnotationFont font)

Sets the AnnotationDefaultAppearance's default font.

Parameters:

font - one of extended annotation fonts to be set as the default one for this AnnotationDefaultAppearance

Returns:

this AnnotationDefaultAppearance

setFontSize

public AnnotationDefaultAppearance setFontSize(float fontSize)

Sets the AnnotationDefaultAppearance's default font size.

Parameters:

fontSize - font size to be set as the AnnotationDefaultAppearance's default font size

Returns:

this AnnotationDefaultAppearance

setColor

public AnnotationDefaultAppearance setColor(DeviceRgb rgbColor)

Sets the AnnotationDefaultAppearance's default font color.

Parameters:

rgbColor - DeviceRgb to be set as the AnnotationDefaultAppearance's default font color

Returns:

this AnnotationDefaultAppearance

setColor

public AnnotationDefaultAppearance setColor(DeviceCmyk cmykColor)

Sets the AnnotationDefaultAppearance's default font color.

Parameters:

cmykColor - DeviceCmyk to be set as the AnnotationDefaultAppearance's default font color

Returns:

this AnnotationDefaultAppearance

setColor

public AnnotationDefaultAppearance setColor(DeviceGray grayColor)

Sets the AnnotationDefaultAppearance's default font color.

Parameters:

grayColor - DeviceGray to be set as the AnnotationDefaultAppearance's default font color

Returns:

this AnnotationDefaultAppearance

toPdfString

public PdfString toPdfString()

Gets the AnnotationDefaultAppearance's representation as PdfString.

Returns:

the PdfString representation of this AnnotationDefaultAppearance