Save This Page
Home » iText-src-2.1.3 » com.lowagie » text » [javadoc | source]
com.lowagie.text
public class: Annotation [javadoc | source]
java.lang.Object
   com.lowagie.text.Annotation

All Implemented Interfaces:
    Element

An Annotation is a little note that can be added to a page on a document.
Field Summary
public static final  int TEXT    This is a possible annotation type. 
public static final  int URL_NET    This is a possible annotation type. 
public static final  int URL_AS_STRING    This is a possible annotation type. 
public static final  int FILE_DEST    This is a possible annotation type. 
public static final  int FILE_PAGE    This is a possible annotation type. 
public static final  int NAMED_DEST    This is a possible annotation type. 
public static final  int LAUNCH    This is a possible annotation type. 
public static final  int SCREEN    This is a possible annotation type. 
public static final  String TITLE    This is a possible attribute. 
public static final  String CONTENT    This is a possible attribute. 
public static final  String URL    This is a possible attribute. 
public static final  String FILE    This is a possible attribute. 
public static final  String DESTINATION    This is a possible attribute. 
public static final  String PAGE    This is a possible attribute. 
public static final  String NAMED    This is a possible attribute. 
public static final  String APPLICATION    This is a possible attribute. 
public static final  String PARAMETERS    This is a possible attribute. 
public static final  String OPERATION    This is a possible attribute. 
public static final  String DEFAULTDIR    This is a possible attribute. 
public static final  String LLX    This is a possible attribute. 
public static final  String LLY    This is a possible attribute. 
public static final  String URX    This is a possible attribute. 
public static final  String URY    This is a possible attribute. 
public static final  String MIMETYPE    This is a possible attribute. 
protected  int annotationtype    This is the type of annotation. 
protected  HashMap annotationAttributes    This is the title of the Annotation
protected  float llx    This is the lower left x-value 
protected  float lly    This is the lower left y-value 
protected  float urx    This is the upper right x-value 
protected  float ury    This is the upper right y-value 
Constructor:
 public Annotation(Annotation an) 
    Copy constructor.
 public Annotation(String title,
    String text) 
    Constructs an Annotation with a certain title and some text.
    Parameters:
    title - the title of the annotation
    text - the content of the annotation
 public Annotation(float llx,
    float lly,
    float urx,
    float ury,
    URL url) 
    Constructs an Annotation.
    Parameters:
    llx - the lower left x-value
    lly - the lower left y-value
    urx - the upper right x-value
    ury - the upper right y-value
    url - the external reference
 public Annotation(float llx,
    float lly,
    float urx,
    float ury,
    String url) 
    Constructs an Annotation.
    Parameters:
    llx - the lower left x-value
    lly - the lower left y-value
    urx - the upper right x-value
    ury - the upper right y-value
    url - the external reference
 public Annotation(float llx,
    float lly,
    float urx,
    float ury,
    int named) 
 public Annotation(String title,
    String text,
    float llx,
    float lly,
    float urx,
    float ury) 
    Constructs an Annotation with a certain title and some text.
    Parameters:
    title - the title of the annotation
    text - the content of the annotation
    llx - the lower left x-value
    lly - the lower left y-value
    urx - the upper right x-value
    ury - the upper right y-value
 public Annotation(float llx,
    float lly,
    float urx,
    float ury,
    String file,
    String dest) 
    Constructs an Annotation.
    Parameters:
    llx - the lower left x-value
    lly - the lower left y-value
    urx - the upper right x-value
    ury - the upper right y-value
    file - an external PDF file
    dest - the destination in this file
 public Annotation(float llx,
    float lly,
    float urx,
    float ury,
    String file,
    int page) 
    Constructs an Annotation.
    Parameters:
    llx - the lower left x-value
    lly - the lower left y-value
    urx - the upper right x-value
    ury - the upper right y-value
    file - an external PDF file
    page - a page number in this file
 public Annotation(float llx,
    float lly,
    float urx,
    float ury,
    String moviePath,
    String mimeType,
    boolean showOnDisplay) 
    Creates a Screen annotation to embed media clips
    Parameters:
    llx -
    lly -
    urx -
    ury -
    moviePath - path to the media clip file
    mimeType - mime type of the media
    showOnDisplay - if true play on display of the page
 public Annotation(float llx,
    float lly,
    float urx,
    float ury,
    String application,
    String parameters,
    String operation,
    String defaultdir) 
    Constructs an Annotation.
    Parameters:
    llx - the lower left x-value
    lly - the lower left y-value
    urx - the upper right x-value
    ury - the upper right y-value
    application - an external application
    parameters - parameters to pass to this application
    operation - the operation to pass to this application
    defaultdir - the default directory to run this application in
Method from com.lowagie.text.Annotation Summary:
annotationType,   attributes,   content,   getChunks,   isContent,   isNestable,   llx,   llx,   lly,   lly,   process,   setDimensions,   title,   type,   urx,   urx,   ury,   ury
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from com.lowagie.text.Annotation Detail:
 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 boolean isContent() 
 public boolean isNestable() 
 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 upper right x-value.
 public float urx(float def) 
    Returns the upper right x-value.
 public float ury() 
    Returns the upper right y-value.
 public float ury(float def) 
    Returns the upper right y-value.