|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.lowagie.text.Annotation
An Annotation is a little note that can be added to a page
on a document.
Element,
Anchor| Field Summary | |
protected HashMap |
annotationAttributes
This is the title of the Annotation. |
protected int |
annotationtype
This is the type of annotation. |
static String |
APPLICATION
This is a possible attribute. |
static String |
CONTENT
This is a possible attribute. |
static String |
DEFAULTDIR
This is a possible attribute. |
static String |
DESTINATION
This is a possible attribute. |
static String |
FILE
This is a possible attribute. |
static int |
FILE_DEST
This is a possible annotation type. |
static int |
FILE_PAGE
This is a possible annotation type. |
static int |
LAUNCH
This is a possible annotation type. |
protected float |
llx
This is the lower left x-value |
static String |
LLX
This is a possible attribute. |
protected float |
lly
This is the lower left y-value |
static String |
LLY
This is a possible attribute. |
protected Properties |
markupAttributes
Contains extra markupAttributes |
static String |
MIMETYPE
This is a possible attribute. |
static String |
NAMED
This is a possible attribute. |
static int |
NAMED_DEST
This is a possible annotation type. |
static String |
OPERATION
This is a possible attribute. |
static String |
PAGE
This is a possible attribute. |
static String |
PARAMETERS
This is a possible attribute. |
static int |
SCREEN
This is a possible annotation type. |
static int |
TEXT
This is a possible annotation type. |
static String |
TITLE
This is a possible attribute. |
static String |
URL
This is a possible attribute. |
static int |
URL_AS_STRING
This is a possible annotation type. |
static int |
URL_NET
This is a possible annotation type. |
protected float |
urx
This is the upper right x-value |
static String |
URX
This is a possible attribute. |
protected float |
ury
This is the upper right y-value |
static String |
URY
This is a possible attribute. |
| Fields inherited from interface com.lowagie.text.Element |
ALIGN_BASELINE, ALIGN_BOTTOM, ALIGN_CENTER, ALIGN_JUSTIFIED, ALIGN_JUSTIFIED_ALL, ALIGN_LEFT, ALIGN_MIDDLE, ALIGN_RIGHT, ALIGN_TOP, ALIGN_UNDEFINED, ANCHOR, ANNOTATION, AUTHOR, CCITT_BLACKIS1, CCITT_ENCODEDBYTEALIGN, CCITT_ENDOFBLOCK, CCITT_ENDOFLINE, CCITTG3_1D, CCITTG3_2D, CCITTG4, CELL, CHAPTER, CHUNK, CREATIONDATE, CREATOR, GRAPHIC, HEADER, IMGRAW, IMGTEMPLATE, JPEG, KEYWORDS, LIST, LISTITEM, PARAGRAPH, PHRASE, PRODUCER, PTABLE, RECTANGLE, ROW, SECTION, SUBJECT, TABLE |
| Constructor Summary | |
private |
Annotation(float llx,
float lly,
float urx,
float ury)
Constructs an Annotation with a certain title and some text. |
|
Annotation(float llx,
float lly,
float urx,
float ury,
int named)
Constructs an Annotation. |
|
Annotation(float llx,
float lly,
float urx,
float ury,
String url)
Constructs an Annotation. |
|
Annotation(float llx,
float lly,
float urx,
float ury,
String file,
int page)
Constructs an Annotation. |
|
Annotation(float llx,
float lly,
float urx,
float ury,
String file,
String dest)
Constructs an Annotation. |
|
Annotation(float llx,
float lly,
float urx,
float ury,
String moviePath,
String mimeType,
boolean showOnDisplay)
Creates a Screen anotation to embed media clips |
|
Annotation(float llx,
float lly,
float urx,
float ury,
String application,
String parameters,
String operation,
String defaultdir)
Constructs an Annotation. |
|
Annotation(float llx,
float lly,
float urx,
float ury,
URL url)
Constructs an Annotation. |
|
Annotation(Properties attributes)
Returns an Annotation that has been constructed taking in account
the value of some attributes. |
|
Annotation(String title,
String text)
Constructs an Annotation with a certain title and some text. |
|
Annotation(String title,
String text,
float llx,
float lly,
float urx,
float ury)
Constructs an Annotation with a certain title and some text. |
| Method Summary | |
int |
annotationType()
Returns the type of this Annotation. |
HashMap |
attributes()
Gets the content of this Annotation. |
String |
content()
Gets the content of this Annotation. |
ArrayList |
getChunks()
Gets all the chunks in this element. |
String |
getMarkupAttribute(String name)
Returns the value of the specified attribute. |
Set |
getMarkupAttributeNames()
Returns a Set of String attribute names for the
MarkupAttributes implementor. |
Properties |
getMarkupAttributes()
Return a Properties-object containing all the markupAttributes. |
static boolean |
isTag(String tag)
Checks if a given tag corresponds with this object. |
float |
llx()
Returns the lower left x-value. |
float |
llx(float def)
Returns the lower left x-value. |
float |
lly()
Returns the lower left y-value. |
float |
lly(float def)
Returns the lower left y-value. |
boolean |
process(ElementListener listener)
Processes the element by adding it (or the different parts) to an ElementListener. |
void |
setDimensions(float llx,
float lly,
float urx,
float ury)
Sets the dimensions of this annotation. |
void |
setMarkupAttribute(String name,
String value)
Sets the specified attribute. |
void |
setMarkupAttributes(Properties markupAttributes)
Sets the markupAttributes. |
String |
title()
Returns the title of this Annotation. |
int |
type()
Gets the type of the text element. |
float |
urx()
Returns the uppper right x-value. |
float |
urx(float def)
Returns the upper right x-value. |
float |
ury()
Returns the uppper right y-value. |
float |
ury(float def)
Returns the upper right y-value. |
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Methods inherited from interface com.lowagie.text.Element |
toString |
| Field Detail |
public static final int TEXT
public static final int URL_NET
public static final int URL_AS_STRING
public static final int FILE_DEST
public static final int FILE_PAGE
public static final int NAMED_DEST
public static final int LAUNCH
public static final int SCREEN
public static String TITLE
public static String CONTENT
public static String URL
public static String FILE
public static String DESTINATION
public static String PAGE
public static String NAMED
public static String APPLICATION
public static String PARAMETERS
public static String OPERATION
public static String DEFAULTDIR
public static String LLX
public static String LLY
public static String URX
public static String URY
public static String MIMETYPE
protected int annotationtype
protected HashMap annotationAttributes
Annotation.
protected Properties markupAttributes
protected float llx
protected float lly
protected float urx
protected float ury
| Constructor Detail |
private Annotation(float llx,
float lly,
float urx,
float ury)
Annotation with a certain title and some text.
public Annotation(String title,
String text)
Annotation with a certain title and some text.
title - the title of the annotationtext - the content of the annotation
public Annotation(String title,
String text,
float llx,
float lly,
float urx,
float ury)
Annotation with a certain title and some text.
title - the title of the annotationtext - the content of the annotationllx - the lower left x-valuelly - the lower left y-valueurx - the upper right x-valueury - the upper right y-value
public Annotation(float llx,
float lly,
float urx,
float ury,
URL url)
Annotation.
llx - the lower left x-valuelly - the lower left y-valueurx - the upper right x-valueury - the upper right y-valueurl - the external reference
public Annotation(float llx,
float lly,
float urx,
float ury,
String url)
Annotation.
llx - the lower left x-valuelly - the lower left y-valueurx - the upper right x-valueury - the upper right y-valueurl - the external reference
public Annotation(float llx,
float lly,
float urx,
float ury,
String file,
String dest)
Annotation.
llx - the lower left x-valuelly - the lower left y-valueurx - the upper right x-valueury - the upper right y-valuefile - an external PDF filedest - the destination in this file
public Annotation(float llx,
float lly,
float urx,
float ury,
String moviePath,
String mimeType,
boolean showOnDisplay)
llx - lly - urx - ury - moviePath - path to the media clip filemimeType - mime type of the mediashowOnDisplay - if true play on display of the page
public Annotation(float llx,
float lly,
float urx,
float ury,
String file,
int page)
Annotation.
llx - the lower left x-valuelly - the lower left y-valueurx - the upper right x-valueury - the upper right y-valuefile - an external PDF filepage - a page number in this file
public Annotation(float llx,
float lly,
float urx,
float ury,
int named)
Annotation.
llx - the lower left x-valuelly - the lower left y-valueurx - the upper right x-valueury - the upper right y-valuenamed - a named destination in this file
public Annotation(float llx,
float lly,
float urx,
float ury,
String application,
String parameters,
String operation,
String defaultdir)
Annotation.
llx - the lower left x-valuelly - the lower left y-valueurx - the upper right x-valueury - the upper right y-valueapplication - an external applicationparameters - parameters to pass to this applicationoperation - the operation to pass to this applicationdefaultdir - the default directory to run this application inpublic Annotation(Properties attributes)
Annotation that has been constructed taking in account
the value of some attributes.
attributes - Some attributes| Method Detail |
public int type()
type in interface Elementpublic boolean process(ElementListener listener)
ElementListener.
process in interface Elementlistener - an ElementListener
true if the element was processed successfullypublic ArrayList getChunks()
getChunks in interface ElementArrayList
public void setDimensions(float llx,
float lly,
float urx,
float ury)
llx - the lower left x-valuelly - the lower left y-valueurx - the upper right x-valueury - the upper right y-valuepublic float llx()
public float lly()
public float urx()
public float ury()
public float llx(float def)
def - the default value
public float lly(float def)
def - the default value
public float urx(float def)
def - the default value
public float ury(float def)
def - the default value
public int annotationType()
Annotation.
public String title()
Annotation.
public String content()
Annotation.
public HashMap attributes()
Annotation.
public static boolean isTag(String tag)
tag - the given tag
public void setMarkupAttribute(String name,
String value)
MarkupAttributes
setMarkupAttribute in interface MarkupAttributesname - String attribute name.value - String attribute value.MarkupAttributes.setMarkupAttribute(java.lang.String, java.lang.String)public void setMarkupAttributes(Properties markupAttributes)
MarkupAttributes
setMarkupAttributes in interface MarkupAttributesmarkupAttributes - a Properties-object containing markupattributesMarkupAttributes.setMarkupAttributes(java.util.Properties)public String getMarkupAttribute(String name)
MarkupAttributes
getMarkupAttribute in interface MarkupAttributesname - String attribute name.
String.MarkupAttributes.getMarkupAttribute(java.lang.String)public Set getMarkupAttributeNames()
MarkupAttributesSet of String attribute names for the
MarkupAttributes implementor.
getMarkupAttributeNames in interface MarkupAttributesSet.MarkupAttributes.getMarkupAttributeNames()public Properties getMarkupAttributes()
MarkupAttributesProperties-object containing all the markupAttributes.
getMarkupAttributes in interface MarkupAttributesPropertiesMarkupAttributes.getMarkupAttributes()
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||