Class MobileTextEditor

Package: @aurigma/design-atoms-text

Constructors

(constructor)(elementHandler, fontService, useSimpleFontList, _inputTextValidator, designAtomsApiClient, colorPreviewService, colorParser, rgbColorParser)

Constructs a new instance of the MobileTextEditor class

Declaration

constructor(elementHandler: ITextEditorElementHandler, fontService: IFontService, useSimpleFontList: boolean, _inputTextValidator: IInputTextValidator, designAtomsApiClient: IDesignAtomsApiClient, colorPreviewService: IColorPreviewService, colorParser: IColorParser, rgbColorParser: IRgbColorParser);

Parameters

Type	Name	Description
ITextEditorElementHandler	elementHandler
IFontService	fontService
boolean	useSimpleFontList
IInputTextValidator	_inputTextValidator
IDesignAtomsApiClient	designAtomsApiClient
IColorPreviewService	colorPreviewService
IColorParser	colorParser
IRgbColorParser	rgbColorParser

Properties

canRedo

Declaration

get canRedo(): boolean;

Property Value

Type	Description
boolean

canUndo

Declaration

get canUndo(): boolean;

Property Value

Type	Description
boolean

disableDrawBaseline

Declaration

get disableDrawBaseline(): boolean;

Property Value

Type	Description
boolean

editorInitialized

Declaration

editorInitialized: EventObject<void>;

Property Value

Type	Description
EventObject<void>

frameChanged

Declaration

get frameChanged(): EventObject<RectangleF>;

Property Value

Type	Description
EventObject<RectangleF>

highlightInEditingModeEnabled

Declaration

get highlightInEditingModeEnabled(): boolean;

Property Value

Type	Description
boolean

invalidCharEntered

Declaration

get invalidCharEntered(): EventObject<void>;

Property Value

Type	Description
EventObject<void>

isActive

Declaration

get isActive(): boolean;

Property Value

Type	Description
boolean

isReady

Declaration

get isReady(): boolean;

Property Value

Type	Description
boolean

redrawActiveTextInEditMode

Indicates if the editor needs to redraw ActiveText when it is edited.

Declaration

get redrawActiveTextInEditMode(): boolean;

Property Value

Type	Description
boolean	Indicates if the editor needs to redraw ActiveText when it is edited.

styleChanged

Declaration

styleChanged: EventObject<void>;

Property Value

Type	Description
EventObject<void>

textLimits

Declaration

get textLimits(): ITextLimits;

Property Value

Type	Description
ITextLimits

textLimitsViolationEvent

Declaration

get textLimitsViolationEvent(): EventObject<ILimitsViolationEventData>;

Property Value

Type	Description
EventObject<ILimitsViolationEventData>

textMetrics

Declaration

get textMetrics(): ITextMetrics;

Property Value

Type	Description
ITextMetrics

textMetricsChangedEvent

Declaration

get textMetricsChangedEvent(): EventObject<ITextMetrics>;

Property Value

Type	Description
EventObject<ITextMetrics>

Methods

dispose()

Declaration

dispose(): void;

Returns

Type	Description
void

ensureFocus()

Declaration

ensureFocus(): void;

Returns

Type	Description
void

enterEditMode(point)

Declaration

enterEditMode(point?: IPoint): Promise<void>;

Parameters

Type	Name	Description
IPoint	point

Returns

Type	Description
Promise<void>

executeCommand(commandType, initData)

Declaration

executeCommand(commandType: CommandType, initData?: any): void;

Parameters

Type	Name	Description
CommandType	commandType
any	initData

Returns

Type	Description
void

exitEditMode()

Declaration

exitEditMode(): void;

Returns

Type	Description
void

getFormattedText()

Declaration

getFormattedText(): Promise<string>;

Returns

Type	Description
Promise<string>

getInlineStyle()

Declaration

getInlineStyle(): ICharStyle | null;

Returns

Type	Description
ICharStyle | null

getParagraphLength(index)

Declaration

getParagraphLength(index: number): number;

Parameters

Type	Name	Description
number	index

Returns

Type	Description
number

getParagraphStyle()

Declaration

getParagraphStyle(): IParagraphStyle;

Returns

Type	Description
IParagraphStyle

getTextMetrics()

Declaration

getTextMetrics(): TextMetrics;

Returns

Type	Description
TextMetrics

getTextModel()

Declaration

getTextModel(): TextModel;

Returns

Type	Description
Text_2

initialize(data, colorPalette, listStyleSheetManager)

Declaration

initialize(data: EditorInitData, colorPalette: IColorPalette, listStyleSheetManager: IListStyleSheetManager): void;

Parameters

Type	Name	Description
EditorInitData	data
IColorPalette	colorPalette
IListStyleSheetManager	listStyleSheetManager

Returns

Type	Description
void

isApplyingListsEnabled()

Declaration

isApplyingListsEnabled(): boolean;

Returns

Type	Description
boolean

isBulletedList()

Declaration

isBulletedList(): boolean;

Returns

Type	Description
boolean

isIndentationEnabled()

Declaration

isIndentationEnabled(): boolean;

Returns

Type	Description
boolean

isIndentationHidden()

Declaration

isIndentationHidden(): boolean;

Returns

Type	Description
boolean

isNumberedList()

Declaration

isNumberedList(): boolean;

Returns

Type	Description
boolean

processKeyEvent(e)

Declaration

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

Parameters

Type	Name	Description
KeyboardEvent	e

Returns

Type	Description
Promise<boolean>

processMouseEvent(e)

Declaration

processMouseEvent(e: IMouseEvent): void;

Parameters

Type	Name	Description
IMouseEvent	e

Returns

Type	Description
void

processZoomChangedEvent()

Declaration

processZoomChangedEvent(): Promise<boolean>;

Returns

Type	Description
Promise<boolean>

redo()

Declaration

redo(): void;

Returns

Type	Description
void

redraw()

Declaration

redraw(): void;

Returns

Type	Description
void

setFontRegistry(fontRegistry)

Declaration

setFontRegistry(fontRegistry: IFontRegistry): void;

Parameters

Type	Name	Description
IFontRegistry	fontRegistry

Returns

Type	Description
void

setInlineStyle(value)

Declaration

setInlineStyle(value: ICharStyle): Promise<void>;

Parameters

Type	Name	Description
ICharStyle	value

Returns

Type	Description
Promise<void>

setParagraphStyle(value)

Declaration

setParagraphStyle(value: IParagraphStyle): Promise<void>;

Parameters

Type	Name	Description
IParagraphStyle	value

Returns

Type	Description
Promise<void>

undo()

Declaration

undo(): void;

Returns

Type	Description
void