Package com.itextpdf.layout.renderer

Class TextSequenceWordWrapping

java.lang.Object

com.itextpdf.layout.renderer.TextSequenceWordWrapping

final class TextSequenceWordWrapping
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static class	TextSequenceWordWrapping.LastFittingChildRendererData
(package private) static class	TextSequenceWordWrapping.MinMaxWidthOfTextRendererSequenceHelper
(package private) static class	TextSequenceWordWrapping.SpecialScriptsContainingSequenceStatus
(package private) static class	TextSequenceWordWrapping.SpecialScriptsContainingTextRendererSequenceInfo

Field Summary

Fields

Modifier and Type	Field	Description
private static float	OCCUPIED_AREA_RELAYOUT_EPS

Constructor Summary

Constructors

Modifier	Constructor	Description
private	TextSequenceWordWrapping()

Method Summary

Modifier and Type	Method	Description
private static java.util.List<java.lang.Integer>	convertPossibleBreakPointsToGlyphLineBased(java.util.List<java.lang.Integer> possibleBreakPoints, java.util.List<java.lang.Integer> amountOfChars, java.util.List<java.lang.Integer> indices)
(package private) static void	distributePossibleBreakPointsOverSequentialTextRenderers(LineRenderer lineRenderer, int childPos, int numberOfSequentialTextRenderers, java.util.List<java.lang.Integer> possibleBreakPointsGlobal, java.util.List<java.lang.Integer> indicesOfFloating)
private static void	fillActualTextChunkRelatedLists(GlyphLine glyphLine, java.util.List<java.lang.Integer> amountOfCharsBetweenTextStartAndActualTextChunk, java.util.List<java.lang.Integer> glyphLineBasedIndicesOfActualTextChunkEnds)
(package private) static float	getCurWidthRelayoutedTextSequenceDecrement(int childPos, int newChildPos, java.util.Map<java.lang.Integer,LayoutResult> textRendererLayoutResults)
static TextSequenceWordWrapping.LastFittingChildRendererData	getIndexAndLayoutResultOfTheLastTextRendererContainingSpecialScripts(LineRenderer lineRenderer, int childPos, java.util.Map<java.lang.Integer,LayoutResult> specialScriptLayoutResults, boolean wasParentsHeightClipped, boolean isOverflowFit)
static TextSequenceWordWrapping.LastFittingChildRendererData	getIndexAndLayoutResultOfTheLastTextRendererWithNoSpecialScripts(LineRenderer lineRenderer, int childPos, java.util.Map<java.lang.Integer,LayoutResult> textSequenceLayoutResults, boolean wasParentsHeightClipped, boolean isOverflowFit, boolean floatsPlaced)
(package private) static TextSequenceWordWrapping.SpecialScriptsContainingSequenceStatus	getSpecialScriptsContainingSequenceStatus(LineRenderer lineRenderer, int analyzedTextRendererIndex)	This method defines how to proceed with a TextRenderer within which possible breaks haven't been found.
(package private) static TextSequenceWordWrapping.SpecialScriptsContainingTextRendererSequenceInfo	getSpecialScriptsContainingTextRendererSequenceInfo(LineRenderer lineRenderer, int childPos)
static boolean	isTextRendererAndRequiresSpecialScriptPreLayoutProcessing(IRenderer childRenderer)
static boolean	postprocessTextSequenceOverflowX(LineRenderer lineRenderer, boolean textSequenceOverflowXProcessing, int childPos, IRenderer childRenderer, LayoutResult childResult, boolean wasXOverflowChanged)	Checks if the layouting should be stopped on current child and resets configurations set on preprocessTextSequenceOverflowX(LineRenderer, boolean, IRenderer, boolean, OverflowPropertyValue).
static void	preprocessTextSequenceOverflowX(LineRenderer lineRenderer, boolean textSequenceOverflowXProcessing, IRenderer childRenderer, boolean wasXOverflowChanged, OverflowPropertyValue oldXOverflow)	Performs some settings on LineRenderer and its child prior to layouting the child to be overflowed beyond the available area.
static void	processSpecialScriptPreLayout(LineRenderer lineRenderer, int childPos)	Preprocess a continuous sequence of TextRenderer containing special scripts prior to layouting the first TextRenderer in the sequence.
static void	resetTextSequenceIfItEnded(java.util.Map<java.lang.Integer,LayoutResult> textRendererLayoutResults, boolean specialScripts, IRenderer childRenderer, int childPos, TextSequenceWordWrapping.MinMaxWidthOfTextRendererSequenceHelper minMaxWidthOfTextRendererSequenceHelper, boolean noSoftWrap, AbstractWidthHandler widthHandler)
private static void	updateMinMaxWidthOfLineRendererAfterTextRendererSequenceProcessing(boolean noSoftWrap, int childPos, LayoutResult layoutResult, AbstractWidthHandler widthHandler, TextSequenceWordWrapping.MinMaxWidthOfTextRendererSequenceHelper minMaxWidthOfTextRendererSequenceHelper, java.util.Map<java.lang.Integer,LayoutResult> textRendererLayoutResults)
static LineRenderer.LineAscentDescentState	updateTextRendererSequenceAscentDescent(LineRenderer lineRenderer, java.util.Map<java.lang.Integer,float[]> textRendererSequenceAscentDescent, int childPos, float[] childAscentDescent, LineRenderer.LineAscentDescentState preTextSequenceAscentDescent)
static TextSequenceWordWrapping.MinMaxWidthOfTextRendererSequenceHelper	updateTextRendererSequenceMinMaxWidth(LineRenderer lineRenderer, AbstractWidthHandler widthHandler, int childPos, TextSequenceWordWrapping.MinMaxWidthOfTextRendererSequenceHelper minMaxWidthOfTextRendererSequenceHelper, boolean anythingPlaced, java.util.Map<java.lang.Integer,LayoutResult> textRendererLayoutResults, java.util.Map<java.lang.Integer,LayoutResult> specialScriptLayoutResults, float textIndent)
static void	updateTextSequenceLayoutResults(java.util.Map<java.lang.Integer,LayoutResult> textRendererLayoutResults, boolean specialScripts, IRenderer childRenderer, int childPos, LayoutResult childResult)

Methods inherited from class java.lang.Object

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

Field Detail

OCCUPIED_AREA_RELAYOUT_EPS

private static final float OCCUPIED_AREA_RELAYOUT_EPS

See Also:

Constant Field Values

Constructor Detail

TextSequenceWordWrapping

private TextSequenceWordWrapping()

Method Detail

isTextRendererAndRequiresSpecialScriptPreLayoutProcessing

public static boolean isTextRendererAndRequiresSpecialScriptPreLayoutProcessing(IRenderer childRenderer)

processSpecialScriptPreLayout

public static void processSpecialScriptPreLayout(LineRenderer lineRenderer,
                                                 int childPos)

Preprocess a continuous sequence of TextRenderer containing special scripts prior to layouting the first TextRenderer in the sequence.

In this method we preprocess a sequence containing special scripts only, skipping floating renderers as they're not part of a regular layout flow, and breaking the prelayout processing once a non-special script containing renderer occurs. Note! Even though floats are skipped during calculating correct word boundaries, floats themselves are considered as soft-wrap opportunities.

Prelayout processing includes the following steps:

• getSpecialScriptsContainingTextRendererSequenceInfo(LineRenderer, int): determine boundaries of the sequence and concatenate its TextRenderer#text fields converted to a String representation;
• get the String analyzed with WordWrapper#getPossibleBreaks and receive a zero-based array of points where the String is allowed to got broken in lines;
• distributePossibleBreakPointsOverSequentialTextRenderers(LineRenderer, int, int, List, List): distribute the list over the TextRenderer#specialScriptsWordBreakPoints, preliminarily having the points shifted, so that each TextRenderer#specialScriptsWordBreakPoints is based on the first element of TextRenderer#text.

Parameters:

lineRenderer - line renderer containing text sequence to process

childPos - index of the childRenderer in LineRenderer#childRenderers from which the a continuous sequence of TextRenderer containing special scripts starts

updateTextSequenceLayoutResults

public static void updateTextSequenceLayoutResults(java.util.Map<java.lang.Integer,LayoutResult> textRendererLayoutResults,
                                                   boolean specialScripts,
                                                   IRenderer childRenderer,
                                                   int childPos,
                                                   LayoutResult childResult)

resetTextSequenceIfItEnded

public static void resetTextSequenceIfItEnded(java.util.Map<java.lang.Integer,LayoutResult> textRendererLayoutResults,
                                              boolean specialScripts,
                                              IRenderer childRenderer,
                                              int childPos,
                                              TextSequenceWordWrapping.MinMaxWidthOfTextRendererSequenceHelper minMaxWidthOfTextRendererSequenceHelper,
                                              boolean noSoftWrap,
                                              AbstractWidthHandler widthHandler)

updateTextRendererSequenceAscentDescent

public static LineRenderer.LineAscentDescentState updateTextRendererSequenceAscentDescent(LineRenderer lineRenderer,
                                                                                          java.util.Map<java.lang.Integer,float[]> textRendererSequenceAscentDescent,
                                                                                          int childPos,
                                                                                          float[] childAscentDescent,
                                                                                          LineRenderer.LineAscentDescentState preTextSequenceAscentDescent)

updateTextRendererSequenceMinMaxWidth

public static TextSequenceWordWrapping.MinMaxWidthOfTextRendererSequenceHelper updateTextRendererSequenceMinMaxWidth(LineRenderer lineRenderer,
                                                                                                                     AbstractWidthHandler widthHandler,
                                                                                                                     int childPos,
                                                                                                                     TextSequenceWordWrapping.MinMaxWidthOfTextRendererSequenceHelper minMaxWidthOfTextRendererSequenceHelper,
                                                                                                                     boolean anythingPlaced,
                                                                                                                     java.util.Map<java.lang.Integer,LayoutResult> textRendererLayoutResults,
                                                                                                                     java.util.Map<java.lang.Integer,LayoutResult> specialScriptLayoutResults,
                                                                                                                     float textIndent)

getIndexAndLayoutResultOfTheLastTextRendererWithNoSpecialScripts

public static TextSequenceWordWrapping.LastFittingChildRendererData getIndexAndLayoutResultOfTheLastTextRendererWithNoSpecialScripts(LineRenderer lineRenderer,
                                                                                                                                     int childPos,
                                                                                                                                     java.util.Map<java.lang.Integer,LayoutResult> textSequenceLayoutResults,
                                                                                                                                     boolean wasParentsHeightClipped,
                                                                                                                                     boolean isOverflowFit,
                                                                                                                                     boolean floatsPlaced)

getIndexAndLayoutResultOfTheLastTextRendererContainingSpecialScripts

public static TextSequenceWordWrapping.LastFittingChildRendererData getIndexAndLayoutResultOfTheLastTextRendererContainingSpecialScripts(LineRenderer lineRenderer,
                                                                                                                                         int childPos,
                                                                                                                                         java.util.Map<java.lang.Integer,LayoutResult> specialScriptLayoutResults,
                                                                                                                                         boolean wasParentsHeightClipped,
                                                                                                                                         boolean isOverflowFit)

preprocessTextSequenceOverflowX

public static void preprocessTextSequenceOverflowX(LineRenderer lineRenderer,
                                                   boolean textSequenceOverflowXProcessing,
                                                   IRenderer childRenderer,
                                                   boolean wasXOverflowChanged,
                                                   OverflowPropertyValue oldXOverflow)

Performs some settings on LineRenderer and its child prior to layouting the child to be overflowed beyond the available area.

Parameters:

lineRenderer - line renderer containing text sequence to process

textSequenceOverflowXProcessing - true if it is TextRenderer sequence processing in overflowX mode

childRenderer - the LineRenderer's child to be preprocessed

wasXOverflowChanged - true if value of Property.OVERFLOW_X has been changed during layouting

oldXOverflow - the value of Property.OVERFLOW_X before it's been changed during layouting of LineRenderer or null if Property.OVERFLOW_X hasn't been changed

postprocessTextSequenceOverflowX

public static boolean postprocessTextSequenceOverflowX(LineRenderer lineRenderer,
                                                       boolean textSequenceOverflowXProcessing,
                                                       int childPos,
                                                       IRenderer childRenderer,
                                                       LayoutResult childResult,
                                                       boolean wasXOverflowChanged)

Checks if the layouting should be stopped on current child and resets configurations set on preprocessTextSequenceOverflowX(LineRenderer, boolean, IRenderer, boolean, OverflowPropertyValue).

Parameters:

lineRenderer - line renderer containing text sequence to process

textSequenceOverflowXProcessing - true if it is TextRenderer sequence processing in overflowX mode

childRenderer - the LineRenderer's child to be preprocessed

wasXOverflowChanged - true if value of Property.OVERFLOW_X has been changed during layouting

getSpecialScriptsContainingTextRendererSequenceInfo

static TextSequenceWordWrapping.SpecialScriptsContainingTextRendererSequenceInfo getSpecialScriptsContainingTextRendererSequenceInfo(LineRenderer lineRenderer,
                                                                                                                                     int childPos)

distributePossibleBreakPointsOverSequentialTextRenderers

static void distributePossibleBreakPointsOverSequentialTextRenderers(LineRenderer lineRenderer,
                                                                     int childPos,
                                                                     int numberOfSequentialTextRenderers,
                                                                     java.util.List<java.lang.Integer> possibleBreakPointsGlobal,
                                                                     java.util.List<java.lang.Integer> indicesOfFloating)

getSpecialScriptsContainingSequenceStatus

static TextSequenceWordWrapping.SpecialScriptsContainingSequenceStatus getSpecialScriptsContainingSequenceStatus(LineRenderer lineRenderer,
                                                                                                                 int analyzedTextRendererIndex)

This method defines how to proceed with a TextRenderer within which possible breaks haven't been found. Possible scenarios are: - Preceding renderer is also an instance of TextRenderer and does contain special scripts: getIndexAndLayoutResultOfTheLastTextRendererContainingSpecialScripts(LineRenderer, int, Map, boolean, boolean) will proceed to analyze the preceding TextRenderer on the subject of possible breaks; - Preceding renderer is either an instance of TextRenderer which does not contain special scripts, or an instance of ImageRenderer or is an inlineBlock child: in this case the entire subsequence of TextRenderer-s containing special scripts is to be moved to the next line; - Otherwise a forced split is to happen.

Parameters:

lineRenderer - line renderer containing text sequence to process

analyzedTextRendererIndex - index of the latter child that has been analyzed on the subject of possible breaks

Returns:

TextSequenceWordWrapping.SpecialScriptsContainingSequenceStatus instance standing for the strategy to proceed with.

getCurWidthRelayoutedTextSequenceDecrement

static float getCurWidthRelayoutedTextSequenceDecrement(int childPos,
                                                        int newChildPos,
                                                        java.util.Map<java.lang.Integer,LayoutResult> textRendererLayoutResults)

updateMinMaxWidthOfLineRendererAfterTextRendererSequenceProcessing

private static void updateMinMaxWidthOfLineRendererAfterTextRendererSequenceProcessing(boolean noSoftWrap,
                                                                                       int childPos,
                                                                                       LayoutResult layoutResult,
                                                                                       AbstractWidthHandler widthHandler,
                                                                                       TextSequenceWordWrapping.MinMaxWidthOfTextRendererSequenceHelper minMaxWidthOfTextRendererSequenceHelper,
                                                                                       java.util.Map<java.lang.Integer,LayoutResult> textRendererLayoutResults)

convertPossibleBreakPointsToGlyphLineBased

private static java.util.List<java.lang.Integer> convertPossibleBreakPointsToGlyphLineBased(java.util.List<java.lang.Integer> possibleBreakPoints,
                                                                                            java.util.List<java.lang.Integer> amountOfChars,
                                                                                            java.util.List<java.lang.Integer> indices)

fillActualTextChunkRelatedLists

private static void fillActualTextChunkRelatedLists(GlyphLine glyphLine,
                                                    java.util.List<java.lang.Integer> amountOfCharsBetweenTextStartAndActualTextChunk,
                                                    java.util.List<java.lang.Integer> glyphLineBasedIndicesOfActualTextChunkEnds)