scene2d/ktx.scene2d/KButtonTable

KButtonTable

class KButtonTable(minCheckCount: Int, maxCheckCount: Int, skin: Skin) : Table, KTable

Extends Table API with type-safe widget builders. All Button instances added to this table will be automatically included in an internal ButtonGroup.

Parameters

minCheckCount

minimum amount of checked buttons.

maxCheckCount

maximum amount of checked buttons.

See also

ButtonGroup

Constructors

Link copied to clipboard
constructor(minCheckCount: Int, maxCheckCount: Int, skin: Skin)

Properties

Link copied to clipboard
open val actions: Array<Action?>?
Link copied to clipboard
open val align: Int
Link copied to clipboard
@get:Null
open var background: Drawable?
Link copied to clipboard
val buttonGroup: ButtonGroup<Button>
Link copied to clipboard
open val captureListeners: DelayedRemovalArray<EventListener?>?
Link copied to clipboard
open val cells: Array<Cell<*>?>?
Link copied to clipboard
open val children: SnapshotArray<Actor?>?
Link copied to clipboard
open var clip: Boolean
Link copied to clipboard
open var color: Color?
Link copied to clipboard
open val columns: Int
Link copied to clipboard
@get:Null
open var cullingArea: Rectangle?
Link copied to clipboard
open var debug: Boolean
Link copied to clipboard
open var height: Float
Link copied to clipboard
open val <T : Actor> T.inCell: Cell<T>

Allows to access Cell in this actor is stored in the Table. Relies on the Actor.userObject mechanism.

Link copied to clipboard
open val isTouchable: Boolean
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open var isTransform: Boolean
Link copied to clipboard
open var isVisible: Boolean
Link copied to clipboard
open val listeners: DelayedRemovalArray<EventListener?>?
Link copied to clipboard
open val maxHeight: Float
Link copied to clipboard
open val maxWidth: Float
Link copied to clipboard
open val minHeight: Float
Link copied to clipboard
open val minWidth: Float
Link copied to clipboard
@get:Null
open var name: String?
Link copied to clipboard
open var originX: Float
Link copied to clipboard
open var originY: Float
Link copied to clipboard
open val padBottom: Float
Link copied to clipboard
open val padBottomValue: Value?
Link copied to clipboard
open val padLeft: Float
Link copied to clipboard
open val padLeftValue: Value?
Link copied to clipboard
open val padRight: Float
Link copied to clipboard
open val padRightValue: Value?
Link copied to clipboard
open val padTop: Float
Link copied to clipboard
open val padTopValue: Value?
Link copied to clipboard
open val padX: Float
Link copied to clipboard
open val padY: Float
Link copied to clipboard
@get:Null
open var parent: Group?
Link copied to clipboard
open val prefHeight: Float
Link copied to clipboard
open val prefWidth: Float
Link copied to clipboard
open val right: Float
Link copied to clipboard
open var rotation: Float
Link copied to clipboard
open val rows: Int
Link copied to clipboard
open var scaleX: Float
Link copied to clipboard
open var scaleY: Float
Link copied to clipboard
@get:Null
open var skin: Skin?
Link copied to clipboard
@get:Null
open var stage: Stage?
Link copied to clipboard
open val tableDebug: Table.Debug?
Link copied to clipboard
open val top: Float
Link copied to clipboard
open var touchable: Touchable?
Link copied to clipboard
@get:Null
open var userObject: Any?
Link copied to clipboard
open var width: Float
Link copied to clipboard
open var x: Float
Link copied to clipboard
open var y: Float
Link copied to clipboard
open var zIndex: Int

Functions

Link copied to clipboard
open fun act(delta: Float)
Link copied to clipboard
inline fun <S, A : Actor> KWidget<S>.actor(actor: A, init: A.(S) -> Unit = {}): A

Utility function for adding existing actors to the group with a type-safe builder init block. Mostly for internal use.

Link copied to clipboard
open fun add(): Cell<*>?
open fun add(@Null text: CharSequence?): Cell<Label?>?
open fun add(vararg actors: Actor?): Table?
open fun add(@Null text: CharSequence?, labelStyleName: String?): Cell<Label?>?
open fun add(@Null text: CharSequence?, fontName: String?, @Null color: Color?): Cell<Label?>?
open fun add(@Null text: CharSequence?, fontName: String?, colorName: String?): Cell<Label?>?

open override fun <T : Actor> add(actor: T): Cell<T>

Matches Table.add API.

Link copied to clipboard
open fun addAction(action: Action?)
Link copied to clipboard
open fun addActor(actor: Actor?)
Link copied to clipboard
open fun addActorAfter(actorAfter: Actor?, actor: Actor?)
Link copied to clipboard
open fun addActorAt(index: Int, actor: Actor?)
Link copied to clipboard
open fun addActorBefore(actorBefore: Actor?, actor: Actor?)
Link copied to clipboard
open fun addCaptureListener(listener: EventListener?): Boolean
Link copied to clipboard
open fun addListener(listener: EventListener?): Boolean
Link copied to clipboard
open fun align(align: Int): Table?
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open fun background(@Null background: Drawable?): Table?
open fun background(drawableName: String?): Table?
Link copied to clipboard
open fun bottom(): Table?
Link copied to clipboard
inline fun <S> KWidget<S>.button(style: String = defaultStyle, skin: Skin = Scene2DSkin.defaultSkin, init: KButton.(S) -> Unit = {}): KButton
Link copied to clipboard
inline fun <S> KWidget<S>.buttonGroup(minCheckedCount: Int, maxCheckedCount: Int, skin: Skin = Scene2DSkin.defaultSkin, init: KButtonTable.(S) -> Unit = {}): KButtonTable
Link copied to clipboard
open fun <T : Actor> T.cell(grow: Boolean = false, growX: Boolean = false, growY: Boolean = false, expand: Boolean? = null, expandX: Boolean? = null, expandY: Boolean? = null, fill: Boolean? = null, fillX: Boolean? = null, fillY: Boolean? = null, uniform: Boolean? = null, uniformX: Boolean? = null, uniformY: Boolean? = null, align: Int? = null, colspan: Int? = null, width: Float? = null, minWidth: Float? = null, preferredWidth: Float? = null, maxWidth: Float? = null, height: Float? = null, minHeight: Float? = null, preferredHeight: Float? = null, maxHeight: Float? = null, pad: Float? = null, padTop: Float? = null, padLeft: Float? = null, padRight: Float? = null, padBottom: Float? = null, space: Float? = null, spaceTop: Float? = null, spaceLeft: Float? = null, spaceRight: Float? = null, spaceBottom: Float? = null, row: Boolean = false): T

Allows to customize properties of the Cell storing this actor.

Link copied to clipboard
open fun center(): Table?
Link copied to clipboard
inline fun <S> KWidget<S>.checkBox(text: String, style: String = defaultStyle, skin: Skin = Scene2DSkin.defaultSkin, init: KCheckBox.(S) -> Unit = {}): KCheckBox
Link copied to clipboard
open fun clear()
open fun clear(unfocus: Boolean)
Link copied to clipboard
open fun clearActions()
Link copied to clipboard
open fun clearChildren()
open fun clearChildren(unfocus: Boolean)
Link copied to clipboard
open fun clearListeners()
Link copied to clipboard
open fun clip(): Table?
open fun clip(enabled: Boolean): Table?
Link copied to clipboard
open fun clipBegin(): Boolean
open fun clipBegin(x: Float, y: Float, width: Float, height: Float): Boolean
Link copied to clipboard
open fun clipEnd()
Link copied to clipboard
open fun columnDefaults(column: Int): Cell<*>?
Link copied to clipboard
inline fun <S> KWidget<S>.container(init: KContainer<Actor>.(S) -> Unit = {}): KContainer<Actor>

inline fun <S, A : Actor> KWidget<S>.container(actor: A, init: KContainer<A>.(S) -> Unit = {}): KContainer<A>

Use this container method variant for customly built actors that you want to keep in a Container.

Link copied to clipboard
open fun debug(): Table?
open fun debug(debug: Table.Debug?): Table?
Link copied to clipboard
open fun debugActor(): Table?
Link copied to clipboard
open fun debugAll(): Table?
Link copied to clipboard
open fun debugCell(): Table?
Link copied to clipboard
open fun debugTable(): Table?
Link copied to clipboard
open fun defaults(): Cell<*>?
Link copied to clipboard
open fun draw(batch: Batch?, parentAlpha: Float)
Link copied to clipboard
open fun drawDebug(shapes: ShapeRenderer?)
Link copied to clipboard
@Null
open fun <T : Actor?> findActor(name: String?): T?
Link copied to clipboard
open fun fire(event: Event?): Boolean
Link copied to clipboard
@Null
open fun <T : Actor?> firstAscendant(type: Class<T?>?): T?
Link copied to clipboard
@Null
open fun <T : Actor?> getCell(actor: T?): Cell<T?>?
Link copied to clipboard
open fun getChild(index: Int): Actor?
Link copied to clipboard
open fun getColumnMinWidth(columnIndex: Int): Float
Link copied to clipboard
open fun getColumnPrefWidth(columnIndex: Int): Float
Link copied to clipboard
open fun getColumnWidth(columnIndex: Int): Float
Link copied to clipboard
open fun getRow(y: Float): Int
Link copied to clipboard
open fun getRowHeight(rowIndex: Int): Float
Link copied to clipboard
open fun getRowMinHeight(rowIndex: Int): Float
Link copied to clipboard
open fun getRowPrefHeight(rowIndex: Int): Float
Link copied to clipboard
open fun hasActions(): Boolean
Link copied to clipboard
open fun hasChildren(): Boolean
Link copied to clipboard
Link copied to clipboard
open fun hasParent(): Boolean
Link copied to clipboard
open fun hasScrollFocus(): Boolean
Link copied to clipboard
@Null
open fun hit(x: Float, y: Float, touchable: Boolean): Actor?
Link copied to clipboard
inline fun <S> KWidget<S>.horizontalGroup(init: KHorizontalGroup.(S) -> Unit = {}): KHorizontalGroup
Link copied to clipboard
inline fun <S> KWidget<S>.image(texture: Texture, init: Image.(S) -> Unit = {}): Image
inline fun <S> KWidget<S>.image(ninePatch: NinePatch, init: Image.(S) -> Unit = {}): Image
inline fun <S> KWidget<S>.image(textureRegion: TextureRegion, init: Image.(S) -> Unit = {}): Image
inline fun <S> KWidget<S>.image(drawable: Drawable? = null, init: Image.(S) -> Unit = {}): Image
inline fun <S> KWidget<S>.image(drawableName: String, skin: Skin = Scene2DSkin.defaultSkin, init: Image.(S) -> Unit = {}): Image
Link copied to clipboard
inline fun <S> KWidget<S>.imageButton(style: String = defaultStyle, skin: Skin = Scene2DSkin.defaultSkin, init: KImageButton.(S) -> Unit = {}): KImageButton
Link copied to clipboard
inline fun <S> KWidget<S>.imageTextButton(text: String, style: String = defaultStyle, skin: Skin = Scene2DSkin.defaultSkin, init: KImageTextButton.(S) -> Unit = {}): KImageTextButton
Link copied to clipboard
open fun invalidate()
Link copied to clipboard
open fun invalidateHierarchy()
Link copied to clipboard
open fun isAscendantOf(actor: Actor?): Boolean
Link copied to clipboard
open fun isDescendantOf(actor: Actor?): Boolean
Link copied to clipboard
inline fun <S> KWidget<S>.label(text: CharSequence, style: String = defaultStyle, skin: Skin = Scene2DSkin.defaultSkin, init: Label.(S) -> Unit = {}): Label
Link copied to clipboard
open fun layout()
Link copied to clipboard
open fun left(): Table?
Link copied to clipboard
inline fun <I> KWidget<*>.listWidget(style: String = defaultStyle, skin: Skin = Scene2DSkin.defaultSkin, init: KListWidget<I>.() -> Unit = {}): KListWidget<I>
Link copied to clipboard
fun <I> KWidget<*>.listWidgetOf(items: Array<I>? = null, style: String = defaultStyle, skin: Skin = Scene2DSkin.defaultSkin): KListWidget<I>
Link copied to clipboard
open fun localToActorCoordinates(actor: Actor?, localCoords: Vector2?): Vector2?
Link copied to clipboard
open fun localToAscendantCoordinates(@Null ascendant: Actor?, localCoords: Vector2?): Vector2?
Link copied to clipboard
open fun localToDescendantCoordinates(descendant: Actor?, localCoords: Vector2?): Vector2?
Link copied to clipboard
open fun localToParentCoordinates(localCoords: Vector2?): Vector2?
Link copied to clipboard
open fun localToScreenCoordinates(localCoords: Vector2?): Vector2?
Link copied to clipboard
open fun localToStageCoordinates(localCoords: Vector2?): Vector2?
Link copied to clipboard
open fun moveBy(x: Float, y: Float)
Link copied to clipboard
open fun needsLayout(): Boolean
Link copied to clipboard
open fun notify(event: Event?, capture: Boolean): Boolean
Link copied to clipboard
open fun pack()
Link copied to clipboard
open fun pad(pad: Value?): Table?
open fun pad(pad: Float): Table?
open fun pad(top: Value?, left: Value?, bottom: Value?, right: Value?): Table?
open fun pad(top: Float, left: Float, bottom: Float, right: Float): Table?
Link copied to clipboard
open fun padBottom(padBottom: Value?): Table?
open fun padBottom(padBottom: Float): Table?
Link copied to clipboard
open fun padLeft(padLeft: Value?): Table?
open fun padLeft(padLeft: Float): Table?
Link copied to clipboard
open fun padRight(padRight: Value?): Table?
open fun padRight(padRight: Float): Table?
Link copied to clipboard
open fun padTop(padTop: Value?): Table?
open fun padTop(padTop: Float): Table?
Link copied to clipboard
open fun parentToLocalCoordinates(parentCoords: Vector2?): Vector2?
Link copied to clipboard
inline fun <S> KWidget<S>.particleEffect(particleEffect: ParticleEffect, resetOnStart: Boolean = true, init: ParticleEffectActor.(S) -> Unit = {}): ParticleEffectActor
Link copied to clipboard
inline fun <S> KWidget<S>.progressBar(min: Float = 0.0f, max: Float = 1.0f, step: Float = 0.01f, vertical: Boolean = false, style: String = if (vertical) defaultVerticalStyle else defaultHorizontalStyle, skin: Skin = Scene2DSkin.defaultSkin, init: ProgressBar.(S) -> Unit = {}): ProgressBar
Link copied to clipboard
open fun remove(): Boolean
Link copied to clipboard
open fun removeAction(@Null action: Action?)
Link copied to clipboard
open fun removeActor(actor: Actor?): Boolean
open fun removeActor(actor: Actor?, unfocus: Boolean): Boolean
Link copied to clipboard
open fun removeActorAt(index: Int, unfocus: Boolean): Actor?
Link copied to clipboard
open fun removeCaptureListener(listener: EventListener?): Boolean
Link copied to clipboard
open fun removeListener(listener: EventListener?): Boolean
Link copied to clipboard
open fun reset()
Link copied to clipboard
open fun right(): Table?
Link copied to clipboard
open fun rotateBy(amountInDegrees: Float)
Link copied to clipboard
open fun row(): Cell<*>?
Link copied to clipboard
open fun scaleBy(scale: Float)
open fun scaleBy(scaleX: Float, scaleY: Float)
Link copied to clipboard
open fun screenToLocalCoordinates(screenCoords: Vector2?): Vector2?
Link copied to clipboard
inline fun <S> KWidget<S>.scrollPane(style: String = defaultStyle, skin: Skin = Scene2DSkin.defaultSkin, init: KScrollPane.(S) -> Unit = {}): KScrollPane
Link copied to clipboard
inline fun <I> KWidget<*>.selectBox(style: String = defaultStyle, skin: Skin = Scene2DSkin.defaultSkin, init: KSelectBox<I>.() -> Unit = {}): KSelectBox<I>
Link copied to clipboard
fun <I> KWidget<*>.selectBoxOf(items: Array<I>? = null, style: String = defaultStyle, skin: Skin = Scene2DSkin.defaultSkin): KSelectBox<I>
Link copied to clipboard
open fun setBounds(x: Float, y: Float, width: Float, height: Float)
Link copied to clipboard
open fun setDebug(enabled: Boolean, recursively: Boolean)
Link copied to clipboard
open fun setFillParent(fillParent: Boolean)
Link copied to clipboard
open fun setLayoutEnabled(enabled: Boolean)
Link copied to clipboard
open fun setOrigin(alignment: Int)
open fun setOrigin(originX: Float, originY: Float)
Link copied to clipboard
open fun setPosition(x: Float, y: Float)
open fun setPosition(x: Float, y: Float, alignment: Int)
Link copied to clipboard
open fun setRound(round: Boolean)
Link copied to clipboard
open fun setScale(scaleXY: Float)
open fun setScale(scaleX: Float, scaleY: Float)
Link copied to clipboard
open fun setSize(width: Float, height: Float)
Link copied to clipboard
open fun sizeBy(size: Float)
open fun sizeBy(width: Float, height: Float)
Link copied to clipboard
inline fun <S> KWidget<S>.slider(min: Float = 0.0f, max: Float = 1.0f, step: Float = 0.01f, vertical: Boolean = false, style: String = if (vertical) defaultVerticalStyle else defaultHorizontalStyle, skin: Skin = Scene2DSkin.defaultSkin, init: Slider.(S) -> Unit = {}): Slider
Link copied to clipboard
inline fun <S> KWidget<S>.splitPane(vertical: Boolean = false, style: String = if (vertical) defaultVerticalStyle else defaultHorizontalStyle, skin: Skin = Scene2DSkin.defaultSkin, init: KSplitPane.(S) -> Unit = {}): KSplitPane
Link copied to clipboard
open fun stack(@Null vararg actors: Actor?): Cell<Stack?>?
Link copied to clipboard
inline fun <S> KWidget<S>.stack(init: KStack.(S) -> Unit = {}): KStack
Link copied to clipboard
open fun stageToLocalCoordinates(stageCoords: Vector2?): Vector2?
Link copied to clipboard
open override fun <T : Actor> storeActor(actor: T): Cell<T>

Internal utility method for adding actors to the group. Assumes the actor might be stored in a container.

Link copied to clipboard
open fun swapActor(first: Actor?, second: Actor?): Boolean
open fun swapActor(first: Int, second: Int): Boolean
Link copied to clipboard
inline fun <S> KWidget<S>.table(skin: Skin = Scene2DSkin.defaultSkin, init: KTableWidget.(S) -> Unit = {}): KTableWidget
Link copied to clipboard
inline fun <S> KWidget<S>.textArea(text: String = "", style: String = defaultStyle, skin: Skin = Scene2DSkin.defaultSkin, init: TextArea.(S) -> Unit = {}): TextArea
Link copied to clipboard
inline fun <S> KWidget<S>.textButton(text: String, style: String = defaultStyle, skin: Skin = Scene2DSkin.defaultSkin, init: KTextButton.(S) -> Unit = {}): KTextButton
Link copied to clipboard
inline fun <S> KWidget<S>.textField(text: String = "", style: String = defaultStyle, skin: Skin = Scene2DSkin.defaultSkin, init: TextField.(S) -> Unit = {}): TextField
Link copied to clipboard
inline fun Actor.textTooltip(text: String, style: String = defaultStyle, skin: Skin = Scene2DSkin.defaultSkin, tooltipManager: TooltipManager = TooltipManager.getInstance(), init: Label.(TextTooltip) -> Unit = {}): TextTooltip

Adds a new TextTooltip to this actor.

Link copied to clipboard
open fun toBack()
Link copied to clipboard
open fun toFront()
Link copied to clipboard
inline fun Actor.tooltip(background: String? = null, skin: Skin = Scene2DSkin.defaultSkin, tooltipManager: TooltipManager = TooltipManager.getInstance(), init: KTableWidget.(Tooltip<KTableWidget>) -> Unit = {}): Tooltip<KTableWidget>

Adds a new Tooltip to this actor, storing a flexible Table widget.

Link copied to clipboard
open fun top(): Table?
Link copied to clipboard
inline fun <S> KWidget<S>.touchpad(deadzone: Float, style: String = defaultStyle, skin: Skin = Scene2DSkin.defaultSkin, init: Touchpad.(S) -> Unit = {}): Touchpad
Link copied to clipboard
inline fun <S> KWidget<S>.tree(style: String = defaultStyle, skin: Skin = Scene2DSkin.defaultSkin, init: KTreeWidget.(S) -> Unit = {}): KTreeWidget
Link copied to clipboard
open fun validate()
Link copied to clipboard
inline fun <S> KWidget<S>.verticalGroup(init: KVerticalGroup.(S) -> Unit = {}): KVerticalGroup
Generated by Dokka
© 2026 Copyright