IPLObject (ph-pdf-layout 7.0.1 API)

Type Parameters:

IMPLTYPE - Implementation type

All Superinterfaces:

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

All Known Subinterfaces:

IPLBlockElement<IMPLTYPE>, IPLElement<IMPLTYPE>, IPLHasHorizontalAlignment<IMPLTYPE>, IPLHasVerticalAlignment<IMPLTYPE>, IPLInlineElement<IMPLTYPE>, IPLRenderableObject<IMPLTYPE>, IPLSplittableObject<IMPLTYPE,SPLITTYPE>

All Known Implementing Classes:

AbstractPLBlockElement, AbstractPLBox, AbstractPLElement, AbstractPLExternalLink, AbstractPLHBox, AbstractPLImage, AbstractPLInlineBox, AbstractPLInlineElement, AbstractPLObject, AbstractPLRenderableObject, AbstractPLText, AbstractPLVBox, PLBox, PLBulletPointList, PLExternalLink, PLHBox, PLImage, PLPageBreak, PLPageSet, PLSpacerX, PLSpacerY, PLStreamImage, PLTable, PLTableCell, PLTableRow, PLText, PLVBox
```
public interface IPLObject<IMPLTYPE extends IPLObject<IMPLTYPE>>
extends com.helger.commons.id.IHasID<String>, com.helger.commons.traits.IGenericImplTrait<IMPLTYPE>, IPLVisitable
```
Base interface for a PDF layout object

Author:

Philip Helger

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`default IPLSplittableObject<?,?>`	`getAsSplittable()`
`String`	`getDebugID()`
`default boolean`	`hasID(String sID)`
`default boolean`	`isVertSplittable()`
`IMPLTYPE`	`setBasicDataFrom(IMPLTYPE aSource)`	For copying stuff internally.

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.IPLVisitable
visit

- Method Detail
  - hasID
```
default boolean hasID(@Nullable
                      String sID)
```
  - getDebugID
```
@Nonnull
@Nonempty
String getDebugID()
```
    Returns:
    
    The debug ID of this element. Neither null nor empty. The debug ID is usually automatically created automatically from the ID.
  - isVertSplittable
```
default boolean isVertSplittable()
```
    Returns:
    
    true if this element is splittable, false otherwise.
  - getAsSplittable
```
@Nonnull
default IPLSplittableObject<?,?> getAsSplittable()
```
    Returns:
    
    this as an IPLSplittableObject - ensure to call it only if isVertSplittable() returns true.
  - setBasicDataFrom
```
@Nonnull
@OverridingMethodsMustInvokeSuper
IMPLTYPE setBasicDataFrom(@Nonnull
                          IMPLTYPE aSource)
```
    For copying stuff internally. Must always call super method
    
    Parameters:
    
    aSource - Source object to copy from. May not be null.
    
    Returns:
    
    this for chaining