| java.lang.Object com.lowagie.text.Annotation
Annotation | public class Annotation implements Element(Code) | | An Annotation is a little note that can be added to a page on
a document.
See Also: Element See Also: Anchor |
Field Summary | |
final public static String | APPLICATION This is a possible attribute. | final public static String | CONTENT This is a possible attribute. | final public static String | DEFAULTDIR This is a possible attribute. | final public static String | DESTINATION This is a possible attribute. | final public static String | FILE This is a possible attribute. | final public static int | FILE_DEST This is a possible annotation type. | final public static int | FILE_PAGE This is a possible annotation type. | final public static int | LAUNCH This is a possible annotation type. | final public static String | LLX This is a possible attribute. | final public static String | LLY This is a possible attribute. | final public static String | MIMETYPE This is a possible attribute. | final public static String | NAMED This is a possible attribute. | final public static int | NAMED_DEST This is a possible annotation type. | final public static String | OPERATION This is a possible attribute. | final public static String | PAGE This is a possible attribute. | final public static String | PARAMETERS This is a possible attribute. | final public static int | SCREEN This is a possible annotation type. | final public static int | TEXT This is a possible annotation type. | final public static String | TITLE This is a possible attribute. | final public static String | URL This is a possible attribute. | final public static int | URL_AS_STRING This is a possible annotation type. | final public static int | URL_NET This is a possible annotation type. | final public static String | URX This is a possible attribute. | final public static String | URY This is a possible attribute. | protected HashMap | annotationAttributes This is the title of the Annotation . | protected int | annotationtype This is the type of annotation. | protected float | llx | protected float | lly | protected float | urx | protected float | ury |
Constructor Summary | |
public | Annotation(Annotation an) Copy constructor. | public | Annotation(String title, String text) Constructs an Annotation with a certain title and some
text. | public | Annotation(String title, String text, float llx, float lly, float urx, float ury) Constructs an Annotation with a certain title and some
text. | public | Annotation(float llx, float lly, float urx, float ury, URL url) Constructs an Annotation . | public | Annotation(float llx, float lly, float urx, float ury, String url) Constructs an Annotation . | public | Annotation(float llx, float lly, float urx, float ury, String file, String dest) Constructs an Annotation . | public | Annotation(float llx, float lly, float urx, float ury, String moviePath, String mimeType, boolean showOnDisplay) | public | Annotation(float llx, float lly, float urx, float ury, String file, int page) Constructs an Annotation . | public | Annotation(float llx, float lly, float urx, float ury, int named) Constructs an Annotation . | public | Annotation(float llx, float lly, float urx, float ury, String application, String parameters, String operation, String defaultdir) Constructs an Annotation . | public | Annotation(java.util.Properties attributes) Returns an Annotation that has been constructed taking in
account the value of some attributes . |
Method Summary | |
public int | annotationType() Returns the type of this Annotation . | public HashMap | attributes() Gets the content of this Annotation . | public String | content() Gets the content of this Annotation . | public ArrayList | getChunks() Gets all the chunks in this element. | public float | llx() Returns the lower left x-value. | public float | llx(float def) Returns the lower left x-value. | public float | lly() Returns the lower left y-value. | public float | lly(float def) Returns the lower left y-value. | public boolean | process(ElementListener listener) Processes the element by adding it (or the different parts) to an
ElementListener . | public void | setDimensions(float llx, float lly, float urx, float ury) Sets the dimensions of this annotation. | public String | title() Returns the title of this Annotation . | public int | type() Gets the type of the text element. | public float | urx() Returns the uppper right x-value. | public float | urx(float def) Returns the upper right x-value. | public float | ury() Returns the uppper right y-value. | public float | ury(float def) Returns the upper right y-value. |
APPLICATION | final public static String APPLICATION(Code) | | This is a possible attribute.
|
CONTENT | final public static String CONTENT(Code) | | This is a possible attribute.
|
DEFAULTDIR | final public static String DEFAULTDIR(Code) | | This is a possible attribute.
|
DESTINATION | final public static String DESTINATION(Code) | | This is a possible attribute.
|
FILE | final public static String FILE(Code) | | This is a possible attribute.
|
FILE_DEST | final public static int FILE_DEST(Code) | | This is a possible annotation type.
|
FILE_PAGE | final public static int FILE_PAGE(Code) | | This is a possible annotation type.
|
LAUNCH | final public static int LAUNCH(Code) | | This is a possible annotation type.
|
LLX | final public static String LLX(Code) | | This is a possible attribute.
|
LLY | final public static String LLY(Code) | | This is a possible attribute.
|
MIMETYPE | final public static String MIMETYPE(Code) | | This is a possible attribute.
|
NAMED | final public static String NAMED(Code) | | This is a possible attribute.
|
NAMED_DEST | final public static int NAMED_DEST(Code) | | This is a possible annotation type.
|
OPERATION | final public static String OPERATION(Code) | | This is a possible attribute.
|
PAGE | final public static String PAGE(Code) | | This is a possible attribute.
|
PARAMETERS | final public static String PARAMETERS(Code) | | This is a possible attribute.
|
SCREEN | final public static int SCREEN(Code) | | This is a possible annotation type.
|
TEXT | final public static int TEXT(Code) | | This is a possible annotation type.
|
TITLE | final public static String TITLE(Code) | | This is a possible attribute.
|
URL | final public static String URL(Code) | | This is a possible attribute.
|
URL_AS_STRING | final public static int URL_AS_STRING(Code) | | This is a possible annotation type.
|
URL_NET | final public static int URL_NET(Code) | | This is a possible annotation type.
|
URX | final public static String URX(Code) | | This is a possible attribute.
|
URY | final public static String URY(Code) | | This is a possible attribute.
|
annotationAttributes | protected HashMap annotationAttributes(Code) | | This is the title of the Annotation .
|
annotationtype | protected int annotationtype(Code) | | This is the type of annotation.
|
llx | protected float llx(Code) | | This is the lower left x-value
|
lly | protected float lly(Code) | | This is the lower left y-value
|
urx | protected float urx(Code) | | This is the upper right x-value
|
ury | protected float ury(Code) | | This is the upper right y-value
|
Annotation | public Annotation(String title, String text)(Code) | | Constructs an Annotation with a certain title and some
text.
Parameters: title - the title of the annotation Parameters: text - the content of the annotation |
Annotation | public Annotation(String title, String text, float llx, float lly, float urx, float ury)(Code) | | Constructs an Annotation with a certain title and some
text.
Parameters: title - the title of the annotation Parameters: text - the content of the annotation Parameters: llx - the lower left x-value Parameters: lly - the lower left y-value Parameters: urx - the upper right x-value Parameters: ury - the upper right y-value |
Annotation | public Annotation(float llx, float lly, float urx, float ury, URL url)(Code) | | Constructs an Annotation .
Parameters: llx - the lower left x-value Parameters: lly - the lower left y-value Parameters: urx - the upper right x-value Parameters: ury - the upper right y-value Parameters: url - the external reference |
Annotation | public Annotation(float llx, float lly, float urx, float ury, String url)(Code) | | Constructs an Annotation .
Parameters: llx - the lower left x-value Parameters: lly - the lower left y-value Parameters: urx - the upper right x-value Parameters: ury - the upper right y-value Parameters: url - the external reference |
Annotation | public Annotation(float llx, float lly, float urx, float ury, String file, String dest)(Code) | | Constructs an Annotation .
Parameters: llx - the lower left x-value Parameters: lly - the lower left y-value Parameters: urx - the upper right x-value Parameters: ury - the upper right y-value Parameters: file - an external PDF file Parameters: dest - the destination in this file |
Annotation | public Annotation(float llx, float lly, float urx, float ury, String moviePath, String mimeType, boolean showOnDisplay)(Code) | | Creates a Screen anotation to embed media clips
Parameters: llx - Parameters: lly - Parameters: urx - Parameters: ury - Parameters: moviePath - path to the media clip file Parameters: mimeType - mime type of the media Parameters: showOnDisplay - if true play on display of the page |
Annotation | public Annotation(float llx, float lly, float urx, float ury, String file, int page)(Code) | | Constructs an Annotation .
Parameters: llx - the lower left x-value Parameters: lly - the lower left y-value Parameters: urx - the upper right x-value Parameters: ury - the upper right y-value Parameters: file - an external PDF file Parameters: page - a page number in this file |
Annotation | public Annotation(float llx, float lly, float urx, float ury, int named)(Code) | | Constructs an Annotation .
Parameters: llx - the lower left x-value Parameters: lly - the lower left y-value Parameters: urx - the upper right x-value Parameters: ury - the upper right y-value Parameters: named - a named destination in this file |
Annotation | public Annotation(float llx, float lly, float urx, float ury, String application, String parameters, String operation, String defaultdir)(Code) | | Constructs an Annotation .
Parameters: llx - the lower left x-value Parameters: lly - the lower left y-value Parameters: urx - the upper right x-value Parameters: ury - the upper right y-value Parameters: application - an external application Parameters: parameters - parameters to pass to this application Parameters: operation - the operation to pass to this application Parameters: defaultdir - the default directory to run this application in |
Annotation | public Annotation(java.util.Properties attributes)(Code) | | Returns an Annotation that has been constructed taking in
account the value of some attributes .
Parameters: attributes - Some attributes |
annotationType | public int annotationType()(Code) | | Returns the type of this Annotation .
a type |
attributes | public HashMap attributes()(Code) | | Gets the content of this Annotation .
a reference |
content | public String content()(Code) | | Gets the content of this Annotation .
a reference |
getChunks | public ArrayList getChunks()(Code) | | Gets all the chunks in this element.
an ArrayList |
llx | public float llx()(Code) | | Returns the lower left x-value.
a value |
llx | public float llx(float def)(Code) | | Returns the lower left x-value.
Parameters: def - the default value a value |
lly | public float lly()(Code) | | Returns the lower left y-value.
a value |
lly | public float lly(float def)(Code) | | Returns the lower left y-value.
Parameters: def - the default value a value |
process | public boolean process(ElementListener listener)(Code) | | Processes the element by adding it (or the different parts) to an
ElementListener .
Parameters: listener - an ElementListener true if the element was processed successfully |
setDimensions | public void setDimensions(float llx, float lly, float urx, float ury)(Code) | | Sets the dimensions of this annotation.
Parameters: llx - the lower left x-value Parameters: lly - the lower left y-value Parameters: urx - the upper right x-value Parameters: ury - the upper right y-value |
title | public String title()(Code) | | Returns the title of this Annotation .
a name |
type | public int type()(Code) | | Gets the type of the text element.
a type |
urx | public float urx()(Code) | | Returns the uppper right x-value.
a value |
urx | public float urx(float def)(Code) | | Returns the upper right x-value.
Parameters: def - the default value a value |
ury | public float ury()(Code) | | Returns the uppper right y-value.
a value |
ury | public float ury(float def)(Code) | | Returns the upper right y-value.
Parameters: def - the default value a value |
|
|