Class TextEditorController

Manages a text editor (TextWhizz or mobile versions).

Package: @aurigma/design-atoms

Remarks

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

Constructors

(constructor)(itemHandler, _textWhizz, textRenderer, activeTextCanvasHandler, viewerConfig, fontRegistry, colorParser, textFormattingEnabled, getTextEditor)

Constructs a new instance of the TextEditorController class

Declaration

constructor(itemHandler: NewBaseTextItemHandler, _textWhizz: typeof TextWhizz, textRenderer: TextRenderer, activeTextCanvasHandler: IActiveTextCanvasHandler, viewerConfig: IViewerConfiguration, fontRegistry: FontRegistry, colorParser: IColorParser, textFormattingEnabled: boolean, getTextEditor: Func<ITextEditor>);

Parameters

Type	Name	Description
NewBaseTextItemHandler	itemHandler
typeof TextWhizz	_textWhizz
TextRenderer	textRenderer
IActiveTextCanvasHandler	activeTextCanvasHandler
IViewerConfiguration	viewerConfig
FontRegistry	fontRegistry
IColorParser	colorParser
boolean	textFormattingEnabled
Func<unknown>	getTextEditor

Properties

activeTextEditor

Declaration

get activeTextEditor(): ITextEditor;

Property Value

Type	Description
IFontRegistry

canRedo

Declaration

get canRedo(): boolean;

Property Value

Type	Description
boolean

canUndo

Declaration

get canUndo(): boolean;

Property Value

Type	Description
boolean

enteredEditModeEvent

Declaration

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

Property Value

Type	Description
EventWithSenderArg<TextEditorController, unknown>

exitedEditModeEvent

Declaration

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

Property Value

Type	Description
EventWithSenderArg<TextEditorController, unknown>

failed

Declaration

get failed(): boolean;

Property Value

Type	Description
boolean

isActive

Declaration

get isActive(): boolean;

Property Value

Type	Description
boolean

isCropped

Declaration

get isCropped(): boolean;

Property Value

Type	Description
boolean

isInEdit

Declaration

get isInEdit(): boolean;

Property Value

Type	Description
boolean

isMobile

Declaration

get isMobile(): boolean;

Property Value

Type	Description
boolean

isStatic

Declaration

get isStatic(): boolean;

Property Value

Type	Description
boolean

ready

Declaration

get 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(): void;

Returns

Type	Description
void

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(useActiveText)

Declaration

measureTextFrame(useActiveText?: boolean): RectangleF;

Parameters

Type	Name	Description
boolean	useActiveText

Returns

Type	Description
RectangleF

processKeyEvent(e)

Declaration

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

Parameters

Type	Name	Description
IKeyboardEventParams	e

Returns

Type	Description
Promise<boolean>

processMouseEvent(pointerParams, mouseOverCurrent)

Declaration

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

Parameters

Type	Name	Description
IPointerParams	pointerParams
boolean	mouseOverCurrent

Returns

Type	Description
Promise<boolean>

redo()

Declaration

redo(): void;

Returns

Type	Description
void

redrawActiveText()

Declaration

redrawActiveText(): void;

Returns

Type	Description
void

redrawText()

Declaration

redrawText(): void;

Returns

Type	Description
void

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(trigger, force)

Declaration

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

Parameters

Type	Name	Description
string	trigger
boolean	force

Returns

Type	Description
Promise<void>

waitUpdate()

Declaration

waitUpdate(): Promise<void>;

Returns

Type	Description
Promise<void>