Interface ITextEditorController

Manages a text editor (TextWhizz or mobile versions).

Package: @aurigma/design-atoms

Properties

activeTextEditor

Declaration

activeTextEditor: ITextEditor;

Property Value

Type	Description
IFontRegistry

canRedo

Declaration

canRedo: boolean;

Property Value

Type	Description
boolean

canUndo

Declaration

canUndo: boolean;

Property Value

Type	Description
boolean

enteredEditModeEvent

Declaration

enteredEditModeEvent: EventWithSenderArg<TextEditorController, unknown>;

Property Value

Type	Description
EventWithSenderArg<TextEditorController, unknown>

exitedEditModeEvent

Declaration

exitedEditModeEvent: EventWithSenderArg<TextEditorController, unknown>;

Property Value

Type	Description
EventWithSenderArg<TextEditorController, unknown>

failed

Declaration

failed: boolean;

Property Value

Type	Description
boolean

isActive

Declaration

isActive: boolean;

Property Value

Type	Description
boolean

isCropped

Declaration

isCropped: boolean;

Property Value

Type	Description
boolean

isInEdit

Declaration

isInEdit: boolean;

Property Value

Type	Description
boolean

isMobile

Declaration

isMobile: boolean;

Property Value

Type	Description
boolean

isStatic

Declaration

isStatic: boolean;

Property Value

Type	Description
boolean

ready

Declaration

ready: boolean;

Property Value

Type	Description
boolean

Methods

add_staticTextImageChanged(handler)

Declaration

add_staticTextImageChanged(handler: StaticTextChangedHandler): void;

Parameters

Type	Name	Description
StaticTextChangedHandler	handler

Returns

Type	Description
void

bindToCanvas(canvas)

Declaration

bindToCanvas(canvas: ICanvas): void;

Parameters

Type	Name	Description
ICanvas	canvas

Returns

Type	Description
void

clearText()

Declaration

clearText(): void;

Returns

Type	Description
void

dispose()

Declaration

dispose(): any;

Returns

Type	Description
any

enterEditMode(x, y)

Declaration

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

Parameters

Type	Name	Description
number	x
number	y

Returns

Type	Description
Promise<void>

exitEditMode(isStayActive)

Declaration

exitEditMode(isStayActive: boolean): Promise<void>;

Parameters

Type	Name	Description
boolean	isStayActive

Returns

Type	Description
Promise<void>

initialize()

Declaration

initialize(): Promise<void>;

Returns

Type	Description
Promise<void>

measureText(extendToBlackBox)

Declaration

measureText(extendToBlackBox?: boolean): RectangleF;

Parameters

Type	Name	Description
boolean	extendToBlackBox

Returns

Type	Description
RectangleF

measureTextFrame()

Declaration

measureTextFrame(): RectangleF;

Returns

Type	Description
RectangleF

processKeyEvent(e)

Declaration

processKeyEvent(e: IKeyboardEventParams): Promise<boolean>;

Parameters

Type	Name	Description
IKeyboardEventParams	e

Returns

Type	Description
Promise<boolean>

processMouseEvent(e, mouseOverCurrent)

Declaration

processMouseEvent(e: IPointerParams, mouseOverCurrent: boolean): Promise<boolean>;

Parameters

Type	Name	Description
IPointerParams	e
boolean	mouseOverCurrent

Returns

Type	Description
Promise<boolean>

redo()

Declaration

redo(): void;

Returns

Type	Description
void

redrawActiveText()

Declaration

redrawActiveText(): any;

Returns

Type	Description
any

redrawText()

Declaration

redrawText(): any;

Returns

Type	Description
any

remove_staticTextImageChanged(handler)

Declaration

remove_staticTextImageChanged(handler: StaticTextChangedHandler): void;

Parameters

Type	Name	Description
StaticTextChangedHandler	handler

Returns

Type	Description
void

transformText(transform)

Declaration

transformText(transform: Transform): void;

Parameters

Type	Name	Description
Transform	transform

Returns

Type	Description
void

unbindFromCanvas()

Declaration

unbindFromCanvas(): void;

Returns

Type	Description
void

undo()

Declaration

undo(): void;

Returns

Type	Description
void

updateItemHandler(newFrame)

Declaration

updateItemHandler(newFrame?: RectangleF): void;

Parameters

Type	Name	Description
RectangleF	newFrame

Returns

Type	Description
void

updateText(source, force)

Declaration

updateText(source: string, force?: boolean): Promise<void>;

Parameters

Type	Name	Description
string	source
boolean	force

Returns

Type	Description
Promise<void>

waitUpdate()

Declaration

waitUpdate(): Promise<void>;

Returns

Type	Description
Promise<void>