| Adobe® Flex® 4 Beta Language Reference | All Packages | All Classes | Language Elements | Index | Appendixes | Conventions | Show Frames Hide Frames |  | |
| CheckBox | Properties | Methods | Events | Styles | Effects | Constants | Examples | ||
| Package | mx.controls |
| Class | public class CheckBox |
| Inheritance | CheckBox  Button UIComponent FlexSprite Sprite DisplayObjectContainer InteractiveObject DisplayObject EventDispatcher Object |
| Implements | IToggleButton |
| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
 | Starting with Flex 4.0, Adobe recommends that you use the spark.components.CheckBox class as an alternative to this class. |
The CheckBox control has the following default characteristics:
| Characteristic | Description |
|---|---|
| Default size | A size large enough to hold the label |
| Minimum size | 0 pixels |
| Maximum size | No limit |
Hide MXML SyntaxThe <mx:CheckBox> tag inherits all of the tag
attributes of its superclass and adds the following tag attributes:
Show MXML Syntax
<mx:CheckBox
Styles
disabledIconColor="0x999999"
iconColor="0x2B333C"
/>
| Method | Defined By | ||
|---|---|---|---|
CheckBox()
Constructor. | CheckBox | ||
 |
Adds a child DisplayObject instance to this DisplayObjectContainer instance. | DisplayObjectContainer | |
|
Adds a child DisplayObject instance to this DisplayObjectContainer
instance. | DisplayObjectContainer | |
| addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener
receives notification of an event. | EventDispatcher | |
|
Indicates whether the security restrictions
would cause any display objects to be omitted from the list returned by calling
the DisplayObjectContainer.getObjectsUnderPoint() method
with the specified point point. | DisplayObjectContainer | |
|
Queues a function to be called later. | UIComponent | |
|
Deletes a style property from this component instance. | UIComponent | |
|
Determines whether the specified display object is a child of the DisplayObjectContainer instance or
the instance itself. | DisplayObjectContainer | |
|
Converts a Point object from content coordinates to global coordinates. | UIComponent | |
|
Converts a Point object from content to local coordinates. | UIComponent | |
|
Returns a set of properties that identify the child within
this container. | UIComponent | |
|
Returns a set of properties as automation ID that identify the child within
this container. | UIComponent | |
|
Creates an id reference to this IUIComponent object
on its parent document object. | UIComponent | |
|
Deletes the id reference to this IUIComponent object
on its parent document object. | UIComponent | |
|
Returns a UITextFormat object corresponding to the text styles
for this UIComponent. | UIComponent | |
| [override]
Dispatches an event into the event flow. | UIComponent | |
|
Shows or hides the focus indicator around this component. | UIComponent | |
| drawRoundRect(x:Number, y:Number, w:Number, h:Number, r:Object = null, c:Object = null, alpha:Object = null, rot:Object = null, gradient:String = null, ratios:Array = null, hole:Object = null):void
Programatically draws a rectangle into this skin's Graphics object. | UIComponent | |
|
Called by the effect instance when it stops playing on the component. | UIComponent | |
|
Called by the effect instance when it starts playing on the component. | UIComponent | |
|
Ends all currently playing effects on the component. | UIComponent | |
|
Executes all the bindings for which the UIComponent object is the destination. | UIComponent | |
|
Called after printing is complete. | UIComponent | |
|
Provides the automation object at the specified index. | UIComponent | |
|
Provides the automation object list . | UIComponent | |
|
Returns a rectangle that defines the area of the display object relative to the coordinate system
of the targetCoordinateSpace object. | DisplayObject | |
|
Returns the x coordinate of the element's bounds at the specified element size. | UIComponent | |
|
Returns the y coordinate of the element's bounds at the specified element size. | UIComponent | |
|
Returns the child display object instance that exists at the specified index. | DisplayObjectContainer | |
|
Returns the child display object that exists with the specified name. | DisplayObjectContainer | |
|
Returns the index position of a child DisplayObject instance. | DisplayObjectContainer | |
|
Finds the type selectors for this UIComponent instance. | UIComponent | |
|
Returns a layout constraint value, which is the same as
getting the constraint style for this component. | UIComponent | |
|
A convenience method for determining whether to use the
explicit or measured height
| UIComponent | |
|
A convenience method for determining whether to use the
explicit or measured width
| UIComponent | |
|
Gets the object that currently has focus. | UIComponent | |
|
Returns the element's layout height. | UIComponent | |
|
Returns the element's layout width. | UIComponent | |
|
Returns the x coordinate that the element uses to draw on screen. | UIComponent | |
|
Returns the y coordinate that the element uses to draw on screen. | UIComponent | |
|
Returns the transform matrix that is used to calculate the component's
layout relative to its siblings. | UIComponent | |
|
Returns the layout transform Matrix3D for this element. | UIComponent | |
|
Returns the element's maximum height. | UIComponent | |
|
Returns the element's maximum width. | UIComponent | |
|
Returns the element's minimum height. | UIComponent | |
|
Returns the element's minimum width. | UIComponent | |
|
Returns an array of objects that lie under the specified point and are children
(or grandchildren, and so on) of this DisplayObjectContainer instance. | DisplayObjectContainer | |
|
Returns the element's preferred height. | UIComponent | |
|
Returns the element's preferred width. | UIComponent | |
|
Returns a rectangle that defines the boundary of the display object,
based on the coordinate system defined by the targetCoordinateSpace
parameter, excluding any strokes on shapes. | DisplayObject | |
|
Returns the item in the dataProvider that was used
by the specified Repeater to produce this Repeater, or
null if this Repeater isn't repeated. | UIComponent | |
|
Gets a style property that has been set anywhere in this
component's style lookup chain. | UIComponent | |
|
Converts a Point object from global to content coordinates. | UIComponent | |
|
Converts the point object from the Stage (global) coordinates
to the display object's (local) coordinates. | DisplayObject | |
|
Converts a two-dimensional point from the Stage (global) coordinates to a
three-dimensional display object's (local) coordinates. | DisplayObject | |
|
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | EventDispatcher | |
|
Indicates whether an object has a specified property defined. | Object | |
|
Determines whether the specified state has been defined on this
UIComponent. | UIComponent | |
|
Evaluates the bounding box of the display object to see if it overlaps or intersects with the
bounding box of the obj display object. | DisplayObject | |
|
Evaluates the display object to see if it overlaps or intersects with the
point specified by the x and y parameters. | DisplayObject | |
|
Returns a box Matrix which can be passed to the
drawRoundRect() method
as the rot parameter when drawing a horizontal gradient. | UIComponent | |
|
Initializes the internal structure of this component. | UIComponent | |
|
Initializes various properties which keep track of repeated instances
of this component. | UIComponent | |
|
Marks a component so that its updateDisplayList()
method gets called during a later screen update. | UIComponent | |
|
Called by a component's items to indicate that their depth
property has changed. | UIComponent | |
|
Marks a component so that its commitProperties()
method gets called during a later screen update. | UIComponent | |
|
Marks a component so that its measure()
method gets called during a later screen update. | UIComponent | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Converts a three-dimensional point of the three-dimensional display
object's (local) coordinates to a two-dimensional point in the Stage (global) coordinates. | DisplayObject | |
|
Converts a Point object from local to content coordinates. | UIComponent | |
|
Converts the point object from the display object's (local) coordinates to the
Stage (global) coordinates. | DisplayObject | |
|
Determins whether the current state of this component matches a
CSS pseudo-selector. | UIComponent | |
|
Determines whether this component is assignable to the given CSS type. | UIComponent | |
|
Measures the specified HTML text, which may contain HTML tags such
as <font> and <b>,
assuming that it is displayed
in a single-line UITextField using a UITextFormat
determined by the styles of this UIComponent. | UIComponent | |
|
Measures the specified text, assuming that it is displayed
in a single-line UITextField using a UITextFormat
determined by the styles of this UIComponent. | UIComponent | |
|
Moves the component to a specified position within its parent. | UIComponent | |
|
Propagates style changes to the children. | UIComponent | |
|
Returns true if the chain of owner properties
points from child to this UIComponent. | UIComponent | |
|
Called by Flex when a UIComponent object is added to or removed from a parent. | UIComponent | |
|
Prepares an IFlexDisplayObject for printing. | UIComponent | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Builds or rebuilds the CSS style cache for this component
and, if the recursive parameter is true,
for all descendants of this component as well. | UIComponent | |
|
For each effect event, registers the EffectManager
as one of the event listeners. | UIComponent | |
|
Removes the specified child DisplayObject instance from the child list of the DisplayObjectContainer instance. | DisplayObjectContainer | |
|
Removes a child DisplayObject from the specified index position in the child list of
the DisplayObjectContainer. | DisplayObjectContainer | |
|
Removes a listener from the EventDispatcher object. | EventDispatcher | |
|
Replays the specified event. | UIComponent | |
|
Resolves a child by using the id provided. | UIComponent | |
| [static]
Resumes the background processing of methods
queued by callLater(), after a call to
suspendBackgroundProcessing(). | UIComponent | |
|
Sizes the object. | UIComponent | |
|
Changes the position of an existing child in the display object container. | DisplayObjectContainer | |
|
Sets a layout constraint value, which is the same as
setting the constraint style for this component. | UIComponent | |
|
Set the current state. | UIComponent | |
|
Sets the focus to this component. | UIComponent | |
|
Sets the coordinates that the element uses to draw on screen. | UIComponent | |
|
Sets the layout size to the specified dimensions. | UIComponent | |
|
Sets the transform Matrix that is used to calculate the component's layout
size and position relative to its siblings. | UIComponent | |
|
Similarly to the layoutMatrix3D property, sets the layout Matrix3D, but
doesn't trigger a layout pass. | UIComponent | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Sets a style property on this component instance. | UIComponent | |
|
Called when the visible property changes. | UIComponent | |
|
Lets the user drag the specified sprite. | Sprite | |
|
Ends the startDrag() method. | Sprite | |
|
Detects changes to style properties. | UIComponent | |
|
Flex calls the stylesInitialized() method when
the styles for a component are first initialized. | UIComponent | |
| [static]
Blocks the background processing of methods
queued by callLater(),
until resumeBackgroundProcessing() is called. | UIComponent | |
|
Swaps the z-order (front-to-back order) of the two specified child objects. | DisplayObjectContainer | |
|
Swaps the z-order (front-to-back order) of the child objects at the two specified index positions in the
child list. | DisplayObjectContainer | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
| [override]
Returns a string indicating the location of this object
within the hierarchy of DisplayObjects in the Application. | FlexSprite | |
| UIComponent | ||
| transformPointToParent(transformCenter:Vector3D, position:Vector3D, postLayoutPosition:Vector3D):void
FIXME (chaase) : FLEXDOCS-1031
| UIComponent | |
|
Validates the position and size of children and draws other
visuals. | UIComponent | |
|
Validate and update the properties and layout of this object
and redraw it, if necessary. | UIComponent | |
|
Used by layout logic to validate the properties of a component
by calling the commitProperties() method. | UIComponent | |
|
Validates the measured size of the component
If the LayoutManager.invalidateSize() method is called with
this ILayoutManagerClient, then the validateSize() method
is called when it's time to do measurements. | UIComponent | |
|
Handles both the valid and invalid events from a
validator assigned to this component. | UIComponent | |
|
Returns the primitive value of the specified object. | Object | |
|
Returns a box Matrix which can be passed to drawRoundRect()
as the rot parameter when drawing a vertical gradient. | UIComponent | |
|
Checks whether an event listener is registered with this EventDispatcher object or any of
its ancestors for the specified event type. | EventDispatcher | |
| Style | Description | Defined By | ||
|---|---|---|---|---|
| Type: uint Format: Color CSS Inheritance: yes Theme: spark The main color for a component. | UIComponent | ||
| Type: String CSS Inheritance: no The vertical distance in pixels from the top edge of the content area to the control's baseline position. | UIComponent | ||
| Type: uint Format: Color CSS Inheritance: no Theme: halo Color of the border. | Button | ||
| Type: String CSS Inheritance: no The vertical distance in pixels from the lower edge of the component to the lower edge of its content area. | UIComponent | ||
| Type: uint Format: Color CSS Inheritance: yes Color of text in the component, including the component label. | Button | ||
| Type: Number Format: Length CSS Inheritance: no Theme: halo, spark Radius of component corners. | Button | ||
| Type: String CSS Inheritance: yes The directionality of the text displayed by the component. | Button | ||
| Type: uint Format: Color CSS Inheritance: yes Color of text in the component if it is disabled. | Button | ||
| Type: Class CSS Inheritance: no Name of the class to use as the icon when the button is disabled and not selected. | Button | ||
disabledIconColor | Type: uint Format: Color CSS Inheritance: yes Theme: halo The color for the icon in a disabled skin. For example, this style is used by the CheckBoxIcon skin class to draw the check mark for a disabled CheckBox control, by the ComboBoxSkin class to draw the down arrow of a disabled ComboBox control, and by the DateChooserMonthArrowSkin skin class to draw the month arrow for a disabled DateChooser control. The default value depends on the component class; if it is not overridden by the class, the default value is 0x999999.
| CheckBox | ||
| Type: Class CSS Inheritance: no Name of the class to use as the skin for the background and border when the button is not selected and is disabled. | Button | ||
| Type: Class CSS Inheritance: no Name of the class to use as the icon when the button is not selected and the mouse button is down. | Button | ||
| Type: Class CSS Inheritance: no Name of the class to use as the skin for the background and border when the button is not selected and the mouse button is down. | Button | ||
| Type: Class CSS Inheritance: no Name of the class to use as the skin for the button when the button is emphasized (such as when serving as the default button for a container). | Button | ||
| Type: Class CSS Inheritance: no Name of the class to use as the emphasized skin for the background and border. | Button | ||
| Type: uint Format: Color CSS Inheritance: yes Color of the component highlight when validation fails. | UIComponent | ||
| Type: Array CSS Inheritance: no Theme: halo Alphas used for the background fill of controls. | Button | ||
| Type: Array Format: Color CSS Inheritance: no Theme: halo Colors used to tint the background of the control. | Button | ||
| Type: Number CSS Inheritance: no Specifies the alpha transparency value of the focus skin. | Button | ||
| Type: String CSS Inheritance: no Blend mode used by the focus rectangle. | UIComponent | ||
| Type: uint Format: Color CSS Inheritance: yes Theme: spark Color of focus ring when the component is in focus. | Button | ||
| Type: String CSS Inheritance: no Specifies which corners of the focus rectangle should be rounded. | Button | ||
| Type: Class CSS Inheritance: no Skin used to draw the focus rectangle. | UIComponent | ||
| Type: Number Format: Length CSS Inheritance: no Thickness, in pixels, of the focus rectangle outline. | UIComponent | ||
| Type: String CSS Inheritance: yes Sets the antiAliasType property of internal TextFields. | Button | ||
| Type: String CSS Inheritance: yes Name of the font to use. | Button | ||
| Type: String CSS Inheritance: yes Sets the gridFitType property of internal TextFields that represent text in Flex controls. | Button | ||
| Type: Number CSS Inheritance: yes Sets the sharpness property of internal TextFields that represent text in Flex controls. | Button | ||
| Type: Number Format: Length CSS Inheritance: yes Height of the text, in pixels. | Button | ||
| Type: String CSS Inheritance: yes Determines whether the text is italic font. | Button | ||
| Type: Number CSS Inheritance: yes Sets the thickness property of internal TextFields that represent text in Flex controls. | Button | ||
| Type: String CSS Inheritance: yes Determines whether the text is boldface. | Button | ||
| Type: Array CSS Inheritance: no Theme: halo Alpha transparencies used for the highlight fill of controls. | Button | ||
| Type: String CSS Inheritance: no The horizontal distance in pixels from the center of the component's content area to the center of the component. | UIComponent | ||
| Type: Number Format: Length CSS Inheritance: no Gap between the label and icon, when the labelPlacement property is set to left or right. | Button | ||
| Type: Class CSS Inheritance: no Name of the class to use as the default icon. | Button | ||
iconColor | Type: uint Format: Color CSS Inheritance: yes Theme: halo The color for the icon in a skin. For example, this style is used by the CheckBoxIcon skin class to draw the check mark for a CheckBox control, by the ComboBoxSkin class to draw the down arrow of the ComboBox control, and by the DateChooserMonthArrowSkin skin class to draw the month arrow for the DateChooser control. The default value depends on the component class; if it is not overridden by the class, the default value is 0x111111.
| CheckBox | ||
| Type: Boolean CSS Inheritance: yes A Boolean value that indicates whether kerning is enabled ( true) or disabled (false). | Button | ||
| Type: Number Format: Length CSS Inheritance: no Number of pixels of vertical offset to apply to the label position. | Button | ||
| Type: Number Format: Length CSS Inheritance: yes Additional vertical space between lines of text. | Button | ||
| Type: String CSS Inheritance: no The horizontal distance in pixels from the left edge of the component's content area to the left edge of the component. | UIComponent | ||
| Type: Number CSS Inheritance: yes The number of additional pixels to appear between each character. | Button | ||
| Type: String CSS Inheritance: yes The locale of the text displayed by this component. | Button | ||
| Type: Class CSS Inheritance: no Name of the class to use as the icon when the button is not selected and the mouse is over the control. | Button | ||
| Type: Class CSS Inheritance: no Name of the class to use as the skin for the background and border when the button is not selected and the mouse is over the control. | Button | ||
| Type: Number Format: Length CSS Inheritance: no Number of pixels between the component's bottom border and the bottom of its content area. | Button | ||
| Type: Number Format: Length CSS Inheritance: no Number of pixels between the component's left border and the left edge of its content area. | Button | ||
| Type: Number Format: Length CSS Inheritance: no Number of pixels between the component's right border and the right edge of its content area. | Button | ||
| Type: Number Format: Length CSS Inheritance: no Number of pixels between the component's top border and the top of its content area. | Button | ||
| Type: Number Format: Time CSS Inheritance: no Number of milliseconds to wait after the first buttonDown event before repeating buttonDown events at each repeatInterval. | Button | ||
| Type: Number Format: Time CSS Inheritance: no Number of milliseconds between buttonDown events if the user presses and holds the mouse on a button. | Button | ||
| Type: String CSS Inheritance: no The horizontal distance in pixels from the right edge of the component to the right edge of its content area. | UIComponent | ||
| Type: Class CSS Inheritance: no Name of the class to use as the icon when the button is selected and disabled. | Button | ||
| Type: Class CSS Inheritance: no Name of the class to use as the skin for the background and border when a toggle button is selected and disabled. | Button | ||
| Type: Class CSS Inheritance: no Name of the class to use as the icon when the button is selected and the mouse button is down. | Button | ||
| Type: Class CSS Inheritance: no Name of the class to use as the skin for the background and border when a toggle button is selected and the mouse button is down. | Button | ||
| Type: Class CSS Inheritance: no Name of the class to use as the icon when the button is selected and the mouse is over the control. | Button | ||
| Type: Class CSS Inheritance: no Name of the class to use as the skin for the background and border when a toggle button is selected and the mouse is over the control. | Button | ||
| Type: Class CSS Inheritance: no Name of the class to use as the icon when the button is selected and the mouse button is up. | Button | ||
| Type: Class CSS Inheritance: no Name of the class to use as the skin for the background and border when a toggle button is selected and the mouse is not over the control. | Button | ||
| Type: Class CSS Inheritance: no Name of the class to use as the default skin for the background and border. | Button | ||
symbolColor | Type: uint Format: Color CSS Inheritance: yes Theme: spark Color of any symbol of a component. Examples include the check mark of a CheckBox or the arrow of a ScrollBar button. The default value is 0x000000. | CheckBox | ||
| Type: String CSS Inheritance: yes Alignment of text within a container. | Button | ||
| Type: String CSS Inheritance: yes Determines whether the text is underlined. | Button | ||
| Type: Class CSS Inheritance: no The class implementing IUITextField that is used by this component to render text. | Button | ||
| Type: Number Format: Length CSS Inheritance: yes Offset of first line of text from the left side of the container, in pixels. | Button | ||
| Type: uint Format: Color CSS Inheritance: yes Text color of the label as the user moves the mouse pointer over the button. | Button | ||
| Type: uint Format: Color CSS Inheritance: yes Text color of the label as the user presses it. | Button | ||
| Type: uint Format: Color CSS Inheritance: yes Theme: halo Theme color of a component. | UIComponent | ||
| Type: String CSS Inheritance: no The vertical distance in pixels from the top edge of the control's content area to the top edge of the component. | UIComponent | ||
| Type: Class CSS Inheritance: no Name of the class to use as the icon when a toggle button is not selected and the mouse is not over the button. | Button | ||
| Type: Class CSS Inheritance: no Name of the class to use as the skin for the background and border when the button is not selected and the mouse is not over the control. | Button | ||
| Type: String CSS Inheritance: no The vertical distance in pixels from the center of the component's content area to the center of the component. | UIComponent | ||
| Type: Number Format: Length CSS Inheritance: no Gap between the button's label and icon when the labelPlacement property is set to "top" or "bottom". | Button | ||
| CheckBox | () | Constructor |
public function CheckBox()| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Constructor.
<?xml version="1.0"?>
<!-- Simple example to demonstrate the Halo CheckBox control -->
<s:Application xmlns:fx="http://ns.adobe.com/mxml/2009"
xmlns:s="library://ns.adobe.com/flex/spark"
xmlns:mx="library://ns.adobe.com/flex/halo">
<fx:Script>
<![CDATA[
import mx.controls.Alert;
// This event handler adds and deletes items from the shopping cart.
private function modifyCart():void {
cartItems.text = "";
if(milkCB.selected) {
cartItems.text += "milk" + "\n";
}
if(eggsCB.selected) {
cartItems.text += "eggs" + "\n";
}
if(breadCB.selected) {
cartItems.text +="bread" + "\n";
}
}
// This event handler opens the Halo Alert control.
private function sendMessage():void {
if(couponCB.selected) {
Alert.show("You will receive coupons.");
} else {
Alert.show("You will not receive any coupons.");
}
}
]]>
</fx:Script>
<s:Panel title="Halo CheckBox Control Example"
width="75%" height="75%"
horizontalCenter="0" verticalCenter="0">
<s:HGroup left="10" right="10" top="10" bottom="10">
<s:VGroup>
<mx:CheckBox id="milkCB" label="milk" click="modifyCart();"/>
<mx:CheckBox id="eggsCB" label="eggs" click="modifyCart();"/>
<mx:CheckBox id="breadCB" label="bread" click="modifyCart();"/>
</s:VGroup>
<s:VGroup>
<s:Label text="Items in my cart "/>
<s:TextArea id="cartItems" width="300" height="50" verticalScrollPolicy="off"/>
<!-- Event handler sendMessages() is used to handle event click -->
<mx:CheckBox id="couponCB" label="Send me coupons for items in my cart"
click="sendMessage();" selected="true" color="blue"/>
</s:VGroup>
</s:HGroup>
</s:Panel>
</s:Application>