Package com.itextpdf.layout.element

Class SectionBreak

java.lang.Object

com.itextpdf.commons.actions.sequence.AbstractIdentifiableElement

com.itextpdf.layout.ElementPropertyContainer

com.itextpdf.layout.element.AbstractElement<SectionBreak>

com.itextpdf.layout.element.SectionBreak

All Implemented Interfaces:

IAbstractElement, IElement, IPropertyContainer

       public class SectionBreak extends AbstractElement<SectionBreak>
      

A layout object that terminates the current page content if any and starts the new page.

If no PageSize and PageMarginBoxes are given, the new content section will have default page size and page margins.

Specified (or default if not specified) PageSize and PageMarginBoxes will be applied for all next pages until it'll be overridden by other SectionBreak or AreaBreak elements.

Field Summary

Fields inherited from class com.itextpdf.layout.element.AbstractElement

childElements, nextRenderer, styles

Fields inherited from class com.itextpdf.layout.ElementPropertyContainer

properties

Constructor Summary

Constructors

Constructor	Description
SectionBreak()	Creates new SectionBreak instance.
SectionBreak(PageSize pageSize)	Creates new SectionBreak instance.
SectionBreak(PageSize pageSize, PageMarginBoxes pageMarginBoxes)	Creates new SectionBreak instance.
SectionBreak(PageMarginBoxes pageMarginBoxes)	Creates new SectionBreak instance.

Method Summary

Modifier and Type	Method	Description
FootnotesProperties	getFootnotesProperties()	Gets FootnotesProperties specified for the document via SectionBreak to customize footnotes.
PageMarginBoxes	getPageMargins()	Gets the page margins.
PageSize	getPageSize()	Gets the page size.
protected IRenderer	makeNewRenderer()	Creates a new renderer instance.
SectionBreak	setFootnotesProperties(FootnotesProperties footnotesProperties)	Sets FootnotesProperties for the document.
SectionBreak	setPageMargins(PageMarginBoxes pageMarginBoxes)	Sets the page margins.
SectionBreak	setPageSize(PageSize pageSize)	Sets the page size.

Methods inherited from class com.itextpdf.layout.element.AbstractElement

addStyle, createRendererSubTree, getChildren, getProperty, getRenderer, hasProperty, isEmpty, setAction, setNextRenderer, setPageNumber

Methods inherited from class com.itextpdf.layout.ElementPropertyContainer

deleteOwnProperty, getDefaultProperty, getOwnProperty, getSplitCharacters, getStrokeColor, getStrokeWidth, getTextRenderingMode, getTransparentStrokeColor, hasOwnProperty, setBackgroundColor, setBackgroundColor, setBackgroundColor, setBackgroundColor, setBackgroundImage, setBackgroundImage, setBaseDirection, setBorder, setBorderBottom, setBorderBottomLeftRadius, setBorderBottomRightRadius, setBorderLeft, setBorderRadius, setBorderRight, setBorderTop, setBorderTopLeftRadius, setBorderTopRightRadius, setCharacterSpacing, setDashPattern, setDestination, setFixedPosition, setFixedPosition, setFixedPosition, setFixedPosition, setFont, setFontColor, setFontColor, setFontColor, setFontFamily, setFontFamily, setFontKerning, setFontScript, setFontSize, setHorizontalAlignment, setHyphenation, setLineThrough, setOpacity, setProperty, setRelativePosition, setSplitCharacters, setStrokeColor, setStrokeColor, setStrokeColor, setStrokeWidth, setTextAlignment, setTextRenderingMode, setUnderline, setUnderline, setUnderline, setUnderline, setUnderline, setWordSpacing, simulateBold, simulateItalic

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.itextpdf.layout.IPropertyContainer

deleteOwnProperty, getDefaultProperty, getOwnProperty, hasOwnProperty, setProperty

Constructor Details

SectionBreak

             public SectionBreak()
            

Creates new SectionBreak instance.

The new content section will have default page size and page margins.

SectionBreak

             public SectionBreak
             (PageSize pageSize)
            

Creates new SectionBreak instance.

The new content section will have the specified page size and default page margins.

Parameters:

pageSize - PageSize page size of the new content section

SectionBreak

             public SectionBreak
             (PageMarginBoxes pageMarginBoxes)
            

Creates new SectionBreak instance.

The new content section will have the specified page margins and default page size.

Parameters:

pageMarginBoxes - PageMarginBoxes page margins of the new content section

SectionBreak

             public SectionBreak
             (PageSize pageSize, PageMarginBoxes pageMarginBoxes)
            

Creates new SectionBreak instance.

The new content section will have the specified page size and page margins.

Parameters:

pageSize - PageSize page size of the new content section

pageMarginBoxes - PageMarginBoxes page margins of the new content section

Method Details

getPageSize

             public PageSize getPageSize()
            

Gets the page size.

Returns:

the page size of the next content section

setPageSize

             public SectionBreak setPageSize
             (PageSize pageSize)
            

Sets the page size.

Parameters:

pageSize - the new page size of the next content section

Returns:

this same instance

getPageMargins

             public PageMarginBoxes getPageMargins()
            

Gets the page margins.

Returns:

the page margins of the next content section

setPageMargins

             public SectionBreak setPageMargins
             (PageMarginBoxes pageMarginBoxes)
            

Sets the page margins.

Parameters:

pageMarginBoxes - the page margins of the next content section

Returns:

this same instance

getFootnotesProperties

             public FootnotesProperties getFootnotesProperties()
            

Gets FootnotesProperties specified for the document via SectionBreak to customize footnotes.

Returns:

FootnotesProperties specified for the document

setFootnotesProperties

             public SectionBreak setFootnotesProperties
             (FootnotesProperties footnotesProperties)
            

Sets FootnotesProperties for the document.

Parameters:

footnotesProperties - FootnotesProperties to customize footnotes

Returns:

this same SectionBreak instance

makeNewRenderer

             protected IRenderer makeNewRenderer()
            

Description copied from class: AbstractElement

Creates a new renderer instance.

Specified by:

makeNewRenderer in class AbstractElement<SectionBreak>

Returns:

new IRenderer