com.helger.pdflayout.base

Interface IPLHasMargin<IMPLTYPE extends IPLHasMargin<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 IPLHasMargin<IMPLTYPE extends IPLHasMargin<IMPLTYPE>>
extends IPLObject<IMPLTYPE>

Base interface for objects having a margin

Author:

Philip Helger

Field Summary

Fields

Modifier and Type	Field and Description
static MarginSpec	DEFAULT_MARGIN

Method Summary

Modifier and Type	Method and Description
MarginSpec	getMargin()
default float	getMarginBottom()
default float	getMarginLeft()
default float	getMarginRight()
default float	getMarginTop()
default float	getMarginXSum()
default float	getMarginYSum()
default IMPLTYPE	setMargin(float fMargin) Set all margin values (left, top, right, bottom) to the same value.
default IMPLTYPE	setMargin(float fMarginY, float fMarginX) Set all margin values.
default IMPLTYPE	setMargin(float fMarginTop, float fMarginRight, float fMarginBottom, float fMarginLeft) Set all margin values to potentially different values.
IMPLTYPE	setMargin(MarginSpec aMargin) Set the margin values.
default IMPLTYPE	setMarginBottom(float fMargin) Set the bottom margin value.
default IMPLTYPE	setMarginLeft(float fMargin) Set the left margin value.
default IMPLTYPE	setMarginRight(float fMargin) Set the right margin value.
default IMPLTYPE	setMarginTop(float fMargin) Set the top margin 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_MARGIN

static final MarginSpec DEFAULT_MARGIN

Method Detail

setMargin

@Nonnull
default IMPLTYPE setMargin(float fMargin)

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

Parameters:

fMargin - The value to use.

Returns:

this

setMargin

@Nonnull
default IMPLTYPE setMargin(float fMarginY,
                                     float fMarginX)

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

Parameters:

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

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

Returns:

this

setMargin

@Nonnull
default IMPLTYPE setMargin(float fMarginTop,
                                     float fMarginRight,
                                     float fMarginBottom,
                                     float fMarginLeft)

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

Parameters:

fMarginTop - Top

fMarginRight - Right

fMarginBottom - Bottom

fMarginLeft - Left

Returns:

this

setMargin

@Nonnull
IMPLTYPE setMargin(@Nonnull
                             MarginSpec aMargin)

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

Parameters:

aMargin - Margin to use. May not be null.

Returns:

this

setMarginTop

@Nonnull
default IMPLTYPE setMarginTop(float fMargin)

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

Parameters:

fMargin - The value to use.

Returns:

this

setMarginRight

@Nonnull
default IMPLTYPE setMarginRight(float fMargin)

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

Parameters:

fMargin - The value to use.

Returns:

this

setMarginBottom

@Nonnull
default IMPLTYPE setMarginBottom(float fMargin)

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

Parameters:

fMargin - The value to use.

Returns:

this

setMarginLeft

@Nonnull
default IMPLTYPE setMarginLeft(float fMargin)

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

Parameters:

fMargin - The value to use.

Returns:

this

getMargin

@Nonnull
MarginSpec getMargin()

Returns:

The current margin. Never null.

getMarginTop

default float getMarginTop()

Returns:

The current top margin.

getMarginRight

default float getMarginRight()

Returns:

The current right margin.

getMarginBottom

default float getMarginBottom()

Returns:

The current bottom margin.

getMarginLeft

default float getMarginLeft()

Returns:

The current left margin.

getMarginXSum

default float getMarginXSum()

Returns:

The sum of left and right margin.

getMarginYSum

default float getMarginYSum()

Returns:

The sum of top and bottom margin.