Java Doc for List.java in  » PDF » pdf-itext » com » lowagie » text » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » PDF » pdf itext » com.lowagie.text 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   com.lowagie.text.List

All known Subclasses:   com.lowagie.text.GreekList,  com.lowagie.text.ZapfDingbatsList,  com.lowagie.text.ZapfDingbatsNumberList,  com.lowagie.text.RomanList,
List
public class List implements TextElementArray(Code)
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
See Also:   ListItem


Field Summary
final public static  booleanALPHABETICAL
    
final public static  booleanLOWERCASE
    
final public static  booleanNUMERICAL
    
final public static  booleanORDERED
    
final public static  booleanUNORDERED
    
final public static  booleanUPPERCASE
    
protected  booleanalignindent
     Indicates if the indentation of all the items has to be aligned.
protected  booleanautoindent
     Indicates if the indentation has to be set automatically.
protected  intfirst
     This variable indicates the first number of a numbered list.
protected  floatindentationLeft
     The indentation of this list on the left side.
protected  floatindentationRight
     The indentation of this list on the right side.
protected  booleanlettered
     Indicates if the listsymbols are numerical or alphabetical.
protected  ArrayListlist
     This is the ArrayList containing the different ListItems.
protected  booleanlowercase
     Indicates if the listsymbols are lowercase or uppercase.
protected  booleannumbered
     Indicates if the list has to be numbered.
protected  Chunksymbol
     This is the listsymbol of a list that is not numbered.
protected  floatsymbolIndent
     The indentation of the listitems.

Constructor Summary
public  List()
     Constructs a List.
public  List(boolean numbered)
     Constructs a List.
public  List(boolean numbered, boolean lettered)
     Constructs a List.
public  List(boolean numbered, float symbolIndent)
     Constructs a List.
public  List(boolean numbered, boolean lettered, float symbolIndent)
    
public  List(java.util.Properties attributes)
     Returns a List that has been constructed taking in account the value of some attributes.

Method Summary
public  booleanadd(Object o)
     Adds an Object to the List.
Parameters:
  o - the object to add.
public  intfirst()
     Gets the first number .
public  ArrayListgetChunks()
     Gets all the chunks in this element.
public  intgetFirst()
     Gets the first number .
public  floatgetIndentationLeft()
     Gets the indentation of this paragraph on the left side.
public  floatgetIndentationRight()
     Gets the indentation of this paragraph on the right side.
public  ArrayListgetItems()
     Gets all the items in the list.
public  ChunkgetSymbol()
     Gets the Chunk containing the symbol.
public  floatgetSymbolIndent()
     Gets the symbol indentation.
public  floatgetTotalLeading()
     Gets the leading of the first listitem.
public  floatindentationLeft()
     Gets the indentation of this paragraph on the left side.
public  floatindentationRight()
     Gets the indentation of this paragraph on the right side.
public  booleanisAlignindent()
     Checks if all the listitems should be aligned.
public  booleanisAutoindent()
     Checks if the indentation of list items is done automatically.
public  booleanisEmpty()
     Returns true if the list is empty.
public  booleanisLettered()
     Checks if the list is lettered.
public  booleanisLowerCase()
     Checks if the list lettering is lowercase.
public  booleanisLowercase()
     Checks if the list lettering is lowercase.
public  booleanisNumbered()
     Checks if the list is numbered.
public  voidnormalizeIndentation()
     Makes sure all the items in the list have the same indentation.
public  booleanprocess(ElementListener listener)
     Processes the element by adding it (or the different parts) to an ElementListener.
public  voidsetAlignindent(boolean alignindent)
    
public  voidsetAutoindent(boolean autoindent)
    
public  voidsetFirst(int first)
     Sets the number that has to come first in the list.
public  voidsetIndentationLeft(float indentation)
     Sets the indentation of this paragraph on the left side.
public  voidsetIndentationRight(float indentation)
     Sets the indentation of this paragraph on the right side.
public  voidsetLettered(boolean lettered)
    
public  voidsetListSymbol(Chunk symbol)
     Sets the listsymbol.
public  voidsetListSymbol(String symbol)
     Sets the listsymbol.
public  voidsetLowercase(boolean uppercase)
    
public  voidsetNumbered(boolean numbered)
    
public  voidsetSymbolIndent(float symbolIndent)
    
public  intsize()
     Gets the size of the list.
public  Chunksymbol()
     Gets the Chunk containing the symbol.
public  floatsymbolIndent()
     Gets the symbol indentation.
public  inttype()
     Gets the type of the text element.

Field Detail
ALPHABETICAL
final public static boolean ALPHABETICAL(Code)
a possible value for the lettered parameter



LOWERCASE
final public static boolean LOWERCASE(Code)
a possible value for the lettered parameter



NUMERICAL
final public static boolean NUMERICAL(Code)
a possible value for the lettered parameter



ORDERED
final public static boolean ORDERED(Code)
a possible value for the numbered parameter



UNORDERED
final public static boolean UNORDERED(Code)
a possible value for the numbered parameter



UPPERCASE
final public static boolean UPPERCASE(Code)
a possible value for the lettered parameter



alignindent
protected boolean alignindent(Code)
Indicates if the indentation of all the items has to be aligned.



autoindent
protected boolean autoindent(Code)
Indicates if the indentation has to be set automatically.



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



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



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



lettered
protected boolean lettered(Code)
Indicates if the listsymbols are numerical or alphabetical.



list
protected ArrayList list(Code)
This is the ArrayList containing the different ListItems.



lowercase
protected boolean lowercase(Code)
Indicates if the listsymbols are lowercase or uppercase.



numbered
protected boolean numbered(Code)
Indicates if the list has to be numbered.



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



symbolIndent
protected float symbolIndent(Code)
The indentation of the listitems.




Constructor Detail
List
public List()(Code)
Constructs a List.



List
public List(boolean numbered)(Code)
Constructs a List.
Parameters:
  numbered - a boolean



List
public List(boolean numbered, boolean lettered)(Code)
Constructs a List.
Parameters:
  numbered - a boolean
Parameters:
  lettered - has the list to be 'numbered' with letters



List
public List(boolean numbered, float symbolIndent)(Code)
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
Parameters:
  symbolIndent - the indentation that has to be used for the listsymbol




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



List
public List(java.util.Properties attributes)(Code)
Returns a List that has been constructed taking in account the value of some attributes.
Parameters:
  attributes - Some attributes




Method Detail
add
public boolean add(Object o)(Code)
Adds an Object to the List.
Parameters:
  o - the object to add. true if adding the object succeeded



first
public int first()(Code)
Gets the first number . a number



getChunks
public ArrayList getChunks()(Code)
Gets all the chunks in this element. an ArrayList



getFirst
public int getFirst()(Code)
Gets the first number . a number



getIndentationLeft
public float getIndentationLeft()(Code)
Gets the indentation of this paragraph on the left side. the indentation



getIndentationRight
public float getIndentationRight()(Code)
Gets the indentation of this paragraph on the right side. the indentation



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



getSymbol
public Chunk getSymbol()(Code)
Gets the Chunk containing the symbol. a Chunk with a symbol



getSymbolIndent
public float getSymbolIndent()(Code)
Gets the symbol indentation. the symbol indentation



getTotalLeading
public float getTotalLeading()(Code)
Gets the leading of the first listitem. a leading



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



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



isAlignindent
public boolean isAlignindent()(Code)
Checks if all the listitems should be aligned. the alignindent



isAutoindent
public boolean isAutoindent()(Code)
Checks if the indentation of list items is done automatically. the autoindent



isEmpty
public boolean isEmpty()(Code)
Returns true if the list is empty. true if the list is empty



isLettered
public boolean isLettered()(Code)
Checks if the list is lettered. true if the list is lettered, false otherwise.



isLowerCase
public boolean isLowerCase()(Code)
Checks if the list lettering is lowercase. true if it is lowercase, false otherwise.



isLowercase
public boolean isLowercase()(Code)
Checks if the list lettering is lowercase. true if it is lowercase, false otherwise.



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



normalizeIndentation
public void normalizeIndentation()(Code)
Makes sure all the items in the list have the same indentation.



process
public boolean process(ElementListener listener)(Code)
Processes the element by adding it (or the different parts) to an ElementListener.
Parameters:
  listener - an ElementListener true if the element was processed successfully



setAlignindent
public void setAlignindent(boolean alignindent)(Code)

Parameters:
  alignindent - the alignindent to set



setAutoindent
public void setAutoindent(boolean autoindent)(Code)

Parameters:
  autoindent - the autoindent to set



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



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



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



setLettered
public void setLettered(boolean lettered)(Code)

Parameters:
  lettered - the lettered to set



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



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

This is a shortcut for setListSymbol(Chunk symbol).
Parameters:
  symbol - a String




setLowercase
public void setLowercase(boolean uppercase)(Code)

Parameters:
  uppercase - the uppercase to set



setNumbered
public void setNumbered(boolean numbered)(Code)

Parameters:
  numbered - the numbered to set



setSymbolIndent
public void setSymbolIndent(float symbolIndent)(Code)

Parameters:
  symbolIndent - the symbolIndent to set



size
public int size()(Code)
Gets the size of the list. a size



symbol
public Chunk symbol()(Code)
Gets the Chunk containing the symbol. a Chunk with a symbol



symbolIndent
public float symbolIndent()(Code)
Gets the symbol indentation. the symbol indentation



type
public int type()(Code)
Gets the type of the text element. a type



Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.