|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.lowagie.text.Annotation
public class Annotation
An Annotation
is a little note that can be added to a page on
a document.
Element
,
Anchor
Field Summary | |
---|---|
protected java.util.HashMap |
annotationAttributes
This is the title of the Annotation . |
protected int |
annotationtype
This is the type of annotation. |
static java.lang.String |
APPLICATION
This is a possible attribute. |
static java.lang.String |
CONTENT
This is a possible attribute. |
static java.lang.String |
DEFAULTDIR
This is a possible attribute. |
static java.lang.String |
DESTINATION
This is a possible attribute. |
static java.lang.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 java.lang.String |
LLX
This is a possible attribute. |
protected float |
lly
This is the lower left y-value |
static java.lang.String |
LLY
This is a possible attribute. |
protected java.util.Properties |
markupAttributes
Contains extra markupAttributes |
static java.lang.String |
MIMETYPE
This is a possible attribute. |
static java.lang.String |
NAMED
This is a possible attribute. |
static int |
NAMED_DEST
This is a possible annotation type. |
static java.lang.String |
OPERATION
This is a possible attribute. |
static java.lang.String |
PAGE
This is a possible attribute. |
static java.lang.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 java.lang.String |
TITLE
This is a possible attribute. |
static java.lang.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 java.lang.String |
URX
This is a possible attribute. |
protected float |
ury
This is the upper right y-value |
static java.lang.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, MULTI_COLUMN_TEXT, PARAGRAPH, PHRASE, PRODUCER, PTABLE, RECTANGLE, ROW, SECTION, SUBJECT, TABLE |
Constructor Summary | |
---|---|
|
Annotation(Annotation an)
|
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,
java.lang.String url)
Constructs an Annotation . |
|
Annotation(float llx,
float lly,
float urx,
float ury,
java.lang.String file,
int page)
Constructs an Annotation . |
|
Annotation(float llx,
float lly,
float urx,
float ury,
java.lang.String file,
java.lang.String dest)
Constructs an Annotation . |
|
Annotation(float llx,
float lly,
float urx,
float ury,
java.lang.String moviePath,
java.lang.String mimeType,
boolean showOnDisplay)
Creates a Screen anotation to embed media clips |
|
Annotation(float llx,
float lly,
float urx,
float ury,
java.lang.String application,
java.lang.String parameters,
java.lang.String operation,
java.lang.String defaultdir)
Constructs an Annotation . |
|
Annotation(float llx,
float lly,
float urx,
float ury,
java.net.URL url)
Constructs an Annotation . |
|
Annotation(java.util.Properties attributes)
Returns an Annotation that has been constructed taking in
account the value of some attributes . |
|
Annotation(java.lang.String title,
java.lang.String text)
Constructs an Annotation with a certain title and some
text. |
|
Annotation(java.lang.String title,
java.lang.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 . |
java.util.HashMap |
attributes()
Gets the content of this Annotation . |
java.lang.String |
content()
Gets the content of this Annotation . |
java.util.ArrayList |
getChunks()
Gets all the chunks in this element. |
java.lang.String |
getMarkupAttribute(java.lang.String name)
Returns the value of the specified attribute. |
java.util.Set |
getMarkupAttributeNames()
Returns a Set of String attribute names for the
MarkupAttributes implementor. |
java.util.Properties |
getMarkupAttributes()
Return a Properties -object containing all the markupAttributes. |
static boolean |
isTag(java.lang.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(java.lang.String name,
java.lang.String value)
Sets the specified attribute. |
void |
setMarkupAttributes(java.util.Properties markupAttributes)
Sets the markupAttributes. |
java.lang.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 java.lang.String TITLE
public static java.lang.String CONTENT
public static java.lang.String URL
public static java.lang.String FILE
public static java.lang.String DESTINATION
public static java.lang.String PAGE
public static java.lang.String NAMED
public static java.lang.String APPLICATION
public static java.lang.String PARAMETERS
public static java.lang.String OPERATION
public static java.lang.String DEFAULTDIR
public static java.lang.String LLX
public static java.lang.String LLY
public static java.lang.String URX
public static java.lang.String URY
public static java.lang.String MIMETYPE
protected int annotationtype
protected java.util.HashMap annotationAttributes
Annotation
.
protected java.util.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.
llx
- lower left x coordinatelly
- lower left y coordinateurx
- upper right x coordinateury
- upper right y coordinatepublic Annotation(Annotation an)
public Annotation(java.lang.String title, java.lang.String text)
Annotation
with a certain title and some
text.
title
- the title of the annotationtext
- the content of the annotationpublic Annotation(java.lang.String title, java.lang.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-valuepublic Annotation(float llx, float lly, float urx, float ury, java.net.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 referencepublic Annotation(float llx, float lly, float urx, float ury, java.lang.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 referencepublic Annotation(float llx, float lly, float urx, float ury, java.lang.String file, java.lang.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 filepublic Annotation(float llx, float lly, float urx, float ury, java.lang.String moviePath, java.lang.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 pagepublic Annotation(float llx, float lly, float urx, float ury, java.lang.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 filepublic 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 filepublic Annotation(float llx, float lly, float urx, float ury, java.lang.String application, java.lang.String parameters, java.lang.String operation, java.lang.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(java.util.Properties attributes)
Annotation
that has been constructed taking in
account the value of some attributes .
attributes
- Some attributesMethod Detail |
---|
public int type()
type
in interface Element
public boolean process(ElementListener listener)
ElementListener
.
process
in interface Element
listener
- an ElementListener
true
if the element was processed successfullypublic java.util.ArrayList getChunks()
getChunks
in interface Element
ArrayList
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 java.lang.String title()
Annotation
.
public java.lang.String content()
Annotation
.
public java.util.HashMap attributes()
Annotation
.
public static boolean isTag(java.lang.String tag)
tag
- the given tag
public void setMarkupAttribute(java.lang.String name, java.lang.String value)
MarkupAttributes
setMarkupAttribute
in interface MarkupAttributes
name
- String
attribute name.value
- String
attribute value.MarkupAttributes.setMarkupAttribute(java.lang.String,
java.lang.String)
public void setMarkupAttributes(java.util.Properties markupAttributes)
MarkupAttributes
setMarkupAttributes
in interface MarkupAttributes
markupAttributes
- a Properties
-object containing markupattributesMarkupAttributes.setMarkupAttributes(java.util.Properties)
public java.lang.String getMarkupAttribute(java.lang.String name)
MarkupAttributes
getMarkupAttribute
in interface MarkupAttributes
name
- String
attribute name.
String
.MarkupAttributes.getMarkupAttribute(java.lang.String)
public java.util.Set getMarkupAttributeNames()
MarkupAttributes
Set
of String
attribute names for the
MarkupAttributes
implementor.
getMarkupAttributeNames
in interface MarkupAttributes
Set
.MarkupAttributes.getMarkupAttributeNames()
public java.util.Properties getMarkupAttributes()
MarkupAttributes
Properties
-object containing all the markupAttributes.
getMarkupAttributes
in interface MarkupAttributes
Properties
MarkupAttributes.getMarkupAttributes()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |