Java tutorial
/* * $Id: ListItem.java 3373 2008-05-12 16:21:24Z xlv $ * * 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; /** * A <CODE>ListItem</CODE> is a <CODE>Paragraph</CODE> * that can be added to a <CODE>List</CODE>. * <P> * <B>Example 1:</B> * <BLOCKQUOTE><PRE> * List list = new List(true, 20); * list.add(<STRONG>new ListItem("First line")</STRONG>); * list.add(<STRONG>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?")</STRONG>); * list.add(<STRONG>new ListItem("Third line")</STRONG>); * </PRE></BLOCKQUOTE> * * The result of this code looks like this: * <OL> * <LI> * First line * </LI> * <LI> * The second line is longer to see what happens once the end of the line is reached. Will it start on a new line? * </LI> * <LI> * Third line * </LI> * </OL> * * <B>Example 2:</B> * <BLOCKQUOTE><PRE> * List overview = new List(false, 10); * overview.add(<STRONG>new ListItem("This is an item")</STRONG>); * overview.add("This is another item"); * </PRE></BLOCKQUOTE> * * The result of this code looks like this: * <UL> * <LI> * This is an item * </LI> * <LI> * This is another item * </LI> * </UL> * * @see Element * @see List * @see Paragraph */ public class ListItem extends Paragraph { // constants private static final long serialVersionUID = 1970670787169329006L; // member variables /** this is the symbol that will precede the listitem. */ private Chunk symbol; // constructors /** * Constructs a <CODE>ListItem</CODE>. */ public ListItem() { super(); } /** * Constructs a <CODE>ListItem</CODE> with a certain leading. * * @param leading the leading */ public ListItem(float leading) { super(leading); } /** * Constructs a <CODE>ListItem</CODE> with a certain <CODE>Chunk</CODE>. * * @param chunk a <CODE>Chunk</CODE> */ public ListItem(Chunk chunk) { super(chunk); } /** * Constructs a <CODE>ListItem</CODE> with a certain <CODE>String</CODE>. * * @param string a <CODE>String</CODE> */ public ListItem(String string) { super(string); } /** * Constructs a <CODE>ListItem</CODE> with a certain <CODE>String</CODE> * and a certain <CODE>Font</CODE>. * * @param string a <CODE>String</CODE> * @param font a <CODE>String</CODE> */ public ListItem(String string, Font font) { super(string, font); } /** * Constructs a <CODE>ListItem</CODE> with a certain <CODE>Chunk</CODE> * and a certain leading. * * @param leading the leading * @param chunk a <CODE>Chunk</CODE> */ public ListItem(float leading, Chunk chunk) { super(leading, chunk); } /** * Constructs a <CODE>ListItem</CODE> with a certain <CODE>String</CODE> * and a certain leading. * * @param leading the leading * @param string a <CODE>String</CODE> */ public ListItem(float leading, String string) { super(leading, string); } /** * Constructs a <CODE>ListItem</CODE> with a certain leading, <CODE>String</CODE> * and <CODE>Font</CODE>. * * @param leading the leading * @param string a <CODE>String</CODE> * @param font a <CODE>Font</CODE> */ public ListItem(float leading, String string, Font font) { super(leading, string, font); } /** * Constructs a <CODE>ListItem</CODE> with a certain <CODE>Phrase</CODE>. * * @param phrase a <CODE>Phrase</CODE> */ public ListItem(Phrase phrase) { super(phrase); } // implementation of the Element-methods /** * Gets the type of the text element. * * @return a type */ public int type() { return Element.LISTITEM; } // methods /** * Sets the listsymbol. * * @param symbol a <CODE>Chunk</CODE> */ public void setListSymbol(Chunk symbol) { if (this.symbol == null) { this.symbol = symbol; if (this.symbol.getFont().isStandardFont()) { this.symbol.setFont(font); } } } /** * Sets the indentation of this paragraph on the left side. * * @param indentation the new indentation */ public void setIndentationLeft(float indentation, boolean autoindent) { if (autoindent) { setIndentationLeft(getListSymbol().getWidthPoint()); } else { setIndentationLeft(indentation); } } // methods to retrieve information /** * Returns the listsymbol. * * @return a <CODE>Chunk</CODE> */ public Chunk getListSymbol() { return symbol; } }