final class UIExpander

package smidr.widgets

extends UIComponent

@:build(openfl.utils._internal.AssetsMacro.initBinding())@:autoBuild(openfl.utils._internal.AssetsMacro.initBinding())

A single collapsible section: a clickable header with a rotating chevron over a body you fill via content. Unlike UIAccordion (which only toggles an external body's visibility), the expander owns its body and its own height grows/shrinks with the state, so h reflects headerHeight plus contentHeight while open. onToggle(open) lets a host relayout.

Constructor

@:value({ expanded : true })new(title:String, width:Float, expanded:Bool = true, ?onToggle:Bool ‑> Void)

Parameters:

title

the header text

width

layout width

expanded

start open (default open)

onToggle

fired on open/close

Variables

read onlycontent:Sprite

The body container; add your widgets here.

@:value(0)contentHeight:Float = 0

Body height when open (set to your content's height).

@:value(true)expanded:Bool = true

Whether the section is open.

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

@:value(30)headerHeightBase:Float = 30

Base (unscaled) header height.

@:value(null)key:String = null

title:String

@:value(null)onToggle:Bool ‑> Void = null

Fired when the section opens (true) or closes (false).

Methods

localize(key:String, fallback:String):Void

Switches the header to a localized string.

Parameters:

key

the translation key

fallback

the source-language text

Inherited Variables

Defined by UIComponent

@:value(true)enabled:Bool = true

Disabled widgets ignore the pointer and typically render dimmed.

@:value(0)read onlyh:Float = 0

Layout height in UI units.

@:value(MouseCursor.BUTTON)hoverCursor:MouseCursor = MouseCursor.BUTTON

Native cursor while hovering (interactive widgets; null keeps the arrow).

@:value(false)read onlyhovered:Bool = false

true while the cursor is over this widget.

@:value(false)longPressable:Bool = false

Opts a subclass that overrides onRightPress (without setting onRightClick) into long-press-as-right-click on touch. Widgets with onRightClick set are included automatically.

@:value(null)onClick:() ‑> Void = null

Fired on a completed click (press + release on this widget). Requires an interactive widget.

@:value(null)onHover:() ‑> Void = null

Fired when the cursor first enters this widget (hover-driven descriptions/previews). Interactive widgets only.

@:value(null)onRightClick:() ‑> Void = null

Fired on a right mouse press over this widget (context menus). Only interactive widgets receive pointer events, so this never fires on passive widgets like UILabel/UIPanel — attach it to a UIButton (or another interactive widget) instead. On touch, a long-press fires the same path (see UIRoot.longPressMs).

@:value(false)read onlypressed:Bool = false

true while a press that started here is held.

@:value(null)tooltip:String = null

Optional tooltip text (already-localized or a fixed string).

@:value(null)tooltipShortcut:String = null

Optional right-aligned shortcut hint rendered in the tooltip.

@:value(0)read onlyw:Float = 0

Layout width in UI units (independent of DisplayObject's content-derived width).

Inherited Methods

Defined by UIComponent

dispose():Void

Tears the widget down: listeners, pointer references, children, parent link.

invalidate():Void

Schedules a repaint for the next frame (cheap; deduplicated).

resize(width:Float, height:Float):Void

Sets the layout size and repaints when it changed.

Parameters:

width

the new layout width in UI units

height

the new layout height in UI units