[ view source ]

class WindowData

package elements

extends Model › Entity

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

Available with elements plugin

Events

@:dox(show)xChange(current:Float, previous:Float):Void

Event when x field changes.

@:dox(show)yChange(current:Float, previous:Float):Void

Event when y field changes.

@:dox(show)widthChange(current:Float, previous:Float):Void

Event when width field changes.

@:dox(show)heightChange(current:Float, previous:Float):Void

Event when height field changes.

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

Event when expanded field changes.

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

Event when header field changes.

@:dox(show)scrollbarChange(current:ScrollbarVisibility, previous:ScrollbarVisibility):Void

Event when scrollbar field changes.

Static variables

@:value(200)staticfinalinlineread onlyDEFAULT_WIDTH:Float = 200

@:value(-60001.0)staticfinalinlineread onlyDEFAULT_HEIGHT:Float = -60001.0

Constructor

new()

Variables

@:value(50)@serializex:Float = 50

@:value(50)@serializey:Float = 50

@:value(50)@serializewidth:Float = 50

@:value(50)@serializeheight:Float = 50

@:value(true)@serializeexpanded:Bool = true

@:value(true)@serializeheader:Bool = true

@:value(AUTO_ADD)@serializescrollbar:ScrollbarVisibility = AUTO_ADD

@:value(0)computedContentHeight:Float = 0

@:value([])read onlyitems:ReadOnlyArray<WindowItem> = []

read onlynumItems:Int

@:value(null)theme:Theme = null

@:value(null)form:FormLayout = null

@:value(null)filler:View = null

@:value(false)scrollable:Bool = false

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

@:value(true)used:Bool = true

@:value(false)justClosed:Bool = false

@:value(false)closable:Bool = false

@:value(false)movable:Bool = false

@:value(true)collapsible:Bool = true

@:value(false)overlay:Bool = false

@:value(null)overlayTheme:Theme = null

@:value(false)overlayClicked:Bool = false

@:value(LEFT)titleAlign:TextAlign = LEFT

@:value(-999999999)targetX:Float = -999999999

@:value(-999999999)targetY:Float = -999999999

@:value(-999999999)targetAnchorX:Float = -999999999

@:value(-999999999)targetAnchorY:Float = -999999999

@:value(null)window:Window = null

Methods

invalidateX():Void

invalidateY():Void

invalidateWidth():Void

invalidateHeight():Void

invalidateExpanded():Void

invalidateHeader():Void

invalidateScrollbar():Void

beginFrame():Void

endFrame():Void

addItem(item:WindowItem):Void

Inherited Events

Defined by Model

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

Event when any observable value as changed on this instance.

@:dox(show)_modelDirty(model:Model):Void

@:dox(show)serialize():Void

Event when this object gets serialized.

@:dox(show)deserialize():Void

Event when this object gets deserialized.

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

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

Inherited Variables

Defined by Model

@:value(false)observedDirty:Bool = false

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

@componentserializer:SerializeModel

@componentsharer:ShareModel

@:value(false)dirty:Bool = false

Defined by Entity

@:value(null)id:String = null

read onlydestroyed:Bool

read onlydisposed:Bool

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

components: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 Model

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

Start a tween associated with this entity.

Parameters:

easing

The easing to use

duration

The duration of the tween

fromValue

The start value of the tween

toValue

The end value of the tween

update

An update function called at each iteration of the tween

Returns:

The instance of the created Tween object

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

Start an eager tween associated with this entity. This is the same as a regular tween, except that it will start updating itself using current frame's delta time instead of next frame like in a regular tween.

Parameters:

easing

The easing to use

duration

The duration of the tween

fromValue

The start value of the tween

toValue

The end value of the tween

update

An update function called at each iteration of the tween

Returns:

The instance of the created Tween object

className():String

inlineclearComponents():Void

@:value({ hasField : false })component<C>(?name:String, ?component:Null<C>, hasField:Bool = false):C

hasComponent(name:String):Bool

removeComponent(name:String):Void