View source

class TextInput

package h2d

extends Text › Drawable › Object

@:directlyUsed

A skinnable text input handler.

Supports text selection, keyboard cursor navigation, as well as basic hotkeys: Ctrl + Z, Ctrl + Y for undo and redo and Ctrl + A to select all text.

Static methods

staticdynamichideSoftwareKeyboard(target:TextInput):Void

staticdynamicshowSoftwareKeyboard(target:TextInput):Void

Constructor

new(font:Font, ?parent:Object)

Create a new TextInput instance.

Parameters:

font

The font used to render the text.

parent

An optional parent h2d.Object instance to which TextInput adds itself if set.

Variables

backgroundColor:Null<Int>

If set, TextInput will render provided color as a background to text interactive area.

@:value(true)canEdit:Bool = true

When disabled, user would not be able to edit the input text (selection is still available).

@:value(0.5)cursorBlinkTime:Float = 0.5

The blinking interval of the cursor in seconds.

@:value(-1)cursorIndex:Int = -1

Current position of the input cursor. When TextInput is not focused value is -1.

cursorTile:Tile

The Tile used to render the input cursor.

inputWidth:Null<Int>

Maximum input width. Contrary to Text.maxWidth does not cause a word-wrap, but also masks out contents that are outside the max width.

@:value(false)multiline:Bool = false

Whether the text input allows multiple lines.

selectionRange:{start:Int, length:Int}

If not null, represents current text selection range.

selectionTile:Tile

The Tile used to render the background for selected text. When rendering, this Tile is stretched horizontally to fill entire selection area.

@:value(true)useSoftwareKeyboard:Bool = true

When disabled, showSoftwareKeyboard will not be called.

Methods

focus():Void

Sets focus on this TextInput.

getSelectedText():String

Returns a String representing currently selected text area or null if no text is selected.

hasFocus():Bool

Checks if TextInput is currently focused.

dynamiconChange():Void

Sent when user modifies TextInput contents.

dynamiconClick(e:Event):Void

Delegate of underlying Interactive.onClick.

dynamiconFocus(e:Event):Void

Delegate of underlying Interactive.onFocus.

dynamiconFocusLost(e:Event):Void

Delegate of underlying Interactive.onFocusLost.

dynamiconKeyDown(e:Event):Void

Delegate of underlying Interactive.onKeyDown.

dynamiconKeyUp(e:Event):Void

Delegate of underlying Interactive.onKeyUp.

dynamiconMove(e:Event):Void

Delegate of underlying Interactive.onMove.

dynamiconOut(e:Event):Void

Delegate of underlying Interactive.onOut.

dynamiconOver(e:Event):Void

Delegate of underlying Interactive.onOver.

dynamiconPush(e:Event):Void

Delegate of underlying Interactive.onPush.

dynamiconRelease(e:Event):Void

Delegate of underlying Interactive.onRelease.

dynamiconTextInput(e:Event):Void

Delegate of underlying Interactive.onTextInput.

Inherited Variables

Defined by Text

dropShadow:{dy:Float, dx:Float, color:Int, alpha:Float}

Adds simple drop shadow to the Text with specified offset, color and alpha. Causes text to be rendered twice (first drop shadow and then the text itself).

font:Font

The font used to render text.

@:value(0)letterSpacing:Float = 0

Extra letter spacing in pixels.

@:value(true)lineBreak:Bool = true

Allow line break.

@:value(0)lineSpacing:Float = 0

Extra line spacing in pixels.

maxWidth:Null<Float>

When set, limits maximum line width and causes word-wrap. Affects positioning of the text depending on textAlign value.

When Text is affected by size constraints (see Object.constraintSize), smallest of the two is used for word-wrap.

text:String

Current rendered text.

textAlign:Align

Text align rules dictate how the text lines are positioned. See Align for specific details on each alignment mode.

textColor:Int

Text RGB color. Alpha value is ignored.

read onlytextHeight:Float

Calculated text height.

Not a completely precise text metric and increments in the Font.lineHeight steps. In HtmlText, can be increased by various values depending on the active line font and HtmlText.lineHeightMode value.

read onlytextWidth:Float

Calculated text width. Can exceed maxWidth in certain cases.

Defined by Drawable

color:Vector4

The color multiplier for the drawable. Can be used to adjust individually each of the four channels R,G,B,A (default [1,1,1,1])

colorAdd:Null<Vector>

Setting colorAdd will add the amount of color of each channel R,G,B,A to the object pixels.

colorKey:Null<Int>

Setting a colorKey color value will discard all pixels that have this exact color in the tile.

colorMatrix:Null<Matrix>

Setting a colorMatrix will apply a color transformation. See also adjustColor.

smooth:Null<Bool>

By enabling smoothing, scaling the object up or down will use hardware bilinear filtering resulting in a less crisp aspect.

By default smooth is null in which case Scene.defaultSmooth value is used.

tileWrap:Bool

Enables texture uv wrap for this Drawable, causing tiles with uv exceeding the texture size to repeat instead of clamping on edges.

Note that tileWrap does not use the Tile region as a wrapping area but instead uses underlying h3d.mat.Texture size. This is due to implementation specifics, as it just sets the Texture.wrap to either Repeat or Clamp. Because of that, proper Tile tiling can be expected only when the tile covers an entire Texture area.

Defined by Object

private@:dox(show)allocated:Bool

A flag that indicates whether the object was allocated or not.

When adding children to allocated objects, onAdd is being called immediately, otherwise it's delayed until the whole tree is added to a currently active Scene.

@:value(1.)alpha:Float = 1.

The amount of transparency of the Object.

@:value(Alpha)blendMode:BlendMode = Alpha

The blending mode of the object.

If there is no Object.filter active, only applies to the current object (not inherited by children). Otherwise tells how the filter is blended with background.

filter:Filter

The post process filter for this object.

When set, Object.alpha value affects both filter and object transparency (use Drawable.color.a to set transparency only for the object).

name:String

The name of the object. Can be used to retrieve an object within a tree by using Object.getObjectByName.

read onlynumChildren:Int

How many immediate children this object has.

read onlyparent:Object

The parent object in the scene tree.

private@:dox(show)parentContainer:Object

The parent container of this object. See Object.contentChanged for more details.

private@:dox(show)posChanged:Bool

A flag that indicates that the object transform was modified and absolute position recalculation is required.

Automatically cleared on Object.sync and can be manually synced with the Object.syncPos.

@:value(0)rotation:Float = 0

The rotation angle of this object, in radians.

@:value(1)scaleX:Float = 1

The amount of horizontal scaling of this object.

@:value(1)scaleY:Float = 1

The amount of vertical scaling of this object.

@:value(true)visible:Bool = true

Is the object and its children are displayed on screen.

@:value(0)x:Float = 0

The x position (in pixels) of the object relative to its parent.

@:value(0)y:Float = 0

The y position (in pixels) of the object relative to its parent.

Inherited Methods

Defined by Text

calcTextWidth(text:String):Float

Calculates and returns width of the provided text with settings this Text instance.

getTextProgress(text:String, progress:Float):String

Returns cut text based on progress percentile. Can be used to gradually show appearing text. (Especially useful when using HtmlText)

private@:value({ prevChar : -1, afterData : 0., leftMargin : 0. })@:dox(show)splitRawText(text:String, leftMargin:Float = 0., afterData:Float = 0., ?font:Font, ?sizes:Array<Float>, prevChar:Int = -1):String

Advanced usage Perform a word-wrap of the text based on this Text settings.

Parameters:

text

String to word-wrap.

leftMargin

Starting x offset of the first line.

afterData

Minimum remaining space required at the end of the line.

font

Optional overriding font to use instead of currently set.

sizes

Optional line width array. Will be populated with sizes of split lines if present. Sizes will include both leftMargin in it's first line entry.

prevChar

Optional character code for concatenation purposes (proper kernings).

splitText(text:String):String

Perform a word-wrap of the text based on this Text settings.

private@:dox(show)validateText():Void

Extra validation of the text variable when it's changed. Override to add custom validation.

Only validation of the text is allowed, and attempting to change the text value will lead to undefined behavior.

Defined by Drawable

addShader<T>(s:T):T

Add a shader to the drawable shaders.

Keep in mind, that as stated before, drawable children do not inherit Drawable properties, which includes shaders.

adjustColor(?col:Null<ColorAdjust>):Void

Set the Drawable.colorMatrix value by specifying which effects to apply. Calling adjustColor() without arguments will reset the colorMatrix to null.

getShader<T>(stype:Class<T>):T

Returns the first shader of the given shader class among the drawable shaders.

Parameters:

stype

The class of the shader to look up.

inlinegetShaders():ShaderIterator

Returns an iterator of all drawable shaders

removeShader(s:Shader):Bool

Remove a shader from the drawable shaders, returns true if found or false if it was not part of our shaders.

Defined by Object

private@:dox(show)addBounds(relativeTo:Object, out:Bounds, dx:Float, dy:Float, width:Float, height:Float):Void

Adds specified area in local coordinate space to the bounds. Expected to be used within Object.getBoundsRec.

Parameters:

relativeTo

An object relative to which the Object bounds coordinates should be. If not set, coordinates are in absolute coordinate space.

out

An output Bounds instance.

dx

The top-left X offset of the added bounds rectangle.

dy

The top-left Y offset of the added bounds rectangle.

width

The width of the added bounds rectangle.

height

The height of the added bounds rectangle.

addChild(s:Object):Void

Add a child object at the end of the children list.

addChildAt(s:Object, pos:Int):Void

Insert a child object at the specified position of the children list.

private@:dox(show)calcAbsPos():Void

Internal usage Calculates the absolute object position transform. See `Object.syncPos` for a safe position sync method. This method does not ensure that object parents also have up-to-date transform nor does it clear the `Object.posChanged` flag.

private@:value({ scaleY : 1., scaleX : 1. })@:dox(show)clipBounds(ctx:RenderContext, bounds:Bounds, scaleX:Float = 1., scaleY:Float = 1.):Void

Internal usage Clip the local bounds with our global viewport. Used during filter rendering in order to clip out areas that are off-screen and should not be rendered.

h2d.Scene note: clipBounds will always output bounds equivalent to entire window. This is done in order for scene to never clip out cameras as they may render virtually any area of the Scene.

private@:dox(show)constraintSize(maxWidth:Float, maxHeight:Float):Void

Advanced usage This can be called by a parent container to constraint the size of its children. Negative value mean that constraint is to be disabled.

For example, Text constraints it's maximum width, causing word-wrap to occur within constrained area.

See also:

contains(o:Object):Bool

Tells if the object is contained into this object children, recursively.

private@:dox(show)contentChanged(s:Object):Void

Advanced usage Called by the children of a container object if they have `parentContainer` defined in them. Primary use-case is when the child size got changed, requiring content to reevaluate positioning such as `Flow` layouts, but also can be used for other purposes.

private@:dox(show)draw(ctx:RenderContext):Void

Override this method in order to add custom graphics rendering to your Object. draw is invoked before rendering of the object children.

drawTo(t:Texture):Void

Draw the object and all its children into the given Texture.

drawToTextures(texs:Array<Texture>, outputs:Array<Output>):Void

Draw the object and all its children into the given Textures.

private@:dox(show)emitTile(ctx:RenderContext, tile:Tile):Void

Draws single Tile instance with this Object transform.

find<T>(f:Object ‑> Null<T>):Null<T>

Find a single object in the tree by calling f on each and returning the first not-null value returned, or null if not found.

findAll<T>(f:Object ‑> Null<T>, ?arr:Array<T>):Array<T>

Find several objects in the tree by calling f on each and returning all the not-null values returned.

Parameters:

arr

An optional array instance to fill results with. Allocates a new array if not set.

inlinegetAbsPos():Matrix

Returns the updated absolute position matrix. See Object.getMatrix for current matrix values.

getBounds(?relativeTo:Object, ?out:Bounds):Bounds

Return the bounds of the object for its whole content, recursively.

Parameters:

relativeTo

An optional object relative to coordinates of which bounds are returned. Returns bounds in the absolute coordinates if not set.

out

An optional bounds instance to fill. Allocates new Bounds instance and returns it if not set.

private@:dox(show)getBoundsRec(relativeTo:Object, out:Bounds, forSize:Bool):Void

Override this method in order to expand the reported bounds of an object. Object.addBounds can be used to add bounds with respect to relativeTo. Do not remove the super call.

Parameters:

relativeTo

An object relative to which the Object bounds coordinates should be.

out

An output Bounds instance.

forSize

Whether it's being called for Object.getSize or Object.getBounds.

getChildAt(n:Int):Object

Return the nth element among the immediate children list of this object, or null if there is no Object at this position.

getChildIndex(o:Object):Int

Return the index of the object o within the immediate children list of this object, or -1 if it is not part of the children list.

private@:dox(show)getMatrix(m:Matrix):Void

Populates m with current absolute object transform values. See Object.getAbsPos for up-to-date values.

getObjectByName(name:String):Object

Search for an object recursively by name, return null if not found.

getObjectsCount():Int

Return the total number of children in the whole tree, recursively.

getScene():Scene

Returns an h2d.Scene down the hierarchy tree or null if object is not added to Scene.

finalgetSize(?out:Bounds):Bounds

Similar to getBounds(parent), but instead of the full content, it will return the size based on the alignment of the object. For instance for a text, Object.getBounds will return the full glyphs size whereas getSize will ignore the pixels under the baseline.

Parameters:

out

An optional bounds instance to fill. Allocates new Bounds instance and returns it if not set.

globalToLocal(pt:Point):Point

Convert an absolute screen position into a local position relative to the object origin, applying all the inherited transforms.

Parameters:

pt

A position to convert and return. Modifies the Point instance as is.

inlineiterator():ArrayIterator_h2d_Object

Return an iterator over this object immediate children

localToGlobal(?pt:Point):Point

Convert a local position (or [0,0] if pt is null) relative to the object origin into an absolute screen position, applying all the inherited transforms.

Parameters:

pt

An optional position to convert and return. Allocates new Point at 0,0 position if not set. Modifies the Point instance as is.

move(dx:Float, dy:Float):Void

Move the object by the specified amount along its current direction (Object.rotation angle).

private@:dox(show)onAdd():Void

Sent when object is being added to an allocated scene.

Do not remove the super call when overriding.

private@:dox(show)inlineonContentChanged():Void

Should be called when Object content was changed in order to notify parent container. See Object.contentChanged.

private@:dox(show)onHierarchyMoved(parentChanged:Bool):Void

Sent when object was already allocated and moved within scene object tree hierarchy.

Do not remove the super call when overriding.

Parameters:

parentChanged

Whether Object was moved withing same parent (through Layers.ysort for example) or relocated to a new one.

private@:dox(show)onRemove():Void

Sent when object is removed from the allocated scene.

Do not remove the super call when overriding.

inlineremove():Void

Same as parent.removeChild(this), but does nothing if parent is null.

removeChild(s:Object):Void

Remove the given object from the immediate children list of the object if it's part of it.

removeChildren():Void

Remove all children from the immediate children list.

inlinerotate(v:Float):Void

Rotate the object by the given angle (in radians)

inlinescale(v:Float):Void

Scale uniformly the object by the given factor.

private@:dox(show)setParentContainer(c:Object):Void

Sets the parent container for this Object and it's children. See Object.contentChanged for more details.

inlinesetPosition(x:Float, y:Float):Void

Set the position of the object relative to its parent.

inlinesetScale(v:Float):Void

Set the uniform scale for the object.

private@:dox(show)sync(ctx:RenderContext):Void

Performs a sync of data for rendering (such as absolute position recalculation). While this method can be used as a substitute to an update loop, it's primary purpose it to prepare the Object to be rendered.

Do not remove the super call when overriding.

private@:dox(show)syncPos():Void

Ensures that object has an up-to-date position transform.