final class UIDockGroup

package smidr.widgets

extends UIComponent

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

A leaf of a UIDockHost: a tabbed group of UIDockPanels, one visible at a time. Clicking a tab activates its panel; dragging a tab hands off to the host to re-dock (split, tab into another group, or move). The host sizes and positions the group; do not use it standalone.

Constructor

new(host:UIDockHost)

Parameters:

host

the dock host that lays this group out

Variables

@:value(-1)read onlyactiveIndex:Int = -1

The visible panel index, or -1 when empty.

read onlycount:Int

Number of panels in the group.

@:value(26)tabBarHeight:Float = 26

Base (unscaled) tab-strip height.

Methods

@:value({ activate : true })addPanel(panel:UIDockPanel, activate:Bool = true):Void

Adds a panel to the group.

Parameters:

panel

the panel to host

activate

true makes it the visible tab

inlinepanelAt(index:Int):UIDockPanel

The panel at an index (no bounds check beyond the array).

removePanel(panel:UIDockPanel):Void

Removes a panel (does not dispose it — the host may re-dock it).

Parameters:

panel

the panel to remove

setActive(index:Int):Void

Makes a tab the visible panel.

Parameters:

index

the panel index

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

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