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");
* 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);
}
/**
* Returns an Anchor that has been constructed taking in account
* the value of some attributes.
*
* @param attributes Some attributes
*/
public Anchor(Properties attributes) {
this("", FontFactory.getFont(attributes));
String value;
if ((value = (String)attributes.remove(ElementTags.ITEXT)) != null) {
Chunk chunk = new Chunk(value);
if ((value = (String)attributes.remove(ElementTags.GENERICTAG)) != null) {
chunk.setGenericTag(value);
}
add(chunk);
}
if ((value = (String)attributes.remove(ElementTags.LEADING)) != null) {
setLeading(Float.valueOf(value + "f").floatValue());
}
else if ((value = (String)attributes.remove(MarkupTags.CSS_KEY_LINEHEIGHT)) != null) {
setLeading(MarkupParser.parseLength(value));
}
if ((value = (String)attributes.remove(ElementTags.NAME)) != null) {
setName(value);
}
if ((value = (String)attributes.remove(ElementTags.REFERENCE)) != null) {
setReference(value);
}
if (attributes.size() > 0) setMarkupAttributes(attributes);
}
// 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
/**
* Gets an iterator of Elements.
*
* @return an Iterator
*/
// suggestion by by Curt Thompson
public Iterator getElements() {
return this.iterator();
}
/**
* 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 name() {
return name;
}
/**
* Gets the reference of this Anchor.
*
* @return a reference
*/
public String reference() {
return reference;
}
/**
* Gets the reference of this Anchor.
*
* @return an URL
*/
public URL url() {
try {
return new URL(reference);
}
catch(MalformedURLException mue) {
return null;
}
}
/**
* Checks if a given tag corresponds with this object.
*
* @param tag the given tag
* @return true if the tag corresponds
*/
public static boolean isTag(String tag) {
return ElementTags.ANCHOR.equals(tag);
}
}