com.lowagie.text

Class Section

public class Section extends ArrayList implements TextElementArray

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
protected booleanbookmarkOpen
false if the bookmark children are not visible
protected StringbookmarkTitle
The bookmark title if different from the content title
protected floatindentation
The additional indentation of the content of this section.
protected floatindentationLeft
The indentation of this section on the left side.
protected floatindentationRight
The indentation of this section on the right side.
protected intnumberDepth
The number of sectionnumbers that has to be shown before the section title.
protected ArrayListnumbers
This is the complete list of sectionnumbers of this section and the parents of this section.
static longserialVersionUID
protected intsubsections
This is the number of subsections.
protected Paragraphtitle
The title of this section.
protected booleantriggerNewPage
true if the section has to trigger a new page
Constructor Summary
protected Section()
Constructs a new Section.
protected Section(Paragraph title, int numberDepth)
Constructs a new Section.
Method Summary
voidadd(int index, Object o)
Adds a Paragraph, List or Table to this Section.
booleanadd(Object o)
Adds a Paragraph, List, Table or another Section to this Section.
booleanaddAll(Collection collection)
Adds a collection of Elements to this Section.
MarkedSectionaddMarkedSection()
Adds a marked section.
SectionaddSection(float indentation, Paragraph title, int numberDepth)
Creates a Section, adds it to this Section and returns it.
SectionaddSection(float indentation, Paragraph title)
Creates a Section, adds it to this Section and returns it.
SectionaddSection(Paragraph title, int numberDepth)
Creates a Section, add it to this Section and returns it.
SectionaddSection(Paragraph title)
Creates a Section, adds it to this Section and returns it.
SectionaddSection(float indentation, String title, int numberDepth)
Adds a Section to this Section and returns it.
SectionaddSection(String title, int numberDepth)
Adds a Section to this Section and returns it.
SectionaddSection(float indentation, String title)
Adds a Section to this Section and returns it.
SectionaddSection(String title)
Adds a Section to this Section and returns it.
SectionaddSection(Properties attributes)
Creates a given Section following a set of attributes and adds it to this one.
intdepth()
Returns the depth of this section.
ParagraphgetBookmarkTitle()
Gets the bookmark title.
ArrayListgetChunks()
Gets all the chunks in this element.
intgetDepth()
Returns the depth of this section.
floatgetIndentation()
Returns the indentation of the content of this Section.
floatgetIndentationLeft()
Returns the indentation of this Section on the left side.
floatgetIndentationRight()
Returns the indentation of this Section on the right side.
intgetNumberDepth()
Returns the numberdepth of this Section.
ParagraphgetTitle()
Returns the title, preceeded by a certain number of sectionnumbers.
floatindentation()
Returns the indentation of the content of this Section.
floatindentationLeft()
Returns the indentation of this Section on the left side.
floatindentationRight()
Returns the indentation of this Section on the right side.
booleanisBookmarkOpen()
Getter for property bookmarkOpen.
booleanisChapter()
Checks if this object is a Chapter.
booleanisSection()
Checks if this object is a Section.
booleanisTriggerNewPage()
Getter for property bookmarkOpen.
intnumberDepth()
Returns the numberdepth of this Section.
booleanprocess(ElementListener listener)
Processes the element by adding it (or the different parts) to an ElementListener.
voidsetBookmarkOpen(boolean bookmarkOpen)
Setter for property bookmarkOpen.
voidsetBookmarkTitle(String bookmarkTitle)
Sets the bookmark title.
voidsetChapterNumber(int number)
Changes the Chapter number.
voidsetIndentation(float indentation)
Sets the indentation of the content of this Section.
voidsetIndentationLeft(float indentation)
Sets the indentation of this Section on the left side.
voidsetIndentationRight(float indentation)
Sets the indentation of this Section on the right side.
voidsetNumberDepth(int numberDepth)
Sets the depth of the sectionnumbers that will be shown preceding the title.
voidsetNumbers(int number, ArrayList numbers)
Sets the number of this section.
voidsetTitle(Paragraph title)
Sets the title of this section.
voidsetTriggerNewPage(boolean triggerNewPage)
Setter for property triggerNewPage.
Paragraphtitle()
Returns the title, preceeded by a certain number of sectionnumbers.
inttype()
Gets the type of the text element.

Field Detail

bookmarkOpen

protected boolean bookmarkOpen
false if the bookmark children are not visible

bookmarkTitle

protected String bookmarkTitle
The bookmark title if different from the content title

indentation

protected float indentation
The additional indentation of the content of this section.

indentationLeft

protected float indentationLeft
The indentation of this section on the left side.

indentationRight

protected float indentationRight
The indentation of this section on the right side.

numberDepth

protected int numberDepth
The number of sectionnumbers that has to be shown before the section title.

numbers

protected ArrayList numbers
This is the complete list of sectionnumbers of this section and the parents of this section.

serialVersionUID

private static final long serialVersionUID

subsections

protected int subsections
This is the number of subsections.

title

protected Paragraph title
The title of this section.

triggerNewPage

protected boolean triggerNewPage
true if the section has to trigger a new page

Constructor Detail

Section

protected Section()
Constructs a new Section.

Section

protected Section(Paragraph title, int numberDepth)
Constructs a new Section.

Parameters: title a Paragraph numberDepth the numberDepth

Method Detail

add

public void add(int index, Object o)
Adds a Paragraph, List or Table to this Section.

Parameters: index index at which the specified element is to be inserted 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)
Adds a Paragraph, List, Table or another Section to this Section.

Parameters: o an object of type Paragraph, List, Table or another Section

Returns: a boolean

Throws: ClassCastException if the object is not a Paragraph, List, Table or Section

addAll

public boolean addAll(Collection collection)
Adds a collection of Elements to this Section.

Parameters: collection a collection of Paragraphs, Lists and/or Tables

Returns: 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()
Adds a marked section. For use in class MarkedSection only!

addSection

public Section addSection(float indentation, Paragraph title, int numberDepth)
Creates a Section, adds it to this Section and returns it.

Parameters: indentation the indentation of the new section title the title of the new section numberDepth the numberDepth of the section

Returns: a new Section object

addSection

public Section addSection(float indentation, Paragraph title)
Creates a Section, adds it to this Section and returns it.

Parameters: indentation the indentation of the new section title the title of the new section

Returns: a new Section object

addSection

public Section addSection(Paragraph title, int numberDepth)
Creates a Section, add it to this Section and returns it.

Parameters: title the title of the new section numberDepth the numberDepth of the section

Returns: a new Section object

addSection

public Section addSection(Paragraph title)
Creates a Section, adds it to this Section and returns it.

Parameters: title the title of the new section

Returns: a new Section object

addSection

public Section addSection(float indentation, String title, int numberDepth)
Adds a Section to this Section and returns it.

Parameters: indentation the indentation of the new section title the title of the new section numberDepth the numberDepth of the section

Returns: a new Section object

addSection

public Section addSection(String title, int numberDepth)
Adds a Section to this Section and returns it.

Parameters: title the title of the new section numberDepth the numberDepth of the section

Returns: a new Section object

addSection

public Section addSection(float indentation, String title)
Adds a Section to this Section and returns it.

Parameters: indentation the indentation of the new section title the title of the new section

Returns: a new Section object

addSection

public Section addSection(String title)
Adds a Section to this Section and returns it.

Parameters: title the title of the new section

Returns: a new Section object

addSection

public Section addSection(Properties attributes)

Deprecated: Use ElementFactory.getSection(this, attributes)

Creates a given Section following a set of attributes and adds it to this one.

Parameters: attributes the attributes

Returns: a Section

depth

public int depth()

Deprecated: Use getDepth instead

Returns the depth of this section.

Returns: the depth

getBookmarkTitle

public Paragraph getBookmarkTitle()
Gets the bookmark title.

Returns: the bookmark title

getChunks

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

Returns: an ArrayList

getDepth

public int getDepth()
Returns the depth of this section.

Returns: the depth

getIndentation

public float getIndentation()
Returns the indentation of the content of this Section.

Returns: the indentation

getIndentationLeft

public float getIndentationLeft()
Returns the indentation of this Section on the left side.

Returns: the indentation

getIndentationRight

public float getIndentationRight()
Returns the indentation of this Section on the right side.

Returns: the indentation

getNumberDepth

public int getNumberDepth()
Returns the numberdepth of this Section.

Returns: the numberdepth

getTitle

public Paragraph getTitle()
Returns the title, preceeded by a certain number of sectionnumbers.

Returns: a Paragraph

indentation

public float indentation()

Deprecated: Use getIndentation instead

Returns the indentation of the content of this Section.

Returns: the indentation

indentationLeft

public float indentationLeft()

Deprecated: Use getIndentationLeft instead

Returns the indentation of this Section on the left side.

Returns: the indentation

indentationRight

public float indentationRight()

Deprecated: Use getIndentationRight instead

Returns the indentation of this Section on the right side.

Returns: the indentation

isBookmarkOpen

public boolean isBookmarkOpen()
Getter for property bookmarkOpen.

Returns: Value of property bookmarkOpen.

isChapter

public boolean isChapter()
Checks if this object is a Chapter.

Returns: true if it is a Chapter, false if it is a Section.

isSection

public boolean isSection()
Checks if this object is a Section.

Returns: true if it is a Section, false if it is a Chapter.

isTriggerNewPage

public boolean isTriggerNewPage()
Getter for property bookmarkOpen.

Returns: Value of property triggerNewPage.

numberDepth

public int numberDepth()

Deprecated: Use getNumberDepth instead

Returns the numberdepth of this Section.

Returns: the numberdepth

process

public boolean process(ElementListener listener)
Processes the element by adding it (or the different parts) to an ElementListener.

Parameters: listener the ElementListener

Returns: true if the element was processed successfully

setBookmarkOpen

public void setBookmarkOpen(boolean bookmarkOpen)
Setter for property bookmarkOpen.

Parameters: bookmarkOpen false if the bookmark children are not visible.

setBookmarkTitle

public void setBookmarkTitle(String bookmarkTitle)
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)
Changes the Chapter number.

setIndentation

public void setIndentation(float indentation)
Sets the indentation of the content of this Section.

Parameters: indentation the indentation

setIndentationLeft

public void setIndentationLeft(float indentation)
Sets the indentation of this Section on the left side.

Parameters: indentation the indentation

setIndentationRight

public void setIndentationRight(float indentation)
Sets the indentation of this Section on the right side.

Parameters: indentation the indentation

setNumberDepth

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. 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

setNumbers

private void setNumbers(int number, ArrayList numbers)
Sets the number of this section.

Parameters: number the number of this section numbers an ArrayList, containing the numbers of the Parent

setTitle

public void setTitle(Paragraph title)
Sets the title of this section.

Parameters: title the new title

setTriggerNewPage

public void setTriggerNewPage(boolean triggerNewPage)
Setter for property triggerNewPage.

Parameters: triggerNewPage true if a new page has to be triggered.

title

public Paragraph title()

Deprecated: Use getTitle instead

Returns the title, preceeded by a certain number of sectionnumbers.

Returns: a Paragraph

type

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

Returns: a type