The AbstractFormFieldRenderer implementation for checkboxes. More...

Inheritance diagram for iText.Forms.Form.Renderer.CheckBoxRenderer:

Classes
class	FlatParagraphRenderer
	A flat renderer for the checkbox.

Public Member Functions
	CheckBoxRenderer (CheckBox modelElement)
	Creates a new CheckBoxRenderer instance. 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...

virtual ? RenderingMode	GetRenderingMode ()
	Gets the rendering mode of the checkbox. More...

virtual bool	IsPdfA ()
	Returns whether or not the checkbox is in PDF/A mode. More...

virtual CheckBoxType	GetCheckBoxType ()
	Gets the checkBoxType. More...

virtual ICheckBoxRenderingStrategy	CreateCheckBoxRenderStrategy ()
	creates a ICheckBoxRenderingStrategy based on the current settings. More...

override void	DrawBackground (DrawContext drawContext)
	Draws a background layer if it is defined by a key iText.Layout.Properties.Property.BACKGROUND in either the layout element or this IRenderer itself. More...

override void	DrawBorder (DrawContext drawContext)
	Performs the drawing operation for the border of this renderer, if defined by any of the iText.Layout.Properties.Property.BORDER values in either the layout element or this IRenderer itself. More...

virtual bool	IsBoxChecked ()
	Defines whether the box is checked or not. More...

Public Member Functions inherited from iText.Forms.Form.Renderer.AbstractFormFieldRenderer
virtual bool	IsFlatten ()
	Checks if form fields need to be flattened. More...

virtual String	GetDefaultValue ()
	Gets the default value of the form field. 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)
	Flushes the renderer subtree contents, i.e. draws itself on canvas, adds necessary objects to the iText.Kernel.Pdf.PdfDocument etc. More...

override void	DrawChildren (DrawContext drawContext)
	Performs the drawing operation for all children of this renderer. More...

override MinMaxWidth	GetMinMaxWidth ()
	Calculates min and max width values for current renderer. More...

Public Member Functions inherited from iText.Layout.Renderer.BlockRenderer
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)
	Flushes the renderer subtree contents, i.e. draws itself on canvas, adds necessary objects to the iText.Kernel.Pdf.PdfDocument etc. More...

override Rectangle	GetOccupiedAreaBBox ()
	Gets the bounding box that contains all content written to the DrawContext by this IRenderer. More...

override MinMaxWidth	GetMinMaxWidth ()
	Calculates min and max width values for current renderer. More...

Public Member Functions inherited from iText.Layout.Renderer.AbstractRenderer
virtual void	AddChild (IRenderer renderer)
	Adds a child to the current renderer More...

virtual IPropertyContainer	GetModelElement ()
	Gets the model element associated with this renderer. More...

virtual IList< IRenderer >	GetChildRenderers ()
	Gets the child IRenderer s. 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 bool	HasOwnOrModelProperty (int property)
	Checks if this renderer or its model element have the specified property, i.e. if it was set to this very element or its very model element earlier. More...

virtual void	DeleteOwnProperty (int property)
	Deletes the own property of this entity. More...

virtual void	DeleteProperty (int property)
	Deletes property from this very renderer, or in case the property is specified on its model element, the property of the model element is deleted 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	GetProperty< T1 > (int property, T1 defaultValue)
	Gets a property from this entity or one of its hierarchical parents. More...

virtual void	SetProperty (int property, Object value)
	Sets a property for this entity. More...

virtual T1	GetDefaultProperty< T1 > (int property)
	Gets the default property from this entity. More...

virtual PdfFont	GetPropertyAsFont (int property)
	Returns a property with a certain key, as a font object. More...

virtual Color	GetPropertyAsColor (int property)
	Returns a property with a certain key, as a color. More...

virtual TransparentColor	GetPropertyAsTransparentColor (int property)
	Returns a property with a certain key, as a iText.Layout.Properties.TransparentColor. More...

virtual ? float	GetPropertyAsFloat (int property)
	Returns a property with a certain key, as a floating point value. More...

virtual ? float	GetPropertyAsFloat (int property, float? defaultValue)
	Returns a property with a certain key, as a floating point value. More...

virtual ? bool	GetPropertyAsBoolean (int property)
	Returns a property with a certain key, as a boolean value. More...

virtual UnitValue	GetPropertyAsUnitValue (int property)
	Returns a property with a certain key, as a unit value. More...

virtual ? int	GetPropertyAsInteger (int property)
	Returns a property with a certain key, as an integer value. More...

override String	ToString ()
	Returns a string representation of the renderer. More...

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

virtual bool	IsFlushed ()
	Indicates whether this renderer is flushed or not, i.e. if Draw(DrawContext) has already been called. 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 void	Move (float dxRight, float dyUp)
	Moves the renderer subtree by the specified offset. More...

virtual IList< Rectangle >	InitElementAreas (LayoutArea area)
	Gets all rectangles that this IRenderer can draw upon in the given area. More...

virtual Rectangle	GetBorderAreaBBox ()
	Gets the border box of a renderer. More...

virtual Rectangle	GetInnerAreaBBox ()

virtual Rectangle	ApplyMargins (Rectangle rect, bool reverse)
	Applies margins of the renderer on the given rectangle More...

virtual Rectangle	ApplyBorderBox (Rectangle rect, bool reverse)
	Applies the border box of the renderer on the given rectangle If the border of a certain side is null, the side will remain as it was. More...

virtual Rectangle	ApplyPaddings (Rectangle rect, bool reverse)
	Applies paddings of the renderer on the given rectangle More...

virtual bool	IsFirstOnRootArea ()

Static Public Attributes
const float	DEFAULT_BORDER_WIDTH = 0.75F

Static Public Attributes inherited from iText.Layout.Renderer.AbstractRenderer
const float	OVERLAP_EPSILON = 1e-4f

Protected Member Functions
override Rectangle	ApplyBorderBox (Rectangle rect, Border[] borders, bool reverse)
	Applies the given border box (borders) on the given rectangle More...

Additional Inherited Members
Static Public Member Functions inherited from iText.Layout.Renderer.AbstractRenderer
static PdfFormXObject	CreateXObject (AbstractLinearGradientBuilder linearGradientBuilder, Rectangle xObjectArea, PdfDocument document)
	Create a iText.Kernel.Pdf.Xobject.PdfFormXObject with the given area and containing a linear gradient inside. More...

Detailed Description

The AbstractFormFieldRenderer implementation for checkboxes.

Constructor & Destructor Documentation

◆ CheckBoxRenderer()

iText.Forms.Form.Renderer.CheckBoxRenderer.CheckBoxRenderer ( CheckBox modelElement )

inline

Creates a new CheckBoxRenderer instance.

Parameters

modelElement the model element

Member Function Documentation

◆ ApplyBorderBox()

override Rectangle iText.Forms.Form.Renderer.CheckBoxRenderer.ApplyBorderBox	(	Rectangle	rect,
		Border[]	borders,
		bool	reverse
	)

inlineprotectedvirtual

Applies the given border box (borders) on the given rectangle

Reimplemented from iText.Layout.Renderer.AbstractRenderer.

◆ CreateCheckBoxRenderStrategy()

virtual ICheckBoxRenderingStrategy iText.Forms.Form.Renderer.CheckBoxRenderer.CreateCheckBoxRenderStrategy ( )

inlinevirtual

creates a ICheckBoxRenderingStrategy based on the current settings.

Returns: the ICheckBoxRenderingStrategy

◆ DrawBackground()

override void iText.Forms.Form.Renderer.CheckBoxRenderer.DrawBackground ( DrawContext drawContext )

inlinevirtual

Draws a background layer if it is defined by a key iText.Layout.Properties.Property.BACKGROUND in either the layout element or this IRenderer itself.

Reimplemented from iText.Layout.Renderer.AbstractRenderer.

◆ DrawBorder()

override void iText.Forms.Form.Renderer.CheckBoxRenderer.DrawBorder ( DrawContext drawContext )

inlinevirtual

Performs the drawing operation for the border of this renderer, if defined by any of the iText.Layout.Properties.Property.BORDER values in either the layout element or this IRenderer itself.

Reimplemented from iText.Layout.Renderer.AbstractRenderer.

◆ GetCheckBoxType()

virtual CheckBoxType iText.Forms.Form.Renderer.CheckBoxRenderer.GetCheckBoxType ( )

inlinevirtual

Gets the checkBoxType.

Returns: the checkBoxType

◆ GetNextRenderer()

override IRenderer iText.Forms.Form.Renderer.CheckBoxRenderer.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.

Implements iText.Layout.Renderer.AbstractRenderer.

◆ GetRenderingMode()

virtual ? RenderingMode iText.Forms.Form.Renderer.CheckBoxRenderer.GetRenderingMode ( )

inlinevirtual

Gets the rendering mode of the checkbox.

Returns: the rendering mode of the checkbox

◆ IsBoxChecked()

virtual bool iText.Forms.Form.Renderer.CheckBoxRenderer.IsBoxChecked ( )

inlinevirtual

Defines whether the box is checked or not.

Returns: the default value of the checkbox field

◆ IsPdfA()

virtual bool iText.Forms.Form.Renderer.CheckBoxRenderer.IsPdfA ( )

inlinevirtual

Returns whether or not the checkbox is in PDF/A mode.

Returns: true if the checkbox is in PDF/A mode, false otherwise

Classes

Public Member Functions

Static Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CheckBoxRenderer()

Member Function Documentation

◆ ApplyBorderBox()

◆ CreateCheckBoxRenderStrategy()

◆ DrawBackground()

◆ DrawBorder()

◆ GetCheckBoxType()

◆ GetNextRenderer()

◆ GetRenderingMode()

◆ IsBoxChecked()

◆ IsPdfA()