package haxe.ui.components

haxe.ui.core.Component
      ↪ haxe.ui.core.InteractiveComponent
           ↪ haxe.ui.components.Button

General purpose push button that supports both text and icon as well as repeat event dispatching

Composite Children

Id Type Style Name Notes button-label haxe.ui.components.Label .label The text of the button (if applicable) button-icon haxe.ui.components.Image .icon The icon of the button (if applicable)

Pseudo Classes

Name Notes :hover The style to be applied when the cursor is over the button :down The style to be applied when a mouse button is pressed inside the button :active The style to be applied when the button has focus

Example (XML)

<button text="Button" styleNames="myCustomButton" style="font-size: 30px" onClick="trace('hello world')" />

Example (Haxe)

var button = new Button(); button.text = "Button"; button.styleNames = "myCustomButton"; button.fontSize = 30; button.onClick = function(e) { trace("hello world"); }

Properties

Button

InteractiveComponent

Component

easeInRepeater:Bool clonable bindable behaviour Whether this button will ease in to specified repeatInterval

icon:Variant clonable bindable behaviour The image resource to use as the buttons icon

remainPressed:Bool clonable bindable behaviour Whether the buttons state should remain pressed even when the mouse has left its bounds

repeatInterval:Int clonable bindable behaviour How often this button will dispatch multiple click events while the the mouse is pressed within it

repeater:Bool clonable bindable behaviour Whether this button will dispatch multiple click events while the the mouse is pressed within it

selected:Bool clonable bindable behaviour Whether this button is toggled or not (only relavant if toggle = true)

toggle:Bool clonable bindable behaviour Whether this button should behave as a toggle button or not

allowFocus:Bool Whether this component is allowed to gain focus

allowInteraction:Bool clonable bindable behaviour

focus:Bool Whether this component currently has focus Note: components that have focus will have an `:active` css psuedo class automatically added

animatable:Bool Whether this component is allowed to animate

componentAnimation:Animation Current animation running

cssName:String read-only

native:Null<Bool> Whether to try to use a native version of this component

screen:Screen read-only Reference to the Screen object this component is displayed on

scriptEvents:Map read-only

styleSheet:StyleSheet

userData:Dynamic User specific data stored against this component instance

Methods

Button

Component

cloneComponent():Button override

fadeIn(onEnd = null, show:Bool = true)

fadeOut(onEnd = null, hide:Bool = true)

findComponents(styleName:String = null, type:Class<T> = null, maxDepth:Int = 5):Array<T>

findComponentsUnderPoint(screenX:Float, screenY:Float, type:Class<T> = null):Array<Component>

lockLayout(recursive:Bool = false)

ready() Tells the framework this component is ready Note: this is called internally by the framework

setComponentIndex(child:Component, index:Int):Component

unlockLayout(recursive:Bool = false)

walkComponents(callback:Component->Bool) Walk all children recursively, callback should return "true" if walking should continue

Display tree related properties and methods

hidden:Bool clonable Whether this component is hidden or not

numComponents:Int read-only Gets the number of child components under this component instance

rootComponent:Component read-only The top level component of this component instance

addComponent(child:Component):Component override Adds a child component to this component instance

addComponentAt(child:Component, index:Int):Component override Adds a child component to this component instance

findAncestor(criteria:String = null, type:Class<T> = null, searchType:String = "id"):Null<T> Finds a specific parent in this components display tree and can optionally cast the result criteria - The criteria by which to search, the interpretation of this is defined using searchType (the default search type is id) type - The component class you wish to cast the result to (defaults to null) searchType - Allows you specify how to consider a parent a match (defaults to id), can be either: id - The first component that has the id specified in criteria will be considered a match css - The first component that contains a style name specified by criteria will be considered a match

findComponent(criteria:String = null, type:Class<T> = null, recursive:Bool = null, searchType:String = "id"):Null<T> Finds a specific child in this components display tree (recusively if desired) and can optionally cast the result criteria - The criteria by which to search, the interpretation of this is defined using searchType (the default search type is id) type - The component class you wish to cast the result to (defaults to null) recursive - Whether to search this components children and all its childrens children till it finds a match (the default depends on the searchType param. If searchType is id the default is true otherwise it is false) searchType - Allows you specify how to consider a child a match (defaults to id), can be either: id - The first component that has the id specified in criteria will be considered a match css - The first component that contains a style name specified by criteria will be considered a match

getComponentAt(index:Int):Component Gets a child component at a specified index

getComponentIndex(child:Component):Int Gets the index of a child component

hide() Hides this component and all its children

removeAllComponents(dispose:Bool = true) Removes all child components from this component instance

removeComponent(child:Component, dispose:Bool = true, invalidate:Bool = true):Component override Removes the specified child component from this component instance

removeComponentAt(index:Int, dispose:Bool = true, invalidate:Bool = true):Component override Removes the child component from this component instance

show() Shows this component and all its children

Event related properties and methods

onAnimationEnd:AnimationEvent->Void write-only

onAnimationStart:AnimationEvent->Void write-only

onChange:UIEvent->Void write-only

onClick:MouseEvent->Void write-only

onRightClick:MouseEvent->Void write-only

Layout related properties and methods

includeInLayout:Bool Whether to use this component as part of its part layout Note: invisible components are not included in parent layouts

layout:Layout The layout of this component

Script related properties and methods

namedComponents:Array<Component> read-only Recursively generates list of all child components that have specified an id

script:String write-only A script string to associate with this component Note: setting this to non-null will cause this component to create and maintain its own script interpreter during initialsation

scriptAccess:Bool Whether or not this component is allowed to be exposed to script interpreters (defaults to _true_)

addScriptEvent(event:String, script:String) Registers a piece of hscript to be execute when a certain UIEvent is fired

executeScriptCall(expr:String, variablesMap = null) Execute a script call Note: this component will first attempt to use its own script interpreter if its avialable otherwise it will scan its parents until it finds one

Style properties

Button

Component

fontSize:Null<Float> style

iconPosition:String style

textAlign:String style

backgroundColor:Null<Color> style

borderColor:Null<Color> style

borderRadius:Null<Float> style

borderSize:Null<Float> style

clip:Null<Bool> style

color:Null<Color> style

horizontalAlign:String style

marginBottom:Null<Float> style

marginLeft:Null<Float> style

marginRight:Null<Float> style

marginTop:Null<Float> style

opacity:Null<Float> style

paddingBottom:Null<Float> style

paddingLeft:Null<Float> style

paddingRight:Null<Float> style

paddingTop:Null<Float> style

verticalAlign:String style

Style related properties and methods

customStyle:Style A custom style object that will appled to this component after any css rules have been matched and applied

styleNames:String clonable A string representation of the css classes associated with this component

styleString:String clonable An inline css string that will be parsed and applied as a custom style

addClass(name:String, invalidate:Bool = true, recursive:Bool = false) Adds a css style name to this component

addClasses(names:Array<String>, invalidate:Bool = true, recursive:Bool = false) Adds a css style names to this component

hasClass(name:String):Bool Whether or not this component has a css class associated with it

removeClass(name:String, invalidate:Bool = true, recursive:Bool = false) Removes a css style name from this component

removeClasses(names:Array<String>, invalidate:Bool = true, recursive:Bool = false) Removes a css style names from this component

swapClass(classToAdd:String, classToRemove:String = null, invalidate:Bool = true, recursive:Bool = false) Adds a css style name to this component