Module com.github.librepdf.openpdf

Package org.openpdf.text

Class ChapterAutoNumber

java.lang.Object

java.util.AbstractCollection<Element>

java.util.AbstractList<Element>

java.util.ArrayList<Element>

org.openpdf.text.Section

org.openpdf.text.Chapter

org.openpdf.text.ChapterAutoNumber

All Implemented Interfaces:

Serializable, Cloneable, Iterable<Element>, Collection<Element>, List<Element>, RandomAccess, SequencedCollection<Element>, Element, LargeElement, TextElementArray

public class ChapterAutoNumber
extends Chapter

Chapter with auto numbering.

Author:

Michael Niedermair

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	numberSet	Is the chapter number already set?

Fields inherited from class org.openpdf.text.Section

addedCompletely, bookmarkOpen, bookmarkTitle, complete, indentation, indentationLeft, indentationRight, notAddedYet, numberDepth, numbers, numberStyle, NUMBERSTYLE_DOTTED, NUMBERSTYLE_DOTTED_WITHOUT_FINAL_DOT, subsections, title, triggerNewPage

Fields inherited from class java.util.AbstractList

modCount

Fields inherited from interface org.openpdf.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

Constructor	Description
ChapterAutoNumber(String title)	Create a new object.
ChapterAutoNumber(Paragraph para)	Create a new object.

Method Summary

Modifier and Type	Method	Description
Section	addSection(String title)	Create a new section for this chapter and ad it.
Section	addSection(Paragraph title)	Create a new section for this chapter and add it.
int	setAutomaticNumber(int number)	Changes the Chapter number.

Methods inherited from class org.openpdf.text.Chapter

isNestable, type

Methods inherited from class org.openpdf.text.Section

add, add, addAll, addMarkedSection, addSection, addSection, addSection, addSection, addSection, addSection, constructTitle, flushContent, getBookmarkTitle, getChunks, getDepth, getIndentation, getIndentationLeft, getIndentationRight, getNumberDepth, getNumberStyle, getTitle, isAddedCompletely, isBookmarkOpen, isChapter, isComplete, isContent, isNotAddedYet, isSection, isTriggerNewPage, newPage, process, setAddedCompletely, setBookmarkOpen, setBookmarkTitle, setChapterNumber, setComplete, setIndentation, setIndentationLeft, setIndentationRight, setNotAddedYet, setNumberDepth, setNumberStyle, setTitle, setTriggerNewPage

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 org.openpdf.text.Element

toString

Methods inherited from interface java.util.List

containsAll, reversed

Field Details

numberSet

protected boolean numberSet

Is the chapter number already set?

Since:

2.1.4

Constructor Details

ChapterAutoNumber

public ChapterAutoNumber(Paragraph para)

Create a new object.

Parameters:

para - the Chapter title (as a Paragraph)

ChapterAutoNumber

public ChapterAutoNumber(String title)

Create a new object.

Parameters:

title - the Chapter title (as a String)

Method Details

addSection

public Section addSection(String title)

Create a new section for this chapter and ad it.

Overrides:

addSection in class Section

Parameters:

title - the Section title (as a String)

Returns:

Returns the new section.

addSection

public Section addSection(Paragraph title)

Create a new section for this chapter and add it.

Overrides:

addSection in class Section

Parameters:

title - the Section title (as a Paragraph)

Returns:

Returns the new section.

setAutomaticNumber

public int setAutomaticNumber(int number)

Changes the Chapter number.

Parameters:

number - the new chapter number

Returns:

updated chapter number

Since:

2.1.4