| java.util.ArrayList
 com.lowagie.text.Section
All known Subclasses: com.lowagie.text.Chapter,
| Section | | public class Section extends ArrayList implements TextElementArray(Code) | | 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);
|
| Constructor Summary | |
| protected | Section()
Constructs a new Section. | | protected | Section(Paragraph title, int numberDepth)
Constructs a new Section. |
| Method Summary | |
| public void | add(int index, Object o)
Adds a Paragraph, List or Table
to this Section. | | public boolean | add(Object o)
Adds a Paragraph, List, Table or another Section
to this Section. | | public boolean | addAll(Collection collection)
Adds a collection of Elements
to this Section. | | public MarkedSection | addMarkedSection()
Adds a marked section. | | public Section | addSection(float indentation, Paragraph title, int numberDepth)
Creates a Section, adds it to this Section and returns it. | | public Section | addSection(float indentation, Paragraph title)
Creates a Section, adds it to this Section and returns it. | | public Section | addSection(Paragraph title, int numberDepth)
Creates a Section, add it to this Section and returns it. | | public Section | addSection(Paragraph title)
Creates a Section, adds it to this Section and returns it. | | public Section | addSection(float indentation, String title, int numberDepth)
Adds a Section to this Section and returns it. | | public Section | addSection(String title, int numberDepth)
Adds a Section to this Section and returns it. | | public Section | addSection(float indentation, String title)
Adds a Section to this Section and returns it. | | public Section | addSection(String title)
Adds a Section to this Section and returns it. | | public Section | addSection(java.util.Properties attributes)
Creates a given Section following a set of attributes and adds it to this one. | | public int | depth()
Returns the depth of this section. | | public Paragraph | getBookmarkTitle()
Gets the bookmark title. | | public ArrayList | getChunks()
Gets all the chunks in this element. | | public int | getDepth()
Returns the depth of this section. | | public float | getIndentation()
Returns the indentation of the content of this Section. | | public float | getIndentationLeft()
Returns the indentation of this Section on the left side. | | public float | getIndentationRight()
Returns the indentation of this Section on the right side. | | public int | getNumberDepth()
Returns the numberdepth of this Section. | | public Paragraph | getTitle()
Returns the title, preceeded by a certain number of sectionnumbers. | | public float | indentation()
Returns the indentation of the content of this Section. | | public float | indentationLeft()
Returns the indentation of this Section on the left side. | | public float | indentationRight()
Returns the indentation of this Section on the right side. | | public boolean | isBookmarkOpen()
Getter for property bookmarkOpen. | | public boolean | isChapter()
Checks if this object is a Chapter. | | public boolean | isSection()
Checks if this object is a Section. | | public boolean | isTriggerNewPage()
Getter for property bookmarkOpen. | | public int | numberDepth()
Returns the numberdepth of this Section. | | public boolean | process(ElementListener listener)
Processes the element by adding it (or the different parts) to an
ElementListener. | | public void | setBookmarkOpen(boolean bookmarkOpen)
Setter for property bookmarkOpen. | | public void | setBookmarkTitle(String bookmarkTitle)
Sets the bookmark title. | | public void | setChapterNumber(int number)
Changes the Chapter number. | | public void | setIndentation(float indentation)
Sets the indentation of the content of this Section. | | public void | setIndentationLeft(float indentation)
Sets the indentation of this Section on the left side. | | public void | setIndentationRight(float indentation)
Sets the indentation of this Section on the right side. | | public void | setNumberDepth(int numberDepth)
Sets the depth of the sectionnumbers that will be shown preceding the title.
If the numberdepth is 0, the sections will not be numbered. | | public void | setTitle(Paragraph title)
Sets the title of this section. | | public void | setTriggerNewPage(boolean triggerNewPage)
Setter for property triggerNewPage. | | public Paragraph | title()
Returns the title, preceeded by a certain number of sectionnumbers. | | public int | type()
Gets the type of the text element. |
| bookmarkOpen | | protected boolean bookmarkOpen(Code) | | false if the bookmark children are not visible
|
| bookmarkTitle | | protected String bookmarkTitle(Code) | | The bookmark title if different from the content title
|
| indentation | | protected float indentation(Code) | | The additional indentation of the content of this section.
|
| indentationLeft | | protected float indentationLeft(Code) | | The indentation of this section on the left side.
|
| indentationRight | | protected float indentationRight(Code) | | The indentation of this section on the right side.
|
| numberDepth | | protected int numberDepth(Code) | | The number of sectionnumbers that has to be shown before the section title.
|
| numbers | | protected ArrayList numbers(Code) | | This is the complete list of sectionnumbers of this section and the parents of this section.
|
| subsections | | protected int subsections(Code) | | This is the number of subsections.
|
| triggerNewPage | | protected boolean triggerNewPage(Code) | | true if the section has to trigger a new page
|
| Section | | protected Section()(Code) | | Constructs a new Section.
|
| Section | | protected Section(Paragraph title, int numberDepth)(Code) | | Constructs a new Section.
Parameters:
title - a Paragraph
Parameters:
numberDepth - the numberDepth |
| add | | public void add(int index, Object o)(Code) | | Adds a Paragraph, List or Table
to this Section.
Parameters:
index - index at which the specified element is to be inserted
Parameters:
o - an object of type Paragraph, List or Table=
throws:
ClassCastException - if the object is not a Paragraph, List or Table |
| add | | public boolean add(Object o)(Code) | | Adds a Paragraph, List, Table or another Section
to this Section.
Parameters:
o - an object of type Paragraph, List, Table or another Section a boolean
throws:
ClassCastException - if the object is not a Paragraph, List, Table or Section |
| addAll | | public boolean addAll(Collection collection)(Code) | | Adds a collection of Elements
to this Section.
Parameters:
collection - a collection of Paragraphs, Lists and/or Tables true if the action succeeded, false if not.
throws:
ClassCastException - if one of the objects isn't a Paragraph, List, Table |
| addMarkedSection | | public MarkedSection addMarkedSection()(Code) | | Adds a marked section. For use in class MarkedSection only!
|
| addSection | | public Section addSection(float indentation, Paragraph title, int numberDepth)(Code) | | Creates a Section, adds it to this Section and returns it.
Parameters:
indentation - the indentation of the new section
Parameters:
title - the title of the new section
Parameters:
numberDepth - the numberDepth of the section a new Section object |
| addSection | | public Section addSection(float indentation, Paragraph title)(Code) | | Creates a Section, adds it to this Section and returns it.
Parameters:
indentation - the indentation of the new section
Parameters:
title - the title of the new section a new Section object |
| addSection | | public Section addSection(Paragraph title, int numberDepth)(Code) | | Creates a Section, add it to this Section and returns it.
Parameters:
title - the title of the new section
Parameters:
numberDepth - the numberDepth of the section a new Section object |
| addSection | | public Section addSection(Paragraph title)(Code) | | Creates a Section, adds it to this Section and returns it.
Parameters:
title - the title of the new section a new Section object |
| addSection | | public Section addSection(float indentation, String title, int numberDepth)(Code) | | Adds a Section to this Section and returns it.
Parameters:
indentation - the indentation of the new section
Parameters:
title - the title of the new section
Parameters:
numberDepth - the numberDepth of the section a new Section object |
| addSection | | public Section addSection(String title, int numberDepth)(Code) | | Adds a Section to this Section and returns it.
Parameters:
title - the title of the new section
Parameters:
numberDepth - the numberDepth of the section a new Section object |
| addSection | | public Section addSection(float indentation, String title)(Code) | | Adds a Section to this Section and returns it.
Parameters:
indentation - the indentation of the new section
Parameters:
title - the title of the new section a new Section object |
| addSection | | public Section addSection(String title)(Code) | | Adds a Section to this Section and returns it.
Parameters:
title - the title of the new section a new Section object |
| addSection | | public Section addSection(java.util.Properties attributes)(Code) | | Creates a given Section following a set of attributes and adds it to this one.
Parameters:
attributes - the attributes a Section |
| getBookmarkTitle | | public Paragraph getBookmarkTitle()(Code) | | Gets the bookmark title.
the bookmark title |
| getChunks | | public ArrayList getChunks()(Code) | | Gets all the chunks in this element.
an ArrayList |
| getDepth | | public int getDepth()(Code) | | Returns the depth of this section.
the depth |
| getIndentation | | public float getIndentation()(Code) | | Returns the indentation of the content of this Section.
the indentation |
| getIndentationLeft | | public float getIndentationLeft()(Code) | | Returns the indentation of this Section on the left side.
the indentation |
| getIndentationRight | | public float getIndentationRight()(Code) | | Returns the indentation of this Section on the right side.
the indentation |
| getNumberDepth | | public int getNumberDepth()(Code) | | Returns the numberdepth of this Section.
the numberdepth |
| getTitle | | public Paragraph getTitle()(Code) | | Returns the title, preceeded by a certain number of sectionnumbers.
a Paragraph |
| isBookmarkOpen | | public boolean isBookmarkOpen()(Code) | | Getter for property bookmarkOpen.
Value of property bookmarkOpen. |
| isChapter | | public boolean isChapter()(Code) | | Checks if this object is a Chapter.
true if it is a Chapter,false if it is a Section. |
| isSection | | public boolean isSection()(Code) | | Checks if this object is a Section.
true if it is a Section,false if it is a Chapter. |
| isTriggerNewPage | | public boolean isTriggerNewPage()(Code) | | Getter for property bookmarkOpen.
Value of property triggerNewPage. |
| process | | public boolean process(ElementListener listener)(Code) | | Processes the element by adding it (or the different parts) to an
ElementListener.
Parameters:
listener - the ElementListener true if the element was processed successfully |
| setBookmarkOpen | | public void setBookmarkOpen(boolean bookmarkOpen)(Code) | | Setter for property bookmarkOpen.
Parameters:
bookmarkOpen - false if the bookmark children are notvisible. |
| setBookmarkTitle | | public void setBookmarkTitle(String bookmarkTitle)(Code) | | Sets the bookmark title. The bookmark title is the same as the section title but
can be changed with this method.
Parameters:
bookmarkTitle - the bookmark title |
| setChapterNumber | | public void setChapterNumber(int number)(Code) | | Changes the Chapter number.
|
| setIndentation | | public void setIndentation(float indentation)(Code) | | Sets the indentation of the content of this Section.
Parameters:
indentation - the indentation |
| setIndentationLeft | | public void setIndentationLeft(float indentation)(Code) | | Sets the indentation of this Section on the left side.
Parameters:
indentation - the indentation |
| setIndentationRight | | public void setIndentationRight(float indentation)(Code) | | Sets the indentation of this Section on the right side.
Parameters:
indentation - the indentation |
| setNumberDepth | | public void setNumberDepth(int numberDepth)(Code) | | Sets the depth of the sectionnumbers that will be shown preceding the title.
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.
Parameters:
numberDepth - the new numberDepth |
| setTitle | | public void setTitle(Paragraph title)(Code) | | Sets the title of this section.
Parameters:
title - the new title |
| setTriggerNewPage | | public void setTriggerNewPage(boolean triggerNewPage)(Code) | | Setter for property triggerNewPage.
Parameters:
triggerNewPage - true if a new page has to be triggered. |
| type | | public int type()(Code) | | Gets the type of the text element.
a type |
|
|