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...

virtual void	AddChild (IRenderer renderer)
	Throws an UnsupportedOperationException because instances of this class are only used for terminating the current content area. More...

virtual 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...

virtual void	Draw (DrawContext drawContext)
	Throws an UnsupportedOperationException because instances of this class are only used for terminating the current content area. More...

virtual LayoutArea	GetOccupiedArea ()
	Throws an UnsupportedOperationException because instances of this class are only used for terminating the current content area. More...

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	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 T1	GetProperty< T1 > (int property, T1 defaultValue)
	Throws an UnsupportedOperationException because instances of this class are only used for terminating the current content area. More...

virtual void	SetProperty (int property, Object value)
	Throws an UnsupportedOperationException because instances of this class are only used for terminating the current content area. 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 IPropertyContainer	GetModelElement ()
	Gets the model element associated with this renderer. 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...

virtual void	Move (float dx, float dy)
	Throws an UnsupportedOperationException because instances of this class are only used for terminating the current content area. More...

virtual 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...

Package Attributes
AreaBreak	areaBreak

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()

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

inlinevirtual

Throws an UnsupportedOperationException 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.IRenderer.

◆ DeleteOwnProperty()

virtual void iText.Layout.Renderer.AreaBreakRenderer.DeleteOwnProperty ( int property )

inlinevirtual

Deletes the own property of this entity.

Parameters

property the property to be deleted

Implements iText.Layout.IPropertyContainer.

◆ Draw()

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

inlinevirtual

Throws an UnsupportedOperationException 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.IRenderer.

◆ GetChildRenderers()

virtual IList<IRenderer> iText.Layout.Renderer.AreaBreakRenderer.GetChildRenderers ( )

inlinevirtual

Gets the child IRenderer s.

Returns: a list of direct child renderers of this instance

Implements iText.Layout.Renderer.IRenderer.

◆ GetDefaultProperty< T1 >()

virtual T1 iText.Layout.Renderer.AreaBreakRenderer.GetDefaultProperty< T1 > ( int property )

inlinevirtual

Gets the default property from this entity.

Template Parameters

T1	the return type associated with the property

Parameters

property the property to be retrieved

Returns: the default property value. If the default property is not defined, null will be returned

Implements iText.Layout.IPropertyContainer.

◆ GetModelElement()

virtual 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.IRenderer.

◆ GetNextRenderer()

virtual 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.IRenderer.

◆ GetOccupiedArea()

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

inlinevirtual

Throws an UnsupportedOperationException 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.IRenderer.

◆ GetOwnProperty< T1 >()

virtual T1 iText.Layout.Renderer.AreaBreakRenderer.GetOwnProperty< T1 > ( int property )

inlinevirtual

Gets own property from this entity.

Gets own property from this entity. The property must have been set earlier to this entity. If the property is not found, null will be returned.

Template Parameters

T1	the return type associated with the property

Parameters

property the property to be retrieved

Returns: the value of the given own property. null will be returned if the property value was not found

Implements iText.Layout.IPropertyContainer.

◆ GetParent()

virtual IRenderer iText.Layout.Renderer.AreaBreakRenderer.GetParent ( )

inlinevirtual

Gets the parent IRenderer.

Returns: direct parent renderer of this instance

Implements iText.Layout.Renderer.IRenderer.

◆ GetProperty< T1 >() [1/2]

virtual T1 iText.Layout.Renderer.AreaBreakRenderer.GetProperty< T1 > ( int property )

inlinevirtual

Gets the property from this entity.

Gets the property from this entity. Compared to GetOwnProperty(int) , this method can check parent's properties, styles, etc, depending on the origin of the instance

Template Parameters

T1	the return type associated with the property

Parameters

property the property to be retrieved

Returns: the value of the given property. null will be returned if the property value was not found

Implements iText.Layout.IPropertyContainer.

◆ GetProperty< T1 >() [2/2]

virtual T1 iText.Layout.Renderer.AreaBreakRenderer.GetProperty< T1 >	(	int	property,
		T1	defaultValue
	)

inlinevirtual

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

Parameters

property

Gets a property from this entity or one of its hierarchical parents.

Parameters

defaultValue

Gets a property from this entity or one of its hierarchical parents.

Template Parameters

T1

Gets a property from this entity or one of its hierarchical parents.

Returns

Gets a property from this entity or one of its hierarchical parents.

Implements iText.Layout.Renderer.IRenderer.

◆ HasOwnProperty()

virtual bool iText.Layout.Renderer.AreaBreakRenderer.HasOwnProperty ( int property )

inlinevirtual

Checks if this entity has the specified property, i.e. if it was set to this very element earlier

Parameters

property the property to be checked

Returns

true if this instance has given own property, false otherwise

Implements iText.Layout.IPropertyContainer.

◆ HasProperty()

virtual bool iText.Layout.Renderer.AreaBreakRenderer.HasProperty ( int property )

inlinevirtual

Checks if this entity has the specified property.

Checks if this entity has the specified property. Compared to HasOwnProperty(int) , this method can check parent's properties, styles, etc, depending on the origin of the instance

Parameters

property the property to be checked

Returns

true if this instance has given property, false otherwise

Implements iText.Layout.IPropertyContainer.

◆ IsFlushed()

virtual bool iText.Layout.Renderer.AreaBreakRenderer.IsFlushed ( )

inlinevirtual

Indicates whether this renderer is flushed or not, i.e. if Draw(DrawContext) has already been called.

Returns: whether the renderer has been flushed

Implements iText.Layout.Renderer.IRenderer.

◆ Layout()

virtual 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.IRenderer.

◆ Move()

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

inlinevirtual

Throws an UnsupportedOperationException 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.IRenderer.

◆ SetParent()

virtual IRenderer iText.Layout.Renderer.AreaBreakRenderer.SetParent ( IRenderer parent )

inlinevirtual

Explicitly sets this object as the child of another IRenderer in the renderer hierarchy.

Explicitly sets this object as the child of another IRenderer in the renderer hierarchy. Some implementations also use this method internally to create a consistent hierarchy tree.

Parameters

parent the object to place higher in the renderer hierarchy

Returns: by default, this object

Implements iText.Layout.Renderer.IRenderer.

◆ SetProperty()

virtual void iText.Layout.Renderer.AreaBreakRenderer.SetProperty	(	int	property,
		Object	value
	)

inlinevirtual

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

Parameters

property

Sets a property for this entity.

Parameters

value

Sets a property for this entity.

Implements iText.Layout.IPropertyContainer.

Public Member Functions

Package Attributes

Detailed Description

Constructor & Destructor Documentation

◆ AreaBreakRenderer()

Member Function Documentation

◆ AddChild()

◆ DeleteOwnProperty()

◆ Draw()

◆ GetChildRenderers()

◆ GetDefaultProperty< T1 >()

◆ GetModelElement()

◆ GetNextRenderer()

◆ GetOccupiedArea()

◆ GetOwnProperty< T1 >()

◆ GetParent()

◆ GetProperty< T1 >() [1/2]

◆ GetProperty< T1 >() [2/2]

◆ HasOwnProperty()

◆ HasProperty()

◆ IsFlushed()

◆ Layout()

◆ Move()

◆ SetParent()

◆ SetProperty()