Package com.helger.pdflayout.element.link

Class AbstractPLExternalLink<IMPLTYPE extends AbstractPLExternalLink<IMPLTYPE>>

java.lang.Object

com.helger.pdflayout.base.AbstractPLObject<IMPLTYPE>

com.helger.pdflayout.base.AbstractPLRenderableObject<IMPLTYPE>

com.helger.pdflayout.base.AbstractPLElement<IMPLTYPE>

com.helger.pdflayout.element.box.AbstractPLInlineBox<IMPLTYPE>

com.helger.pdflayout.element.link.AbstractPLExternalLink<IMPLTYPE>

Type Parameters:

IMPLTYPE - Implementation type

All Implemented Interfaces:

com.helger.commons.id.IHasID<String>, com.helger.commons.traits.IGenericImplTrait<IMPLTYPE>, IPLElement<IMPLTYPE>, IPLHasBorder<IMPLTYPE>, IPLHasFillColor<IMPLTYPE>, IPLHasMargin<IMPLTYPE>, IPLHasMarginBorderPadding<IMPLTYPE>, IPLHasOutline, IPLHasPadding<IMPLTYPE>, IPLObject<IMPLTYPE>, IPLRenderableObject<IMPLTYPE>, IPLSplittableObject<IMPLTYPE,IMPLTYPE>, IPLVisitable

Direct Known Subclasses:

PLExternalLink

public abstract class AbstractPLExternalLink<IMPLTYPE extends AbstractPLExternalLink<IMPLTYPE>>
extends AbstractPLInlineBox<IMPLTYPE>

An external link that references to an external URI. Use setURI(String) to define the link target.

Since:

6.0.1

Author:

Philip Helger

Field Summary

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

DEFAULT_MAX_SIZE, DEFAULT_MIN_SIZE

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

DEFAULT_BORDER

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

DEFAULT_FILL_COLOR

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

DEFAULT_MARGIN

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

DEFAULT_PADDING

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

DEFAULT_VERT_SPLITTABLE

Constructor Summary

Constructors

Constructor	Description
AbstractPLExternalLink(IPLRenderableObject<?> aElement)

Method Summary

Modifier and Type	Method	Description
final String	getURI()
protected void	onRender(PageRenderContext aCtx)	Abstract method to be implemented by subclasses.
IMPLTYPE	setBasicDataFrom(IMPLTYPE aSource)	For copying stuff internally.
final IMPLTYPE	setURI(String sURI)	Set the URI to link to.

Methods inherited from class com.helger.pdflayout.element.box.AbstractPLInlineBox

getElement, getElementPreparedSize, hasElement, internalSetElementPreparedSize, isVertSplittable, onMarkAsNotPrepared, onPrepare, setElement, setVertSplittable, splitElementVert, toString, visit

Methods inherited from class com.helger.pdflayout.base.AbstractPLElement

getBorder, getFillColor, getMargin, getMaxSize, getMinSize, getPadding, getRenderSize, setBorder, setFillColor, setMargin, setMaxSize, setMinSize, setPadding

Methods inherited from class com.helger.pdflayout.base.AbstractPLRenderableObject

getPrepareAvailableSize, getPreparedSize, getRenderSize, internalCheckAlreadyPrepared, internalCheckNotPrepared, internalMarkAsNotPrepared, internalMarkAsNotPreparedDontPropagate, internalMarkAsPrepared, isPrepared, onRenderSizeChange, prepare, render

Methods inherited from class com.helger.pdflayout.base.AbstractPLObject

getDebugID, getID, onAfterSetID, setID

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.commons.id.IHasID

getID

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

getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, setExactHeight, setExactSize, setExactWidth, setMaxHeight, setMaxSize, setMaxWidth, setMinHeight, setMinSize, setMinWidth

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.IPLHasFillColor

hasFillColor

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

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

getAsSplittable, getDebugID, hasID

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

beforeRender, getPreparedHeight, getPreparedSize, getPreparedWidth, getRenderHeight, getRenderSize, getRenderWidth, isPrepared, prepare, render

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

internalCreateNewVertSplitObject

Constructor Details

AbstractPLExternalLink

public AbstractPLExternalLink(@Nullable
 IPLRenderableObject<?> aElement)

Method Details

setBasicDataFrom

@Nonnull
@OverridingMethodsMustInvokeSuper
public IMPLTYPE setBasicDataFrom(@Nonnull
 IMPLTYPE aSource)

Description copied from interface: IPLObject

For copying stuff internally. Must always call super method

Specified by:

setBasicDataFrom in interface IPLObject<IMPLTYPE extends AbstractPLExternalLink<IMPLTYPE>>

Overrides:

setBasicDataFrom in class AbstractPLInlineBox<IMPLTYPE extends AbstractPLExternalLink<IMPLTYPE>>

Parameters:

aSource - Source object to copy from. May not be null.

Returns:

this for chaining

getURI

@Nullable
public final String getURI()

Returns:

The URI to link to. May be null.

setURI

@Nonnull
public final IMPLTYPE setURI(@Nullable
 String sURI)

Set the URI to link to.

Parameters:

sURI - The URI to link to. May be null.

Returns:

this for chaining.

onRender

protected void onRender(@Nonnull
 PageRenderContext aCtx)
                 throws IOException

Description copied from class: AbstractPLRenderableObject

Abstract method to be implemented by subclasses.

Overrides:

onRender in class AbstractPLInlineBox<IMPLTYPE extends AbstractPLExternalLink<IMPLTYPE>>

Parameters:

aCtx - Rendering context. Never null.

Throws:

IOException - In case of a PDFBox error