|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
java.lang.Objectjava.util.AbstractCollection
java.util.AbstractList
java.util.ArrayList
com.lowagie.text.Section
A Section is a part of a Document containing
other Sections, Paragraphs, List
and/or Tables.
Remark: you can not construct a Section yourself.
You will have to ask an instance of Section to the
Chapter or Section to which you want to
add the new Section.
Example:
Paragraph title2 = new Paragraph("This is Chapter 2", FontFactory.getFont(FontFactory.HELVETICA, 18, Font.BOLDITALIC, new Color(0, 0, 255)));
Chapter chapter2 = new Chapter(title2, 2);
Paragraph someText = new Paragraph("This is some text");
chapter2.add(someText);
Paragraph title21 = new Paragraph("This is Section 1 in Chapter 2", FontFactory.getFont(FontFactory.HELVETICA, 16, Font.BOLD, new Color(255, 0, 0)));
Section section1 = chapter2.addSection(title21);
Paragraph someSectionText = new Paragraph("This is some silly paragraph in a chapter and/or section. It contains some text to test the functionality of Chapters and Section.");
section1.add(someSectionText);
Paragraph title211 = new Paragraph("This is SubSection 1 in Section 1 in Chapter 2", FontFactory.getFont(FontFactory.HELVETICA, 14, Font.BOLD, new Color(255, 0, 0)));
Section section11 = section1.addSection(40, title211, 2);
section11.add(someSectionText);
| Field Summary | |
static int |
NUMBERSTYLE_DOTTED
A possible number style. |
static int |
NUMBERSTYLE_DOTTED_WITHOUT_FINAL_DOT
A possible number style. |
| Fields inherited from interface com.lowagie.text.Element |
ALIGN_BASELINE, ALIGN_BOTTOM, ALIGN_CENTER, ALIGN_JUSTIFIED, ALIGN_JUSTIFIED_ALL, ALIGN_LEFT, ALIGN_MIDDLE, ALIGN_RIGHT, ALIGN_TOP, ALIGN_UNDEFINED, ANCHOR, ANNOTATION, AUTHOR, CCITT_BLACKIS1, CCITT_ENCODEDBYTEALIGN, CCITT_ENDOFBLOCK, CCITT_ENDOFLINE, CCITTG3_1D, CCITTG3_2D, CCITTG4, CELL, CHAPTER, CHUNK, CREATIONDATE, CREATOR, HEADER, IMGRAW, IMGTEMPLATE, JPEG, JPEG2000, KEYWORDS, LIST, LISTITEM, MARKED, MULTI_COLUMN_TEXT, PARAGRAPH, PHRASE, PRODUCER, PTABLE, RECTANGLE, ROW, SECTION, SUBJECT, TABLE, TITLE, YMARK |
| Method Summary | |
void |
add(int index,
Object o)
Adds a Paragraph, List or Table
to this Section. |
boolean |
add(Object o)
Adds a Paragraph, List, Table or another Section
to this Section. |
boolean |
addAll(Collection collection)
Adds a collection of Elements
to this Section. |
MarkedSection |
addMarkedSection()
Adds a marked section. |
Section |
addSection(float indentation,
Paragraph title)
Creates a Section, adds it to this Section and returns it. |
Section |
addSection(float indentation,
Paragraph title,
int numberDepth)
Creates a Section, adds it to this Section and returns it. |
Section |
addSection(float indentation,
String title)
Adds a Section to this Section and returns it. |
Section |
addSection(float indentation,
String title,
int numberDepth)
Adds a Section to this Section and returns it. |
Section |
addSection(Paragraph title)
Creates a Section, adds it to this Section and returns it. |
Section |
addSection(Paragraph title,
int numberDepth)
Creates a Section, add it to this Section and returns it. |
Section |
addSection(String title)
Adds a Section to this Section and returns it. |
Section |
addSection(String title,
int numberDepth)
Adds a Section to this Section and returns it. |
static Paragraph |
constructTitle(Paragraph title,
ArrayList numbers,
int numberDepth,
int numberStyle)
Constructs a Paragraph that will be used as title for a Section or Chapter. |
void |
flushContent()
Flushes the content that has been added. |
Paragraph |
getBookmarkTitle()
Gets the bookmark title. |
ArrayList |
getChunks()
Gets all the chunks in this element. |
int |
getDepth()
Returns the depth of this section. |
float |
getIndentation()
Returns the indentation of the content of this Section. |
float |
getIndentationLeft()
Returns the indentation of this Section on the left side. |
float |
getIndentationRight()
Returns the indentation of this Section on the right side. |
int |
getNumberDepth()
Returns the numberdepth of this Section. |
int |
getNumberStyle()
Gets the style used for numbering sections. |
Paragraph |
getTitle()
Returns the title, preceded by a certain number of sectionnumbers. |
boolean |
isBookmarkOpen()
Getter for property bookmarkOpen. |
boolean |
isChapter()
Checks if this object is a Chapter. |
boolean |
isComplete()
Indicates if the element is complete or not. |
boolean |
isContent()
Checks if this element is a content object. |
boolean |
isNestable()
Checks if this element is nestable. |
boolean |
isNotAddedYet()
Indicates if this is the first time the section is added. |
boolean |
isSection()
Checks if this object is a Section. |
boolean |
isTriggerNewPage()
Getter for property bookmarkOpen. |
void |
newPage()
Adds a new page to the section. |
boolean |
process(ElementListener listener)
Processes the element by adding it (or the different parts) to an ElementListener. |
void |
setBookmarkOpen(boolean bookmarkOpen)
Setter for property bookmarkOpen. |
void |
setBookmarkTitle(String bookmarkTitle)
Sets the bookmark title. |
void |
setChapterNumber(int number)
Changes the Chapter number. |
void |
setComplete(boolean complete)
If you invoke setComplete(false), you indicate that the content of the object isn't complete yet; it can be added to the document partially, but more will follow. |
void |
setIndentation(float indentation)
Sets the indentation of the content of this Section. |
void |
setIndentationLeft(float indentation)
Sets the indentation of this Section on the left side. |
void |
setIndentationRight(float indentation)
Sets the indentation of this Section on the right side. |
void |
setNotAddedYet(boolean notAddedYet)
Sets the indication if the section was already added to the document. |
void |
setNumberDepth(int numberDepth)
Sets the depth of the sectionnumbers that will be shown preceding the title. |
void |
setNumberStyle(int numberStyle)
Sets the style for numbering sections. |
void |
setTitle(Paragraph title)
Sets the title of this section. |
void |
setTriggerNewPage(boolean triggerNewPage)
Setter for property triggerNewPage. |
int |
type()
Gets the type of the text element. |
| Methods inherited from class java.util.ArrayList |
addAll, clear, clone, contains, ensureCapacity, get, indexOf, isEmpty, lastIndexOf, remove, set, size, toArray, toArray, trimToSize |
| Methods inherited from class java.util.AbstractList |
equals, hashCode, iterator, listIterator, listIterator, subList |
| Methods inherited from class java.util.AbstractCollection |
containsAll, remove, removeAll, retainAll, toString |
| Methods inherited from class java.lang.Object |
getClass, notify, notifyAll, wait, wait, wait |
| Methods inherited from interface com.lowagie.text.Element |
toString |
| Methods inherited from interface java.util.List |
containsAll, equals, hashCode, iterator, listIterator, listIterator, remove, removeAll, retainAll, subList |
| Field Detail |
public static final int NUMBERSTYLE_DOTTED
public static final int NUMBERSTYLE_DOTTED_WITHOUT_FINAL_DOT
| Method Detail |
public boolean process(ElementListener listener)
ElementListener.
process in interface Elementlistener - the ElementListener
true if the element was processed successfullypublic int type()
type in interface Elementpublic boolean isChapter()
Chapter.
true if it is a Chapter,
false if it is a Section.public boolean isSection()
Section.
true if it is a Section,
false if it is a Chapter.public ArrayList getChunks()
getChunks in interface ElementArrayListpublic boolean isContent()
Element
isContent in interface ElementElement.isContent()public boolean isNestable()
Element
isNestable in interface ElementElement.isNestable()
public void add(int index,
Object o)
Paragraph, List or Table
to this Section.
add in interface Listindex - index at which the specified element is to be insertedo - an object of type Paragraph, List or Table=
ClassCastException - if the object is not a Paragraph, List or Tablepublic boolean add(Object o)
Paragraph, List, Table or another Section
to this Section.
add in interface TextElementArrayo - an object of type Paragraph, List, Table or another Section
ClassCastException - if the object is not a Paragraph, List, Table or Sectionpublic boolean addAll(Collection collection)
Elements
to this Section.
addAll in interface Listcollection - a collection of Paragraphs, Lists and/or Tables
true if the action succeeded, false if not.
ClassCastException - if one of the objects isn't a Paragraph, List, Table
public Section addSection(float indentation,
Paragraph title,
int numberDepth)
Section, adds it to this Section and returns it.
indentation - the indentation of the new sectiontitle - the title of the new sectionnumberDepth - the numberDepth of the section
public Section addSection(float indentation,
Paragraph title)
Section, adds it to this Section and returns it.
indentation - the indentation of the new sectiontitle - the title of the new section
public Section addSection(Paragraph title,
int numberDepth)
Section, add it to this Section and returns it.
title - the title of the new sectionnumberDepth - the numberDepth of the section
public MarkedSection addMarkedSection()
public Section addSection(Paragraph title)
Section, adds it to this Section and returns it.
title - the title of the new section
public Section addSection(float indentation,
String title,
int numberDepth)
Section to this Section and returns it.
indentation - the indentation of the new sectiontitle - the title of the new sectionnumberDepth - the numberDepth of the section
public Section addSection(String title,
int numberDepth)
Section to this Section and returns it.
title - the title of the new sectionnumberDepth - the numberDepth of the section
public Section addSection(float indentation,
String title)
Section to this Section and returns it.
indentation - the indentation of the new sectiontitle - the title of the new section
public Section addSection(String title)
Section to this Section and returns it.
title - the title of the new section
public void setTitle(Paragraph title)
title - the new titlepublic Paragraph getTitle()
Paragraph
public static Paragraph constructTitle(Paragraph title,
ArrayList numbers,
int numberDepth,
int numberStyle)
title - the title of the sectionnumbers - a list of sectionnumbersnumberDepth - how many numbers have to be shownnumberStyle - the numbering style
public void setNumberDepth(int numberDepth)
If the numberdepth is 0, the sections will not be numbered. If the numberdepth is 1, the section will be numbered with their own number. If the numberdepth is higher (for instance x > 1), the numbers of x - 1 parents will be shown.
numberDepth - the new numberDepthpublic int getNumberDepth()
Section.
public void setNumberStyle(int numberStyle)
public int getNumberStyle()
public void setIndentationLeft(float indentation)
Section on the left side.
indentation - the indentationpublic float getIndentationLeft()
Section on the left side.
public void setIndentationRight(float indentation)
Section on the right side.
indentation - the indentationpublic float getIndentationRight()
Section on the right side.
public void setIndentation(float indentation)
Section.
indentation - the indentationpublic float getIndentation()
Section.
public void setBookmarkOpen(boolean bookmarkOpen)
bookmarkOpen - false if the bookmark children are not
visible.public boolean isBookmarkOpen()
public void setTriggerNewPage(boolean triggerNewPage)
triggerNewPage - true if a new page has to be triggered.public boolean isTriggerNewPage()
public void setBookmarkTitle(String bookmarkTitle)
bookmarkTitle - the bookmark titlepublic Paragraph getBookmarkTitle()
public void setChapterNumber(int number)
public int getDepth()
public boolean isNotAddedYet()
public void setNotAddedYet(boolean notAddedYet)
notAddedYet - public void flushContent()
LargeElement
flushContent in interface LargeElementLargeElement.flushContent()public boolean isComplete()
LargeElement
isComplete in interface LargeElementLargeElement.isComplete()public void setComplete(boolean complete)
LargeElement
setComplete in interface LargeElementcomplete - false if you'll be adding more data after
adding the object to the document.LargeElement.setComplete(boolean)public void newPage()
|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||