since: iText - 2.1.1

since: iText - 2.1.1

 public List() 
{
    
    // constructors
        this(false, false);
}

Constructs a List.

 public List(float symbolIndent) 
{
    	this.symbolIndent = symbolIndent;
}

Constructs a List with a specific symbol indentation.

Parameters:

symbolIndent - the symbol indentation

since: iText - 2.0.8

 public List(boolean numbered) 
{
      	this(numbered, false);
}

Constructs a List.

Parameters:

numbered - a boolean

 public List(boolean numbered,
    boolean lettered) 
{
    	this.numbered = numbered;
        this.lettered = lettered;
        this.autoindent = true;
        this.alignindent = true;
}

Constructs a List.

Parameters:

numbered - a boolean

lettered - has the list to be 'numbered' with letters

 public List(boolean numbered,
    float symbolIndent) 
{
        this(numbered, false, 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

 public List(boolean numbered,
    boolean lettered,
    float symbolIndent) 
{
        this.numbered = numbered;
        this.lettered = lettered;
        this.symbolIndent = 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

 public boolean add(Object o) 
{
        if (o instanceof ListItem) {
            ListItem item = (ListItem) o;
            if (numbered || lettered) {
                Chunk chunk = new Chunk(preSymbol, symbol.getFont());
                int index = first + list.size();
                if ( lettered )
                    chunk.append(RomanAlphabetFactory.getString(index, lowercase));
                else
                    chunk.append(String.valueOf(index));
                chunk.append(postSymbol);
                item.setListSymbol(chunk);
            }
            else {
                item.setListSymbol(symbol);
            }
            item.setIndentationLeft(symbolIndent, autoindent);
            item.setIndentationRight(0);
            return list.add(item);
        }
        else if (o instanceof List) {
            List nested = (List) o;
            nested.setIndentationLeft(nested.getIndentationLeft() + symbolIndent);
            first--;
            return list.add(nested);
        }
        else if (o instanceof String) {
            return this.add(new ListItem((String) o));
        }
        return false;
}

Adds an Object to the List.

 public ArrayList getChunks() 
{
        ArrayList tmp = new ArrayList();
        for (Iterator i = list.iterator(); i.hasNext(); ) {
            tmp.addAll(((Element) i.next()).getChunks());
        }
        return tmp;
}

Gets all the chunks in this element.

 public int getFirst() 
{
		return first;
}

Gets the first number .

 public float getIndentationLeft() 
{
		return indentationLeft;
}

Gets the indentation of this paragraph on the left side.

 public float getIndentationRight() 
{
		return indentationRight;
}

Gets the indentation of this paragraph on the right side.

 public ArrayList getItems() 
{
        return list;
}

Gets all the items in the list.

 public String getPostSymbol() 
{
		return postSymbol;
}

Returns the String that is after a number or letter in the list symbol.

 public String getPreSymbol() 
{
		return preSymbol;
}

Returns the String that is before a number or letter in the list symbol.

 public Chunk getSymbol() 
{
		return symbol;
}

Gets the Chunk containing the symbol.

 public float getSymbolIndent() 
{
		return symbolIndent;
}

Gets the symbol indentation.

 public float getTotalLeading() 
{
        if (list.size() <  1) {
            return -1;
        }
        ListItem item = (ListItem) list.get(0);
        return item.getTotalLeading();
}

Gets the leading of the first listitem.

 public boolean isAlignindent() 
{
		return alignindent;
}

Checks if all the listitems should be aligned.

 public boolean isAutoindent() 
{
		return autoindent;
}

Checks if the indentation of list items is done automatically.

 public boolean isContent() 
{
		return true;
}

 public boolean isEmpty() 
{
    	return list.isEmpty();
}

Returns true if the list is empty.

 public boolean isLettered() 
{
        return lettered;
}

Checks if the list is lettered.

 public boolean isLowercase() 
{
        return lowercase;
}

Checks if the list lettering is lowercase.

 public boolean isNestable() 
{
		return true;
}

 public boolean isNumbered() 
{
        return numbered;
}

Checks if the list is numbered.

 public  void normalizeIndentation() 
{
        float max = 0;
    	Element o;
        for (Iterator i = list.iterator(); i.hasNext(); ) {
        	o = (Element)i.next();
            if (o instanceof ListItem) {
            	max = Math.max(max, ((ListItem)o).getIndentationLeft());
            }
        }
        for (Iterator i = list.iterator(); i.hasNext(); ) {
        	o = (Element)i.next();
            if (o instanceof ListItem) {
            	((ListItem)o).setIndentationLeft(max);
            }
        }
}

Makes sure all the items in the list have the same indentation.

 public boolean process(ElementListener listener) 
{
        try {
            for (Iterator i = list.iterator(); i.hasNext(); ) {
                listener.add((Element) i.next());
            }
            return true;
        }
        catch(DocumentException de) {
            return false;
        }
}

Processes the element by adding it (or the different parts) to an ElementListener.

 public  void setAlignindent(boolean alignindent) 
{
		this.alignindent = alignindent;
}

 public  void setAutoindent(boolean autoindent) 
{
		this.autoindent = autoindent;
}

 public  void setFirst(int first) 
{
        this.first = first;
}

Sets the number that has to come first in the list.

 public  void setIndentationLeft(float indentation) 
{
        this.indentationLeft = indentation;
}

Sets the indentation of this paragraph on the left side.

 public  void setIndentationRight(float indentation) 
{
        this.indentationRight = indentation;
}

Sets the indentation of this paragraph on the right side.

 public  void setLettered(boolean lettered) 
{
		this.lettered = lettered;
}

 public  void setListSymbol(Chunk symbol) 
{
        this.symbol = symbol;
}

Sets the listsymbol.

 public  void setListSymbol(String symbol) 
{
        this.symbol = new Chunk(symbol);
}

Sets the listsymbol.

This is a shortcut for setListSymbol(Chunk symbol).

 public  void setLowercase(boolean uppercase) 
{
		this.lowercase = uppercase;
}

 public  void setNumbered(boolean numbered) 
{
		this.numbered = numbered;
}

 public  void setPostSymbol(String postSymbol) 
{
		this.postSymbol = postSymbol;
}

Sets the String that has to be added after a number or letter in the list symbol.

 public  void setPreSymbol(String preSymbol) 
{
		this.preSymbol = preSymbol;
}

Sets the String that has to be added before a number or letter in the list symbol.

 public  void setSymbolIndent(float symbolIndent) 
{
		this.symbolIndent = symbolIndent;
}

 public int size() 
{
        return list.size();
}

Gets the size of the list.

 public int type() 
{
        return Element.LIST;
}

Gets the type of the text element.