[ view source ]

class SelectText

package ceramic

extends Entity

implements Observable, Component

@:directlyUsed@:build(tracker.macros.ObservableMacro.build())@:autoBuild(tracker.macros.ObservableMacro.build())@:build(ceramic.macros.ComponentMacro.build())@:autoBuild(ceramic.macros.ComponentMacro.build())@:build(ceramic.macros.EntityMacro.buildForCompletion())@:autoBuild(ceramic.macros.EntityMacro.buildForCompletion())@:build(tracker.macros.EventsMacro.build())@:autoBuild(tracker.macros.EventsMacro.build())

Available on all targets

Events

@:dox(show)observedDirty(instance:SelectText, fromSerializedField:Bool):Void

Event when any observable value as changed on this instance.

@:dox(show)selection(selectionStart:Int, selectionEnd:Int, inverted:Bool):Void

@:dox(show)containerChange(current:Visual, previous:Visual):Void

Event when container field changes.

@:dox(show)allowSelectingFromPointerChange(current:Bool, previous:Bool):Void

Event when allowSelectingFromPointer field changes.

@:dox(show)showCursorChange(current:Bool, previous:Bool):Void

Event when showCursor field changes.

@:dox(show)selectionStartChange(current:Int, previous:Int):Void

Event when selectionStart field changes.

@:dox(show)selectionEndChange(current:Int, previous:Int):Void

Event when selectionEnd field changes.

@:dox(show)invertedSelectionChange(current:Bool, previous:Bool):Void

Event when invertedSelection field changes.

@:dox(show)pointerIsDownChange(current:Bool, previous:Bool):Void

Event when pointerIsDown field changes.

Constructor

@:value({ textCursorHeightFactor : 1, textCursorOffsetY : 0, textCursorOffsetX : 0 })new(selectionColor:Color, textCursorColor:Color, textCursorOffsetX:Float = 0, textCursorOffsetY:Float = 0, textCursorHeightFactor:Float = 1)

Variables

@:value(false)observedDirty:Bool = false

Default is false, automatically set to true when any of this instance's observable variables has changed.

@:keepentity:Text

selectionColor:Color

textCursorColor:Color

@:value(0)textCursorOffsetX:Float = 0

@:value(0)textCursorOffsetY:Float = 0

@:value(1)textCursorHeightFactor:Float = 1

@:value(null)@observecontainer:Visual = null

Optional container on which pointer events are bound

@:value(false)@observeallowSelectingFromPointer:Bool = false

@:value(false)@observeshowCursor:Bool = false

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

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

@:value(false)@observeinvertedSelection:Bool = false

@:value(false)@observepointerIsDown:Bool = false

@:value(null)read onlyinitializerName:String = null

Methods

invalidateContainer():Void

invalidateAllowSelectingFromPointer():Void

invalidateShowCursor():Void

invalidateSelectionStart():Void

invalidateSelectionEnd():Void

invalidateInvertedSelection():Void

invalidatePointerIsDown():Void

Inherited Events

Defined by Entity

@:dox(show)dispose(entity:Entity):Void

@:dox(show)destroy(entity:Entity):Void

Inherited Variables

Defined by Entity

read onlyhasData:Bool

data:Dynamic

@:value(null)id:String = null

read onlydestroyed:Bool

read onlydisposed:Bool

@:value(null)read onlyautoruns:Array<Autorun> = null

@editablecomponents:ReadOnlyMap<String, Component>

Public components mapping. Contain components created separately with component() or macro-based components as well.

scriptContent:ScriptContent

Available with script plugin

script:Script

Available with script plugin

Inherited Methods

Defined by Entity

destroy():Void

Destroy this entity. This method is automatically protected from duplicate calls. That means calling multiple times an entity's destroy() method will run the destroy code only one time. As soon as destroy() is called, the entity is marked destroyed=true, even when calling destroy() method on a subclass (a macro is inserting a code to mark the object as destroyed at the beginning of every destroy() override function.

dispose():Void

Schedules destroy, at the end of the current frame.

unbindEvents():Void

Remove all events handlers from this entity.

autorun(run:() ‑> Void, ?afterRun:() ‑> Void):Autorun

Creates a new Autorun instance with the given callback associated with the current entity.

Parameters:

run

The run callback

Returns:

The autorun instance

tween(?easing:Easing, duration:Float, fromValue:Float, toValue:Float, update:(Float, Float) ‑> Void):Tween

className():String

inlineclearComponents():Void

component<C>(?name:String, ?component:Null<C>):C

hasComponent(name:String):Bool

removeComponent(name:String):Void