iText 8.0.2 API
Public Member Functions | List of all members
iText.Layout.IPropertyContainer Interface Reference

A generic Map-like interface that defines methods for storing and retrieving objects by an enum key of the iText.Layout.Properties.Property type. More...

Inheritance diagram for iText.Layout.IPropertyContainer:
iText.Layout.Element.IElement iText.Layout.ElementPropertyContainer< T > iText.Layout.Renderer.IRenderer iText.Layout.Tagging.TaggingDummyElement iText.Layout.Element.IAbstractElement iText.Layout.Element.ILargeElement iText.Layout.Element.ILeafElement iText.Layout.Element.AbstractElement< T > iText.Layout.RootElement< T > iText.Layout.Renderer.AbstractRenderer iText.Layout.Renderer.AreaBreakRenderer iText.Layout.Renderer.ILeafElementRenderer

Public Member Functions
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 generic Map-like interface that defines methods for storing and retrieving objects by an enum key of the iText.Layout.Properties.Property type.

Member Function Documentation

◆ DeleteOwnProperty()

void iText.Layout.IPropertyContainer.DeleteOwnProperty ( int  property )

Deletes the own property of this entity.

Parameters
property the property to be deleted

Implemented in iText.Layout.Renderer.AbstractRenderer, iText.Layout.RootElement< T >, iText.Layout.Renderer.AreaBreakRenderer, iText.Layout.Tagging.TaggingDummyElement, and iText.Layout.ElementPropertyContainer< T >.

◆ GetDefaultProperty< T1 >()

T1 iText.Layout.IPropertyContainer.GetDefaultProperty< T1 > ( int  property )

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

Implemented in iText.Layout.Renderer.ParagraphRenderer, iText.Layout.Renderer.AbstractRenderer, iText.Layout.RootElement< T >, iText.Forms.Form.Element.FormField< T >, iText.Layout.Renderer.AreaBreakRenderer, iText.Layout.ElementPropertyContainer< T >, iText.Layout.Tagging.TaggingDummyElement, and iText.Layout.Element.BlockElement< T >.

◆ GetOwnProperty< T1 >()

T1 iText.Layout.IPropertyContainer.GetOwnProperty< T1 > ( int  property )

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

Implemented in iText.Layout.Renderer.AbstractRenderer, iText.Layout.RootElement< T >, iText.Layout.Renderer.AreaBreakRenderer, iText.Layout.ElementPropertyContainer< T >, and iText.Layout.Tagging.TaggingDummyElement.

◆ GetProperty< T1 >()

T1 iText.Layout.IPropertyContainer.GetProperty< T1 > ( int  property )

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

Implemented in iText.Layout.RootElement< T >, iText.Layout.Element.AbstractElement< T >, iText.Layout.ElementPropertyContainer< T >, iText.Layout.Tagging.TaggingDummyElement, iText.Layout.Renderer.AbstractRenderer, iText.Forms.Form.Renderer.InputFieldRenderer, iText.Layout.Renderer.AreaBreakRenderer, and iText.Forms.Form.Renderer.TextAreaRenderer.

◆ HasOwnProperty()

bool iText.Layout.IPropertyContainer.HasOwnProperty ( int  property )

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

Implemented in iText.Layout.Renderer.AbstractRenderer, iText.Layout.RootElement< T >, iText.Layout.Renderer.AreaBreakRenderer, iText.Layout.Tagging.TaggingDummyElement, and iText.Layout.ElementPropertyContainer< T >.

◆ HasProperty()

bool iText.Layout.IPropertyContainer.HasProperty ( int  property )

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

Implemented in iText.Layout.Renderer.AbstractRenderer, iText.Layout.RootElement< T >, iText.Layout.Renderer.AreaBreakRenderer, iText.Layout.Element.AbstractElement< T >, iText.Layout.Tagging.TaggingDummyElement, and iText.Layout.ElementPropertyContainer< T >.

◆ SetProperty()

void iText.Layout.IPropertyContainer.SetProperty ( int  property,
Object  value 
)

Sets a property for this entity.

Parameters
property the property to be set
value the value of the property

Implemented in iText.Layout.Renderer.AbstractRenderer, iText.Layout.RootElement< T >, iText.Layout.Renderer.AreaBreakRenderer, iText.Layout.ElementPropertyContainer< T >, and iText.Layout.Tagging.TaggingDummyElement.