TextEditorController

Classes

TextEditorController

Manages a text editor (TextWhizz or mobile versions).

Remarks

The text editor is shared by item handlers, we get it from 'Canvas' entry. The TextWhizz is used as a text engine.

Implements

• ITextEditorController

Constructors

Constructor

new TextEditorController(
   itemHandler,
   textWhizz,
   textRenderer,
   activeTextCanvasHandler,
   viewerConfig,
   fontRegistry,
   colorParser,
   textFormattingEnabled,
   getTextEditor): TextEditorController;

Parameters

Parameter	Type
itemHandler	NewBaseTextItemHandler
textWhizz	any
textRenderer	TextRenderer
activeTextCanvasHandler	IActiveTextCanvasHandler
viewerConfig	IViewerConfiguration
fontRegistry	FontRegistry
colorParser	IColorParser
textFormattingEnabled	boolean
getTextEditor	Func<ITextEditor>

Returns

TextEditorController

Accessors

activeTextEditor

Get Signature

get activeTextEditor(): ITextEditor;

Returns

ITextEditor

Implementation of

ITextEditorController.activeTextEditor

canRedo

Get Signature

get canRedo(): boolean;

Returns

boolean

Implementation of

ITextEditorController.canRedo

canUndo

Get Signature

get canUndo(): boolean;

Returns

boolean

Implementation of

ITextEditorController.canUndo

enteredEditModeEvent

Get Signature

get enteredEditModeEvent(): EventWithSenderArg<TextEditorController, unknown>;

Returns

EventWithSenderArg<TextEditorController, unknown>

Implementation of

ITextEditorController.enteredEditModeEvent

exitedEditModeEvent

Get Signature

get exitedEditModeEvent(): EventWithSenderArg<TextEditorController, unknown>;

Returns

EventWithSenderArg<TextEditorController, unknown>

Implementation of

ITextEditorController.exitedEditModeEvent

failed

Get Signature

get failed(): boolean;

Returns

boolean

Implementation of

ITextEditorController.failed

isActive

Get Signature

get isActive(): boolean;

Returns

boolean

Implementation of

ITextEditorController.isActive

isCropped

Get Signature

get isCropped(): boolean;

Returns

boolean

Implementation of

ITextEditorController.isCropped

isInEdit

Get Signature

get isInEdit(): boolean;

Returns

boolean

Implementation of

ITextEditorController.isInEdit

isMobile

Get Signature

get isMobile(): boolean;

Returns

boolean

Implementation of

ITextEditorController.isMobile

isStatic

Get Signature

get isStatic(): boolean;

Returns

boolean

Implementation of

ITextEditorController.isStatic

ready

Get Signature

get ready(): boolean;

Returns

boolean

Implementation of

ITextEditorController.ready

Methods

bindToCanvas()

bindToCanvas(canvas): void;

Parameters

Parameter	Type
canvas	ICanvas

Returns

void

Implementation of

ITextEditorController.bindToCanvas

clearText()

clearText(): void;

Returns

void

Implementation of

ITextEditorController.clearText

dispose()

dispose(): void;

Returns

void

Implementation of

ITextEditorController.dispose

enterEditMode()

enterEditMode(x, y): Promise<void>;

Parameters

Parameter	Type
x	number
y	number

Returns

Promise<void>

Implementation of

ITextEditorController.enterEditMode

exitEditMode()

exitEditMode(isStayActive?): Promise<void>;

Parameters

Parameter	Type	Default value
isStayActive	boolean	false

Returns

Promise<void>

Implementation of

ITextEditorController.exitEditMode

initialize()

initialize(): Promise<void>;

Returns

Promise<void>

Implementation of

ITextEditorController.initialize

measureText()

measureText(extendToBlackBox?): RectangleF;

Parameters

Parameter	Type
extendToBlackBox?	boolean

Returns

RectangleF

Implementation of

ITextEditorController.measureText

measureTextFrame()

measureTextFrame(useActiveText?): RectangleF;

Parameters

Parameter	Type	Default value
useActiveText	boolean	false

Returns

RectangleF

Implementation of

ITextEditorController.measureTextFrame

processKeyEvent()

processKeyEvent(e): Promise<boolean>;

Parameters

Parameter	Type
e	IKeyboardEventParams

Returns

Promise<boolean>

Implementation of

ITextEditorController.processKeyEvent

processMouseEvent()

processMouseEvent(pointerParams, mouseOverCurrent): Promise<boolean>;

Parameters

Parameter	Type
pointerParams	IPointerParams
mouseOverCurrent	boolean

Returns

Promise<boolean>

Implementation of

ITextEditorController.processMouseEvent

redo()

redo(): void;

Returns

void

Implementation of

ITextEditorController.redo

redrawActiveText()

redrawActiveText(): void;

Returns

void

Implementation of

ITextEditorController.redrawActiveText

redrawText()

redrawText(): void;

Returns

void

Implementation of

ITextEditorController.redrawText

staticTextImageChanged()

staticTextImageChanged(handler): void;

Parameters

Parameter	Type
handler	StaticTextChangedHandler

Returns

void

Implementation of

ITextEditorController.staticTextImageChanged

staticTextImageChanged()

staticTextImageChanged(handler): void;

Parameters

Parameter	Type
handler	StaticTextChangedHandler

Returns

void

Implementation of

ITextEditorController.staticTextImageChanged

transformText()

transformText(transform): void;

Parameters

Parameter	Type
transform	Transform

Returns

void

Implementation of

ITextEditorController.transformText

unbindFromCanvas()

unbindFromCanvas(): void;

Returns

void

Implementation of

ITextEditorController.unbindFromCanvas

undo()

undo(): void;

Returns

void

Implementation of

ITextEditorController.undo

updateItemHandler()

updateItemHandler(newFrame?): void;

Parameters

Parameter	Type
newFrame?	RectangleF

Returns

void

Implementation of

ITextEditorController.updateItemHandler

updateText()

updateText(trigger, force?): Promise<void>;

Parameters

Parameter	Type	Default value
trigger	string	undefined
force	boolean	false

Returns

Promise<void>

Implementation of

ITextEditorController.updateText

waitUpdate()

waitUpdate(): Promise<void>;

Returns

Promise<void>

Implementation of

ITextEditorController.waitUpdate