Package com.helger.pdflayout.base

Interface IPLBlockElement<IMPLTYPE extends IPLBlockElement<IMPLTYPE>>

Type Parameters:

IMPLTYPE - Implementation type

All Superinterfaces:

com.helger.commons.traits.IGenericImplTrait<IMPLTYPE>, com.helger.commons.id.IHasID<String>, IPLElement<IMPLTYPE>, IPLHasBorder<IMPLTYPE>, IPLHasFillColor<IMPLTYPE>, IPLHasHorizontalAlignment<IMPLTYPE>, IPLHasMargin<IMPLTYPE>, IPLHasMarginBorderPadding<IMPLTYPE>, IPLHasOutline, IPLHasPadding<IMPLTYPE>, IPLHasVerticalAlignment<IMPLTYPE>, IPLObject<IMPLTYPE>, IPLRenderableObject<IMPLTYPE>, IPLVisitable

All Known Implementing Classes:

AbstractPLBlockElement, AbstractPLBox, PLBox, PLTableCell

public interface IPLBlockElement<IMPLTYPE extends IPLBlockElement<IMPLTYPE>>
extends IPLElement<IMPLTYPE>, IPLHasHorizontalAlignment<IMPLTYPE>, IPLHasVerticalAlignment<IMPLTYPE>

Base interface for block elements. Compared to normal elements (IPLElement) they additionally have a horizontal alignment (IPLHasHorizontalAlignment) and vertical alignment (IPLHasVerticalAlignment).

Author:

Philip Helger

Field Summary

Fields

Modifier and Type	Field	Description
static final boolean	DEFAULT_CLIP_CONTENT	By default content is not clipped
static final boolean	DEFAULT_FULL_WIDTH	By default all block elements are full width.

Fields inherited from interface com.helger.pdflayout.base.IPLElement

DEFAULT_MAX_SIZE, DEFAULT_MIN_SIZE

Fields inherited from interface com.helger.pdflayout.base.IPLHasBorder

DEFAULT_BORDER

Fields inherited from interface com.helger.pdflayout.base.IPLHasFillColor

DEFAULT_FILL_COLOR

Fields inherited from interface com.helger.pdflayout.base.IPLHasHorizontalAlignment

DEFAULT_HORZ_ALIGNMENT

Fields inherited from interface com.helger.pdflayout.base.IPLHasMargin

DEFAULT_MARGIN

Fields inherited from interface com.helger.pdflayout.base.IPLHasPadding

DEFAULT_PADDING

Fields inherited from interface com.helger.pdflayout.base.IPLHasVerticalAlignment

DEFAULT_VERT_ALIGNMENT

Method Summary

Modifier and Type	Method	Description
boolean	isClipContent()
boolean	isFullWidth()
IMPLTYPE	setClipContent(boolean bClipContent)	Enable the clipping of content, so that only the content inside the rendering area is shown.
IMPLTYPE	setFullWidth(boolean bFullWidth)	Set usage of full width.

Methods inherited from interface com.helger.commons.traits.IGenericImplTrait

thisAsT

Methods inherited from interface com.helger.commons.id.IHasID

getID

Methods inherited from interface com.helger.pdflayout.base.IPLElement

getMaxHeight, getMaxSize, getMaxWidth, getMinHeight, getMinSize, getMinWidth, setExactHeight, setExactSize, setExactWidth, setMaxHeight, setMaxSize, setMaxSize, setMaxWidth, setMinHeight, setMinSize, setMinSize, setMinWidth

Methods inherited from interface com.helger.pdflayout.base.IPLHasBorder

getBorder, getBorderBottomWidth, getBorderLeftWidth, getBorderRightWidth, getBorderTopWidth, getBorderXSumWidth, getBorderYSumWidth, setBorder, setBorder, setBorder, setBorder, setBorder, setBorderBottom, setBorderLeft, setBorderRight, setBorderTop, setBorderX, setBorderY

Methods inherited from interface com.helger.pdflayout.base.IPLHasFillColor

getFillColor, hasFillColor, setFillColor

Methods inherited from interface com.helger.pdflayout.base.IPLHasHorizontalAlignment

getHorzAlign, getIndentX, setHorzAlign

Methods inherited from interface com.helger.pdflayout.base.IPLHasMargin

addMarginBottom, addMarginLeft, addMarginRight, addMarginTop, addMarginX, addMarginY, getMargin, getMarginBottom, getMarginLeft, getMarginRight, getMarginTop, getMarginXSum, getMarginYSum, setMargin, setMargin, setMargin, setMargin, setMarginBottom, setMarginLeft, setMarginRight, setMarginTop, setMarginX, setMarginY

Methods inherited from interface com.helger.pdflayout.base.IPLHasMarginBorderPadding

getOutlineBottom, getOutlineLeft, getOutlineRight, getOutlineTop, getOutlineXSum, getOutlineYSum

Methods inherited from interface com.helger.pdflayout.base.IPLHasPadding

addPaddingBottom, addPaddingLeft, addPaddingRight, addPaddingTop, addPaddingX, addPaddingY, getPadding, getPaddingBottom, getPaddingLeft, getPaddingRight, getPaddingTop, getPaddingXSum, getPaddingYSum, setPadding, setPadding, setPadding, setPadding, setPaddingBottom, setPaddingLeft, setPaddingRight, setPaddingTop, setPaddingX, setPaddingY

Methods inherited from interface com.helger.pdflayout.base.IPLHasVerticalAlignment

getIndentY, getIndentY, getVertAlign, setVertAlign

Methods inherited from interface com.helger.pdflayout.base.IPLObject

getAsSplittable, getDebugID, hasID, isVertSplittable, setBasicDataFrom

Methods inherited from interface com.helger.pdflayout.base.IPLRenderableObject

beforeRender, getPreparedHeight, getPreparedSize, getPreparedWidth, getRenderHeight, getRenderSize, getRenderWidth, isPrepared, prepare, render

Methods inherited from interface com.helger.pdflayout.base.IPLVisitable

visit

Field Details

DEFAULT_FULL_WIDTH

static final boolean DEFAULT_FULL_WIDTH

By default all block elements are full width.

See Also:

• Constant Field Values

DEFAULT_CLIP_CONTENT

static final boolean DEFAULT_CLIP_CONTENT

By default content is not clipped

See Also:

• Constant Field Values

Method Details

isFullWidth

boolean isFullWidth()

Returns:

Should the element occupy the full width? The default is DEFAULT_FULL_WIDTH.

setFullWidth

@Nonnull
IMPLTYPE setFullWidth(boolean bFullWidth)

Set usage of full width.

Parameters:

bFullWidth - true to enable full width, false to use only what is available.

Returns:

this for chaining

isClipContent

boolean isClipContent()

Returns:

true if any overflowing content should be clipped, false if not. Default is DEFAULT_CLIP_CONTENT.

Since:

7.3.1

setClipContent

@Nonnull
IMPLTYPE setClipContent(boolean bClipContent)

Enable the clipping of content, so that only the content inside the rendering area is shown. Similar to CSS style overflow:hidden. This usually only makes sense if a maximum width or height is defined additionally.

Parameters:

bClipContent - true to enable it, false to disable it.

Returns:

this for chaining

Since:

7.3.1