com.itextpdf.layout

Interface IPropertyContainer

All Known Subinterfaces:

IBlockElement, IElement, ILargeElement, ILeafElement, ILeafElementRenderer, IRenderer

All Known Implementing Classes:

AbstractElement, AbstractRenderer, AreaBreak, AreaBreakRenderer, BlockElement, BlockRenderer, Canvas, CanvasRenderer, Cell, CellRenderer, ColumnDocumentRenderer, Div, DivRenderer, Document, DocumentRenderer, ElementPropertyContainer, Image, ImageRenderer, LineRenderer, LineSeparator, LineSeparatorRenderer, Link, LinkRenderer, List, ListItem, ListItemRenderer, ListRenderer, Paragraph, ParagraphRenderer, RootElement, RootRenderer, Style, Tab, Table, TableRenderer, TabRenderer, TaggingDummyElement, Text, TextRenderer

public interface IPropertyContainer

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

Method Summary

Modifier and Type	Method and Description
void	deleteOwnProperty(int property) Deletes the own property of this entity.
<T1> T1	getDefaultProperty(int property) Gets the default property from this entity.
<T1> T1	getOwnProperty(int property) Gets own property from this entity.
<T1> T1	getProperty(int property) Gets the property from this entity.
boolean	hasOwnProperty(int property) Checks if this entity has the specified property, i.e.
boolean	hasProperty(int property) Checks if this entity has the specified property.
void	setProperty(int property, Object value) Sets a property for this entity.

Method Detail

hasProperty

boolean hasProperty(int 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

hasOwnProperty

boolean 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

getProperty

<T1> T1 getProperty(int property)

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

Type 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

getOwnProperty

<T1> T1 getOwnProperty(int property)

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.

Type 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

getDefaultProperty

<T1> T1 getDefaultProperty(int property)

Gets the default property from this entity.

Type 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

setProperty

void setProperty(int property,
                 Object value)

Sets a property for this entity.

Parameters:

property - the property to be set

value - the value of the property

deleteOwnProperty

void deleteOwnProperty(int property)

Deletes the own property of this entity.

Parameters:

property - the property to be deleted