Skip to main content

TextHandler

Classes​

TextHandler​

Handler for performing simple operations with text content.

Remarks​

the TextWhizz is used as a text engine.

Implements​

Constructors​

Constructor​
new TextHandler(
tw,
textMeasurerHolder,
colorParser): TextHandler;
Parameters​
ParameterType
twITextWhizzHolder
textMeasurerHolderITextMeasurerHolder
colorParserIColorParser
Returns​

TextHandler

Accessors​

textChangeEvent​
Get Signature​
get textChangeEvent(): EventObject<void>;

Text content change event.

Returns​

EventObject<void>

Text content change event.

Implementation of​

ITextHandler.textChangeEvent

Methods​

deleteAllText()​
deleteAllText(): IPositionInText;

Deletes all text.

Returns​

IPositionInText

Implementation of​

ITextHandler.deleteAllText

deleteTextByRange()​
deleteTextByRange(textRange): IPositionInText;

Deletes text by range

Parameters​
ParameterTypeDescription
textRangeITextRangetext range.
Returns​

IPositionInText

Implementation of​

ITextHandler.deleteTextByRange

deleteTextToDirection()​
deleteTextToDirection(directionType): IPositionInText;

Deletes the selected text or character relative to the current cursor position.

Parameters​
ParameterTypeDescription
directionTypeMoveDirectionTypedirection of text deletion.
Returns​

IPositionInText

Implementation of​

ITextHandler.deleteTextToDirection

getAllText()​
getAllText(): ITextRange;

Returns all text.

Returns​

ITextRange

Implementation of​

ITextHandler.getAllText

getFormattedText()​
getFormattedText(): string;

Returns formatted text.

Returns​

string

Implementation of​

ITextHandler.getFormattedText

getParagraphCount()​
getParagraphCount(): number;

Returns paragraph count.

Returns​

number

Implementation of​

ITextHandler.getParagraphCount

getParagraphText()​
getParagraphText(paragraphIndex): ITextRange;

Returns the text range of a paragraph by index.

Parameters​
ParameterTypeDescription
paragraphIndexanyparagraph index (from 0).
Returns​

ITextRange

Implementation of​

ITextHandler.getParagraphText

getTextModel()​
getTextModel(): Text;

Returns the text model.

Returns​

Text

Implementation of​

ITextHandler.getTextModel

getTextRangeByPositions()​
getTextRangeByPositions(startPosition, endPosition): ITextRange;

Returns the range of text by starting and ending position.

Parameters​
ParameterTypeDescription
startPositionIPositionInTextstarting position.
endPositionIPositionInTextending position.
Returns​

ITextRange

Implementation of​

ITextHandler.getTextRangeByPositions

insertFormattedText()​
insertFormattedText(text): void;

Inserts formatted text relative to the current cursor position.

Parameters​
ParameterTypeDescription
textstringtext to insert.
Returns​

void

Implementation of​

ITextHandler.insertFormattedText

insertNewLine()​
insertNewLine(): void;

Inserts a new line relative to the current cursor position.

Returns​

void

Implementation of​

ITextHandler.insertNewLine

insertPlainText()​
insertPlainText(text): void;

Inserts plain text relative to the current cursor position.

Parameters​
ParameterTypeDescription
textstringtext to insert.
Returns​

void

Implementation of​

ITextHandler.insertPlainText

setTextFrames()​
setTextFrames(data, isMeasureFrame): void;

Sets the frame of text.

Parameters​
ParameterTypeDescription
dataITextFrameDatatext frame data.
isMeasureFramebooleanindicates if the frame is needed for further measurement.
Returns​

void

Implementation of​

ITextHandler.setTextFrames

setTextModel()​
setTextModel(model): void;

Sets the text model.

Parameters​
ParameterTypeDescription
modelTexttext model.
Returns​

void

Implementation of​

ITextHandler.setTextModel

setWrappingPath()​
setWrappingPath(data): void;

Sets the wrapping path.

Parameters​
ParameterTypeDescription
dataIWrappingPathDatawrapping path data.
Returns​

void

Implementation of​

ITextHandler.setWrappingPath

Was this page helpful?