iText 7 7.1.9 API
iText.Layout.Renderer.CanvasRenderer Class Reference
Inheritance diagram for iText.Layout.Renderer.CanvasRenderer:
iText.Layout.Renderer.RootRenderer iText.Layout.Renderer.AbstractRenderer iText.Layout.Renderer.IRenderer iText.Layout.IPropertyContainer

Public Member Functions

  CanvasRenderer (Canvas canvas)
  Creates a CanvasRenderer from its corresponding layout object. More...
 
  CanvasRenderer (Canvas canvas, bool immediateFlush)
  Creates a CanvasRenderer from its corresponding layout object. More...
 
override void  AddChild (IRenderer renderer)
  Adds a child to the current renderer More...
 
override IRenderer  GetNextRenderer ()
  For CanvasRenderer , this has a meaning of the renderer that will be used for relayout. More...
 
- Public Member Functions inherited from iText.Layout.Renderer.RootRenderer
override void  AddChild (IRenderer renderer)
  Adds a child to the current renderer More...
 
virtual void  Flush ()
  Draws (flushes) the content. More...
 
virtual void  Close ()
  This method correctly closes the RootRenderer instance. 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...
 
virtual LayoutArea  GetCurrentArea ()
 
- Public Member Functions inherited from iText.Layout.Renderer.AbstractRenderer
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 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...
 
virtual 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...
 
virtual void  DrawChildren (DrawContext drawContext)
  Performs the drawing operation for all children of this renderer. More...
 
virtual 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  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  GetOccupiedAreaBBox ()
  Gets the bounding box that contains all content written to the DrawContext by this IRenderer. 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 ()
 
virtual MinMaxWidth  GetMinMaxWidth ()
 

Constructor & Destructor Documentation

◆ CanvasRenderer() [1/2]

iText.Layout.Renderer.CanvasRenderer.CanvasRenderer ( Canvas  canvas )
inline

Creates a CanvasRenderer from its corresponding layout object.

Creates a CanvasRenderer from its corresponding layout object. Sets RootRenderer.immediateFlush to true.

Parameters
canvas the iText.Layout.Canvas which this object should manage

◆ CanvasRenderer() [2/2]

iText.Layout.Renderer.CanvasRenderer.CanvasRenderer ( Canvas  canvas,
bool  immediateFlush 
)
inline

Creates a CanvasRenderer from its corresponding layout object.

Creates a CanvasRenderer from its corresponding layout object. Defines whether the content should be flushed immediately after addition AddChild(IRenderer) or not

Parameters
canvas the iText.Layout.Canvas which this object should manage
immediateFlush the value which stands for immediate flushing

Member Function Documentation

◆ AddChild()

override void iText.Layout.Renderer.CanvasRenderer.AddChild ( IRenderer  renderer )
inlinevirtual

Adds a child to the current renderer

Reimplemented from iText.Layout.Renderer.AbstractRenderer.

◆ GetNextRenderer()

override IRenderer iText.Layout.Renderer.CanvasRenderer.GetNextRenderer ( )
inlinevirtual

For CanvasRenderer , this has a meaning of the renderer that will be used for relayout.

Returns
relayout renderer.

Implements iText.Layout.Renderer.AbstractRenderer.