Package com.lowagie.text
Class Section
- All Implemented Interfaces:
Element
,LargeElement
,TextElementArray
,Serializable
,Cloneable
,Iterable<Element>
,Collection<Element>
,List<Element>
,RandomAccess
,SequencedCollection<Element>
- Direct Known Subclasses:
Chapter
A
Section
is a part of a Document
containing other Section
s,
Paragraph
s, List
and/or Table
s.
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);
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected boolean
Indicates if the Section was added completely to the document.protected boolean
false if the bookmark children are not visibleprotected String
The bookmark title if different from the content titleprotected boolean
Indicates if the Section will be complete once added to the document.protected float
The additional indentation of the content of this section.protected float
The indentation of this section on the left side.protected float
The indentation of this section on the right side.protected boolean
Indicates if this is the first time the section was added.protected int
The number of sectionnumbers that has to be shown before the section title.This is the complete list of sectionnumbers of this section and the parents of this section.protected int
The style for sectionnumbers.static final int
A possible number style.static final int
A possible number style.private static final long
A serial version uid.protected int
This is the number of subsections.protected Paragraph
The title of this section.protected boolean
true if the section has to trigger a new pageFields inherited from class java.util.AbstractList
modCount
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, FOOTNOTE, HEADER, IMGRAW, IMGTEMPLATE, JBIG2, JPEG, JPEG2000, KEYWORDS, LIST, LISTITEM, MARKED, MODIFICATIONDATE, MULTI_COLUMN_TEXT, PARAGRAPH, PHRASE, PRODUCER, PTABLE, RECTANGLE, ROW, SECTION, SUBJECT, TABLE, TITLE, YMARK
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
Adds aParagraph
,List
orTable
to thisSection
.boolean
Adds aParagraph
,List
,Table
or anotherSection
to thisSection
.boolean
addAll
(Collection<? extends Element> collection) Adds a collection ofElement
s to thisSection
.Adds a marked section.addSection
(float indentation, Paragraph title) Creates aSection
, adds it to thisSection
and returns it.addSection
(float indentation, Paragraph title, int numberDepth) Creates aSection
, adds it to thisSection
and returns it.addSection
(float indentation, String title) Adds aSection
to thisSection
and returns it.addSection
(float indentation, String title, int numberDepth) Adds aSection
to thisSection
and returns it.addSection
(Paragraph title) Creates aSection
, adds it to thisSection
and returns it.addSection
(Paragraph title, int numberDepth) Creates aSection
, add it to thisSection
and returns it.addSection
(String title) Adds aSection
to thisSection
and returns it.addSection
(String title, int numberDepth) Adds aSection
to thisSection
and returns it.static Paragraph
constructTitle
(Paragraph title, List<Integer> numbers, int numberDepth, int numberStyle) Constructs a Paragraph that will be used as title for a Section or Chapter.void
Flushes the content that has been added.Gets the bookmark title.Gets all the chunks in this element.int
getDepth()
Returns the depth of this section.float
Returns the indentation of the content of thisSection
.float
Returns the indentation of thisSection
on the left side.float
Returns the indentation of thisSection
on the right side.int
Returns the numberdepth of thisSection
.int
Gets the style used for numbering sections.getTitle()
Returns the title, preceded by a certain number of sectionnumbers.protected boolean
boolean
Getter for property bookmarkOpen.boolean
Checks if this object is aChapter
.boolean
Indicates if the element is complete or not.boolean
Checks if this element is a content object.boolean
Checks if this element is nestable.boolean
Indicates if this is the first time the section is added.boolean
Checks if this object is aSection
.boolean
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 anElementListener
.protected void
setAddedCompletely
(boolean addedCompletely) 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 thisSection
.void
setIndentationLeft
(float indentation) Sets the indentation of thisSection
on the left side.void
setIndentationRight
(float indentation) Sets the indentation of thisSection
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.private void
setNumbers
(int number, List<Integer> numbers) Sets the number of this section.void
setNumberStyle
(int numberStyle) Sets the style for numbering sections.void
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, addFirst, addLast, clear, clone, contains, ensureCapacity, equals, forEach, get, getFirst, getLast, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeFirst, removeIf, removeLast, removeRange, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray, trimToSize
Methods inherited from class java.util.AbstractCollection
containsAll, toString
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface java.util.Collection
parallelStream, stream, toArray
Methods inherited from interface java.util.List
containsAll, reversed
-
Field Details
-
NUMBERSTYLE_DOTTED
public static final int NUMBERSTYLE_DOTTEDA possible number style. The default number style: "1.2.3."- Since:
- iText 2.0.8
- See Also:
-
NUMBERSTYLE_DOTTED_WITHOUT_FINAL_DOT
public static final int NUMBERSTYLE_DOTTED_WITHOUT_FINAL_DOTA possible number style. For instance: "1.2.3"- Since:
- iText 2.0.8
- See Also:
-
serialVersionUID
private static final long serialVersionUIDA serial version uid.- See Also:
-
title
The title of this section. -
bookmarkTitle
The bookmark title if different from the content title -
numberDepth
protected int numberDepthThe number of sectionnumbers that has to be shown before the section title. -
numberStyle
protected int numberStyleThe style for sectionnumbers.- Since:
- iText 2.0.8
-
indentationLeft
protected float indentationLeftThe indentation of this section on the left side. -
indentationRight
protected float indentationRightThe indentation of this section on the right side. -
indentation
protected float indentationThe additional indentation of the content of this section. -
bookmarkOpen
protected boolean bookmarkOpenfalse if the bookmark children are not visible -
triggerNewPage
protected boolean triggerNewPagetrue if the section has to trigger a new page -
subsections
protected int subsectionsThis is the number of subsections. -
numbers
This is the complete list of sectionnumbers of this section and the parents of this section. -
complete
protected boolean completeIndicates if the Section will be complete once added to the document.- Since:
- iText 2.0.8
-
addedCompletely
protected boolean addedCompletelyIndicates if the Section was added completely to the document.- Since:
- iText 2.0.8
-
notAddedYet
protected boolean notAddedYetIndicates if this is the first time the section was added.- Since:
- iText 2.0.8
-
-
Constructor Details
-
Section
protected Section()Constructs a newSection
. -
Section
Constructs a newSection
.- Parameters:
title
- aParagraph
numberDepth
- the numberDepth
-
-
Method Details
-
constructTitle
public static Paragraph constructTitle(Paragraph title, List<Integer> numbers, int numberDepth, int numberStyle) Constructs a Paragraph that will be used as title for a Section or Chapter.- Parameters:
title
- the title of the sectionnumbers
- a list of sectionnumbersnumberDepth
- how many numbers have to be shownnumberStyle
- the numbering style- Returns:
- a Paragraph object
- Since:
- iText 2.0.8
-
process
Processes the element by adding it (or the different parts) to anElementListener
. -
type
public int type()Gets the type of the text element. -
isChapter
public boolean isChapter()Checks if this object is aChapter
.- Returns:
true
if it is aChapter
,false
if it is aSection
.
-
isSection
public boolean isSection()Checks if this object is aSection
.- Returns:
true
if it is aSection
,false
if it is aChapter
.
-
getChunks
Gets all the chunks in this element. -
isContent
public boolean isContent()Description copied from interface:Element
Checks if this element is a content object. If not, it's a metadata object. -
isNestable
public boolean isNestable()Description copied from interface:Element
Checks if this element is nestable.- Specified by:
isNestable
in interfaceElement
- Returns:
- true if this element can be nested inside other elements.
- Since:
- iText 2.0.8
- See Also:
-
add
Adds aParagraph
,List
orTable
to thisSection
. -
add
Adds aParagraph
,List
,Table
or anotherSection
to thisSection
.- Specified by:
add
in interfaceCollection<Element>
- Specified by:
add
in interfaceList<Element>
- Specified by:
add
in interfaceTextElementArray
- Overrides:
add
in classArrayList<Element>
- Parameters:
o
- an object of typeParagraph
,List
,Table
or anotherSection
- Returns:
- a boolean
- Throws:
ClassCastException
- if the object is not aParagraph
,List
,Table
orSection
-
addAll
Adds a collection ofElement
s to thisSection
.- Specified by:
addAll
in interfaceCollection<Element>
- Specified by:
addAll
in interfaceList<Element>
- Overrides:
addAll
in classArrayList<Element>
- Parameters:
collection
- a collection ofParagraph
s,List
s and/orTable
s- Returns:
true
if the action succeeded,false
if not.- Throws:
ClassCastException
- if one of the objects isn't aParagraph
,List
,Table
-
addSection
Creates aSection
, adds it to thisSection
and returns it.- Parameters:
indentation
- the indentation of the new sectiontitle
- the title of the new sectionnumberDepth
- the numberDepth of the section- Returns:
- a new Section object
-
addSection
Creates aSection
, adds it to thisSection
and returns it.- Parameters:
indentation
- the indentation of the new sectiontitle
- the title of the new section- Returns:
- a new Section object
-
addSection
Creates aSection
, add it to thisSection
and returns it.- Parameters:
title
- the title of the new sectionnumberDepth
- the numberDepth of the section- Returns:
- a new Section object
-
addMarkedSection
Adds a marked section. For use in class MarkedSection only!- Returns:
- an object of
MarkedSection
-
addSection
Creates aSection
, adds it to thisSection
and returns it.- Parameters:
title
- the title of the new section- Returns:
- a new Section object
-
addSection
Adds aSection
to thisSection
and returns it.- Parameters:
indentation
- the indentation of the new sectiontitle
- the title of the new sectionnumberDepth
- the numberDepth of the section- Returns:
- a new Section object
-
addSection
Adds aSection
to thisSection
and returns it.- Parameters:
title
- the title of the new sectionnumberDepth
- the numberDepth of the section- Returns:
- a new Section object
-
addSection
Adds aSection
to thisSection
and returns it.- Parameters:
indentation
- the indentation of the new sectiontitle
- the title of the new section- Returns:
- a new Section object
-
addSection
Adds aSection
to thisSection
and returns it.- Parameters:
title
- the title of the new section- Returns:
- a new Section object
-
getTitle
Returns the title, preceded by a certain number of sectionnumbers.- Returns:
- a
Paragraph
-
setTitle
Sets the title of this section.- Parameters:
title
- the new title
-
getNumberDepth
public int getNumberDepth()Returns the numberdepth of thisSection
.- Returns:
- the numberdepth
-
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
-
getNumberStyle
public int getNumberStyle()Gets the style used for numbering sections.- Returns:
- a value corresponding with a numbering style
- Since:
- iText 2.0.8
-
setNumberStyle
public void setNumberStyle(int numberStyle) Sets the style for numbering sections. Possible values are NUMBERSTYLE_DOTTED: 1.2.3. (the default) or NUMBERSTYLE_DOTTED_WITHOUT_FINAL_DOT: 1.2.3- Parameters:
numberStyle
-numberStyle
- Since:
- iText 2.0.8
-
getIndentationLeft
public float getIndentationLeft()Returns the indentation of thisSection
on the left side.- Returns:
- the indentation
-
setIndentationLeft
public void setIndentationLeft(float indentation) Sets the indentation of thisSection
on the left side.- Parameters:
indentation
- the indentation
-
getIndentationRight
public float getIndentationRight()Returns the indentation of thisSection
on the right side.- Returns:
- the indentation
-
setIndentationRight
public void setIndentationRight(float indentation) Sets the indentation of thisSection
on the right side.- Parameters:
indentation
- the indentation
-
getIndentation
public float getIndentation()Returns the indentation of the content of thisSection
.- Returns:
- the indentation
-
setIndentation
public void setIndentation(float indentation) Sets the indentation of the content of thisSection
.- Parameters:
indentation
- the indentation
-
isBookmarkOpen
public boolean isBookmarkOpen()Getter for property bookmarkOpen.- Returns:
- Value of property bookmarkOpen.
-
setBookmarkOpen
public void setBookmarkOpen(boolean bookmarkOpen) Setter for property bookmarkOpen.- Parameters:
bookmarkOpen
- false if the bookmark children are not visible.
-
isTriggerNewPage
public boolean isTriggerNewPage()Getter for property bookmarkOpen.- Returns:
- Value of property triggerNewPage.
-
setTriggerNewPage
public void setTriggerNewPage(boolean triggerNewPage) Setter for property triggerNewPage.- Parameters:
triggerNewPage
- true if a new page has to be triggered.
-
getBookmarkTitle
Gets the bookmark title.- Returns:
- the bookmark title
-
setBookmarkTitle
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.- Parameters:
number
- new chapter number
-
getDepth
public int getDepth()Returns the depth of this section.- Returns:
- the depth
-
setNumbers
Sets the number of this section.- Parameters:
number
- the number of this sectionnumbers
- anArrayList
, containing the numbers of the Parent
-
isNotAddedYet
public boolean isNotAddedYet()Indicates if this is the first time the section is added.- Returns:
- true if the section wasn't added yet
- Since:
- iText2.0.8
-
setNotAddedYet
public void setNotAddedYet(boolean notAddedYet) Sets the indication if the section was already added to the document.- Parameters:
notAddedYet
-notAddedYet
- Since:
- iText2.0.8
-
isAddedCompletely
protected boolean isAddedCompletely()- Returns:
- boolean,
true
if section is added completely, elsefalse
- Since:
- iText 2.0.8
-
setAddedCompletely
protected void setAddedCompletely(boolean addedCompletely) - Parameters:
addedCompletely
-addedCompletely
- Since:
- iText 2.0.8
-
flushContent
public void flushContent()Description copied from interface:LargeElement
Flushes the content that has been added.- Specified by:
flushContent
in interfaceLargeElement
- Since:
- iText 2.0.8
- See Also:
-
isComplete
public boolean isComplete()Description copied from interface:LargeElement
Indicates if the element is complete or not.- Specified by:
isComplete
in interfaceLargeElement
- Returns:
- indicates if the element is complete according to the user.
- Since:
- iText 2.0.8
- See Also:
-
setComplete
public void setComplete(boolean complete) Description copied from interface:LargeElement
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. If you invoke setComplete(true), you indicate that you won't add any more data to the object.- Specified by:
setComplete
in interfaceLargeElement
- Parameters:
complete
- false if you'll be adding more data after adding the object to the document.- Since:
- iText 2.0.8
- See Also:
-
newPage
public void newPage()Adds a new page to the section.- Since:
- 2.1.1
-