com.helger.pdflayout.base

Interface IPLSplittableObject<IMPLTYPE extends IPLSplittableObject<IMPLTYPE>>

Type Parameters:

IMPLTYPE - Implementation type

All Superinterfaces:

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

All Known Implementing Classes:

AbstractPLHBoxSplittable, AbstractPLVBoxSplittable, PLHBoxSplittable, PLTable, PLTextSplittable, PLVBoxSplittable

public interface IPLSplittableObject<IMPLTYPE extends IPLSplittableObject<IMPLTYPE>>
extends IPLObject<IMPLTYPE>

Base interface for a splittable element

Author:

Philip Helger

Method Summary

Modifier and Type	Method and Description
default boolean	isSplittable()
PLSplitResult	splitElements(float fElementWidth, float fAvailableHeight) Split this element into sub-elements according to the available height.

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

getAsSplittable, getDebugID

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

getComparatorID, getID

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

thisAsT

Method Detail

isSplittable

default boolean isSplittable()

Specified by:

isSplittable in interface IPLObject<IMPLTYPE extends IPLSplittableObject<IMPLTYPE>>

Returns:

Always true for splittable elements

splitElements

@Nullable
PLSplitResult splitElements(@Nonnegative
                                       float fElementWidth,
                                       @Nonnegative
                                       float fAvailableHeight)

Split this element into sub-elements according to the available height. Splitting is always done after preparation and must return prepared objects!

Parameters:

fElementWidth - The element width without padding or margin of the element.

fAvailableHeight - The available height without y-padding and y-margin of this element. Must be ≥ 0.

Returns:

null if splitting makes no sense.