iText.Layout.Renderer.AreaBreakRenderer Class Reference

Renderer for the iText.Layout.Element.AreaBreak layout element. More...

Inheritance diagram for iText.Layout.Renderer.AreaBreakRenderer:

Public Member Functions
	AreaBreakRenderer (AreaBreak areaBreak)
	Creates an AreaBreakRenderer. More...
override void	AddChild (IRenderer renderer)
	Logs a warning about unexpected use of AreaBreakRenderer if not ignored, because instances of this class are only used for terminating the current content area. More...
override LayoutResult	Layout (LayoutContext layoutContext)
	This method simulates positioning of the renderer, including all of its children, and returns the iText.Layout.Layout.LayoutResult , representing the layout result, including occupied area, status, i.e. if there was enough place to fit the renderer subtree, etc. More...
override void	Draw (DrawContext drawContext)
	Logs a warning about unexpected use of AreaBreakRenderer if not ignored, because instances of this class are only used for terminating the current content area. More...
override LayoutArea	GetOccupiedArea ()
	Throws an UnsupportedOperationException if not ignored, because instances of this class are only used for terminating the current content area. More...
override IPropertyContainer	GetModelElement ()
	Gets the model element associated with this renderer. More...
override void	Move (float dx, float dy)
	Logs a warning about unexpected use of AreaBreakRenderer if not ignored, because instances of this class are only used for terminating the current content area. More...
override IRenderer	GetNextRenderer ()
	Gets a new instance of this class to be used as a next renderer, after this renderer is used, if Layout(iText.Layout.Layout.LayoutContext) is called more than once. More...
Public Member Functions inherited from iText.Layout.Renderer.AbstractBreakRenderer
virtual bool	HasProperty (int property)
	Checks if this entity has the specified property. More...
virtual bool	HasOwnProperty (int property)
	Checks if this entity has the specified property, i.e. if it was set to this very element earlier More...
virtual T1	GetProperty< T1 > (int key)
	Gets the property from this entity. More...
virtual T1	GetProperty< T1 > (int property, T1 defaultValue)
	Gets a property from this entity or one of its hierarchical parents. More...
virtual T1	GetOwnProperty< T1 > (int property)
	Gets own property from this entity. More...
virtual T1	GetDefaultProperty< T1 > (int property)
	Gets the default property from this entity. More...
virtual void	SetProperty (int property, Object value)
	Sets a property for this entity. More...
virtual void	DeleteOwnProperty (int property)
	Deletes the own property of this entity. More...
virtual IRenderer	SetParent (IRenderer parent)
	Explicitly sets this object as the child of another IRenderer in the renderer hierarchy. More...
virtual IRenderer	GetParent ()
	Gets the parent IRenderer. More...
virtual IList< IRenderer >	GetChildRenderers ()
	Gets the child IRenderer s. More...
virtual bool	IsFlushed ()
	Indicates whether this renderer is flushed or not, i.e. if Draw(DrawContext) has already been called. More...

Package Attributes
AreaBreak	areaBreak
LayoutArea	occupiedArea
Package Attributes inherited from iText.Layout.Renderer.AbstractBreakRenderer
IRenderer	parent
IDictionary< int, Object >	properties = new Dictionary()

Additional Inherited Members
Package Functions inherited from iText.Layout.Renderer.AbstractBreakRenderer
	AbstractBreakRenderer ()
	Creates new AbstractBreakRenderer instance. More...

Detailed Description

Renderer for the iText.Layout.Element.AreaBreak layout element.

Renderer for the iText.Layout.Element.AreaBreak layout element. Will terminate the current content area and initialize a new one.

Constructor & Destructor Documentation

AreaBreakRenderer()

iText.Layout.Renderer.AreaBreakRenderer.AreaBreakRenderer ( AreaBreak  areaBreak )

inline

Creates an AreaBreakRenderer.

Parameters

areaBreak

the iText.Layout.Element.AreaBreak that will be rendered by this object

Member Function Documentation

AddChild()

override void iText.Layout.Renderer.AreaBreakRenderer.AddChild ( IRenderer  renderer )

inlinevirtual

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

Parameters

renderer

Adds a child to the current renderer

Implements iText.Layout.Renderer.AbstractBreakRenderer.

Draw()

override void iText.Layout.Renderer.AreaBreakRenderer.Draw ( DrawContext  drawContext )

inlinevirtual

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

Parameters

drawContext

Flushes the renderer subtree contents, i.e. draws itself on canvas, adds necessary objects to the iText.Kernel.Pdf.PdfDocument etc.

Implements iText.Layout.Renderer.AbstractBreakRenderer.

GetModelElement()

override IPropertyContainer iText.Layout.Renderer.AreaBreakRenderer.GetModelElement ( )

inlinevirtual

Gets the model element associated with this renderer.

Returns

the model element, as a container of properties

Implements iText.Layout.Renderer.AbstractBreakRenderer.

GetNextRenderer()

override IRenderer iText.Layout.Renderer.AreaBreakRenderer.GetNextRenderer ( )

inlinevirtual

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

Returns

new renderer instance

Implements iText.Layout.Renderer.AbstractBreakRenderer.

GetOccupiedArea()

override LayoutArea iText.Layout.Renderer.AreaBreakRenderer.GetOccupiedArea ( )

inlinevirtual

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

Returns

Gets the resultant occupied area after the last call to the Layout(iText.Layout.Layout.LayoutContext) method.

Implements iText.Layout.Renderer.AbstractBreakRenderer.

Layout()

override LayoutResult iText.Layout.Renderer.AreaBreakRenderer.Layout ( LayoutContext  layoutContext )

inlinevirtual

This method simulates positioning of the renderer, including all of its children, and returns the iText.Layout.Layout.LayoutResult , representing the layout result, including occupied area, status, i.e. if there was enough place to fit the renderer subtree, etc.

This method simulates positioning of the renderer, including all of its children, and returns the iText.Layout.Layout.LayoutResult , representing the layout result, including occupied area, status, i.e. if there was enough place to fit the renderer subtree, etc. iText.Layout.Layout.LayoutResult can be extended to return custom layout results for custom elements, e.g. TextRenderer uses iText.Layout.Layout.TextLayoutResult as its result. This method can be called standalone to learn how much area the renderer subtree needs, or can be called before 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

Implements iText.Layout.Renderer.AbstractBreakRenderer.

Move()

override void iText.Layout.Renderer.AreaBreakRenderer.Move ( float  dx, float  dy  )

inlinevirtual

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

Parameters

dx

Moves the renderer subtree by the specified offset.

Parameters

dy

Moves the renderer subtree by the specified offset.

Implements iText.Layout.Renderer.AbstractBreakRenderer.