Package com.helger.pdflayout.base

Class PLMarginBorderPadding

java.lang.Object

com.helger.pdflayout.base.PLMarginBorderPadding

All Implemented Interfaces:

com.helger.commons.traits.IGenericImplTrait<PLMarginBorderPadding>, IPLHasBorder<PLMarginBorderPadding>, IPLHasMargin<PLMarginBorderPadding>, IPLHasMarginBorderPadding<PLMarginBorderPadding>, IPLHasOutline, IPLHasPadding<PLMarginBorderPadding>

@NotThreadSafe
public class PLMarginBorderPadding
extends Object
implements IPLHasMarginBorderPadding<PLMarginBorderPadding>

Represents a single page layout as element. It consists of a page size, a page header and footer as well as a set of page body elements.

Author:

Philip Helger

Field Summary

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

DEFAULT_BORDER

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

DEFAULT_MARGIN

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

DEFAULT_PADDING

Constructor Summary

Constructors

Constructor	Description
PLMarginBorderPadding(MarginSpec aMargin, PaddingSpec aPadding, BorderSpec aBorder)

Method Summary

Modifier and Type	Method	Description
BorderSpec	getBorder()
MarginSpec	getMargin()
PaddingSpec	getPadding()
PLMarginBorderPadding	setBorder(BorderSpec aBorder)	Set the border values.
PLMarginBorderPadding	setMargin(MarginSpec aMargin)	Set the margin values.
PLMarginBorderPadding	setPadding(PaddingSpec aPadding)	Set the padding values.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

thisAsT

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

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

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

addMarginBottom, addMarginLeft, addMarginRight, addMarginTop, addMarginX, addMarginY, getMarginBottom, getMarginLeft, getMarginRight, getMarginTop, getMarginXSum, getMarginYSum, 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, getPaddingBottom, getPaddingLeft, getPaddingRight, getPaddingTop, getPaddingXSum, getPaddingYSum, setPadding, setPadding, setPadding, setPaddingBottom, setPaddingLeft, setPaddingRight, setPaddingTop, setPaddingX, setPaddingY

Constructor Detail

PLMarginBorderPadding

public PLMarginBorderPadding(@Nonnull
                             MarginSpec aMargin,
                             @Nonnull
                             PaddingSpec aPadding,
                             @Nonnull
                             BorderSpec aBorder)

Method Detail

getMargin

@Nonnull
public final MarginSpec getMargin()

Specified by:

getMargin in interface IPLHasMargin<PLMarginBorderPadding>

Returns:

The current margin. Never null.

setMargin

@Nonnull
public final PLMarginBorderPadding setMargin(@Nonnull
                                             MarginSpec aMargin)

Description copied from interface: IPLHasMargin

Set the margin values.

Specified by:

setMargin in interface IPLHasMargin<PLMarginBorderPadding>

Parameters:

aMargin - Margin to use. May not be null.

Returns:

this

getPadding

@Nonnull
public final PaddingSpec getPadding()

Specified by:

getPadding in interface IPLHasPadding<PLMarginBorderPadding>

Returns:

The current padding. Never null.

setPadding

@Nonnull
public final PLMarginBorderPadding setPadding(@Nonnull
                                              PaddingSpec aPadding)

Description copied from interface: IPLHasPadding

Set the padding values.

Specified by:

setPadding in interface IPLHasPadding<PLMarginBorderPadding>

Parameters:

aPadding - Padding to use. May not be null.

Returns:

this

getBorder

@Nonnull
public final BorderSpec getBorder()

Specified by:

getBorder in interface IPLHasBorder<PLMarginBorderPadding>

Returns:

The current border. Never null.

setBorder

@Nonnull
public final PLMarginBorderPadding setBorder(@Nonnull
                                             BorderSpec aBorder)

Description copied from interface: IPLHasBorder

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

Specified by:

setBorder in interface IPLHasBorder<PLMarginBorderPadding>

Parameters:

aBorder - Border to use. May not be null.

Returns:

this

toString

public String toString()

Overrides:

toString in class Object