com.itextpdf.layout.element

Class Div

java.lang.Object

com.itextpdf.layout.ElementPropertyContainer<T>

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

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

com.itextpdf.layout.element.Div

All Implemented Interfaces:

IBlockElement, IElement, IPropertyContainer, IAccessibleElement

Direct Known Subclasses:

ListItem

public class Div
extends BlockElement<Div>

A Div is a container object that defines a section in a document, which will have some shared layout properties. Like all BlockElement types, it will try to take up as much horizontal space as possible.

The concept is very similar to that of the div tag in HTML.

Field Summary

Fields

Modifier and Type	Field and Description
protected DefaultAccessibilityProperties	tagProperties

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

childElements, nextRenderer, styles

Fields inherited from class com.itextpdf.layout.ElementPropertyContainer

properties

Constructor Summary

Constructors

Constructor and Description
Div()

Method Summary

Modifier and Type	Method and Description
Div	add(AreaBreak areaBreak) Adds an area break to the div's contents.
Div	add(IBlockElement element) Adds any block element to the div's contents.
Div	add(Image element) Adds an image to the div's contents.
AccessibilityProperties	getAccessibilityProperties() Gets the accessibility properties.
protected IRenderer	makeNewRenderer()
Div	setFillAvailableArea(boolean fillArea)
Div	setFillAvailableAreaOnSplit(boolean fillAreaOnSplit)

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

getDefaultProperty, getHeight, getMarginBottom, getMarginLeft, getMarginRight, getMarginTop, getPaddingBottom, getPaddingLeft, getPaddingRight, getPaddingTop, getWidth, isKeepTogether, isKeepWithNext, setHeight, setHeight, setKeepTogether, setKeepWithNext, setMargin, setMarginBottom, setMarginLeft, setMarginRight, setMargins, setMarginTop, setMaxHeight, setMaxHeight, setMaxWidth, setMaxWidth, setMinHeight, setMinHeight, setMinWidth, setMinWidth, setPadding, setPaddingBottom, setPaddingLeft, setPaddingRight, setPaddings, setPaddingTop, setRotationAngle, setRotationAngle, setSpacingRatio, setVerticalAlignment, setWidth, setWidth

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

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

Methods inherited from class com.itextpdf.layout.ElementPropertyContainer

deleteOwnProperty, getOwnProperty, getSplitCharacters, getStrokeColor, getStrokeWidth, getTextRenderingMode, hasOwnProperty, setBackgroundColor, setBackgroundColor, setBackgroundColor, setBackgroundColor, setBackgroundImage, setBackgroundImage, setBaseDirection, setBold, setBorder, setBorderBottom, setBorderBottomLeftRadius, setBorderBottomRightRadius, setBorderLeft, setBorderRadius, setBorderRight, setBorderTop, setBorderTopLeftRadius, setBorderTopRightRadius, setCharacterSpacing, setDestination, setFixedPosition, setFixedPosition, setFixedPosition, setFixedPosition, setFont, setFont, setFontColor, setFontColor, setFontFamily, setFontFamily, setFontKerning, setFontScript, setFontSize, setHorizontalAlignment, setHyphenation, setItalic, setLineThrough, setOpacity, setProperty, setRelativePosition, setSplitCharacters, setStrokeColor, setStrokeWidth, setTextAlignment, setTextRenderingMode, setUnderline, setUnderline, setUnderline, setUnderline, 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.layout.element.IElement

createRendererSubTree, getRenderer, setNextRenderer

Methods inherited from interface com.itextpdf.layout.IPropertyContainer

deleteOwnProperty, getOwnProperty, getProperty, hasOwnProperty, hasProperty, setProperty

Field Detail

tagProperties

protected DefaultAccessibilityProperties tagProperties

Constructor Detail

Div

public Div()

Method Detail

add

public Div add(IBlockElement element)

Adds any block element to the div's contents.

Parameters:

element - a BlockElement

Returns:

this Element

add

public Div add(Image element)

Adds an image to the div's contents.

Parameters:

element - an Image

Returns:

this Element

add

public Div add(AreaBreak areaBreak)

Adds an area break to the div's contents.

Parameters:

areaBreak - an AreaBreak

Returns:

this Element

getAccessibilityProperties

public AccessibilityProperties getAccessibilityProperties()

Description copied from interface: IAccessibleElement

Gets the accessibility properties. See also IAccessibleElement.

Returns:

an interface that allows to specify properties of a tagged element in Tagged PDF.

setFillAvailableArea

public Div setFillAvailableArea(boolean fillArea)

setFillAvailableAreaOnSplit

public Div setFillAvailableAreaOnSplit(boolean fillAreaOnSplit)

makeNewRenderer

protected IRenderer makeNewRenderer()

Specified by:

makeNewRenderer in class AbstractElement<Div>