Package com.gitlab.pdftk_java.com.lowagie.text

Class List

  • All Implemented Interfaces:
    Element, MarkupAttributes, TextElementArray
    public class List
extends Object
implements TextElementArray, MarkupAttributes
    A List contains several ListItems.

    Example 1: 

     List list = new List(true, 20);
 list.add(new ListItem("First line"));
 list.add(new ListItem("The second line is longer to see what happens once the end of the line is reached. Will it start on a new line?"));
 list.add(new ListItem("Third line"));
    The result of this code looks like this:
    1. First line
    2. The second line is longer to see what happens once the end of the line is reached. Will it start on a new line?
    3. Third line
    Example 2: 
     List overview = new List(false, 10);
 overview.add(new ListItem("This is an item"));
 overview.add("This is another item");
    The result of this code looks like this:
    • This is an item
    • This is another item
    See Also:
    Element, ListItem

    • Field Detail

      • ORDERED

        public static final boolean ORDERED
        a possible value for the numbered parameter
        See Also:
        Constant Field Values

      • UNORDERED

        public static final boolean UNORDERED
        a possible value for the numbered parameter
        See Also:
        Constant Field Values

      • NUMBERICAL

        public static final boolean NUMBERICAL
        a possible value for the lettered parameter
        See Also:
        Constant Field Values

      • ALPHABETICAL

        public static final boolean ALPHABETICAL
        a possible value for the lettered parameter
        See Also:
        Constant Field Values

      • list

        protected ArrayList list
        This is the ArrayList containing the different ListItems.

      • numbered

        protected boolean numbered
        This variable indicates if the list has to be numbered.

      • lettered

        protected boolean lettered

      • first

        protected int first
        This variable indicates the first number of a numbered list.

      • firstCh

        protected char firstCh

      • lastCh

        protected char lastCh

      • symbol

        protected Chunk symbol
        This is the listsymbol of a list that is not numbered.

      • indentationLeft

        protected float indentationLeft
        The indentation of this list on the left side.

      • indentationRight

        protected float indentationRight
        The indentation of this list on the right side.

      • symbolIndent

        protected float symbolIndent
        The indentation of the listitems.

      • markupAttributes

        protected Properties markupAttributes
        Contains extra markupAttributes

    • Constructor Detail

      • List

        public List​(boolean numbered,
            float symbolIndent)
        Constructs a List.

        Remark: the parameter symbolIndent is important for instance when generating PDF-documents; it indicates the indentation of the listsymbol. It is not important for HTML-documents.

        Parameters:
        numbered - a boolean
        symbolIndent - the indentation that has to be used for the listsymbol

      • List

        public List​(boolean numbered,
            boolean lettered,
            float symbolIndent)
        Creates a list
        Parameters:
        numbered - has the list to be numbered?
        lettered - has the list to be 'numbered' with letters
        symbolIndent - the indentation of the symbol

      • List

        public List​(Properties attributes)
        Returns a List 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
        Parameters:
        listener - an ElementListener
        Returns:
        true if the element was processed successfully

      • type

        public int type()
        Gets the type of the text element.
        Specified by:
        type in interface Element
        Returns:
        a type

      • getChunks

        public ArrayList getChunks()
        Gets all the chunks in this element.
        Specified by:
        getChunks in interface Element
        Returns:
        an ArrayList

      • add

        public boolean add​(Object o)
        Adds an Object to the List.
        Specified by:
        add in interface TextElementArray
        Parameters:
        o - the object to add.
        Returns:
        true if adding the object succeeded

      • setIndentationLeft

        public void setIndentationLeft​(float indentation)
        Sets the indentation of this paragraph on the left side.
        Parameters:
        indentation - the new indentation

      • setIndentationRight

        public void setIndentationRight​(float indentation)
        Sets the indentation of this paragraph on the right side.
        Parameters:
        indentation - the new indentation

      • setFirst

        public void setFirst​(int first)
        Sets the number that has to come first in the list.
        Parameters:
        first - a number

      • setFirst

        public void setFirst​(char first)
        Sets the Letter that has to come first in the list.
        Parameters:
        first - a letter

      • setListSymbol

        public void setListSymbol​(Chunk symbol)
        Sets the listsymbol.
        Parameters:
        symbol - a Chunk

      • setListSymbol

        public void setListSymbol​(String symbol)
        Sets the listsymbol.

        This is a shortcut for setListSymbol(Chunk symbol).

        Parameters:
        symbol - a String

      • getItems

        public ArrayList getItems()
        Gets all the items in the list.
        Returns:
        an ArrayList containing ListItems.

      • size

        public int size()
        Gets the size of the list.
        Returns:
        a size

      • leading

        public float leading()
        Gets the leading of the first listitem.
        Returns:
        a leading

      • isNumbered

        public boolean isNumbered()
        Checks if the list is numbered.
        Returns:
        true if the list is numbered, false otherwise.

      • symbolIndent

        public float symbolIndent()
        Gets the symbol indentation.
        Returns:
        the symbol indentation

      • symbol

        public Chunk symbol()
        Gets the Chunk containing the symbol.
        Returns:
        a Chunk with a symbol

      • first

        public int first()
        Gets the first number .
        Returns:
        a number

      • indentationLeft

        public float indentationLeft()
        Gets the indentation of this paragraph on the left side.
        Returns:
        the indentation

      • indentationRight

        public float indentationRight()
        Gets the indentation of this paragraph on the right side.
        Returns:
        the indentation

      • isSymbol

        public static boolean isSymbol​(String tag)
        Checks if a given tag corresponds with the listsymbol tag of this object.
        Parameters:
        tag - the given tag
        Returns:
        true if the tag corresponds

      • isTag

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