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);
* Section.
*/
protected Section() {
title = new Paragraph();
numberDepth = 1;
title.setRole(new PdfName("H" + numberDepth));
}
/**
* Constructs a new Section.
*
* @param title a Paragraph
* @param numberDepth the numberDepth
*/
protected Section(final Paragraph title, final int numberDepth) {
this.numberDepth = numberDepth;
this.title = title;
title.setRole(new PdfName("H" + numberDepth));
}
// implementation of the Element-methods
/**
* Processes the element by adding it (or the different parts) to an
* ElementListener.
*
* @param listener the ElementListener
* @return true if the element was processed successfully
*/
public boolean process(final ElementListener listener) {
try {
Element element;
for (Object element2 : this) {
element = (Element)element2;
listener.add(element);
}
return true;
}
catch(DocumentException de) {
return false;
}
}
/**
* Gets the type of the text element.
*
* @return a type
*/
public int type() {
return Element.SECTION;
}
/**
* Checks if this object is a Chapter.
*
* @return true if it is a Chapter,
* false if it is a Section.
*/
public boolean isChapter() {
return type() == Element.CHAPTER;
}
/**
* Checks if this object is a Section.
*
* @return true if it is a Section,
* false if it is a Chapter.
*/
public boolean isSection() {
return type() == Element.SECTION;
}
/**
* Gets all the chunks in this element.
*
* @return an ArrayList
*/
public ListParagraph, List or Table
* to this Section.
*
* @param index index at which the specified element is to be inserted
* @param element an element of type Paragraph, List or Table=
* @throws ClassCastException if the object is not a Paragraph, List or Table
* @since 5.0.1 (signature changed to use Element)
*/
@Override
public void add(final int index, final Element element) {
if (isAddedCompletely()) {
throw new IllegalStateException(MessageLocalization.getComposedMessage("this.largeelement.has.already.been.added.to.the.document"));
}
try {
if (element.isNestable()) {
super.add(index, element);
}
else {
throw new ClassCastException(MessageLocalization.getComposedMessage("you.can.t.add.a.1.to.a.section", element.getClass().getName()));
}
}
catch(ClassCastException cce) {
throw new ClassCastException(MessageLocalization.getComposedMessage("insertion.of.illegal.element.1", cce.getMessage()));
}
}
/**
* Adds a Paragraph, List, Table or another Section
* to this Section.
*
* @param element an element of type Paragraph, List, Table or another Section
* @return a boolean
* @throws ClassCastException if the object is not a Paragraph, List, Table or Section
* @since 5.0.1 (signature changed to use Element)
*/
@Override
public boolean add(final Element element) {
if (isAddedCompletely()) {
throw new IllegalStateException(MessageLocalization.getComposedMessage("this.largeelement.has.already.been.added.to.the.document"));
}
try {
if (element.type() == Element.SECTION) {
Section section = (Section) element;
section.setNumbers(++subsections, numbers);
return super.add(section);
}
else if (element instanceof MarkedSection && ((MarkedObject)element).element.type() == Element.SECTION) {
MarkedSection mo = (MarkedSection)element;
Section section = (Section)mo.element;
section.setNumbers(++subsections, numbers);
return super.add(mo);
}
else if (element.isNestable()) {
return super.add(element);
}
else {
throw new ClassCastException(MessageLocalization.getComposedMessage("you.can.t.add.a.1.to.a.section", element.getClass().getName()));
}
}
catch(ClassCastException cce) {
throw new ClassCastException(MessageLocalization.getComposedMessage("insertion.of.illegal.element.1", cce.getMessage()));
}
}
/**
* Adds a collection of Elements
* to this Section.
*
* @param collection a collection of Paragraphs, Lists and/or Tables
* @return true if the action succeeded, false if not.
* @throws ClassCastException if one of the objects isn't a Paragraph, List, Table
*/
@Override
public boolean addAll(final Collection collection) {
if (collection.size() == 0)
return false;
for (Element element : collection) {
this.add(element);
}
return true;
}
// methods that return a Section
/**
* Creates a Section, adds it to this Section and returns it.
*
* @param indentation the indentation of the new section
* @param title the title of the new section
* @param numberDepth the numberDepth of the section
* @return a new Section object
*/
public Section addSection(final float indentation, final Paragraph title, final int numberDepth) {
if (isAddedCompletely()) {
throw new IllegalStateException(MessageLocalization.getComposedMessage("this.largeelement.has.already.been.added.to.the.document"));
}
Section section = new Section(title, numberDepth);
section.setIndentation(indentation);
add(section);
return section;
}
/**
* Creates a Section, adds it to this Section and returns it.
*
* @param indentation the indentation of the new section
* @param title the title of the new section
* @return a new Section object
*/
public Section addSection(final float indentation, final Paragraph title) {
return addSection(indentation, title, numberDepth + 1);
}
/**
* Creates a Section, add it to this Section and returns it.
*
* @param title the title of the new section
* @param numberDepth the numberDepth of the section
* @return a new Section object
*/
public Section addSection(final Paragraph title, final int numberDepth) {
return addSection(0, title, numberDepth);
}
/**
* Adds a marked section. For use in class MarkedSection only!
* @return the MarkedSection
*/
protected MarkedSection addMarkedSection() {
MarkedSection section = new MarkedSection(new Section(null, numberDepth + 1));
add(section);
return section;
}
/**
* Creates a Section, adds it to this Section and returns it.
*
* @param title the title of the new section
* @return a new Section object
*/
public Section addSection(final Paragraph title) {
return addSection(0, title, numberDepth + 1);
}
/**
* Adds a Section to this Section and returns it.
*
* @param indentation the indentation of the new section
* @param title the title of the new section
* @param numberDepth the numberDepth of the section
* @return a new Section object
*/
public Section addSection(final float indentation, final String title, final int numberDepth) {
return addSection(indentation, new Paragraph(title), numberDepth);
}
/**
* Adds a Section to this Section and returns it.
*
* @param title the title of the new section
* @param numberDepth the numberDepth of the section
* @return a new Section object
*/
public Section addSection(final String title, final int numberDepth) {
return addSection(new Paragraph(title), numberDepth);
}
/**
* Adds a Section to this Section and returns it.
*
* @param indentation the indentation of the new section
* @param title the title of the new section
* @return a new Section object
*/
public Section addSection(final float indentation, final String title) {
return addSection(indentation, new Paragraph(title));
}
/**
* Adds a Section to this Section and returns it.
*
* @param title the title of the new section
* @return a new Section object
*/
public Section addSection(final String title) {
return addSection(new Paragraph(title));
}
// public methods
/**
* Sets the title of this section.
*
* @param title the new title
*/
public void setTitle(final Paragraph title) {
this.title = title;
}
/**
* Returns the title, preceded by a certain number of sectionnumbers.
*
* @return a Paragraph
*/
public Paragraph getTitle() {
return constructTitle(title, numbers, numberDepth, numberStyle);
}
/**
* Constructs a Paragraph that will be used as title for a Section or Chapter.
* @param title the title of the section
* @param numbers a list of sectionnumbers
* @param numberDepth how many numbers have to be shown
* @param numberStyle the numbering style
* @return a Paragraph object
* @since iText 2.0.8
*/
public static Paragraph constructTitle(final Paragraph title, final ArrayList
* 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.
*
* @param numberDepth the new numberDepth
*/
public void setNumberDepth(final int numberDepth) {
this.numberDepth = numberDepth;
}
/**
* Returns the numberdepth of this Section.
*
* @return the numberdepth
*/
public int getNumberDepth() {
return numberDepth;
}
/**
* Sets the style for numbering sections.
* Possible values are {@link Section#NUMBERSTYLE_DOTTED}: 1.2.3. (the default)
* or {@link Section#NUMBERSTYLE_DOTTED_WITHOUT_FINAL_DOT}: 1.2.3
* @param numberStyle the style to use
* @since iText 2.0.8
*/
public void setNumberStyle(final int numberStyle) {
this.numberStyle = numberStyle;
}
/**
* Gets the style used for numbering sections.
* @since iText 2.0.8
* @return a value corresponding with a numbering style
*/
public int getNumberStyle() {
return numberStyle;
}
/**
* Sets the indentation of this Section on the left side.
*
* @param indentation the indentation
*/
public void setIndentationLeft(final float indentation) {
indentationLeft = indentation;
}
/**
* Returns the indentation of this Section on the left side.
*
* @return the indentation
*/
public float getIndentationLeft() {
return indentationLeft;
}
/**
* Sets the indentation of this Section on the right side.
*
* @param indentation the indentation
*/
public void setIndentationRight(final float indentation) {
indentationRight = indentation;
}
/**
* Returns the indentation of this Section on the right side.
*
* @return the indentation
*/
public float getIndentationRight() {
return indentationRight;
}
/**
* Sets the indentation of the content of this Section.
*
* @param indentation the indentation
*/
public void setIndentation(final float indentation) {
this.indentation = indentation;
}
/**
* Returns the indentation of the content of this Section.
*
* @return the indentation
*/
public float getIndentation() {
return indentation;
}
/** Setter for property bookmarkOpen.
* @param bookmarkOpen false if the bookmark children are not
* visible.
*/
public void setBookmarkOpen(final boolean bookmarkOpen) {
this.bookmarkOpen = bookmarkOpen;
}
/**
* Getter for property bookmarkOpen.
* @return Value of property bookmarkOpen.
*/
public boolean isBookmarkOpen() {
return bookmarkOpen;
}
/**
* Setter for property triggerNewPage.
* @param triggerNewPage true if a new page has to be triggered.
*/
public void setTriggerNewPage(final boolean triggerNewPage) {
this.triggerNewPage = triggerNewPage;
}
/**
* Getter for property bookmarkOpen.
* @return Value of property triggerNewPage.
*/
public boolean isTriggerNewPage() {
return triggerNewPage && notAddedYet;
}
/**
* Sets the bookmark title. The bookmark title is the same as the section title but
* can be changed with this method.
* @param bookmarkTitle the bookmark title
*/
public void setBookmarkTitle(final String bookmarkTitle) {
this.bookmarkTitle = bookmarkTitle;
}
/**
* Gets the bookmark title.
* @return the bookmark title
*/
public Paragraph getBookmarkTitle() {
if (bookmarkTitle == null)
return getTitle();
else
return new Paragraph(bookmarkTitle);
}
/**
* Changes the Chapter number.
* @param number the new number
*/
public void setChapterNumber(final int number) {
numbers.set(numbers.size() - 1, Integer.valueOf(number));
Object s;
for (IteratorArrayList, containing the numbers of the Parent
*/
private void setNumbers(final int number, final ArrayList