iText 9.4.0  Overview   Package   Class  Text Changes  Statistics  Help 
Generated by
JDiff
PREV PACKAGE    NEXT PACKAGE          FRAMES    NO FRAMES  

com.itextpdf.layout.renderer Documentation Differences

This file contains all the changes in documentation in the package com.itextpdf.layout.renderer as colored differences. Deletions are shown like this , and additions are shown like this.
If no deletions or additions are shown in an entry, the HTML tags will be what has changed. The new HTML tags are shown in the differences. If no documentation existed, and then some was added in a later version, this change is noted in the appropriate class pages of differences, but the change is not shown on this page. Only changes in existing text are shown here. Similarly, documentation which was inherited from another class or interface is not shown here.
Note that an HTML error in the new documentation may cause the display of other documentation changes to be presented incorrectly. For instance, failure to close a tag will cause all subsequent paragraphs to be displayed differently.
Class AbstractRenderer, Rectangle applyBorderBox(Rectangle, Border[], boolean)

Applies the given border box (borders) on the given rectangle @param rect a rectangle paddings will be applied on. @param borders the borders to be applied on the given rectangle @param reverse indicates whether the border box will be applied inside (in case of false) or outside (in case of false) the rectangle. @return a border box of the renderer
Class AbstractRenderer, Rectangle applyBorderBox(Rectangle, boolean)

Applies the border box of the renderer on the given rectangle If the border of a certain side is null, the side will remain as it was. @param rect a rectangle the border box will be applied on. @param reverse indicates whether the border box will be applied inside (in case of false) or outside (in case of true) the rectangle. @return a border box of the renderer renderer @see #getBorders
Class AbstractRenderer, Rectangle applyMargins(Rectangle, UnitValue[], boolean)

Applies given margins on the given rectangle @param rect a rectangle margins will be applied on. @param margins the margins to be applied on the given rectangle @param reverse indicates whether margins will be applied inside (in case of false) or outside (in case of true) the rectangle. @return a border box of the renderer
Class AbstractRenderer, Rectangle applyMargins(Rectangle, boolean)

Applies margins of the renderer on the given rectangle @param rect a rectangle margins will be applied on. @param reverse indicates whether margins will be applied inside (in case of false) or outside (in case of true) the rectangle. @return a border box of the renderer renderer @see #getMargins
Class AbstractRenderer, Rectangle applyPaddings(Rectangle, UnitValue[], boolean)

Applies given paddings to the given rectangle. @param rect a rectangle paddings will be applied on. @param paddings the paddings to be applied on the given rectangle @param reverse indicates whether paddings will be applied inside (in case of false) or outside (in case of true) the rectangle. @return a border box of the renderer
Class AbstractRenderer, Rectangle applyPaddings(Rectangle, boolean)

Applies paddings of the renderer on the given rectangle @param rect a rectangle paddings will be applied on. @param reverse indicates whether paddings will be applied inside (in case of false) or outside (in case of true) the rectangle. @return a border box of the renderer renderer @see #getPaddings
Class AbstractRenderer, void beginElementOpacityApplying(DrawContext)

Apply {@code Property.OPACITY} property if specified by setting corresponding values in graphic state dictionary opacity will be applied to all elements drawn after calling this method and before calling AbstractRenderer.endElementOpacityApplying(DrawContext) ()} . @param drawContext the context (canvas, document, etc.) of this drawing operation.
Class AbstractRenderer, Rectangle calculateAbsolutePdfBBox()

Calculates the bounding box of the content in the coordinate system of the pdf entity on which content is placed, e.g. document page or form xObject. This is particularly useful for the cases when element is nested in the rotated element. @return a Rectangle which is a bbox of the content not relative to the parent's layout area but rather to the some pdf entity coordinate system.
Class AbstractRenderer, Rectangle calculateBBox(List)

Calculates bounding box around points. @param points list of the points calculated bbox will enclose. @return array of float values which denote left, bottom, right, top lines of bbox in this specific order
Class AbstractRenderer, float[] calculateShiftToPositionBBoxOfPointsAt(float, float, List)

This method calculates the shift needed to be applied to the points in order to position upper and left borders of their bounding box at the given lines. @param left x coordinate at which points bbox left border is to be aligned @param top y coordinate at which points bbox upper border is to be aligned @param points the points, which bbox will be aligned at the given position position @return array of two floats, where first element denotes x-coordinate shift and the second element denotes y-coordinate shift which are needed to align points bbox at the given lines.
Class AbstractRenderer, PdfFormXObject createXObject(AbstractLinearGradientBuilder, Rectangle, PdfDocument)

Create a PdfFormXObject with the given area and containing a linear gradient inside. @param linearGradientBuilder the linear gradient builder @param xObjectArea the result object area @param document the pdf document document @return the xObject with a specified area and a linear gradient
Class AbstractRenderer, void drawBackground(DrawContext)

Draws a background layer if it is defined by a key Property.BACKGROUND in either the layout element or this IRenderer itself. @param drawContext the context (canvas, document, etc.) of this drawing operation.
Class AbstractRenderer, void drawChildren(DrawContext)

Performs the drawing operation for all children of this renderer. @param drawContext the context (canvas, document, etc.) of this drawing operation.
Class AbstractRenderer, void endElementOpacityApplying(DrawContext)

AbstractRenderer.beginElementOpacityApplying(DrawContext). @param drawContext the context (canvas, document, etc.) of this drawing operation.
Class AbstractRenderer, Rectangle getBackgroundArea(Rectangle)

Evaluate the actual background @param occupiedAreaWithMargins the current occupied area with applied margins margins @return the actual background area
Class AbstractRenderer, Float getFirstYLineRecursively()

Gets the first yLine of the nested children recursively. E.g. for a list, this will be the yLine of the first item (if the first item is indeed a paragraph). NOTE: this method will no not go further than the first child. @return the first yline y line of the nested children, null if there is no text found
Class AbstractRenderer, Boolean getPropertyAsBoolean(int)

Returns a property with a certain key, as a boolean value. @param property an enum value @return a Boolean
Class AbstractRenderer, Color getPropertyAsColor(int)

Returns a property with a certain key, as a color. @param property an enum value @return a Color
Class AbstractRenderer, Float getPropertyAsFloat(int)

Returns a property with a certain key, as a floating point value. @param property an enum value @return a Float
Class AbstractRenderer, Float getPropertyAsFloat(int, Float)

Returns a property with a certain key, as a floating point value. @param property an enum value @param defaultValue default value to be returned if property is not found found @return a Float
Class AbstractRenderer, PdfFont getPropertyAsFont(int)

Returns a property with a certain key, as a font object. @param property an enum value @return a PdfFont
Class AbstractRenderer, Integer getPropertyAsInteger(int)

Returns a property with a certain key, as an integer value. @param property an enum value @return a Integer
Class AbstractRenderer, TransparentColor getPropertyAsTransparentColor(int)

Returns a property with a certain key, as a TransparentColor. @param property an enum value @return a TransparentColor
Class AbstractRenderer, UnitValue getPropertyAsUnitValue(int)

Returns a property with a certain key, as a unit value. @param property an enum value @return a UnitValue
Class AbstractRenderer, boolean hasAbsoluteUnitValue(int)

Check if corresponding property has point value. @param property Property @return false if property value either null, or percent, otherwise true.
Class AbstractRenderer, boolean hasOwnOrModelProperty(int)

Checks if this renderer or its model element have the specified property, i.e. if it was set to this very element or its very model element earlier. @param property the property to be checked checked @return {@code true} if this instance or its model element have given own property, {@code false} otherwise
Class AbstractRenderer, boolean hasRelativeUnitValue(int)

Check if corresponding property has relative value. @param property Property @return false if property value either null, or point, otherwise true.
Class AbstractRenderer, List initElementAreas(LayoutArea)

Gets all rectangles that this IRenderer can draw upon in the given area. @param area a physical area on the DrawContext @return a list of rectangles
Class AbstractRenderer, boolean isFlushed()

Indicates whether this renderer is flushed or not, i.e. if .draw(DrawContext) has already been called. @return whether the renderer has been flushed flushed @see #draw
Class AbstractRenderer, Float retrieveMaxHeight()

Retrieve element's content box max- ehight height, if it's set. Takes into account Property.BOX_SIZING property value. @return element's content box max-height or null if it's not set .
Class AbstractRenderer, Float retrieveMaxWidth(float)

Retrieves element's fixed content box max width, if it's set. Takes into account Property.BOX_SIZING and Property.MIN_WIDTH properties. @param parentBoxWidth width of the parent element content box. If element has relative width, it will be calculated relatively to this parameter. @return element's fixed content box max width or null if it's not set. @see AbstractRenderer#hasAbsoluteUnitValue(int)
Class AbstractRenderer, Float retrieveMinWidth(float)

Retrieves element's fixed content box max width, if it's set. Takes into account Property.BOX_SIZING property value. @param parentBoxWidth width of the parent element content box. If element has relative width, it will be calculated relatively to this parameter. @return element's fixed content box max width or null if it's not set. @see AbstractRenderer#hasAbsoluteUnitValue(int)
Class AbstractRenderer, Float retrieveWidth(float)

Retrieves element's fixed content box width, if it's set. Takes into account Property.BOX_SIZING, Property.MIN_WIDTH, and Property.MAX_WIDTH properties. @param parentBoxWidth width of the parent element content box. If element has relative width, it will be calculated relatively to this parameter. @return element's fixed content box width or null if it's not set. @see AbstractRenderer#hasAbsoluteUnitValue(int)
Class AbstractRenderer, String toString()

Returns a string representation of the renderer. @return a String @see java.lang.Object#toString()
Class CanvasRenderer, constructor CanvasRenderer(Canvas, boolean)

Creates a CanvasRenderer from its corresponding layout object. Defines whether the content should be flushed immediately after addition .addChild(IRenderer) or not @param canvas the com.itextpdf.layout.Canvas which this object should manage @param immediateFlush the value which stands for immediate flushing
Class CellRenderer, Rectangle applySpacings(Rectangle, boolean)

Applies spacings on the given rectangle. @param rect a rectangle spacings will be applied on @param reverse indicates whether spacings will be applied inside (in case of false) or outside (in case of true) the rectangle. @return a border box of the renderer
Class CellRenderer, Rectangle applySpacings(Rectangle, float[], boolean)

Applies given spacings on the given rectangle. @param rect a rectangle spacings will be applied on @param spacings the spacings to be applied on the given rectangle @param reverse indicates whether spacings will be applied inside (in case of false) or outside (in case of true) the rectangle. @return a border box of the renderer
Class CellRenderer, IRenderer getNextRenderer()

Gets a new instance of this class to be used as a next renderer, after this renderer is used, if .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 CellRenderer, one should override this method: otherwise the default method will be used and thus the default rather than the custom renderer will be created. @return new renderer instance

Class DivRenderer, constructor DivRenderer(Div)

Creates a DivRenderer from its corresponding layout object. @param modelElement the com.itextpdf.layout.element.Div which this object should manage
Class DivRenderer, IRenderer getNextRenderer()

Gets a new instance of this class to be used as a next renderer, after this renderer is used, if .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 DivRenderer, one should override this method: otherwise the default method will be used and thus the default rather than the custom renderer will be created. @return new renderer instance

Class DocumentRenderer, PageSize addNewPage(PageSize)

Adds new page with defined page size to PDF document. @param customPageSize the size of new page, can be null null @return the page size of created page
Class DocumentRenderer, PageSize ensureDocumentHasNPages(int, PageSize)

Ensures that PDF document has n pages. If document has fewer pages, adds new pages by calling .addNewPage(PageSize) method. @param n the expected number of pages if document @param customPageSize the size of created pages, can be null null @return the page size of the last created page, or null if no page was created
Class GridContainerRenderer, constructor GridContainerRenderer(GridContainer)

Creates a Grid renderer from its corresponding layout object. @param modelElement the GridContainer which this object should manage
Class LineSeparatorRenderer, constructor LineSeparatorRenderer(LineSeparator)

Creates a LineSeparatorRenderer from its corresponding layout object. @param lineSeparator the com.itextpdf.layout.element.LineSeparator which this object should manage
Class LinkRenderer, constructor LinkRenderer(Link)

Creates a LinkRenderer from its corresponding layout object. @param link the com.itextpdf.layout.element.Link which this object should manage
Class LinkRenderer, IRenderer getNextRenderer()

Gets a new instance of this class to be used as a next renderer, after this renderer is used, if .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. @return new renderer instance

Class ListRenderer, IRenderer getNextRenderer()

Gets a new instance of this class to be used as a next renderer, after this renderer is used, if .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 ListRenderer, one should override this method: otherwise the default method will be used and thus the default rather than the custom renderer will be created. @return new renderer instance

Class MulticolRenderer.ColumnHeightCalculator, Float getAdditionalHeightOfEachColumn(MulticolRenderer, MulticolLayoutResult)

Calculate height, by which current height of given {@code MulticolRenderer} should be increased so {@code MulticolLayoutResult#getOverflowRenderer} could be lauded @param renderer multicol renderer for which height needs to be increased @param result result of one iteration of {@code MulticolRenderer} layouting @return height by which current height of given multicol renderer should be increased
Class MulticolRenderer, void drawBorder(DrawContext)

Performs the drawing operation for the border of this renderer, if defined by the Property.BORDER_TOP, Property.BORDER_RIGHT, Property.BORDER_BOTTOM and Property.BORDER_LEFT values in either the layout element or this IRenderer itself. @param drawContext the context (canvas, document, etc.) of this drawing operation.
Class MulticolRenderer, MulticolLayoutResult layoutInColumns(LayoutContext, Rectangle)

Layouts multicol in the passed provided area. @param layoutContext the layout context @param actualBBox the area to layout multicol on @return the MulticolLayoutResult instance
Class TabRenderer, IRenderer getNextRenderer()

Gets a new instance of this class to be used as a next renderer, after this renderer is used, if .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 TabRenderer, one should override this method: otherwise the default method will be used and thus the default rather than the custom renderer will be created. @return new renderer instance

Class TableRenderer, constructor TableRenderer(Table, RowRange)

Creates a TableRenderer from a Table which will partially render the table. @param modelElement the table to be rendered by this renderer @param rowRange the table rows to be rendered
Class TableRenderer, IRenderer getNextRenderer()

Gets a new instance of this class to be used as a next renderer, after this renderer is used, if .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 TableRenderer, one should override this method: otherwise the default method will be used and thus the default rather than the custom renderer will be created. @return new renderer instance

Class TextRenderer, constructor TextRenderer(Text, String)

Creates a TextRenderer from its corresponding layout object, with a custom text to replace the contents of the Text. @param textElement the Text which this object should manage @param text the replacement text
Class TextRenderer, float[] calculateAscenderDescender(PdfFont)

Get ascender and descender from font metrics. If these values are obtained from typo metrics they are normalized with a scale coefficient. @param font from which metrics will be extracted extracted @return array in which the first element is an ascender and the second is a descender
Class TextRenderer, float[] calculateAscenderDescender(PdfFont, RenderingMode)

Get ascender and descender from font metrics. In RenderingMode.DEFAULT_LAYOUT_MODE if these values are obtained from typo metrics they are normalized with a scale coefficient. @param font from which metrics will be extracted @param mode mode in which metrics will be obtained. Impact on the use of scale coefficient coefficient @return array in which the first element is an ascender and the second is a descender
Class TextRenderer, int charAt(int)

Gets char code at given position for the text belonging to this renderer. @param pos the position in range [0; length()) @return Unicode char code
Class TextRenderer, TextRenderer createCopy(GlyphLine, PdfFont)

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 com.itextpdf.layout.font.FontSelector related logic is triggered, copies of this TextRenderer will have the default behavior rather than the custom one. @param gl a GlyphLine which represents some of this TextRenderer's content @param font a PdfFont for this part of the TextRenderer's content content @return copy of this TextRenderer, which correspond to the passed GlyphLine with PdfFont

Class TextRenderer, float getAscent()

Gets the maximum offset above the base baseline line that this Text extends to. @return the upwards vertical offset of this Text
Class TextRenderer, float getDescent()

Gets the maximum offset below the base baseline line that this Text extends to. @return the downwards vertical offset of this Text
Class TextRenderer, IRenderer getNextRenderer()

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

If TextRenderer overflows to the next line, iText uses this method to create a renderer for the overflow part. So if one wants to extend TextRenderer, one should override this method: otherwise the default method will be used and thus the default rather than the custom renderer will be created. Another method that should be overridden in case of TextRenderer's extension is .createCopy(GlyphLine, PdfFont). This method is responsible for creation of TextRenderer's copies, which represent its parts of specific font. @return new renderer instance

Class TextRenderer, boolean resolveFonts(List)

Resolve Property.FONT String[] value. @param addTo add all processed renderers to. @return true, if new TextRenderer has been created.