core.com.lowagie.text.Anchor 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: Anchor.java 3004 2007-11-21 15:24:27Z 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.MalformedURLException;
import java.net.URL;
import java.util.ArrayList;
import java.util.Iterator;
/**
* An Anchor can be a reference or a destination of a reference.
*
* An Anchor is a special kind of Phrase.
* It is constructed in the same way.
*
* Example:
*
* Anchor anchor = new Anchor("this is a link");
* anchor.setName("LINK");
* anchor.setReference("http://www.lowagie.com");
*
*
* @see Element
* @see Phrase
*/
public class Anchor extends Phrase {
// constant
private static final long serialVersionUID = -852278536049236911L;
// membervariables
/** This is the name of the Anchor. */
protected String name = null;
/** This is the reference of the Anchor. */
protected String reference = null;
// constructors
/**
* Constructs an Anchor without specifying a leading.
*/
public Anchor() {
super(16);
}
/**
* Constructs an Anchor with a certain leading.
*
* @param leading the leading
*/
public Anchor(float leading) {
super(leading);
}
/**
* Constructs an Anchor with a certain Chunk.
*
* @param chunk a Chunk
*/
public Anchor(Chunk chunk) {
super(chunk);
}
/**
* Constructs an Anchor with a certain String.
*
* @param string a String
*/
public Anchor(String string) {
super(string);
}
/**
* Constructs an Anchor with a certain String
* and a certain Font.
*
* @param string a String
* @param font a Font
*/
public Anchor(String string, Font font) {
super(string, font);
}
/**
* Constructs an Anchor with a certain Chunk
* and a certain leading.
*
* @param leading the leading
* @param chunk a Chunk
*/
public Anchor(float leading, Chunk chunk) {
super(leading, chunk);
}
/**
* Constructs an Anchor with a certain leading
* and a certain String.
*
* @param leading the leading
* @param string a String
*/
public Anchor(float leading, String string) {
super(leading, string);
}
/**
* Constructs an Anchor with a certain leading,
* a certain String and a certain Font.
*
* @param leading the leading
* @param string a String
* @param font a Font
*/
public Anchor(float leading, String string, Font font) {
super(leading, string, font);
}
/**
* Constructs an Anchor with a certain Phrase.
*
* @param phrase a Phrase
*/
public Anchor(Phrase phrase) {
super(phrase);
if (phrase instanceof Anchor) {
Anchor a = (Anchor) phrase;
setName(a.name);
setReference(a.reference);
}
}
// implementation of the Element-methods
/**
* 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 {
Chunk chunk;
Iterator i = getChunks().iterator();
boolean localDestination = (reference != null && reference.startsWith("#"));
boolean notGotoOK = true;
while (i.hasNext()) {
chunk = (Chunk) i.next();
if (name != null && notGotoOK && !chunk.isEmpty()) {
chunk.setLocalDestination(name);
notGotoOK = false;
}
if (localDestination) {
chunk.setLocalGoto(reference.substring(1));
}
listener.add(chunk);
}
return true;
}
catch(DocumentException de) {
return false;
}
}
/**
* Gets all the chunks in this element.
*
* @return an ArrayList
*/
public ArrayList getChunks() {
ArrayList tmp = new ArrayList();
Chunk chunk;
Iterator i = iterator();
boolean localDestination = (reference != null && reference.startsWith("#"));
boolean notGotoOK = true;
while (i.hasNext()) {
chunk = (Chunk) i.next();
if (name != null && notGotoOK && !chunk.isEmpty()) {
chunk.setLocalDestination(name);
notGotoOK = false;
}
if (localDestination) {
chunk.setLocalGoto(reference.substring(1));
}
else if (reference != null)
chunk.setAnchor(reference);
tmp.add(chunk);
}
return tmp;
}
/**
* Gets the type of the text element.
*
* @return a type
*/
public int type() {
return Element.ANCHOR;
}
// methods
/**
* Sets the name of this Anchor.
*
* @param name a new name
*/
public void setName(String name) {
this.name = name;
}
/**
* Sets the reference of this Anchor.
*
* @param reference a new reference
*/
public void setReference(String reference) {
this.reference = reference;
}
// methods to retrieve information
/**
* Returns the name of this Anchor.
*
* @return a name
*/
public String getName() {
return name;
}
/**
* Gets the reference of this Anchor.
*
* @return a reference
*/
public String getReference() {
return reference;
}
/**
* Gets the reference of this Anchor.
*
* @return an URL
*/
public URL getUrl() {
try {
return new URL(reference);
}
catch(MalformedURLException mue) {
return null;
}
}
// deprecated stuff
/**
* Returns an Anchor 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#getAnchor(Properties)},
* scheduled for removel at 2.1.0
*/
public Anchor(java.util.Properties attributes) {
this(com.lowagie.text.factories.ElementFactory.getAnchor(attributes));
}
/**
* Returns the name of this Anchor.
*
* @return a name
* @deprecated As of iText 2.0.3, use {@link #getName()} instead,
* scheduled for removal at 2.1.0
*/
public String name() {
return getName();
}
/**
* Gets the reference of this Anchor.
*
* @return a reference
* @deprecated As of iText 2.0.3, use {@link #getReference()} instead,
* scheduled for removal at 2.1.0
*/
public String reference() {
return getReference();
}
/**
* Gets the reference of this Anchor.
*
* @return an URL
* @deprecated As of iText 2.0.3, use {@link #getUrl()} instead,
* scheduled for removal at 2.1.0
*/
public URL url() {
return getUrl();
}
}