Packagecom.ghostwire.ui.controls
Classpublic class uiCheckBox
InheritanceuiCheckBox Inheritance uiLabelButton Inheritance uiButton Inheritance uiComponent Inheritance flash.display.Sprite
SubclassesuiRadioButton

The uiCheckBox component toggles its selected property when it is clicked. This control is used to give the user an option, such as true/false or yes/no. The component is typically rendered as an empty box when the selected property is false and a box with a check inside when the property is true. The uiCheckBox component can display, next to itself, an uiImage or uiText or both (the component contains a uiLabel instance which in turn contains the uiImage and/or uiText instances).

"group" Property
Note: if you set the group property to an existing uiButtonGroup object, the uiCheckBox will behave as a uiRadioButton.

"skin" Property
The default value is "CheckBox" and the asset(s) used are:

 CheckBox.png
 

"toggle" Property
Always true - attempting to set this property will throw an error.

~ This class is available in Aspire UI Components Lite Edition ~



Public Properties
 PropertyDefined by
 InheritedalignX : Number
Indicates how the component would like to be aligned horizontally within its allocated space.
uiComponent
 InheritedalignY : Number
Indicates how the component would like to be aligned vertically within its allocated space.
uiComponent
 Inheritedbackground : Object
Indicates the style of the background for this component.
uiComponent
 Inheritedcontainer : uiComponent
Indicates the uiComponent instance that contains this instance.
uiComponent
 Inheriteddata : Object
Indicates the data to be associated with this button.
uiButton
 Inheriteddepth : int
Indicates how deep the component is in the containment hierarchy.
uiComponent
 InheriteddesiredAllocationHeight : int
Indicates the vertical space this component would like to be allocated.
uiComponent
 InheriteddesiredAllocationWidth : int
Indicates the horizontal space this component would like to be allocated.
uiComponent
 InheriteddisplaceX : int
Indicates the amount of pixels to move any embedded child object horizontally to the right when the button is pressed down.
uiButton
 InheriteddisplaceY : int
Indicates the amount of pixels to move any embedded child object vertically downwards when the button is pressed down.
uiButton
 Inheritedenabled : Boolean
Indicates whether the component is enabled for user interaction.
uiComponent
 InheritedfillX : Boolean
Indicates whether or not the component should automatically expand or shrink to fill its allocated horizontal space.
uiComponent
 InheritedfillY : Boolean
Indicates whether or not the component should automatically expand or shrink to fill its allocated vertical space.
uiComponent
 InheritedfocusPadding : Object
Indicates the thickness of the interior space from the edge of the component to the focus rectangle.
uiComponent
 InheritedfocusRect : Object
Indicates the class to use when rendering the rectangle around the component to indicate that it is in focus.
uiComponent
 Inheritedgroup : uiButtonGroup
Indicates the uiButtonGroup this button is assigned to.
uiButton
 Inheritedheight : Number
Indicates the current height of the component.
uiComponent
 Inheritedimage : String
Indicates the source to the image displayed inside/beside the button.
uiLabelButton
  labelMargin : Object
Indicates the spacing that should be applied around the uiLabel instance.
uiCheckBox
  labelPosition : int
Indicates the position of the uiLabel instance (which contains the uiImage and/or uiText) vis-a-vis the checkbox.
uiCheckBox
 Inheritedmargin : Object
Indicates the thickness of the space surrounding the component.
uiComponent
 InheritedmaxHeight : int
Indicates the upper limit for height.
uiComponent
 InheritedmaxWidth : int
Indicates the upper limit for width.
uiComponent
 InheritedminHeight : int
Indicates the lower limit for height.
uiComponent
 InheritedminWidth : int
Indicates the lower limit for width.
uiComponent
 Inheritedpadding : Object
Indicates the thickness of the interior space from the edge of the component to the content area, which is where child components, if any, are contained.
uiComponent
 Inheritedselected : Boolean
Indicates whether the button is selected; applicable only if the toggle property is set to true.
uiButton
 Inheritedskin : String
Indicates the name of the skin to use for this component instance.
uiComponent
 Inheritedstretch : Boolean
Indicates whether surplus space available in the parent container should be allocated to this component.
uiComponent
 Inheritedtext : String
Indicates the text displayed inside/beside the button.
uiLabelButton
 InheritedtextPosition : int
Indicates the position of the uiText instance vis-a-vis the uiImage instance, if any.
uiLabelButton
 InheritedtextStyle : String
Indicates the style to use for uiText instances contained in this component.
uiComponent
 Inheritedtoggle : Boolean
Indicates whether the button should toggle its selected property value between true and false when it is clicked.
uiButton
 InheritedtoolTip : Object
Indicates the content (text) of the tooltip that should be shown when the mouse hovers over this control.
uiComponent
 Inheriteduilabel : uiLabel
Returns the embedded uiLabel instance - for advanced users only.
uiLabelButton
 Inheriteduiskin : uiBitmapImage
Returns the uiBitmapImage rendered as the skin - for advanced users only.
uiComponent
 Inheriteduitext : uiText
Returns the embedded uiText instance - for advanced users only.
uiLabelButton
 Inheritedvisible : Boolean
Indicates whether or not the component is visible within its container.
uiComponent
 Inheritedwidth : Number
Indicates the current width of the component.
uiComponent
Public Methods
 MethodDefined by
  
uiCheckBox(text:String = null, image:String = null, textPosition:int = 0, labelPosition:int = 0)
Constructor - creates a new uiCheckBox instance.
uiCheckBox
 Inherited
activate(noEvent:Boolean = false):void
Activates and gives focus to the button as if the button has been clicked on (a MouseEvent.CLICK event will be dispatched).
uiButton
 Inherited
invalidate(type:String):void
Invalidates this component's "size", "display", "layout" or "textstyle".
uiComponent
 Inherited
move(x:Number, y:Number, noEvent:Boolean = false):void
Moves the component to the specified position, disregarding its allocation.
uiComponent
 Inherited
removeAllChildren(all:Boolean = false):void
Removes all children from this component.
uiComponent
 Inherited
setFocus(flag:Boolean = true):void
Gives this component instance the focus; the component must be on the display list and has its tabEnabled property set to true, otherwise this method will fail silently.
uiComponent
 Inherited
setSize(width:Number, height:Number, noEvent:Boolean = false):void
Sets this component's size to the specified width and height.
uiComponent
 Inherited
setVisible(value:Boolean, noEvent:Boolean = false):void
Sets the visibility of this component instance, dispatching a "show" or "hide" event accordingly.
uiComponent
 Inherited
validateNow():void
Validates and render the component instance, and any component instances with depth higher than itself in the validation queue, immediately.
uiComponent
Events
 EventSummaryDefined by
 Inherited Dispatched when the selected property changes.uiButton
 Inherited Dispatched when the button is activated, either by user clicking on it or pressing the SPACE key while the button is in focus.uiButton
 Inherited Dispatched when the component's visible property is changed from true to false via calling the setVisible() method.uiComponent
 Inherited Dispatched when the component's position within its parent container has changed via calling the move() method.uiComponent
 Inherited Dispatched when the component's size has changed via calling the setSize() method.uiComponent
 Inherited Dispatched when the component's visible property is changed from false to true via calling the setVisible() method.uiComponent
Property detail
labelMarginproperty
labelMargin:Object  [read-write]

Indicates the spacing that should be applied around the uiLabel instance. You can use this property to specify the spacing between the check box and the label, for example:

  var mycheck:uiCheckBox = new uiCheckBox("Item A");
  mycheck.labelMargin = "0,0,0,4"; // 0px margin top, left, bottom; 4px margin left

Implementation
    public function get labelMargin():Object
    public function set labelMargin(value:Object):void
labelPositionproperty 
labelPosition:int  [read-write]

Indicates the position of the uiLabel instance (which contains the uiImage and/or uiText) vis-a-vis the checkbox. Qualified values are POSITION.LEFT, POSITION.RIGHT, POSITION.TOP or POSITION.BOTTOM. By default, the uiLabel will be positioned to the right of the checkbox.

Implementation
    public function get labelPosition():int
    public function set labelPosition(value:int):void

See also

Constructor detail
uiCheckBox()constructor
public function uiCheckBox(text:String = null, image:String = null, textPosition:int = 0, labelPosition:int = 0)

Constructor - creates a new uiCheckBox instance.

Parameters
text:String (default = null) — A String value specifying the text to display next to the checkbox.
 
image:String (default = null) — A String value indicating the source to the image/icon to be displayed next to the checkbox.
 
textPosition:int (default = 0) — A String value indicating the position of the uiText instance vis-a-vis the uiImage instance, if any. Qualified values are POSITION.LEFT, POSITION.RIGHT, POSITION.TOP or POSITION.BOTTOM. By default, the uiText is placed to the right of the uiImage.
 
labelPosition:int (default = 0) — A String value indicating the position of the label (text/icon) vis-a-vis the checkbox. Qualified values are POSITION.LEFT, POSITION.RIGHT, POSITION.TOP or POSITION.BOTTOM. By default, the label is positioned to the right of the checkbox.