import TextField from '@mobilizing/library/js/Mobilizing/text/TextField.js'

public class |source

TextField

Constructor Summary

Public Constructor
public	constructor(params: Object) TextField to simulate the input textfield we can find in the DOM.

Member Summary

Public Members
public	backgroundColor: *
public	blinkTime: *
public	color: *
public	cursorColor: *
public	cursorWidth: *
public	font: *
public	fontBold: *
public	fontBoldItalic: *
public	fontItalic: *
public	height: *
public	margins: *
public	maxCharCount: *
public	size: *
public	width: *

Private Members
private	_blinkState: boolean
private	_boldFont: *
private	_boldItalicFont: *
private	_canvas: *
private	_canvasContext: *
private	_currentFont: *
private	_cursorIndex: *
private	_cursorX: number
private	_cursorY: number
private	_font: *
private	_italicFont: *
private	_ready: boolean
private	_styledLetters: *[]
private	_text: string

Method Summary

Public Methods
public	addLetter(value: String) add a letter to the field content.
public	clear() Clears this textField : erase everything and make the cursor back to the first character place.
public	delete() Delete the letter currently before the cursor (or under selection when implemented)
public	getCanvas(): Canvas Get the canvas
public	getHeight(): Number Get canvas height
public	getText(): String Get the text displayed as a string
public	getWidth(): Number Get canvas width
public	moveCursorBack() Moves the cursor to the pevious letter
public	moveCursorForward() Moves the cursor to the next letter
public	moveCursorTo(index: Number) Moves the cursor to the given index of the letter
public	pickLetter(x: Number, y: Number): * Pick the letter situated under the given x,y coordinates
public	render() Renders the canvas
public	setColor(color: Color) Set the color of the next letter
public	setFont(font: Font) Set the font.
public	setSize(size: Number) Set the size of the next letter

Private Methods
private	onBlink() Cursor blink callback
private	setup() Setup bloc called after default font loading

Public Constructors

public constructor(params: Object) source

TextField to simulate the input textfield we can find in the DOM. This is implemented in an HTLM Canvas so it can be rendered in a texture.

Params:

Name	Type	Attribute	Description
params	Object		Parameters object, given by the constructor.
params.maxCharCount	Number	optional default: 1000
params.size	Number	optional default: 20
params.color	CSSColor	optional default: "gray"
params.backgroundColor	CSSColor	optional default: "white"
params.margins	Number	optional default: 10
params.width	Number	optional default: 300
params.height	Number	optional default: 100
params.font	Font	optional default: undefined
params.fontItalic	Font	optional default: undefined
params.fontBold	Font	optional default: undefined
params.fontBoldItalic	Font	optional default: undefined
params.cursorColor	CSSColor	optional default: "gray"
params.cursorWidth	Number	optional default: 2
params.blinkTime	Number	optional default: 300

Example:

   //TODO

Public Members

public backgroundColor: * source

public blinkTime: * source

public color: * source

public cursorColor: * source

public cursorWidth: * source

public font: * source

public fontBold: * source

public fontBoldItalic: * source

public fontItalic: * source

public height: * source

public margins: * source

public maxCharCount: * source

public size: * source

public width: * source

Private Members

private _blinkState: boolean source

private _boldFont: * source

private _boldItalicFont: * source

private _canvas: * source

private _canvasContext: * source

private _currentFont: * source

private _cursorIndex: * source

private _cursorX: number source

private _cursorY: number source

private _font: * source

private _italicFont: * source

private _ready: boolean source

private _styledLetters: *[] source

private _text: string source

Public Methods

public addLetter(value: String) source

add a letter to the field content. Styles (font, color, etc) should be defined before calling this method.

Params:

Name	Type	Attribute	Description
value	String		the letter to add

public clear() source

Clears this textField : erase everything and make the cursor back to the first character place.

public delete() source

Delete the letter currently before the cursor (or under selection when implemented)

public getCanvas(): Canvas source

Get the canvas

Return:

Canvas

canvas

public getHeight(): Number source

Get canvas height

Return:

Number

canvas height

public getText(): String source

Get the text displayed as a string

Return:

String

the text displayed in this TextField

public getWidth(): Number source

Get canvas width

Return:

Number

canvas width

public moveCursorBack() source

Moves the cursor to the pevious letter

public moveCursorForward() source

Moves the cursor to the next letter

public moveCursorTo(index: Number) source

Moves the cursor to the given index of the letter

Params:

Name	Type	Attribute	Description
index	Number

public pickLetter(x: Number, y: Number): * source

Pick the letter situated under the given x,y coordinates

Params:

Name	Type	Attribute	Description
x	Number
y	Number

Return:

public render() source

Renders the canvas

public setColor(color: Color) source

Set the color of the next letter

Params:

Name	Type	Attribute	Description
color	Color		the new Mobilizing Color

public setFont(font: Font) source

Set the font.

Params:

Name	Type	Attribute	Description
font	Font		Mobilizing font to use for the next letter

public setSize(size: Number) source

Set the size of the next letter

Params:

Name	Type	Attribute	Description
size	Number		the new size of the font

TextField

Constructor Summary

Member Summary

Method Summary

Public Constructors

public constructor(params: Object) source

Params:

Example:

Public Members

public backgroundColor: * source

public blinkTime: * source

public color: * source

public cursorColor: * source

public cursorWidth: * source

public font: * source

public fontBold: * source

public fontBoldItalic: * source

public fontItalic: * source

public height: * source

public margins: * source

public maxCharCount: * source

public size: * source

public width: * source

Private Members

private _blinkState: boolean source

private _boldFont: * source

private _boldItalicFont: * source

private _canvas: * source

private _canvasContext: * source

private _currentFont: * source

private _cursorIndex: * source

private _cursorX: number source

private _cursorY: number source

private _font: * source

private _italicFont: * source

private _ready: boolean source

private _styledLetters: *[] source

private _text: string source

Public Methods

public addLetter(value: String) source

Params:

public clear() source

public delete() source

public getCanvas(): Canvas source

Return:

public getHeight(): Number source

Return:

public getText(): String source

Return:

public getWidth(): Number source

Return:

public moveCursorBack() source

public moveCursorForward() source

public moveCursorTo(index: Number) source

Params:

public pickLetter(x: Number, y: Number): * source

Params:

Return:

public render() source

public setColor(color: Color) source

Params:

public setFont(font: Font) source

Params:

public setSize(size: Number) source

Params:

Private Methods

private onBlink() source

private setup() source