CPDFGeneration.layout

Class CBlockElement

java.lang.Object

CPDFGeneration.layout.CElementPropertyContainer

CPDFGeneration.layout.CAbstractElement

CPDFGeneration.layout.CBlockElement

All Implemented Interfaces:

CIElement

Direct Known Subclasses:

CCell, CDiv, CLineSeparator, CList, CPage, CParagraph, CTable

public abstract class CBlockElement
extends CAbstractElement

Field Summary

Fields inherited from class CPDFGeneration.layout.CElementPropertyContainer

elementPtr

Constructor Summary

Constructors

Constructor and Description
CBlockElement(long ptr) Create a block element with native pointer.

Method Summary

Modifier and Type	Method and Description
CUnitValue	getHeight() Get height.
CUnitValue	getMarginBottom() Get bottom margin.
CUnitValue	getMarginLeft() Get left margin.
CUnitValue	getMarginRight() Get right margin.
CUnitValue	getMarginTop() Get top margin.
CUnitValue	getPaddingBottom() Get bottom padding.
CUnitValue	getPaddingLeft() Get left padding.
CUnitValue	getPaddingRight() Get right padding.
CUnitValue	getPaddingTop() Get top padding.
CUnitValue	getWidth() Get width.
void	setHeight(CUnitValue height) Set height using a unit value.
void	setHeight(float height) Set height in points.
void	setMargin(float commonMargin) Set all margins using the same value.
void	setMarginBottom(float value) Set bottom margin in points.
void	setMarginLeft(float value) Set left margin in points.
void	setMarginRight(float value) Set right margin in points.
void	setMargins(float marginTop, float marginRight, float marginBottom, float marginLeft) Set margins for each side.
void	setMarginTop(float value) Set top margin in points.
void	setMaxHeight(CUnitValue maxHeight) Set maximum height using a unit value.
void	setMaxHeight(float maxHeight) Set maximum height in points.
void	setMaxWidth(CUnitValue maxWidth) Set maximum width using a unit value.
void	setMaxWidth(float maxWidth) Set maximum width in points.
void	setMinHeight(CUnitValue minHeight) Set minimum height using a unit value.
void	setMinHeight(float minHeight) Set minimum height in points.
void	setMinWidth(CUnitValue minWidth) Set minimum width using a unit value.
void	setMinWidth(float minWidth) Set minimum width in points.
void	setPadding(float commonPadding) Set all paddings using the same value.
void	setPaddingBottom(float value) Set bottom padding in points.
void	setPaddingLeft(float value) Set left padding in points.
void	setPaddingRight(float value) Set right padding in points.
void	setPaddings(float paddingTop, float paddingRight, float paddingBottom, float paddingLeft) Set paddings for each side.
void	setPaddingTop(float value) Set top padding in points.
void	setVerticalAlignment(CVerticalAlignment verticalAlignment) Set vertical alignment for this block element.
void	setWidth(CUnitValue width) Set width using a unit value.
void	setWidth(float width) Set width in points.

Methods inherited from class CPDFGeneration.layout.CAbstractElement

addStyle, getChildren, getStyles, hasProperty, isAbsolute, isEmpty

Methods inherited from class CPDFGeneration.layout.CElementPropertyContainer

deleteProperty, getProperties, getStrokeColor, getStrokeWidth, hasProperty, setAbsolutePosition, setAbsolutePosition, setBackgroundColor, setBackgroundImage, setBorder, setBorderBottom, setBorderBottomLeftRadius, setBorderBottomRightRadius, setBorderLeft, setBorderRadius, setBorderRight, setBorderTop, setBorderTopLeftRadius, setBorderTopRightRadius, setCharacterSpacing, setFontColor, setFontFamily, setFontSize, setFontStyle, setFontWeight, setHorizontalAlignment, setInlineVerticalAlignment, setOpacity, setStrokeColor, setStrokeWidth, setTextAlignment, setUnderline, setWordSpacing

Methods inherited from class java.lang.Object

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

Methods inherited from interface CPDFGeneration.layout.CIElement

getType

Constructor Detail

CBlockElement

public CBlockElement(long ptr)

Create a block element with native pointer.

Parameters:

ptr - Native element pointer/handle.

Method Detail

getMarginLeft

public CUnitValue getMarginLeft()

Get left margin.

Returns:

Left margin as a CUnitValue.

getMarginRight

public CUnitValue getMarginRight()

Get right margin.

Returns:

Right margin as a CUnitValue.

getMarginTop

public CUnitValue getMarginTop()

Get top margin.

Returns:

Top margin as a CUnitValue.

getMarginBottom

public CUnitValue getMarginBottom()

Get bottom margin.

Returns:

Bottom margin as a CUnitValue.

setMarginLeft

public void setMarginLeft(float value)

Set left margin in points.

Parameters:

value - Left margin value (unit is implementation-defined; commonly points).

setMarginRight

public void setMarginRight(float value)

Set right margin in points.

Parameters:

value - Right margin value (unit is implementation-defined; commonly points).

setMarginTop

public void setMarginTop(float value)

Set top margin in points.

Parameters:

value - Top margin value (unit is implementation-defined; commonly points).

setMarginBottom

public void setMarginBottom(float value)

Set bottom margin in points.

Parameters:

value - Bottom margin value (unit is implementation-defined; commonly points).

setMargin

public void setMargin(float commonMargin)

Set all margins using the same value.

Parameters:

commonMargin - Margin value applied to top/right/bottom/left.

setMargins

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

Set margins for each side.

Parameters:

marginTop - Top margin.

marginRight - Right margin.

marginBottom - Bottom margin.

marginLeft - Left margin.

getPaddingLeft

public CUnitValue getPaddingLeft()

Get left padding.

Returns:

Left padding as a CUnitValue.

getPaddingRight

public CUnitValue getPaddingRight()

Get right padding.

Returns:

Right padding as a CUnitValue.

getPaddingTop

public CUnitValue getPaddingTop()

Get top padding.

Returns:

Top padding as a CUnitValue.

getPaddingBottom

public CUnitValue getPaddingBottom()

Get bottom padding.

Returns:

Bottom padding as a CUnitValue.

setPaddingLeft

public void setPaddingLeft(float value)

Set left padding in points.

Parameters:

value - Left padding value (unit is implementation-defined; commonly points).

setPaddingRight

public void setPaddingRight(float value)

Set right padding in points.

Parameters:

value - Right padding value (unit is implementation-defined; commonly points).

setPaddingTop

public void setPaddingTop(float value)

Set top padding in points.

Parameters:

value - Top padding value (unit is implementation-defined; commonly points).

setPaddingBottom

public void setPaddingBottom(float value)

Set bottom padding in points.

Parameters:

value - Bottom padding value (unit is implementation-defined; commonly points).

setPadding

public void setPadding(float commonPadding)

Set all paddings using the same value.

Parameters:

commonPadding - Padding value applied to top/right/bottom/left.

setPaddings

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

Set paddings for each side.

Parameters:

paddingTop - Top padding.

paddingRight - Right padding.

paddingBottom - Bottom padding.

paddingLeft - Left padding.

setVerticalAlignment

public void setVerticalAlignment(CVerticalAlignment verticalAlignment)

Set vertical alignment for this block element.

Parameters:

verticalAlignment - Vertical alignment enum.

setWidth

public void setWidth(float width)

Set width in points.

Parameters:

width - Width value in points.

setWidth

public void setWidth(CUnitValue width)

Set width using a unit value.

Parameters:

width - Width as CUnitValue.

getWidth

public CUnitValue getWidth()

Get width.

Returns:

Width as a CUnitValue.

setHeight

public void setHeight(float height)

Set height in points.

Parameters:

height - Height value in points.

setHeight

public void setHeight(CUnitValue height)

Set height using a unit value.

Parameters:

height - Height as CUnitValue.

getHeight

public CUnitValue getHeight()

Get height.

Returns:

Height as a CUnitValue.

setMaxHeight

public void setMaxHeight(float maxHeight)

Set maximum height in points.

Parameters:

maxHeight - Maximum height value in points.

setMaxHeight

public void setMaxHeight(CUnitValue maxHeight)

Set maximum height using a unit value.

Parameters:

maxHeight - Maximum height as CUnitValue.

setMinHeight

public void setMinHeight(float minHeight)

Set minimum height in points.

Parameters:

minHeight - Minimum height value in points.

setMinHeight

public void setMinHeight(CUnitValue minHeight)

Set minimum height using a unit value.

Parameters:

minHeight - Minimum height as CUnitValue.

setMaxWidth

public void setMaxWidth(float maxWidth)

Set maximum width in points.

Parameters:

maxWidth - Maximum width value in points.

setMaxWidth

public void setMaxWidth(CUnitValue maxWidth)

Set maximum width using a unit value.

Parameters:

maxWidth - Maximum width as CUnitValue.

setMinWidth

public void setMinWidth(float minWidth)

Set minimum width in points.

Parameters:

minWidth - Minimum width value in points.

setMinWidth

public void setMinWidth(CUnitValue minWidth)

Set minimum width using a unit value.

Parameters:

minWidth - Minimum width as CUnitValue.