Package com.itextpdf.layout.renderer

Class LinkRenderer

java.lang.Object

com.itextpdf.layout.renderer.AbstractRenderer

com.itextpdf.layout.renderer.TextRenderer

com.itextpdf.layout.renderer.LinkRenderer

All Implemented Interfaces:

IPropertyContainer, ILeafElementRenderer, IRenderer

       public class LinkRenderer extends TextRenderer
      

Field Summary

Fields inherited from class com.itextpdf.layout.renderer.TextRenderer

line, otfFeaturesApplied, reversedRanges, savedWordBreakAtLineEnding, strToBeConverted, tabAnchorCharacterPosition, text, TEXT_SPACE_COEFF, yLineOffset

Fields inherited from class com.itextpdf.layout.renderer.AbstractRenderer

childRenderers, EPS, flushed, INF, isLastRendererForModelElement, isVerticalMode, modelElement, occupiedArea, OVERLAP_EPSILON, parent, positionedRenderers, properties

Constructor Summary

Constructors

Modifier	Constructor	Description
	LinkRenderer(Link link)	Creates a LinkRenderer from its corresponding layout object.
	LinkRenderer(Link linkElement, String text)	Creates a LinkRenderer from its corresponding layout object, with a custom text to replace the contents of the Link.
protected	LinkRenderer(LinkRenderer other)	Creates a new LinkRenderer as a copy of the given one.

Method Summary

Modifier and Type	Method	Description
protected TextRenderer	createCopy(GlyphLine gl, PdfFont font)	Creates a copy of this TextRenderer, which corresponds to the passed GlyphLine with PdfFont.
IRenderer	getNextRenderer()	Gets a new instance of this class to be used as a next renderer, after this renderer is used, if TextRenderer.layout(LayoutContext) is called more than once.

Methods inherited from class com.itextpdf.layout.renderer.TextRenderer

applyOtf, baseCharactersCount, calculateAscenderDescender, calculateAscenderDescender, calculateLineWidth, charAt, createOverflowRenderer, createSplitRenderer, draw, drawSingleUnderline, getAscent, getBackgroundArea, getDescent, getFirstYLineRecursively, getLastYLineRecursively, getMinMaxWidth, getNumberOfSpaces, getTabAnchorCharacterPosition, getText, getYLine, layout, length, lineLength, moveYLineTo, resolveFonts, setProcessedGlyphLineAndFont, setText, setText, split, toString, trimFirst

Methods inherited from class com.itextpdf.layout.renderer.AbstractRenderer

addAllProperties, addChild, alignChildHorizontally, allowLastYLineRecursiveExtraction, applyAbsolutePosition, applyAction, applyBorderBox, applyBorderBox, applyDestination, applyDestinationsAndAnnotation, applyLinkAnnotation, applyMargins, applyMargins, applyPaddings, applyPaddings, applyRelativePositioningTranslation, beginElementOpacityApplying, beginTransformationIfApplied, calculateAbsolutePdfBBox, calculateBBox, calculateShiftToPositionBBoxOfPointsAt, clipBackgroundArea, clipBackgroundArea, clipBorderArea, createXObject, createXObject, deleteOwnProperty, deleteProperty, drawBackground, drawBorder, drawChildren, endElementOpacityApplying, endTransformationIfApplied, getBorderAreaBBox, getBorderRadii, getBorders, getChildRenderers, getDefaultProperty, getInnerAreaBBox, getMargins, getMinMaxWidth, getModelElement, getOccupiedArea, getOccupiedAreaBBox, getOwnProperties, getOwnProperty, getPaddings, getParent, getPositionenRenderers, getProperty, getProperty, getPropertyAsBoolean, getPropertyAsColor, getPropertyAsFloat, getPropertyAsFloat, getPropertyAsFont, getPropertyAsInteger, getPropertyAsTransparentColor, getPropertyAsUnitValue, hasAbsoluteUnitValue, hasOwnOrModelProperty, hasOwnProperty, hasProperty, hasRelativeUnitValue, initElementAreas, isAbsolutePosition, isBorderBoxSizing, isFirstOnRootArea, isFixedLayout, isFlushed, isKeepTogether, isNotFittingHeight, isNotFittingLayoutArea, isNotFittingWidth, isOverflowFit, isOverflowProperty, isOverflowProperty, isOverflowProperty, isPositioned, isRelativePosition, isStaticLayout, move, rectangleToPointsList, retrieveHeight, retrieveMaxHeight, retrieveMaxWidth, retrieveMinHeight, retrieveMinWidth, retrieveResolvedDeclaredHeight, retrieveUnitValue, retrieveUnitValue, retrieveWidth, setBorders, setMinMaxWidthBasedOnFixedWidth, setParent, setProperty, transformPoints, updateHeight, updateHeightsOnSplit, updateMaxHeight, updateMinHeight, updateWidth

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.itextpdf.layout.IPropertyContainer

deleteOwnProperty, getDefaultProperty, getOwnProperty, getProperty, hasOwnProperty, hasProperty, setProperty

Methods inherited from interface com.itextpdf.layout.renderer.IRenderer

addChild, getChildRenderers, getModelElement, getOccupiedArea, getParent, getProperty, isFlushed, move, setParent

Constructor Details

LinkRenderer

             public LinkRenderer
             (Link link)
            

Creates a LinkRenderer from its corresponding layout object.

Parameters:

link - the Link which this object should manage

LinkRenderer

             public LinkRenderer
             (Link linkElement, String text)
            

Creates a LinkRenderer from its corresponding layout object, with a custom text to replace the contents of the Link.

Parameters:

linkElement - the Link which this object should manage

text - the replacement text

LinkRenderer

             protected LinkRenderer
             (LinkRenderer other)
            

Creates a new LinkRenderer as a copy of the given one.

Parameters:

other - the LinkRenderer to copy

Method Details

getNextRenderer

             public IRenderer getNextRenderer()
            

Gets a new instance of this class to be used as a next renderer, after this renderer is used, if TextRenderer.layout(LayoutContext) is called more than once.

If a renderer overflows to the next area, iText uses this method to create a renderer for the overflow part. So if one wants to extend LinkRenderer, one should override this method: otherwise the default method will be used and thus the default rather than the custom renderer will be created.

Specified by:

getNextRenderer in interface IRenderer

Overrides:

getNextRenderer in class TextRenderer

Returns:

new renderer instance

createCopy

             protected TextRenderer createCopy
             (GlyphLine gl, PdfFont font)
            

Creates a copy of this TextRenderer, which corresponds to the passed GlyphLine with PdfFont.

While processing TextRenderer, iText uses this method to create glyph lines of specific fonts, which represent the TextRenderer's parts. If one extends TextRenderer, one should override this method, otherwise if FontSelector related logic is triggered, copies of this TextRenderer will have the default behavior rather than the custom one.

Overrides:

createCopy in class TextRenderer

Parameters:

gl - a GlyphLine which represents some of this TextRenderer's content

font - a PdfFont for this part of the TextRenderer's content

Returns:

copy of this TextRenderer, which correspond to the passed GlyphLine with PdfFont