Class Div

java.lang.Object

com.itextpdf.commons.actions.sequence.AbstractIdentifiableElement

com.itextpdf.layout.ElementPropertyContainer<Div>

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

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

com.itextpdf.layout.element.Div

All Implemented Interfaces:

IAbstractElement, IBlockElement, IElement, IPropertyContainer, IAccessibleElement

Direct Known Subclasses:

FlexContainer, GridContainer, ListItem, MulticolContainer

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	Description
protected DefaultAccessibilityProperties	tagProperties

Fields inherited from class AbstractElement

childElements, nextRenderer, styles

Fields inherited from class ElementPropertyContainer

properties

Constructor Summary

Constructors

Constructor	Description
Div()	Creates a new Div instance.

Method Summary

Modifier and Type	Method	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()	Creates a new renderer instance.
Div	setFillAvailableArea(boolean fillArea)	Defines whether the Div should occupy all the space left in the available area in case it is the last element in this area.
Div	setFillAvailableAreaOnSplit(boolean fillAreaOnSplit)	Defines whether the Div should occupy all the space left in the available area in case the area has been split and it is the last element in the split part of this area.

Methods inherited from class 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, setNeutralRole, setPadding, setPaddingBottom, setPaddingLeft, setPaddingRight, setPaddings, setPaddingTop, setRotationAngle, setRotationAngle, setSpacingRatio, setVerticalAlignment, setWidth, setWidth

Methods inherited from class AbstractElement

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

Methods inherited from class ElementPropertyContainer

deleteOwnProperty, getOwnProperty, getSplitCharacters, getStrokeColor, getStrokeWidth, getTextRenderingMode, getTransparentStrokeColor, hasOwnProperty, setBackgroundColor, setBackgroundColor, setBackgroundColor, setBackgroundColor, setBackgroundImage, setBackgroundImage, setBaseDirection, setBorder, setBorderBottom, setBorderBottomLeftRadius, setBorderBottomRightRadius, setBorderLeft, setBorderRadius, setBorderRight, setBorderTop, setBorderTopLeftRadius, setBorderTopRightRadius, setCharacterSpacing, setDashPattern, setDestination, setFixedPosition, setFixedPosition, setFixedPosition, setFixedPosition, setFont, setFontColor, setFontColor, setFontColor, setFontFamily, setFontFamily, setFontKerning, setFontScript, setFontSize, setHorizontalAlignment, setHyphenation, setLineThrough, setOpacity, setProperty, setRelativePosition, setSplitCharacters, setStrokeColor, setStrokeColor, setStrokeColor, setStrokeWidth, setTextAlignment, setTextRenderingMode, setUnderline, setUnderline, setUnderline, setUnderline, setUnderline, setWordSpacing, simulateBold, simulateItalic

Methods inherited from class Object

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

Methods inherited from interface IAbstractElement

getChildren

Methods inherited from interface IElement

createRendererSubTree, getRenderer, setNextRenderer

Methods inherited from interface IPropertyContainer

deleteOwnProperty, getOwnProperty, getProperty, hasOwnProperty, hasProperty, setProperty

Field Details

tagProperties

protected DefaultAccessibilityProperties tagProperties

Constructor Details

Div

public Div()

Creates a new Div instance.

Method Details

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)

Defines whether the Div should occupy all the space left in the available area in case it is the last element in this area.

Parameters:

fillArea - defines whether the available area should be filled

Returns:

this Div

setFillAvailableAreaOnSplit

public Div setFillAvailableAreaOnSplit(boolean fillAreaOnSplit)

Defines whether the Div should occupy all the space left in the available area in case the area has been split and it is the last element in the split part of this area.

Parameters:

fillAreaOnSplit - defines whether the available area should be filled

Returns:

this Div

makeNewRenderer

protected IRenderer makeNewRenderer()

Description copied from class: AbstractElement

Creates a new renderer instance.

Specified by:

makeNewRenderer in class AbstractElement<Div>

Returns:

new IRenderer