| java.lang.Object com.lowagie.text.MarkedObject com.lowagie.text.MarkedSection
MarkedSection | public class MarkedSection extends MarkedObject (Code) | | 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.
|
Constructor Summary | |
public | MarkedSection(Section section) Creates a MarkedObject with a Section or Chapter object. |
Method Summary | |
public void | add(int index, Object o) Adds a Paragraph , List or Table
to this Section . | public boolean | add(Object o) Adds a Paragraph , List , Table or another Section
to this Section . | public boolean | addAll(Collection collection) Adds a collection of Element s
to this Section . | public MarkedSection | addSection(float indentation, int numberDepth) Creates a Section , adds it to this Section and returns it. | public MarkedSection | addSection(float indentation) Creates a Section , adds it to this Section and returns it. | public MarkedSection | addSection(int numberDepth) Creates a Section , add it to this Section and returns it. | public MarkedSection | addSection() Creates a Section , adds it to this Section and returns it. | public boolean | process(ElementListener listener) Processes the element by adding it (or the different parts) to an
ElementListener . | public void | setBookmarkOpen(boolean bookmarkOpen) Setter for property bookmarkOpen. | public void | setBookmarkTitle(String bookmarkTitle) Sets the bookmark title. | public void | setIndentation(float indentation) Sets the indentation of the content of this Section . | public void | setIndentationLeft(float indentation) Sets the indentation of this Section on the left side. | public void | setIndentationRight(float indentation) Sets the indentation of this Section on the right side. | 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. | public void | setTitle(MarkedObject title) Sets the title of this section. | public void | setTriggerNewPage(boolean triggerNewPage) Setter for property triggerNewPage. | public MarkedObject | title() Gets the title of this MarkedSection. |
MarkedSection | public MarkedSection(Section section)(Code) | | Creates a MarkedObject with a Section or Chapter object.
Parameters: section - the marked section |
add | public void add(int index, Object o)(Code) | | Adds a Paragraph , List or Table
to this Section .
Parameters: index - index at which the specified element is to be inserted Parameters: 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)(Code) | | Adds a Paragraph , List , Table or another Section
to this Section .
Parameters: o - an object of type Paragraph , List , Table or another Section a boolean throws: ClassCastException - if the object is not a Paragraph , List , Table or Section |
addAll | public boolean addAll(Collection collection)(Code) | | Adds a collection of Element s
to this Section .
Parameters: collection - a collection of Paragraph s, List s and/or Table s 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)(Code) | | Creates a Section , adds it to this Section and returns it.
Parameters: indentation - the indentation of the new section Parameters: numberDepth - the numberDepth of the section a new Section object |
addSection | public MarkedSection addSection(float indentation)(Code) | | Creates a Section , adds it to this Section and returns it.
Parameters: indentation - the indentation of the new section a new Section object |
addSection | public MarkedSection addSection(int numberDepth)(Code) | | Creates a Section , add it to this Section and returns it.
Parameters: numberDepth - the numberDepth of the section a new Section object |
addSection | public MarkedSection addSection()(Code) | | Creates a Section , adds it to this Section and returns it.
a new Section object |
process | public boolean process(ElementListener listener)(Code) | | Processes the element by adding it (or the different parts) to an
ElementListener .
Parameters: listener - an ElementListener true if the element was processed successfully |
setBookmarkOpen | public void setBookmarkOpen(boolean bookmarkOpen)(Code) | | Setter for property bookmarkOpen.
Parameters: bookmarkOpen - false if the bookmark children are notvisible. |
setBookmarkTitle | public void setBookmarkTitle(String bookmarkTitle)(Code) | | 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 |
setIndentation | public void setIndentation(float indentation)(Code) | | Sets the indentation of the content of this Section .
Parameters: indentation - the indentation |
setIndentationLeft | public void setIndentationLeft(float indentation)(Code) | | Sets the indentation of this Section on the left side.
Parameters: indentation - the indentation |
setIndentationRight | public void setIndentationRight(float indentation)(Code) | | Sets the indentation of this Section on the right side.
Parameters: indentation - the indentation |
setNumberDepth | public void setNumberDepth(int numberDepth)(Code) | | 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 |
setTitle | public void setTitle(MarkedObject title)(Code) | | Sets the title of this section.
Parameters: title - the new title |
setTriggerNewPage | public void setTriggerNewPage(boolean triggerNewPage)(Code) | | Setter for property triggerNewPage.
Parameters: triggerNewPage - true if a new page has to be triggered. |
|
|