com.itextpdf.layout.element

Class BlockElement<T extends IElement>

java.lang.Object

com.itextpdf.layout.ElementPropertyContainer<T>

com.itextpdf.layout.element.AbstractElement<T>

com.itextpdf.layout.element.BlockElement<T>

Type Parameters:

T - the type of the implementation

All Implemented Interfaces:

IAccessibleElement, IBlockElement, IElement, IPropertyContainer

Direct Known Subclasses:

Cell, Div, LineSeparator, List, Paragraph, Table

public abstract class BlockElement<T extends IElement>
extends AbstractElement<T>
implements IAccessibleElement, IBlockElement

A BlockElement will try to take up as much horizontal space as available to it on the canvas or page. The concept is comparable to the block element in HTML. Also like in HTML, the visual representation of the object can be delimited by padding, a border, and/or a margin.

Field Summary

Fields inherited from class com.itextpdf.layout.element.AbstractElement

childElements, nextRenderer, styles

Fields inherited from class com.itextpdf.layout.ElementPropertyContainer

properties

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BlockElement() Creates a BlockElement.

Method Summary

Modifier and Type	Method and Description
<T1> T1	getDefaultProperty(int property) Gets the default property from this entity.
Float	getMarginBottom() Gets the current bottom margin width of the element.
Float	getMarginLeft() Gets the current left margin width of the element.
Float	getMarginRight() Gets the current right margin width of the element.
Float	getMarginTop() Gets the current top margin width of the element.
Float	getPaddingBottom() Gets the current bottom padding width of the element.
Float	getPaddingLeft() Gets the current left padding width of the element.
Float	getPaddingRight() Gets the current right padding width of the element.
Float	getPaddingTop() Gets the current top padding width of the element.
Boolean	isKeepTogether() Returns whether the BlockElement should be kept together as much as possible.
Boolean	isKeepWithNext() Returns whether the end of this BlockElement and the start of the next sibling of this element should be placed in the same area.
T	setHeight(float height) Sets the height of a block element as point-unit value
T	setKeepTogether(boolean keepTogether) Sets whether the BlockElement should be kept together as much as possible.
T	setKeepWithNext(boolean keepWithNext) Sets whether the end of this BlockElement and the start of the next sibling of this element should be placed in the same area.
T	setMargin(float commonMargin) Sets all margins around the element to the same width.
T	setMarginBottom(float value) Sets the bottom margin width of the element.
T	setMarginLeft(float value) Sets the left margin width of the element.
T	setMarginRight(float value) Sets the right margin width of the element.
T	setMargins(float marginTop, float marginRight, float marginBottom, float marginLeft) Sets the margins around the element to a series of new widths.
T	setMarginTop(float value) Sets the top margin width of the element.
T	setMaxHeight(float maxHeight) Sets the max-height of a block element as point-unit value.
T	setMaxWidth(float maxWidth)
T	setMinHeight(float minHeight) Sets the min-height of a block element as point-unit value.
T	setMinWidth(float minWidth)
T	setPadding(float commonPadding) Sets all paddings around the element to the same width.
T	setPaddingBottom(float value) Sets the bottom padding width of the element.
T	setPaddingLeft(float value) Sets the left padding width of the element.
T	setPaddingRight(float value) Sets the right padding width of the element.
T	setPaddings(float paddingTop, float paddingRight, float paddingBottom, float paddingLeft) Sets the paddings around the element to a series of new widths.
T	setPaddingTop(float value) Sets the top padding width of the element.
T	setRotationAngle(double angleInRadians) Sets the rotation angle.
T	setRotationAngle(float angleInRadians) Sets the rotation radAngle.
T	setSpacingRatio(float ratio) Sets a ratio which determines in which proportion will word spacing and character spacing be applied when horizontal alignment is justified.
T	setVerticalAlignment(VerticalAlignment verticalAlignment) Sets the vertical alignment of the element.

Methods inherited from class com.itextpdf.layout.element.AbstractElement

addStyle, createRendererSubTree, getChildren, getProperty, getRenderer, hasProperty, isEmpty, makeNewRenderer, propagateArtifactRoleToChildElements, setAction, setNextRenderer, setPageNumber

Methods inherited from class com.itextpdf.layout.ElementPropertyContainer

deleteOwnProperty, getHeight, getOwnProperty, getSplitCharacters, getStrokeColor, getStrokeWidth, getTextRenderingMode, getWidth, hasOwnProperty, setBackgroundColor, setBackgroundColor, setBackgroundColor, setBackgroundColor, setBaseDirection, setBold, setBorder, setBorderBottom, setBorderLeft, setBorderRight, setBorderTop, setCharacterSpacing, setDestination, setFixedPosition, setFixedPosition, setFixedPosition, setFixedPosition, setFont, setFont, setFontColor, setFontColor, setFontKerning, setFontScript, setFontSize, setHeight, setHeightPercent, setHorizontalAlignment, setHyphenation, setItalic, setLineThrough, setOpacity, setProperty, setRelativePosition, setSplitCharacters, setStrokeColor, setStrokeWidth, setTextAlignment, setTextRenderingMode, setUnderline, setUnderline, setUnderline, setUnderline, setWidth, setWidth, setWidthPercent, setWordSpacing

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.itextpdf.kernel.pdf.tagutils.IAccessibleElement

getAccessibilityProperties, getRole, setRole

Methods inherited from interface com.itextpdf.layout.element.IElement

createRendererSubTree, getRenderer, setNextRenderer

Methods inherited from interface com.itextpdf.layout.IPropertyContainer

deleteOwnProperty, getOwnProperty, getProperty, hasOwnProperty, hasProperty, setProperty

Constructor Detail

BlockElement

protected BlockElement()

Creates a BlockElement.

Method Detail

getDefaultProperty

public <T1> T1 getDefaultProperty(int property)

Description copied from interface: IPropertyContainer

Gets the default property from this entity.

Specified by:

getDefaultProperty in interface IPropertyContainer

Overrides:

getDefaultProperty in class ElementPropertyContainer<T extends IElement>

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

getMarginLeft

public Float getMarginLeft()

Gets the current left margin width of the element.

Returns:

the left margin width, as a float

setMarginLeft

public T setMarginLeft(float value)

Sets the left margin width of the element.

Parameters:

value - the new left margin width

Returns:

this element

getMarginRight

public Float getMarginRight()

Gets the current right margin width of the element.

Returns:

the right margin width, as a float

setMarginRight

public T setMarginRight(float value)

Sets the right margin width of the element.

Parameters:

value - the new right margin width

Returns:

this element

getMarginTop

public Float getMarginTop()

Gets the current top margin width of the element.

Returns:

the top margin width, as a float

setMarginTop

public T setMarginTop(float value)

Sets the top margin width of the element.

Parameters:

value - the new top margin width

Returns:

this element

getMarginBottom

public Float getMarginBottom()

Gets the current bottom margin width of the element.

Returns:

the bottom margin width, as a float

setMarginBottom

public T setMarginBottom(float value)

Sets the bottom margin width of the element.

Parameters:

value - the new bottom margin width

Returns:

this element

setMargin

public T setMargin(float commonMargin)

Sets all margins around the element to the same width.

Parameters:

commonMargin - the new margin width

Returns:

this element

setMargins

public T setMargins(float marginTop,
                    float marginRight,
                    float marginBottom,
                    float marginLeft)

Sets the margins around the element to a series of new widths.

Parameters:

marginTop - the new margin top width

marginRight - the new margin right width

marginBottom - the new margin bottom width

marginLeft - the new margin left width

Returns:

this element

getPaddingLeft

public Float getPaddingLeft()

Gets the current left padding width of the element.

Returns:

the left padding width, as a float

setPaddingLeft

public T setPaddingLeft(float value)

Sets the left padding width of the element.

Parameters:

value - the new left padding width

Returns:

this element

getPaddingRight

public Float getPaddingRight()

Gets the current right padding width of the element.

Returns:

the right padding width, as a float

setPaddingRight

public T setPaddingRight(float value)

Sets the right padding width of the element.

Parameters:

value - the new right padding width

Returns:

this element

getPaddingTop

public Float getPaddingTop()

Gets the current top padding width of the element.

Returns:

the top padding width, as a float

setPaddingTop

public T setPaddingTop(float value)

Sets the top padding width of the element.

Parameters:

value - the new top padding width

Returns:

this element

getPaddingBottom

public Float getPaddingBottom()

Gets the current bottom padding width of the element.

Returns:

the bottom padding width, as a float

setPaddingBottom

public T setPaddingBottom(float value)

Sets the bottom padding width of the element.

Parameters:

value - the new bottom padding width

Returns:

this element

setPadding

public T setPadding(float commonPadding)

Sets all paddings around the element to the same width.

Parameters:

commonPadding - the new padding width

Returns:

this element

setPaddings

public T setPaddings(float paddingTop,
                     float paddingRight,
                     float paddingBottom,
                     float paddingLeft)

Sets the paddings around the element to a series of new widths.

Parameters:

paddingTop - the new padding top width

paddingRight - the new padding right width

paddingBottom - the new padding bottom width

paddingLeft - the new padding left width

Returns:

this element

setVerticalAlignment

public T setVerticalAlignment(VerticalAlignment verticalAlignment)

Sets the vertical alignment of the element.

Parameters:

verticalAlignment - the vertical alignment setting

Returns:

this element

setSpacingRatio

public T setSpacingRatio(float ratio)

Sets a ratio which determines in which proportion will word spacing and character spacing be applied when horizontal alignment is justified.

Parameters:

ratio - the ratio coefficient. It must be between 0 and 1, inclusive. It means that ratio part of the free space will be compensated by word spacing, and 1-ratio part of the free space will be compensated by character spacing. If ratio is 1, additional character spacing will not be applied. If ratio is 0, additional word spacing will not be applied.

Returns:

isKeepTogether

public Boolean isKeepTogether()

Returns whether the BlockElement should be kept together as much as possible.

Returns:

the current value of the Property.KEEP_TOGETHER property

setKeepTogether

public T setKeepTogether(boolean keepTogether)

Sets whether the BlockElement should be kept together as much as possible.

Parameters:

keepTogether - the new value of the Property.KEEP_TOGETHER property

Returns:

this element

isKeepWithNext

public Boolean isKeepWithNext()

Returns whether the end of this BlockElement and the start of the next sibling of this element should be placed in the same area.

Returns:

the current value of the Property.KEEP_WITH_NEXT property

setKeepWithNext

public T setKeepWithNext(boolean keepWithNext)

Sets whether the end of this BlockElement and the start of the next sibling of this element should be placed in the same area. Note that this will only work for high-level elements, i.e. elements added to the RootElement.

Parameters:

keepWithNext - the new value of the Property.KEEP_WITH_NEXT property

Returns:

this element

setRotationAngle

public T setRotationAngle(float angleInRadians)

Sets the rotation radAngle.

Parameters:

angleInRadians - the new rotation radAngle, as a float, in radians

Returns:

this element

setRotationAngle

public T setRotationAngle(double angleInRadians)

Sets the rotation angle.

Parameters:

angleInRadians - the new rotation angle, as a double, in radians

Returns:

this element

setHeight

public T setHeight(float height)

Sets the height of a block element as point-unit value

Overrides:

setHeight in class ElementPropertyContainer<T extends IElement>

Parameters:

height - a floating point value for the new height

Returns:

the block element itself

setMaxHeight

public T setMaxHeight(float maxHeight)

Sets the max-height of a block element as point-unit value.

Parameters:

maxHeight - a floating point value for the new max-height

Returns:

the block element itself

setMinHeight

public T setMinHeight(float minHeight)

Sets the min-height of a block element as point-unit value.

Parameters:

minHeight - a floating point value for the new min-height

Returns:

the block element itself

setMaxWidth

public T setMaxWidth(float maxWidth)

setMinWidth

public T setMinWidth(float minWidth)