com.helger.pdflayout.base

Interface IPLHasPadding<IMPLTYPE extends IPLHasPadding<IMPLTYPE>>

Type Parameters:

IMPLTYPE - Implementation type

All Superinterfaces:

com.helger.commons.traits.IGenericImplTrait<IMPLTYPE>, com.helger.commons.id.IHasID<String>, IPLObject<IMPLTYPE>

All Known Subinterfaces:

IPLElement<IMPLTYPE>, IPLHasMarginBorderPadding<IMPLTYPE>

All Known Implementing Classes:

AbstractPLAlignedElement, AbstractPLElement, AbstractPLHBox, AbstractPLHBoxSplittable, AbstractPLText, AbstractPLVBox, AbstractPLVBoxSplittable, PLHBox, PLHBoxSplittable, PLImage, PLPageSet, PLSpacerX, PLTable, PLText, PLTextSplittable, PLTextWithPlaceholders, PLVBox, PLVBoxSplittable

public interface IPLHasPadding<IMPLTYPE extends IPLHasPadding<IMPLTYPE>>
extends IPLObject<IMPLTYPE>

Base interface for objects having a padding

Author:

Philip Helger

Field Summary

Fields

Modifier and Type	Field and Description
static PaddingSpec	DEFAULT_PADDING

Method Summary

Modifier and Type	Method and Description
PaddingSpec	getPadding()
default float	getPaddingBottom()
default float	getPaddingLeft()
default float	getPaddingRight()
default float	getPaddingTop()
default float	getPaddingXSum()
default float	getPaddingYSum()
default IMPLTYPE	setPadding(float fPadding) Set all padding values (left, top, right, bottom) to the same value.
default IMPLTYPE	setPadding(float fPaddingY, float fPaddingX) Set all padding values.
default IMPLTYPE	setPadding(float fPaddingTop, float fPaddingRight, float fPaddingBottom, float fPaddingLeft) Set all padding values to potentially different values.
IMPLTYPE	setPadding(PaddingSpec aPadding) Set the padding values.
default IMPLTYPE	setPaddingBottom(float fPadding) Set the bottom padding value.
default IMPLTYPE	setPaddingLeft(float fPadding) Set the left padding value.
default IMPLTYPE	setPaddingRight(float fPadding) Set the right padding value.
default IMPLTYPE	setPaddingTop(float fPadding) Set the top padding value.

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

getAsSplittable, getDebugID, isSplittable

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

getComparatorID, getID

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

thisAsT

Field Detail

DEFAULT_PADDING

static final PaddingSpec DEFAULT_PADDING

Method Detail

setPadding

@Nonnull
default IMPLTYPE setPadding(float fPadding)

Set all padding values (left, top, right, bottom) to the same value. This method may not be called after an element got prepared!

Parameters:

fPadding - The value to use.

Returns:

this

setPadding

@Nonnull
default IMPLTYPE setPadding(float fPaddingY,
                                      float fPaddingX)

Set all padding values. This method may not be called after an element got prepared!

Parameters:

fPaddingY - The Y-value to use (for top and bottom).

fPaddingX - The X-value to use (for left and right).

Returns:

this

setPadding

@Nonnull
default IMPLTYPE setPadding(float fPaddingTop,
                                      float fPaddingRight,
                                      float fPaddingBottom,
                                      float fPaddingLeft)

Set all padding values to potentially different values. This method may not be called after an element got prepared!

Parameters:

fPaddingTop - Top

fPaddingRight - Right

fPaddingBottom - Bottom

fPaddingLeft - Left

Returns:

this

setPadding

@Nonnull
IMPLTYPE setPadding(@Nonnull
                              PaddingSpec aPadding)

Set the padding values. This method may not be called after an element got prepared!

Parameters:

aPadding - Padding to use. May not be null.

Returns:

this

setPaddingTop

@Nonnull
default IMPLTYPE setPaddingTop(float fPadding)

Set the top padding value. This method may not be called after an element got prepared!

Parameters:

fPadding - The value to use.

Returns:

this

setPaddingRight

@Nonnull
default IMPLTYPE setPaddingRight(float fPadding)

Set the right padding value. This method may not be called after an element got prepared!

Parameters:

fPadding - The value to use.

Returns:

this

setPaddingBottom

@Nonnull
default IMPLTYPE setPaddingBottom(float fPadding)

Set the bottom padding value. This method may not be called after an element got prepared!

Parameters:

fPadding - The value to use.

Returns:

this

setPaddingLeft

@Nonnull
default IMPLTYPE setPaddingLeft(float fPadding)

Set the left padding value. This method may not be called after an element got prepared!

Parameters:

fPadding - The value to use.

Returns:

this

getPadding

@Nonnull
PaddingSpec getPadding()

Returns:

The current padding. Never null.

getPaddingTop

default float getPaddingTop()

Returns:

The current top padding.

getPaddingRight

default float getPaddingRight()

Returns:

The current right padding.

getPaddingBottom

default float getPaddingBottom()

Returns:

The current bottom padding.

getPaddingLeft

default float getPaddingLeft()

Returns:

The current left padding.

getPaddingXSum

default float getPaddingXSum()

Returns:

The sum of left and right padding.

getPaddingYSum

default float getPaddingYSum()

Returns:

The sum of top and bottom padding.