Private _dirtyHas the text (or properties associated with it) changed?
Private _heightThe current total text height. May be outdated.
Private _lineThe current lineHeight. May be outdated
Private _lineSee lineRanges. For internal use only.
Private _lineThe current lineSpacing. May be outdated
Private _tabThe actual tabWidth in pixels. May be outdated
Private _widthThe current largest text width. May be outdated.
The text alignment mode. Can also be a ratio.
Note that this only aligns text in the text's width. If maxWidth is infinite, then you may still need to align the widget that uses this text helper with a BaseContainer because the width will be set to the longest line range's width.
The current font used for rendering text.
@multiFlagField(['_dirty', 'measureDirty', 'lineHeightSpacingDirty', 'tabWidthDirty'])
Private hasAre any of the lines wrapped? For internal use only.
The height of each line of text when wrapped. If null, then the helper will try to automatically detect it.
@multiFlagField(['_dirty', 'measureDirty', 'lineHeightSpacingDirty'])
Private lineDoes the line height or spacing need to be re-measured?
The amount of spacing between lines. If null, then the helper will try to automatically detect it.
@multiFlagField(['_dirty', 'measureDirty', 'lineHeightSpacingDirty'])
The current maximum text width. If not Infinite and
wrapMode is not WrapMode.None, then text will be
wrapped and width will be set to maxWidth.
@multiFlagField(['_dirty', 'maxWidthDirty'])
Private maxHas the maximum width been changed?
Private measureDoes the text need to be re-measured?
The amount of spaces that each tab character is equivalent to. By default, it is equivalent to 4 spaces.
@multiFlagField(['_dirty', 'measureDirty', 'tabWidthDirty'])
Private tabDoes the tab width need to be re-measured?
The current string of text.
@multiFlagField(['_dirty', 'measureDirty'])
The mode for text wrapping
@multiFlagField(['_dirty', 'measureDirty'])
Get the current line height, even if lineHeight is null. Re-measures line height if neccessary.
Get the current line spacing, even if lineSpacing is null. Re-measures line spacing if neccessary.
Get the current tab width in pixels. Re-measures if neccessary
Has the text (or properties associated with it) changed? Resets _dirty to false
Get the height between the start of each line; the full line height.
Equivalent to the sum of actualLineHeight and actualLineSpacing
The current total text height. Re-measures text if neccessary.
Which range of text indices are used for each line.
If there is no text wrapping (maxWidth is Infinity or wrapMode is
WrapMode.None), then this will contain a single tuple containing
[0, (text length)].
If there is text wrapping, then this will be an array where each member is a tuple containing the starting index of a line of text and the ending index (exclusive) of a line of text.
The current text width. Re-measures text if neccessary.
Get the index and horizontal offset, in pixels, of the beginning of a character at a given offset.
See findOffsetFromIndex for the opposite.
Returns a 2-tuple containing the index of the character at the offset and a 2-tuple containing the offset, in pixels. Note that this is not neccessarily an integer. Note that the returned offset is not the same as the input offset. The returned offset is exactly at the beginning of the character. This is useful for implementing selectable text.
Get the horizontal offset, in pixels, of the beginning of a character at a given index.
See findIndexOffsetFromOffset for the opposite.
Returns a 2-tuple containing the offset, in pixels. Vertical offset in the tuple is at the top of the character. Note that this is not neccessarily an integer.
Private getPrivate measureSimilar to measureTextDims, but uses text render groups for optimisation purposes and for the ability of individual characters to override their natively measured size; tabs having a dynamic size that aligns them to multiples of a value and newlines having no length.
Returns true if the line range was modified and it fit into the maximum width
The inclusive index to start measuring at. If there are render groups and unmeasured text before this index, then this value will be overridden to include the unmeasured text. Render groups will also be merged if they don't override width.
The exclusive index to stop measuring at.
The maximum width of a line of text. If the line contains a single character, this will be ignored.
The current text render groups for this line of text. This will be updated in place.
Private measureMeasure a slice of text taking left offset into account. If left offset is 0, then this will also add the left bounding box overhang. If not, then it will just return the width.
Only for slices of text which have no width-overriding characters, else, you will get wrong measurements.
Returns the new horizontal offset
Paint a single text render group with a given offset and left value for checking if the group is zero-width. left value must not be shifted.
Used mainly for injecting debug code; you won't get much use out of this method unless you have a very specific need.
Private updateUpdate _width, _lineHeight and _lineSpacing. Sets measureDirty to false. Does nothing if measurement is not needed.
Generated using TypeDoc
An aggregate helper class for widgets that contain text.
Contains utilities for measuring text dimensions, converting between offsets in pixels and text indices and painting.