Package com.itextpdf.layout.element

Class AreaBreak

java.lang.Object

com.itextpdf.commons.actions.sequence.AbstractIdentifiableElement

com.itextpdf.layout.ElementPropertyContainer

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

com.itextpdf.layout.element.AreaBreak

All Implemented Interfaces:

IAbstractElement, IElement, IPropertyContainer

       public class AreaBreak extends AbstractElement<AreaBreak>
      

A layout object that terminates the current content area and creates a new one. If no PageSize is given, the new content area will have the same size as the current one.

Field Summary

Fields

Modifier and Type	Field	Description
protected PageSize	pageSize

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
AreaBreak()	Creates an AreaBreak.
AreaBreak(PageSize pageSize)	Creates an AreaBreak.
AreaBreak(AreaBreakType areaBreakType)	Creates an AreaBreak that terminates a specified area type.

Method Summary

Modifier and Type	Method	Description
PageSize	getPageSize()	Gets the page size.
AreaBreakType	getType()	Gets the type of area that this AreaBreak will terminate.
protected IRenderer	makeNewRenderer()	Creates a new renderer instance.
void	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

Field Details

pageSize

             protected PageSize pageSize
            

Constructor Details

AreaBreak

             public AreaBreak()
            

Creates an AreaBreak. The new content area will have the same size as the current one.

AreaBreak

             public AreaBreak
             (AreaBreakType areaBreakType)
            

Creates an AreaBreak that terminates a specified area type.

Parameters:

areaBreakType - an area break type

AreaBreak

             public AreaBreak
             (PageSize pageSize)
            

Creates an AreaBreak. The new content area will have the specified page size.

Parameters:

pageSize - the size of the new content area

Method Details

getPageSize

             public PageSize getPageSize()
            

Gets the page size.

Returns:

the page size of the next content area.

setPageSize

             public void setPageSize
             (PageSize pageSize)
            

Sets the page size.

Parameters:

pageSize - the new page size of the next content area.

getType

             public AreaBreakType getType()
            

Gets the type of area that this AreaBreak will terminate.

Returns:

the current area break type

makeNewRenderer

             protected IRenderer makeNewRenderer()
            

Description copied from class: AbstractElement

Creates a new renderer instance.

Specified by:

makeNewRenderer in class AbstractElement<AreaBreak>

Returns:

new IRenderer