Class Anchor

  • All Implemented Interfaces:
    Element, MarkupAttributes, TextElementArray, java.io.Serializable, java.lang.Cloneable, java.lang.Iterable, java.util.Collection, java.util.List, java.util.RandomAccess

    public class Anchor
    extends Phrase
    implements TextElementArray, MarkupAttributes
    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 Also:
    Element, Phrase, Serialized Form
    • Field Detail

      • ANCHOR

        public static final java.lang.String ANCHOR
        This is the anchor tag.
        See Also:
        Constant Field Values
      • name

        protected java.lang.String name
        This is the name of the Anchor.
      • reference

        protected java.lang.String reference
        This is the reference of the Anchor.
    • Constructor Detail

      • Anchor

        public Anchor()
        Constructs an Anchor without specifying a leading.
      • Anchor

        public Anchor​(float leading)
        Constructs an Anchor with a certain leading.
        Parameters:
        leading - the leading
      • Anchor

        public Anchor​(Chunk chunk)
        Constructs an Anchor with a certain Chunk.
        Parameters:
        chunk - a Chunk
      • Anchor

        public Anchor​(java.lang.String string)
        Constructs an Anchor with a certain String.
        Parameters:
        string - a String
      • Anchor

        public Anchor​(java.lang.String string,
                      Font font)
        Constructs an Anchor with a certain String and a certain Font.
        Parameters:
        string - a String
        font - a Font
      • Anchor

        public Anchor​(float leading,
                      Chunk chunk)
        Constructs an Anchor with a certain Chunk and a certain leading.
        Parameters:
        leading - the leading
        chunk - a Chunk
      • Anchor

        public Anchor​(float leading,
                      java.lang.String string)
        Constructs an Anchor with a certain leading and a certain String.
        Parameters:
        leading - the leading
        string - a String
      • Anchor

        public Anchor​(float leading,
                      java.lang.String string,
                      Font font)
        Constructs an Anchor with a certain leading, a certain String and a certain Font.
        Parameters:
        leading - the leading
        string - a String
        font - a Font
      • Anchor

        public Anchor​(java.util.Properties attributes)
        Returns an Anchor that has been constructed taking in account the value of some attributes.
        Parameters:
        attributes - Some attributes
    • Method Detail

      • process

        public boolean process​(ElementListener listener)
        Processes the element by adding it (or the different parts) to an ElementListener.
        Specified by:
        process in interface Element
        Overrides:
        process in class Phrase
        Parameters:
        listener - an ElementListener
        Returns:
        true if the element was processed successfully
      • getChunks

        public java.util.ArrayList getChunks()
        Gets all the chunks in this element.
        Specified by:
        getChunks in interface Element
        Overrides:
        getChunks in class Phrase
        Returns:
        an ArrayList
      • type

        public int type()
        Gets the type of the text element.
        Specified by:
        type in interface Element
        Overrides:
        type in class Phrase
        Returns:
        a type
      • getElements

        public java.util.Iterator getElements()
        Gets an iterator of Elements.
        Returns:
        an Iterator
      • setName

        public void setName​(java.lang.String name)
        Sets the name of this Anchor.
        Parameters:
        name - a new name
      • setReference

        public void setReference​(java.lang.String reference)
        Sets the reference of this Anchor.
        Parameters:
        reference - a new reference
      • name

        public java.lang.String name()
        Returns the name of this Anchor.
        Returns:
        a name
      • reference

        public java.lang.String reference()
        Gets the reference of this Anchor.
        Returns:
        a reference
      • url

        public java.net.URL url()
        Gets the reference of this Anchor.
        Returns:
        an URL
      • isTag

        public static boolean isTag​(java.lang.String tag)
        Checks if a given tag corresponds with this object.
        Parameters:
        tag - the given tag
        Returns:
        true if the tag corresponds