com.cete.dynamicpdf.pageelements
Class Note

java.lang.Object
  com.cete.dynamicpdf.PageElement
      com.cete.dynamicpdf.pageelements.TaggablePageElement
          com.cete.dynamicpdf.pageelements.Note

All Implemented Interfaces:

IAnnotation, IArea, ICoordinate

public class Note
extends TaggablePageElement
implements IAnnotation, IArea, ICoordinate

This class can be used to place a note annotation on the PDF.

NOTE: This page element cannot be used within a table cell, or tranformation group.

Licensing:
This class is a DynamicPDF Generator Professional Edition feature. One of the following licenses is required for non-evaluation usage:

• DynamicPDF Generator Professional Edition
• DynamicPDF Generator Enterprise Edition
• DynamicPDF Merger Professional Edition
• DynamicPDF Merger Enterprise Edition

View Example

Constructor Summary

Note(java.lang.String text, float x, float y, float width, float height)
Creates a new instance of Note

Note(java.lang.String text, float x, float y, float width, float height, boolean isOpen)
Creates a new instance of Note

Note(java.lang.String text, float x, float y, float width, float height, NoteType type)
Creates a new instance of Note

Note(java.lang.String text, float x, float y, float width, float height, NoteType type, boolean isOpen)
Creates a new instance of Note

Method Summary

void	draw(PageWriter writer) Draws the link to the given PageWriter object.
void	drawAnnotation(DocumentWriter writer) Draws the link to the given DocumentWriter object.
RgbColor	getColor() Gets the color of the note.
float	getHeight() Gets the height of the link.
boolean	getIsOpen() Gets a value indicating if the note is opened by default.
NoteType	getNoteType() Gets the type of note.
java.lang.String	getText() Sets the text of the note.
float	getWidth() Gets the width of the link.
float	getX() Sets the X coordinate of the link.
float	getY() Gets the Y coordinate of the link.
void	setColor(RgbColor value) Sets the color of the note.
void	setHeight(float value) Sets the height of the link.
void	setIsOpen(boolean value) Sets a value indicating if the note is opened by default.
void	setNoteType(NoteType value) Sets the type of note.
void	setTag(Tag tag) Sets the structure element of the note element.
void	setText(java.lang.String value) Sets the text of the note.
void	setWidth(float value) Sets the width of the link.
void	setX(float value) Sets the X coordinate of the link.
void	setY(float value) Sets the Y coordinate of the link.

Methods inherited from class com.cete.dynamicpdf.pageelements.TaggablePageElement

getTag, getTagOrder, setTagOrder

Methods inherited from class com.cete.dynamicpdf.PageElement

getRequiredLicenseLevel, getStrID, setRequiredLicenseLevel, setStrID

Methods inherited from class java.lang.Object

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

Constructor Detail

Note

public Note(java.lang.String text,
            float x,
            float y,
            float width,
            float height)

Creates a new instance of Note

Parameters:

text - Text of the note.

x - X coordinate of the note.

y - Y coordinate of the note.

width - Width of the note.

height - Height of the note.

Note

public Note(java.lang.String text,
            float x,
            float y,
            float width,
            float height,
            NoteType type)

Creates a new instance of Note

Parameters:

text - Text of the note.

x - X coordinate of the note.

y - Y coordinate of the note.

width - Width of the note.

height - Height of the note.

type - Specifies the type of note.

Note

public Note(java.lang.String text,
            float x,
            float y,
            float width,
            float height,
            boolean isOpen)

Creates a new instance of Note

Parameters:

text - Text of the note.

x - X coordinate of the note.

y - Y coordinate of the note.

width - Width of the note.

height - Height of the note.

isOpen - Specifies if the note is open initially.

Note

public Note(java.lang.String text,
            float x,
            float y,
            float width,
            float height,
            NoteType type,
            boolean isOpen)

Creates a new instance of Note

Parameters:

text - Text of the note.

x - X coordinate of the note.

y - Y coordinate of the note.

width - Width of the note.

height - Height of the note.

type - Specifies the type of note.

isOpen - Specifies if the note is open initially.

Method Detail

getHeight

public float getHeight()

Gets the height of the link.

Specified by:

getHeight in interface IArea

Returns:

the height of the link.

getWidth

public float getWidth()

Gets the width of the link.

Specified by:

getWidth in interface IArea

Returns:

the width of the link.

getX

public float getX()

Sets the X coordinate of the link.

Specified by:

getX in interface ICoordinate

Returns:

the X coordinate of the link.

getY

public float getY()

Gets the Y coordinate of the link.

Specified by:

getY in interface ICoordinate

Returns:

the Y coordinate of the link.

getNoteType

public NoteType getNoteType()

Gets the type of note.

Returns:

the type of note.

getText

public java.lang.String getText()

Sets the text of the note.

Returns:

the text of the note.

getIsOpen

public boolean getIsOpen()

Gets a value indicating if the note is opened by default.

Returns:

value indicating if the note is opened by default.

getColor

public RgbColor getColor()

Gets the color of the note.

Returns:

the color of the note.

setHeight

public void setHeight(float value)

Sets the height of the link.

Specified by:

setHeight in interface IArea

Parameters:

value - the height of the link.

setWidth

public void setWidth(float value)

Sets the width of the link.

Specified by:

setWidth in interface IArea

Parameters:

value - the width of the link.

setX

public void setX(float value)

Sets the X coordinate of the link.

Specified by:

setX in interface ICoordinate

Parameters:

value - the X coordinate of the link.

setY

public void setY(float value)

Sets the Y coordinate of the link.

Specified by:

setY in interface ICoordinate

Parameters:

value - the Y coordinate of the link.

setNoteType

public void setNoteType(NoteType value)

Sets the type of note.

Parameters:

value - the type of note.

setText

public void setText(java.lang.String value)

Sets the text of the note.

Parameters:

value - the text of the note.

setIsOpen

public void setIsOpen(boolean value)

Sets a value indicating if the note is opened by default.

Parameters:

value - indicating if the note is opened by default.

setColor

public void setColor(RgbColor value)

Sets the color of the note.

Parameters:

value - the color of the note.

draw

public void draw(PageWriter writer)

Draws the link to the given PageWriter object.

Overrides:

draw in class TaggablePageElement

Parameters:

writer - PageWriter object to receive the link's output.

See Also:

PageWriter

drawAnnotation

public void drawAnnotation(DocumentWriter writer)

Draws the link to the given DocumentWriter object.

Specified by:

drawAnnotation in interface IAnnotation

Parameters:

writer - DocumentWriter object to receive the link's output.

See Also:

DocumentWriter

setTag

public void setTag(Tag tag)

Sets the structure element of the note element.

Licensing:
This class is a DynamicPDF Generator Enterprise Edition feature. One of the following licenses is required for non-evaluation usage:

• DynamicPDF Generator Professional Edition
• DynamicPDF Generator Enterprise Edition
• DynamicPDF Merger Professional Edition
• DynamicPDF Merger Enterprise Edition

Overrides:

setTag in class TaggablePageElement

Parameters:

tag - a structure element for taggable note element.