iText 7 7.1.9 API
iText.Layout.Element.ILargeElement Interface Reference

A ILargeElement is a layout element which may get added to indefinitely, making the object prohibitively large. More...

Inheritance diagram for iText.Layout.Element.ILargeElement:
iText.Layout.Element.IElement iText.Layout.IPropertyContainer iText.Layout.Element.Table

Public Member Functions

bool  IsComplete ()
  Checks whether an element has already been marked as complete. More...
 
void  Complete ()
  Indicates that all the desired content has been added to this large element. More...
 
void  Flush ()
  Writes the newly added content to the document. More...
 
void  FlushContent ()
  Flushes the content which has just been added to the document. More...
 
void  SetDocument (Document document)
  Sets the document this element is bound to. More...
 
- Public Member Functions inherited from iText.Layout.Element.IElement
void  SetNextRenderer (IRenderer renderer)
  Overrides the iText.Layout.Renderer.IRenderer instance which will be returned by the next call to the GetRenderer(). More...
 
IRenderer  GetRenderer ()
  Gets a renderer for this element. More...
 
IRenderer  CreateRendererSubTree ()
  Creates a renderer subtree with root in the current element. More...
 
- Public Member Functions inherited from iText.Layout.IPropertyContainer
bool  HasProperty (int property)
  Checks if this entity has the specified property. More...
 
bool  HasOwnProperty (int property)
  Checks if this entity has the specified property, i.e. if it was set to this very element earlier More...
 
T1  GetProperty< T1 > (int property)
  Gets the property from this entity. More...
 
T1  GetOwnProperty< T1 > (int property)
  Gets own property from this entity. More...
 
T1  GetDefaultProperty< T1 > (int property)
  Gets the default property from this entity. More...
 
void  SetProperty (int property, Object value)
  Sets a property for this entity. More...
 
void  DeleteOwnProperty (int property)
  Deletes the own property of this entity. More...
 

Detailed Description

A ILargeElement is a layout element which may get added to indefinitely, making the object prohibitively large.

A ILargeElement is a layout element which may get added to indefinitely, making the object prohibitively large. In order to avoid consuming and holding on to undesirable amounts of resources, the contents of a ILargeElement can be flushed regularly by client code, e.g. at page boundaries or after a certain amount of additions.

Member Function Documentation

◆ Complete()

void iText.Layout.Element.ILargeElement.Complete ( )

Indicates that all the desired content has been added to this large element.

Implemented in iText.Layout.Element.Table.

◆ Flush()

void iText.Layout.Element.ILargeElement.Flush ( )

Writes the newly added content to the document.

Implemented in iText.Layout.Element.Table.

◆ FlushContent()

void iText.Layout.Element.ILargeElement.FlushContent ( )

Flushes the content which has just been added to the document.

Flushes the content which has just been added to the document. This is a method for internal usage and is called automatically by the document.

Implemented in iText.Layout.Element.Table.

◆ IsComplete()

bool iText.Layout.Element.ILargeElement.IsComplete ( )

Checks whether an element has already been marked as complete.

Returns
the completion marker boolean

Implemented in iText.Layout.Element.Table.

◆ SetDocument()

void iText.Layout.Element.ILargeElement.SetDocument ( Document  document )

Sets the document this element is bound to.

Sets the document this element is bound to. We cannot write a large element into several documents simultaneously because we would need more bulky interfaces for this feature. For now we went for simplicity.

Parameters
document the document

Implemented in iText.Layout.Element.Table.