View source

class Button

package koui.elements

extends Element

@:build(koui.theme.ThemeUtil.buildSubElement())@:autoBuild(koui.theme.ThemeUtil.buildSubElement())

A button is an element that performs an action when clicked. It has a text label that is describing the function of the button.

Button screenshot

// Construct a new Button with the label "Quit"
var myButton = new Button("Quit");

myButton.addEventListener(MouseClickEvent, (event: MouseClickEvent) -> {
    // If the left mouse button is released over the button, quit the application
    if (event.mouseButton == Left && event.getState() == ClickEnd) {
        kha.System.stop();
    }
});

Constructor

new(text:String)

Create a new Button element.

Variables

privatecElemIcon:ImagePanel

privatecElemLabel:Label

icon:Null<Image>

The icon of this button, can be null.

private@:value(false)isClicked:Bool = false

private@:value(false)isHovered:Bool = false

@:value("")text:String = ""

The label of this button.

Methods

private_onClick(event:MouseClickEvent):Void

private_onHover(event:MouseHoverEvent):Void

privateset_icon(img:Null<Image>):Null<Image>

privateset_text(value:String):String

Inherited Variables

Defined by Element

@:value(Anchor.FollowLayout)anchor:Anchor = Anchor.FollowLayout

The anchor of this element. Used for the layout.

See also:

private@:value(true)autoRenderChildren:Bool = true

Whether the children of the element are automatically drawn after the element, or whether element must render its children by its own. The latter can be useful if the children need to be drawn in a specified order.

private@:value([])children:Array<Element> = []

The children of this element.

private@:value("")read onlyctxElement:String = ""

Current context element

@:value(false)disabled:Bool = false

true if the element is disabled and should not react to events. Also, elements might look different if disabled depending on the theme.

privateread onlydrawHeight:Int

The height of this element, used for drawing and event handling.

privateread onlydrawWidth:Int

The width of this element, used for drawing and event handling.

privateread onlydrawX:Int

The x position of this element, used for drawing and event handling.

privateread onlydrawY:Int

The y position of this element, used for drawing and event handling.

private@:value(new Map())eventListeners:Map<String, Array<EventListener<Event>>> = new Map()

@:value(0)height:Int = 0

The height of this element.

@:value(null)layout:Null<Layout> = null

The layout this element belongs to.

privatelayoutHeight:Int

The height of this element, used for the layout.

privatelayoutWidth:Int

The width of this element, used for the layout.

privatelayoutX:Int

The x position of this element, used for the layout.

privatelayoutY:Int

The y position of this element, used for the layout.

@:value(null)read onlyparent:Null<Element> = null

The parent element of this element.

@:value(0)posX:Int = 0

The x position of this element.

@:value(0)posY:Int = 0

The y position of this element.

private@:value("default")read onlystate:String = "default"

Current context state

private@:value(["" => ["default", "disabled"]])read onlystates:Map<String, Array<String>> = ["" => ["default", "disabled"]]

States for each context element: ctxElement => states

privateread onlystyle:Style

Style of the current context

private@:value(false)styleInitialized:Bool = false

Whether this element already initialized its style.

privateread onlystylesCache:Map<String, Style>

ctxElement!state => style

private@:value("_root")tID:String = "_root"

The theme ID of this object. Use this to select which theme settings to apply.

@:value(true)visible:Bool = true

If false, the element is not visible and will not react to any events.

@:value(0)width:Int = 0

The width of this element.

Inherited Methods

Defined by Element

inlineaddChild(child:Element):Void

finaladdEventListener<T>(eventClass:Class<T>, callback:T ‑> Void):Void

Register a callback to be called if the given event occurs on this element.

Example:

var button = new Button("Hello!");
button.addEventListener(MouseClickEvent, (event: MouseClickEvent) -> {
	if (event.mouseButton == Left && event.getState() == ClickStart) {
		trace("Clicked!");
	}
});

Parameters:

eventClass

The class of the event, must be a subclass of koui.events.Event

callback

The callback function to call if the event occurs

private@:value({ ctxElement : "" })cacheStates(states:Array<String>, ctxElement:String = ""):Void

privatedrawOverlay(g:KGraphics):Void

privateinlinegetAnchorResolved():Anchor

getChild<T>(matchBehaviour:ElementMatchBehaviour):Null<T>

privateinlinegetContextState():String

getElementAtPosition(x:Int, y:Int):Null<Element>

getLayoutOffset():Vector<Int>

Return the offset of the element's position to the screen.

inlinegetTID():String

privateinlineinvalidateElem():Void

Notify the parent layout on the next frame that this element has changed its size or position. Use the next frame to make sure we don't waste calculations when more than one value changes during one frame.

inlineisAtPosition(x:Int, y:Int):Bool

Return true if this element overlaps with the given position. Used internally for event handling most of the time. Elements may override this method to provide more detailed mouse interaction. If the element is invisible, false is returned.

finalinlinelistensTo<T>(eventClass:Class<T>):Bool

Returns whether this element has a registered event listener for the given event type.

finalinlinelistensToUID<T>(eventTypeUID:String):Bool

Returns whether this element has a registered event listener for the given event type.

privateloadStyle():Void

Sets the style variable to point to the current context.

inlineremoveChild(child:Element):Void

privateinlinerenderChildren(g:KGraphics, element:Element):Void

finalinlinerenderElement(g:KGraphics, element:Element):Void

Setup the given element for drawing and call its draw method afterwards.

privateinlinerequireContextElement(ctxElement:String):Void

private@:value({ ctxElement : "" })inlinerequireStates(states:Array<String>, ctxElement:String = ""):Void

privateinlineresetContext():Void

privateinlineresetContextState():Void

private@:value({ recursive : true, ctxElement : "" })inlinesetContext(state:String, ctxElement:String = "", recursive:Bool = true):Void

Set the current style context used for drawing. Calling this function is equivalent to calling setContextState and setContextElement. If the given element name is "", the element's tID is used.

Parameters:

state
ctxElement

See also:

  • setContextElement

  • setContextState

  • resetContext

private@:value({ ctxElement : "" })inlinesetContextElement(ctxElement:String = ""):Void

Set the drawing context element but keep the current state. If the given element name is "", the element's tID is used.

See also:

  • setContextState

  • setContext

  • resetContext

private@:value({ recursive : true })inlinesetContextState(state:String, recursive:Bool = true):Void

Set the drawing context state but keep the current element.

See also:

  • setContextElement

  • setContext

  • resetContext

inlinesetPosition(posX:Int, posY:Int):Void

Set the position of this element. You can also change the position per axis, see posX and posY.

inlinesetSize(width:Int, height:Int):Void

Set the size of this element. You can also change the size for each individual side, see width and height.

setTID(tID:String):Void

Set the theme ID of this element.

privateset_height(value:Int):Int

privateinlineset_layout(value:Null<Layout>):Layout

privateset_layoutHeight(value:Int):Int

privateset_layoutWidth(value:Int):Int

privateset_layoutX(value:Int):Int

privateset_layoutY(value:Int):Int

privateset_posX(value:Int):Int

privateset_posY(value:Int):Int

privateset_tID(value:String):String

tID setter. Caches all styles required by this element.

privateset_width(value:Int):Int