PuxiJS

Class: CheckBox

CheckBox

A checkbox is a button can be selected (checked). It has a on/off state that can be controlled by the user.

When used in a checkbox group, the group will control whether the checkbox can be selected or not.

new CheckBox (options)

puxi.mjs:2074
Name Type Description
options PUXI.ICheckBoxOptions
Name Type Default Description
checked bool false optional

is checked
background PIXI.UI.SliceSprite | PIXI.UI.Sprite

will be used as background for CheckBox
checkmark PIXI.UI.SliceSprite | PIXI.UI.Sprite

will be used as checkmark for CheckBox
checkGroup PUXI.CheckGroup null optional

CheckGroup name
value String

mostly used along with checkgroup
tabIndex Number 0 optional

input tab index
tabGroup Number | String 0 optional

input tab group

Extends

Members

alpha number inherited overrides

Alpha of this widget & its contents.

contentContainer PIXI.Container readonly inherited overrides

This container holds the content of this widget. Subclasses should add renderable display-objects to this container.

contentHeight number readonly inherited overrides

Layout height of this widget's content, which is the height minus vertical padding.

contentWidth number readonly inherited overrides

Layout width of this widget's content, which is the width minus horizontal padding.

height number readonly inherited overrides

Layout height of this widget.

insetContainer PIXI.Container readonly inherited overrides

This container owns the background + content of this widget.

interactive boolean inherited overrides

Whether this widget is interactive in the PixiJS scene graph.

isFocused boolean readonly inherited overrides

Whether this widget is in focus.

layoutMeasure PUXI.Insets readonly inherited overrides

Layout insets of this widget. In normal state, the widget should be in this rectangle inside the parent reference frame.

measuredHeight number inherited overrides

The measured height that is used by the parent's layout manager to place this widget.

measuredWidth number inherited overrides

The measured width that is used by the parent's layout manager to place this widget.

paddingBottom number inherited overrides

Padding on bottom side.

paddingHorizontal number readonly inherited overrides

Sum of left & right padding.

paddingLeft number inherited overrides

Padding on left side.

paddingRight number inherited overrides

Padding on right side.

paddingTop number inherited overrides

Padding on top side.

paddingVertical number readonly inherited overrides

Sum of top & bottom padding.

stage PUXI.Stage readonly inherited overrides

Stage whose scene graph holds this widget. Once set, this cannot be changed.

tabGroup PUXI.TabGroup readonly inherited overrides

The name of the tab group in which this widget's focus will move on pressing tab.

tabIndex number readonly inherited overrides

widgetChildren Array.<PUXI.Widget> readonly inherited overrides

Children of this widget. Use WidgetGroup to position children.

width number readonly inherited overrides

Layout width of this widget.

Methods

addChild (widgets)Widget inherited overrides

puxi.mjs:1058

Adds the widgets as children of this one.

Name Type Description
widgets Array.<PUXI.Widget> repeatable
Returns:
Type Description
Widget
  • this widget

blur () inherited overrides

puxi.mjs:1872

Brings this widget out of focus.

clearDraggable () inherited overrides

puxi.mjs:1101

Makes this widget not draggable.

clearDroppable () inherited overrides

puxi.mjs:1183

Makes this widget not droppable.

focus () inherited overrides

puxi.mjs:1859

Brings this widget into focus.

getBackground ()PIXI.Container inherited overrides

puxi.mjs:963
Returns:
Type Description
PIXI.Container
  • the background display-object

getBackgroundAlpha ()number inherited overrides

puxi.mjs:997
Returns:
Type Description
number the alpha on the background display-object.

getElevation ()number inherited overrides

puxi.mjs:1017
Returns:
Type Description
number the elevation set on this widget

getMeasuredHeight ()number inherited overrides

puxi.mjs:710

Alias for Widget.measuredHeight.

Returns:
Type Description
number the measured height

getMeasuredWidth ()number inherited overrides

puxi.mjs:702

Alias for Widget.measuredWidth.

Returns:
Type Description
number the measured width

initialize () protected inherited overrides

puxi.mjs:1119

Widget initialization related to the stage. This method should always call super.initialize().

This method expects stage to be set before calling it. This is handled by the Stage itself.

This will set initialized to true. If it was already set to true, it should do nothing.

makeDraggable () inherited overrides

puxi.mjs:1091

Makes this widget draggable.

makeDroppable () inherited overrides

puxi.mjs:1173

Makes this widget droppable.

measure (width, height, widthMode, heightMode) inherited overrides

puxi.mjs:758

This method calls Widget.onMeasure and should not be overriden. It does internal bookkeeping.

Name Type Description
width number
height number
widthMode PUXI.MeasureMode
heightMode PUXI.MeasureMode

onLayout (l, t, r, b, dirty) protected inherited overrides

puxi.mjs:772

This method should set the frame in which rendering will occur and lay out child widgets in that frame.

Name Type Default Description
l
t
r
b
dirty true

onMeasure (width, height, widthMode, heightMode) inherited overrides

puxi.mjs:723

Override this method to measure the dimensions for your widget. By default, it will use the natural width/height of this widget's content (contentContainer) plus any padding.

Name Type Description
width number

width of region provided by parent
height number

height of region provided by parent
widthMode PUXI.MeasureMode

mode in which provided width is to be used
heightMode PUXI.MeasureMode

mode in which provided height is to be used

removeChild (widgets)Widget inherited overrides

puxi.mjs:1076

Orphans the widgets that are children of this one.

Name Type Description
widgets Array.<PUXI.Widget> repeatable
Returns:
Type Description
Widget
  • this widget

requestLayout () inherited overrides

puxi.mjs:1049

Will trigger a full layout pass next animation frame.

setBackground (bg) inherited overrides

puxi.mjs:973

The background of a widget is a PIXI.DisplayObject that is rendered before all of its children.

Name Type Description
bg PIXI.Container | number | string

the background display-object or a color that will be used to generate a PIXI.Graphics as the background.

setBackgroundAlpha (val) inherited overrides

puxi.mjs:1007

This can be used to set the alpha on the background of this widget. This does not affect the widget's contents nor individual components of the background display-object.

Name Type Description
val number

background alpha

setElevation (val) inherited overrides

puxi.mjs:1026

This can be used add a drop-shadow that will appear to raise this widget by the given elevation against its parent.

Name Type Description
val number

elevation to use. 2px is good for most widgets.

setLayoutOptions (lopt)Widget inherited overrides

puxi.mjs:805

Use this to specify how you want to layout this widget w.r.t its parent. The specific layout options class depends on which layout you are using in the parent widget.

Name Type Description
lopt PUXI.LayoutOptions
Returns:
Type Description
Widget this

setPadding (l, t, r, b) inherited overrides

puxi.mjs:952

Sets the padding values.

To set all paddings to one value:

widget.setPadding(8);

To set horizontal & vertical padding separately:

widget.setPadding(4, 12);
Name Type Default Description
l number 0 optional

left padding
t number l optional

top padding (default is equal to left padding)
r number l optional

right padding (default is equal to right padding)
b number t optional

bottom padding (default is equal to top padding)