com.cete.dynamicpdf
Class Section

java.lang.Object
  com.cete.dynamicpdf.Section

public class Section
extends java.lang.Object

For more details on sections take a look at the Document Sectioning topic.

Licensing:
This class is a DynamicPDF Generator Community Edition feature.

View Example

Method Summary

NumberingStyle	getNumberingStyle() Gets the numbering style for the section.
int	getPageIndex() Gets the page index for the start of the section.
java.lang.String	getPrefix() Gets the prefix string for the section.
Template	getStampTemplate() Gets the StampTemplate for the section.
int	getStartingPageNumber() Gets the starting page number for the section.
Template	getTemplate() Gets the Template for the section.
void	setNumberingStyle(NumberingStyle value) Sets the numbering style for the section.
void	setPrefix(java.lang.String value) Sets the prefix string for the section.
void	setStampTemplate(Template value) Sets the StampTemplate for the section.
void	setStartingPageNumber(int value) Sets the starting page number for the section.
void	setTemplate(Template value) Sets the Template for the section.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

setNumberingStyle

public void setNumberingStyle(NumberingStyle value)

Sets the numbering style for the section.

Parameters:

value - the numbering style for the section.

getNumberingStyle

public NumberingStyle getNumberingStyle()

Gets the numbering style for the section.

Returns:

the numbering style for the section.

setPrefix

public void setPrefix(java.lang.String value)

Sets the prefix string for the section.

Parameters:

value - the prefix string for the section.

getPrefix

public java.lang.String getPrefix()

Gets the prefix string for the section.

Returns:

the prefix string for the section.

setStartingPageNumber

public void setStartingPageNumber(int value)

Sets the starting page number for the section. This must be a value greater than or equal to 1.

Parameters:

value - the starting page number for the section.

getStartingPageNumber

public int getStartingPageNumber()

Gets the starting page number for the section. This must be a value greater than or equal to 1.

Returns:

the starting page number for the section.

getPageIndex

public int getPageIndex()

Gets the page index for the start of the section.

Returns:

the page index for the start of the section.

setTemplate

public void setTemplate(Template value)

Sets the Template for the section. This template will be used for all pages in this section that have their Page.ApplySectionTemplate property set to true(the default value).

Parameters:

value - the Template for the section.

getTemplate

public Template getTemplate()

Gets the Template for the section. This template will be used for all pages in this section that have their Page.ApplySectionTemplate property set to true(the default value).

Returns:

the Template for the section.

getStampTemplate

public Template getStampTemplate()

Gets the StampTemplate for the section. This stamp template will be used for all pages in this section that have their

Returns:

the StampTemplate for the section.

See Also:

method.

setStampTemplate

public void setStampTemplate(Template value)

Sets the StampTemplate for the section. This stamp template will be used for all pages in this section that have their Page.setApplySectionTemplate(boolean value) method set to true(the default value).

Parameters:

value - the StampTemplate for the section.