com.itextpdf.layout.element

Class Div

java.lang.Object

com.itextpdf.layout.ElementPropertyContainer

com.itextpdf.layout.element.AbstractElement

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

com.itextpdf.layout.element.Div

All Implemented Interfaces:

IAccessibleElement, IElement, IPropertyContainer

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 PdfName	role
protected AccessibilityProperties	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
IElement> Div	add(BlockElement 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.
PdfName	getRole() Gets the element's role.
protected IRenderer	makeNewRenderer()
void	setRole(PdfName role) Sets the element's role.

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

getDefaultProperty, getMarginBottom, getMarginLeft, getMarginRight, getMarginTop, getPaddingBottom, getPaddingLeft, getPaddingRight, getPaddingTop, isKeepTogether, setKeepTogether, setMargin, setMarginBottom, setMarginLeft, setMarginRight, setMargins, setMarginTop, setPadding, setPaddingBottom, setPaddingLeft, setPaddingRight, setPaddings, setPaddingTop, setRotationAngle, setRotationAngle, setSpacingRatio, setVerticalAlignment

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

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

Methods inherited from class com.itextpdf.layout.ElementPropertyContainer

deleteOwnProperty, getHeight, getOwnProperty, getSplitCharacters, getStrokeColor, getStrokeWidth, getTextRenderingMode, getWidth, hasOwnProperty, setBackgroundColor, setBackgroundColor, setBaseDirection, setBold, setBorder, setBorderBottom, setBorderLeft, setBorderRight, setBorderTop, setCharacterSpacing, setDestination, setFixedPosition, setFixedPosition, setFixedPosition, setFixedPosition, setFont, setFontColor, setFontKerning, setFontScript, setFontSize, setHeight, setHorizontalAlignment, setHyphenation, setItalic, setLineThrough, setProperty, setRelativePosition, setSplitCharacters, setStrokeColor, setStrokeWidth, setTextAlignment, setTextRenderingMode, 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.layout.IPropertyContainer

deleteOwnProperty, getOwnProperty, hasOwnProperty, setProperty

Field Detail

role

protected PdfName role

tagProperties

protected AccessibilityProperties tagProperties

Constructor Detail

Div

public Div()

Method Detail

add

public IElement> Div add(BlockElement 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

getRole

public PdfName getRole()

Description copied from interface: IAccessibleElement

Gets the element's role.

Returns:

a PdfName containing the name of the role

setRole

public void setRole(PdfName role)

Description copied from interface: IAccessibleElement

Sets the element's role.

Parameters:

role - the new role which the IAccessibleElement should take

getAccessibilityProperties

public AccessibilityProperties getAccessibilityProperties()

Description copied from interface: IAccessibleElement

Gets the accessibility properties.

Returns:

a properties wrapper object specific to a tagged element in Tagged PDF

makeNewRenderer

protected IRenderer makeNewRenderer()

Specified by:

makeNewRenderer in class AbstractElement<Div>