Class MarkedSection

java.lang.Object
com.lowagie.text.MarkedObject
com.lowagie.text.MarkedSection
All Implemented Interfaces:
Element

public class MarkedSection extends MarkedObject
Wrapper that allows to add properties to a Chapter/Section object. Before iText 1.5 every 'basic building block' implemented the MarkupAttributes interface. By setting attributes, you could add markup to the corresponding XML and/or HTML tag. This functionality was hardly used by anyone, so it was removed, and replaced by the MarkedObject functionality.
  • Field Details

    • title

      protected MarkedObject title
      This is the title of this section.
  • Constructor Details

    • MarkedSection

      public MarkedSection(Section section)
      Creates a MarkedObject with a Section or Chapter object.
      Parameters:
      section - the marked section
  • Method Details

    • add

      public void add(int index, Element 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(Element 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
    • process

      public boolean process(ElementListener listener)
      Processes the element by adding it (or the different parts) to an ElementListener.
      Specified by:
      process in interface Element
      Overrides:
      process in class MarkedObject
      Parameters:
      listener - an ElementListener
      Returns:
      true if the element was processed successfully
    • addAll

      public boolean addAll(Collection<? extends Element> 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
    • addSection

      public MarkedSection addSection(float indentation, int numberDepth)
      Creates a Section, adds it to this Section and returns it.
      Parameters:
      indentation - the indentation of the new section
      numberDepth - the numberDepth of the section
      Returns:
      a new Section object
    • addSection

      public MarkedSection addSection(float indentation)
      Creates a Section, adds it to this Section and returns it.
      Parameters:
      indentation - the indentation of the new section
      Returns:
      a new Section object
    • addSection

      public MarkedSection addSection(int numberDepth)
      Creates a Section, add it to this Section and returns it.
      Parameters:
      numberDepth - the numberDepth of the section
      Returns:
      a new Section object
    • addSection

      public MarkedSection addSection()
      Creates a Section, adds it to this Section and returns it.
      Returns:
      a new Section object
    • getTitle

      public MarkedObject getTitle()
      Gets the title of this MarkedSection.
      Returns:
      a MarkObject with a Paragraph containing the title of a Section
      Since:
      iText 2.0.8
    • setTitle

      public void setTitle(MarkedObject title)
      Sets the title of this section.
      Parameters:
      title - the new title
    • 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
    • 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
    • setIndentation

      public void setIndentation(float indentation)
      Sets the indentation of the content of this Section.
      Parameters:
      indentation - the indentation
    • setBookmarkOpen

      public void setBookmarkOpen(boolean bookmarkOpen)
      Setter for property bookmarkOpen.
      Parameters:
      bookmarkOpen - false if the bookmark children are not visible.
    • setTriggerNewPage

      public void setTriggerNewPage(boolean triggerNewPage)
      Setter for property triggerNewPage.
      Parameters:
      triggerNewPage - true if a new page has to be triggered.
    • 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
    • newPage

      public void newPage()
      Adds a new page to the section.
      Since:
      2.1.1