core.com.lowagie.text.Annotation Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of itext Show documentation
Show all versions of itext Show documentation
iText, a free Java-PDF library
/*
* $Id: Annotation.java 3048 2007-12-01 10:33:01Z blowagie $
* $Name$
*
* Copyright 1999, 2000, 2001, 2002 by Bruno Lowagie.
*
* The contents of this file are subject to the Mozilla Public License Version 1.1
* (the "License"); you may not use this file except in compliance with the License.
* You may obtain a copy of the License at http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the License.
*
* The Original Code is 'iText, a free JAVA-PDF library'.
*
* The Initial Developer of the Original Code is Bruno Lowagie. Portions created by
* the Initial Developer are Copyright (C) 1999, 2000, 2001, 2002 by Bruno Lowagie.
* All Rights Reserved.
* Co-Developer of the code is Paulo Soares. Portions created by the Co-Developer
* are Copyright (C) 2000, 2001, 2002 by Paulo Soares. All Rights Reserved.
*
* Contributor(s): all the names of the contributors are added in the source code
* where applicable.
*
* Alternatively, the contents of this file may be used under the terms of the
* LGPL license (the "GNU LIBRARY GENERAL PUBLIC LICENSE"), in which case the
* provisions of LGPL are applicable instead of those above. If you wish to
* allow use of your version of this file only under the terms of the LGPL
* License and not to allow others to use your version of this file under
* the MPL, indicate your decision by deleting the provisions above and
* replace them with the notice and other provisions required by the LGPL.
* If you do not delete the provisions above, a recipient may use your version
* of this file under either the MPL or the GNU LIBRARY GENERAL PUBLIC LICENSE.
*
* This library is free software; you can redistribute it and/or modify it
* under the terms of the MPL as stated above or under the terms of the GNU
* Library General Public License as published by the Free Software Foundation;
* either version 2 of the License, or any later version.
*
* This library is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU Library general Public License for more
* details.
*
* If you didn't download this code from the following link, you should check if
* you aren't using an obsolete version:
* http://www.lowagie.com/iText/
*/
package com.lowagie.text;
import java.net.URL;
import java.util.ArrayList;
import java.util.HashMap;
/**
* An Annotation is a little note that can be added to a page on
* a document.
*
* @see Element
* @see Anchor
*/
public class Annotation implements Element {
// membervariables
/** This is a possible annotation type. */
public static final int TEXT = 0;
/** This is a possible annotation type. */
public static final int URL_NET = 1;
/** This is a possible annotation type. */
public static final int URL_AS_STRING = 2;
/** This is a possible annotation type. */
public static final int FILE_DEST = 3;
/** This is a possible annotation type. */
public static final int FILE_PAGE = 4;
/** This is a possible annotation type. */
public static final int NAMED_DEST = 5;
/** This is a possible annotation type. */
public static final int LAUNCH = 6;
/** This is a possible annotation type. */
public static final int SCREEN = 7;
/** This is a possible attribute. */
public static final String TITLE = "title";
/** This is a possible attribute. */
public static final String CONTENT = "content";
/** This is a possible attribute. */
public static final String URL = "url";
/** This is a possible attribute. */
public static final String FILE = "file";
/** This is a possible attribute. */
public static final String DESTINATION = "destination";
/** This is a possible attribute. */
public static final String PAGE = "page";
/** This is a possible attribute. */
public static final String NAMED = "named";
/** This is a possible attribute. */
public static final String APPLICATION = "application";
/** This is a possible attribute. */
public static final String PARAMETERS = "parameters";
/** This is a possible attribute. */
public static final String OPERATION = "operation";
/** This is a possible attribute. */
public static final String DEFAULTDIR = "defaultdir";
/** This is a possible attribute. */
public static final String LLX = "llx";
/** This is a possible attribute. */
public static final String LLY = "lly";
/** This is a possible attribute. */
public static final String URX = "urx";
/** This is a possible attribute. */
public static final String URY = "ury";
/** This is a possible attribute. */
public static final String MIMETYPE = "mime";
/** This is the type of annotation. */
protected int annotationtype;
/** This is the title of the Annotation. */
protected HashMap annotationAttributes = new HashMap();
/** This is the lower left x-value */
protected float llx = Float.NaN;
/** This is the lower left y-value */
protected float lly = Float.NaN;
/** This is the upper right x-value */
protected float urx = Float.NaN;
/** This is the upper right y-value */
protected float ury = Float.NaN;
// constructors
/**
* Constructs an Annotation with a certain title and some
* text.
*
* @param llx
* lower left x coordinate
* @param lly
* lower left y coordinate
* @param urx
* upper right x coordinate
* @param ury
* upper right y coordinate
*/
private Annotation(float llx, float lly, float urx, float ury) {
this.llx = llx;
this.lly = lly;
this.urx = urx;
this.ury = ury;
}
/**
* Copy constructor.
*/
public Annotation(Annotation an) {
annotationtype = an.annotationtype;
annotationAttributes = an.annotationAttributes;
llx = an.llx;
lly = an.lly;
urx = an.urx;
ury = an.ury;
}
/**
* Constructs an Annotation with a certain title and some
* text.
*
* @param title
* the title of the annotation
* @param text
* the content of the annotation
*/
public Annotation(String title, String text) {
annotationtype = TEXT;
annotationAttributes.put(TITLE, title);
annotationAttributes.put(CONTENT, text);
}
/**
* Constructs an Annotation with a certain title and some
* text.
*
* @param title
* the title of the annotation
* @param text
* the content of the annotation
* @param llx
* the lower left x-value
* @param lly
* the lower left y-value
* @param urx
* the upper right x-value
* @param ury
* the upper right y-value
*/
public Annotation(String title, String text, float llx, float lly,
float urx, float ury) {
this(llx, lly, urx, ury);
annotationtype = TEXT;
annotationAttributes.put(TITLE, title);
annotationAttributes.put(CONTENT, text);
}
/**
* Constructs an Annotation.
*
* @param llx
* the lower left x-value
* @param lly
* the lower left y-value
* @param urx
* the upper right x-value
* @param ury
* the upper right y-value
* @param url
* the external reference
*/
public Annotation(float llx, float lly, float urx, float ury, URL url) {
this(llx, lly, urx, ury);
annotationtype = URL_NET;
annotationAttributes.put(URL, url);
}
/**
* Constructs an Annotation.
*
* @param llx
* the lower left x-value
* @param lly
* the lower left y-value
* @param urx
* the upper right x-value
* @param ury
* the upper right y-value
* @param url
* the external reference
*/
public Annotation(float llx, float lly, float urx, float ury, String url) {
this(llx, lly, urx, ury);
annotationtype = URL_AS_STRING;
annotationAttributes.put(FILE, url);
}
/**
* Constructs an Annotation.
*
* @param llx
* the lower left x-value
* @param lly
* the lower left y-value
* @param urx
* the upper right x-value
* @param ury
* the upper right y-value
* @param file
* an external PDF file
* @param dest
* the destination in this file
*/
public Annotation(float llx, float lly, float urx, float ury, String file,
String dest) {
this(llx, lly, urx, ury);
annotationtype = FILE_DEST;
annotationAttributes.put(FILE, file);
annotationAttributes.put(DESTINATION, dest);
}
/**
* Creates a Screen anotation to embed media clips
*
* @param llx
* @param lly
* @param urx
* @param ury
* @param moviePath
* path to the media clip file
* @param mimeType
* mime type of the media
* @param showOnDisplay
* if true play on display of the page
*/
public Annotation(float llx, float lly, float urx, float ury,
String moviePath, String mimeType, boolean showOnDisplay) {
this(llx, lly, urx, ury);
annotationtype = SCREEN;
annotationAttributes.put(FILE, moviePath);
annotationAttributes.put(MIMETYPE, mimeType);
annotationAttributes.put(PARAMETERS, new boolean[] {
false /* embedded */, showOnDisplay });
}
/**
* Constructs an Annotation.
*
* @param llx
* the lower left x-value
* @param lly
* the lower left y-value
* @param urx
* the upper right x-value
* @param ury
* the upper right y-value
* @param file
* an external PDF file
* @param page
* a page number in this file
*/
public Annotation(float llx, float lly, float urx, float ury, String file,
int page) {
this(llx, lly, urx, ury);
annotationtype = FILE_PAGE;
annotationAttributes.put(FILE, file);
annotationAttributes.put(PAGE, new Integer(page));
}
/**
* Constructs an Annotation.
*
* @param llx
* the lower left x-value
* @param lly
* the lower left y-value
* @param urx
* the upper right x-value
* @param ury
* the upper right y-value
* @param named
* a named destination in this file
*/
public Annotation(float llx, float lly, float urx, float ury, int named) {
this(llx, lly, urx, ury);
annotationtype = NAMED_DEST;
annotationAttributes.put(NAMED, new Integer(named));
}
/**
* Constructs an Annotation.
*
* @param llx
* the lower left x-value
* @param lly
* the lower left y-value
* @param urx
* the upper right x-value
* @param ury
* the upper right y-value
* @param application
* an external application
* @param parameters
* parameters to pass to this application
* @param operation
* the operation to pass to this application
* @param defaultdir
* the default directory to run this application in
*/
public Annotation(float llx, float lly, float urx, float ury,
String application, String parameters, String operation,
String defaultdir) {
this(llx, lly, urx, ury);
annotationtype = LAUNCH;
annotationAttributes.put(APPLICATION, application);
annotationAttributes.put(PARAMETERS, parameters);
annotationAttributes.put(OPERATION, operation);
annotationAttributes.put(DEFAULTDIR, defaultdir);
}
// implementation of the Element-methods
/**
* Gets the type of the text element.
*
* @return a type
*/
public int type() {
return Element.ANNOTATION;
}
/**
* Processes the element by adding it (or the different parts) to an
* ElementListener.
*
* @param listener
* an ElementListener
* @return true if the element was processed successfully
*/
public boolean process(ElementListener listener) {
try {
return listener.add(this);
} catch (DocumentException de) {
return false;
}
}
/**
* Gets all the chunks in this element.
*
* @return an ArrayList
*/
public ArrayList getChunks() {
return new ArrayList();
}
// methods
/**
* Sets the dimensions of this annotation.
*
* @param llx
* the lower left x-value
* @param lly
* the lower left y-value
* @param urx
* the upper right x-value
* @param ury
* the upper right y-value
*/
public void setDimensions(float llx, float lly, float urx, float ury) {
this.llx = llx;
this.lly = lly;
this.urx = urx;
this.ury = ury;
}
// methods to retrieve information
/**
* Returns the lower left x-value.
*
* @return a value
*/
public float llx() {
return llx;
}
/**
* Returns the lower left y-value.
*
* @return a value
*/
public float lly() {
return lly;
}
/**
* Returns the uppper right x-value.
*
* @return a value
*/
public float urx() {
return urx;
}
/**
* Returns the uppper right y-value.
*
* @return a value
*/
public float ury() {
return ury;
}
/**
* Returns the lower left x-value.
*
* @param def
* the default value
* @return a value
*/
public float llx(float def) {
if (Float.isNaN(llx))
return def;
return llx;
}
/**
* Returns the lower left y-value.
*
* @param def
* the default value
* @return a value
*/
public float lly(float def) {
if (Float.isNaN(lly))
return def;
return lly;
}
/**
* Returns the upper right x-value.
*
* @param def
* the default value
* @return a value
*/
public float urx(float def) {
if (Float.isNaN(urx))
return def;
return urx;
}
/**
* Returns the upper right y-value.
*
* @param def
* the default value
* @return a value
*/
public float ury(float def) {
if (Float.isNaN(ury))
return def;
return ury;
}
/**
* Returns the type of this Annotation.
*
* @return a type
*/
public int annotationType() {
return annotationtype;
}
/**
* Returns the title of this Annotation.
*
* @return a name
*/
public String title() {
String s = (String) annotationAttributes.get(TITLE);
if (s == null)
s = "";
return s;
}
/**
* Gets the content of this Annotation.
*
* @return a reference
*/
public String content() {
String s = (String) annotationAttributes.get(CONTENT);
if (s == null)
s = "";
return s;
}
/**
* Gets the content of this Annotation.
*
* @return a reference
*/
public HashMap attributes() {
return annotationAttributes;
}
/**
* @see com.lowagie.text.Element#isContent()
* @since iText 2.0.8
*/
public boolean isContent() {
return true;
}
/**
* @see com.lowagie.text.Element#isNestable()
* @since iText 2.0.8
*/
public boolean isNestable() {
return true;
}
/**
* Returns an Annotation that has been constructed taking in
* account the value of some attributes .
*
* @param attributes
* Some attributes
* @deprecated As of iText 2.0.3, replaced by {@link com.lowagie.text.factories.ElementFactory#getAnnotation(Properties)},
* scheduled for removal at 2.1.0
*/
public Annotation(java.util.Properties attributes) {
this(com.lowagie.text.factories.ElementFactory.getAnnotation(attributes));
}
}