new GOWN.TextArea(theme, skinName)
A text entry control that allows users to enter and edit multiple lines of
uniformly-formatted text with the ability to scroll.
| Name | Type | Default | Description |
|---|---|---|---|
theme |
GOWN.Theme | optional theme for the text area | |
skinName |
String | TextArea.SKIN_NAME | optional name of the text area skin |
Extends
Members
-
static,readonlyGOWN.TextArea.SKIN_NAMEString
-
Default text area skin name
-
allowDestroyCachebool
-
Will destroy the skin cache when the skinable gets destroyed
- Default Value:
- true
-
autoPreventInteractionbool
-
Prevent other interaction (touch/move) on this component
- Default Value:
- false
-
blinkIntervalNumber
-
Interval for the cursor (in milliseconds)
- Default Value:
- 500
-
currentStateString
-
The current state TODO: move to skinable?
- Default Value:
- InputControl.UP
-
enabledBoolean
-
Enables/Disables the control. (not implemented yet)
-
hasFocusbool
-
Determine if the input has the focus
- Default Value:
- false
-
labelNumber
-
Width of the text area
-
maxCharsString
-
The maximum number of characters that may be entered. If 0, any number of characters may be entered. (same as maxLength for DOM inputs)
- Default Value:
- 0
-
receiveKeysbool
-
TODO
- Default Value:
- true
-
selectionBgPIXI.Graphics
-
Text selection background
-
skinFallbackString
-
The fallback skin if the other skin does not exist (e.g. if a mobile theme that does not provide a "hover" state is used on a desktop system) (normally the default "up"-state skin)
- Default Value:
- 'up'
-
skinNameString
-
The skin name
- Default Value:
- TextArea.SKIN_NAME
-
stylePIXI.TextStyle
-
Set the text style
-
textString
-
Set the text that is shown inside the input field. Calls onTextChange callback if text changes.
- Default Value:
- ''
Methods
-
Blur the text input (remove focus)
-
inherited changeSkin(skin)
-
Remove old skin and add new one
Name Type Description skinDisplayObject -
inherited deleteSelection()
-
Delete the selected text
-
inherited deleteText(fromPos, toPos){String}
-
Delete text from a start position to an end position
Name Type Description fromPosNumber start position toPosNumber end position Returns:
Type Description String -
inherited destroy()
-
Destroy the Skinable and empty the skin cache
-
inherited focus()
-
Focus on this input and set it as current
-
inherited fromSkin(name, callback)
-
Get image from skin (will execute a callback with the loaded skin when it is loaded or call it directly when it already is loaded)
Name Type Description nameString name of the state callbackfunction callback that is executed if the skin is loaded -
getLines(){Array|*}
-
Get the text lines as an array
Returns:
Type Description Array | * Returns an array with one text line per array element -
inherited insertChar(char)
-
Insert a char at the current cursor position
Name Type Description charString The char that gets inserted -
inherited lineHeight(){Number}
-
Height of the line in pixel (assume that every character of pixi text has the same line height)
Returns:
Type Description Number -
inherited mousePos(){PIXI.Point}
-
Get the local mouse position from PIXI.InteractionData
Returns:
Type Description PIXI.Point -
inherited moveCursorLeft()
-
Move the cursor left
-
inherited moveCursorRight()
-
Move the cursor right
-
inherited protectedonblur()
-
Callback that will be executed once the text input is blurred
-
inherited protectedonDown()
-
onDown callback
-
inherited protectedonfocus()
-
Callback to execute code on focus
-
inherited protectedonInputChanged()
-
Input changed callback
-
inherited protectedonMouseUpOutside()
-
Blurs the input when the mouse is released outside
-
inherited protectedonMove()
-
onMove callback
-
inherited protectedonUp()
-
onUp callback
-
inherited pixelToTextPos(pixelPos){Number}
-
From pixel position on the text to character position inside the text (used when clicked on the text)
Name Type Description pixelPosPixel position of the mouse on the text Returns:
Type Description Number Position in the text -
inherited preloadSkins()
-
Initiate all skins first
-
inherited protectedredraw()
-
Update before draw call (draw cursor and selection)
-
inherited setCursorPos()
-
Set the cursor position on the text
-
inherited setText(text)
-
Set the input control text.
Name Type Description textString The text to set -
inherited setTheme(theme)
-
Change the theme
Name Type Description themeGOWN.Theme the new theme -
textToLinePos(textPos, position){PIXI.Point}
-
Calculate position in Text
Name Type Description textPosNumber Position in the text positionPIXI.Point optional Position object that gets returned Returns:
Type Description PIXI.Point returns the Line and Position in line -
inherited textToPixelPos(textPos, position){PIXI.Point}
-
From position in the text to pixel position (for cursor/selection positioning)
Name Type Description textPosNumber Current character position in the text positionPIXI.Point optional point that will be set with the pixel position and returned Returns:
Type Description PIXI.Point Pixel position -
inherited textWidth(text){Number}
-
Get the width of a text
Name Type Description textString The text to get the width from Returns:
Type Description Number -
inherited updateSelection(start, end){boolean}
-
Set the selected text
Name Type Description startNumber Start position in the text endNumber End position in the text Returns:
Type Description boolean -
inherited updateTheme(data)
-
Overwrite data from theme for this specific component. (usable if you want to change e.g. background color based on selected items)
Name Type Description dataupdated skin data