Package com.itextpdf.layout.renderer

Class SectionBreakRenderer

java.lang.Object

com.itextpdf.layout.renderer.AbstractBreakRenderer

com.itextpdf.layout.renderer.SectionBreakRenderer

All Implemented Interfaces:

IPropertyContainer, IRenderer

       public class SectionBreakRenderer extends AbstractBreakRenderer
      

Renderer for the SectionBreak layout element. Will terminate the current page content if any and start a new page.

Field Summary

Fields

Modifier and Type	Field	Description
protected LayoutArea	occupiedArea

Fields inherited from class com.itextpdf.layout.renderer.AbstractBreakRenderer

parent, properties

Constructor Summary

Constructors

Constructor	Description
SectionBreakRenderer(SectionBreak sectionBreak)	Creates new SectionBreakRenderer instance.

Method Summary

Modifier and Type	Method	Description
void	addChild(IRenderer renderer)	Logs a warning about unexpected use of SectionBreakRenderer if not ignored, because instances of this class are only used for terminating the current page content.
void	draw(DrawContext drawContext)	Logs a warning about unexpected use of SectionBreakRenderer if not ignored, because instances of this class are only used for terminating the current page content.
IPropertyContainer	getModelElement()	Gets the model element associated with this renderer.
IRenderer	getNextRenderer()	Gets a new instance of this class to be used as a next renderer, after this renderer is used, if IRenderer.layout(LayoutContext) is called more than once.
LayoutArea	getOccupiedArea()	Throws an UnsupportedOperationException if not ignored, because instances of this class are only used for terminating the current page content.
LayoutResult	layout(LayoutContext layoutContext)	This method simulates positioning of the renderer, including all of its children, and returns the LayoutResult, representing the layout result, including occupied area, status, i.e.
void	move(float dx, float dy)	Logs a warning about unexpected use of SectionBreakRenderer if not ignored, because instances of this class are only used for terminating the current page content.

Methods inherited from class com.itextpdf.layout.renderer.AbstractBreakRenderer

deleteOwnProperty, getChildRenderers, getDefaultProperty, getOwnProperty, getParent, getProperty, getProperty, hasOwnProperty, hasProperty, isFlushed, setParent, setProperty

Methods inherited from class java.lang.Object

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

Field Details

occupiedArea

             protected LayoutArea occupiedArea
            

Constructor Details

SectionBreakRenderer

             public SectionBreakRenderer
             (SectionBreak sectionBreak)
            

Creates new SectionBreakRenderer instance.

Parameters:

sectionBreak - the SectionBreak that will be rendered by this object

Method Details

addChild

             public void addChild
             (IRenderer renderer)
            

Logs a warning about unexpected use of SectionBreakRenderer if not ignored, because instances of this class are only used for terminating the current page content.

Parameters:

renderer - a child to be added

layout

             public LayoutResult layout
             (LayoutContext layoutContext)
            

Description copied from interface: IRenderer

This method simulates positioning of the renderer, including all of its children, and returns the LayoutResult, representing the layout result, including occupied area, status, i.e. if there was enough place to fit the renderer subtree, etc. LayoutResult can be extended to return custom layout results for custom elements, e.g. TextRenderer uses TextLayoutResult as its result. This method can be called standalone to learn how much area the renderer subtree needs, or can be called before IRenderer.draw(DrawContext), to prepare the renderer to be flushed to the output stream.

Parameters:

layoutContext - the description of layout area and any other additional information

Returns:

result of the layout process

draw

             public void draw
             (DrawContext drawContext)
            

Logs a warning about unexpected use of SectionBreakRenderer if not ignored, because instances of this class are only used for terminating the current page content.

Parameters:

drawContext - contains the PdfDocument to which the renderer subtree if flushed, the PdfCanvas on which the renderer subtree is drawn and other additional parameters needed to perform drawing

getOccupiedArea

             public LayoutArea getOccupiedArea()
            

Throws an UnsupportedOperationException if not ignored, because instances of this class are only used for terminating the current page content.

Returns:

LayoutArea instance

getModelElement

             public IPropertyContainer getModelElement()
            

Description copied from interface: IRenderer

Gets the model element associated with this renderer.

Returns:

the model element, as a container of properties

move

             public void move
             (float dx, float dy)
            

Logs a warning about unexpected use of SectionBreakRenderer if not ignored, because instances of this class are only used for terminating the current page content.

Parameters:

dx - the x-axis offset in points. Positive value will move the renderer subtree to the right.

dy - the y-axis offset in points. Positive value will move the renderer subtree to the top.

getNextRenderer

             public IRenderer getNextRenderer()
            

Description copied from interface: IRenderer

Gets a new instance of this class to be used as a next renderer, after this renderer is used, if IRenderer.layout(LayoutContext) is called more than once.

Returns:

new renderer instance