Package | spark.components |
Class | public class CheckBox |
Inheritance | CheckBox ToggleButtonBase ButtonBase SkinnableComponent UIComponent FlexSprite Sprite DisplayObjectContainer InteractiveObject DisplayObject EventDispatcher Object |
Language Version: | ActionScript 3.0 |
Product Version: | Flex 4 |
Runtime Versions: | Flash Player 10, AIR 1.5 |
When a user clicks a CheckBox component or its associated text,
the CheckBox component sets its selected
property
to true
for checked, and to false
for unchecked.
The CheckBox control has the following default characteristics:
Characteristic | Description |
---|---|
Default size | Wide enough to display the text label of the control |
Minimum size | 18 pixels wide and 18 pixels high |
Maximum size | 10000 pixels wide and 10000 pixels high |
Default skin class | spark.skins.spark.CheckBoxSkin |
The <s:CheckBox>
tag inherits all of the tag
attributes of its superclass and adds no tag attributes:
<s:CheckBox/>
Default MXML Propertylabel
See also
Method | Defined By | ||
---|---|---|---|
CheckBox()
Constructor. | CheckBox | ||
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 that exists with the specified name. | 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 | ||
Marks the component so that the new state of the skin will get set
during a later screen update. | SkinnableComponent | ||
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 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 | ||
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 | ||
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: String CSS Inheritance: yes Specifies the baseline to which the dominant baseline aligns. | ButtonBase | |||
Type: uint Format: Color CSS Inheritance: yes Theme: spark | SkinnableComponent | |||
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: Object CSS Inheritance: yes Amount to shift the baseline from the dominantBaseline value. | ButtonBase | |||
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: String CSS Inheritance: yes The type of CFF hinting used for this text. | ButtonBase | |||
Type: uint Format: Color CSS Inheritance: yes Color of the text. | ButtonBase | |||
Type: String CSS Inheritance: yes The type of digit case used for this text. | ButtonBase | |||
Type: String CSS Inheritance: yes Type of digit width used for this text. | ButtonBase | |||
Type: String CSS Inheritance: yes Specifies the default bidirectional embedding level of the text in the text block. | ButtonBase | |||
Type: String CSS Inheritance: yes Specifies which element baseline snaps to the alignmentBaseline to determine the vertical position of the element on the line. | ButtonBase | |||
Type: Class Name of the skin class to use for this component when a validation error occurs. | SkinnableComponent | |||
Type: Number CSS Inheritance: no Theme: spark The alpha of the focus ring for this component. | ButtonBase | |||
Type: uint Format: Color CSS Inheritance: yes Theme: spark | ButtonBase | |||
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 The name of the font to use, or a comma-separated list of font names. | ButtonBase | |||
Type: String CSS Inheritance: yes Font lookup to use. | ButtonBase | |||
Type: Number Format: Length CSS Inheritance: yes The size of the text in pixels. | ButtonBase | |||
Type: String CSS Inheritance: yes Style of text. | ButtonBase | |||
Type: String CSS Inheritance: yes Weight of text. | ButtonBase | |||
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: String CSS Inheritance: yes Rule used to justify text in a paragraph. | ButtonBase | |||
Type: String CSS Inheritance: yes The style used for justification of the paragraph. | ButtonBase | |||
Type: String CSS Inheritance: yes Kerning adjusts the pixels between certain character pairs to improve readability. | ButtonBase | |||
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: String CSS Inheritance: yes Controls which of the ligatures that are defined in the font may be used in the text. | ButtonBase | |||
Type: Object CSS Inheritance: yes Leading controls for the text. | ButtonBase | |||
Type: Boolean CSS Inheritance: yes If true , applies strikethrough, a line drawn through the middle of the text. | ButtonBase | |||
Type: String CSS Inheritance: yes The locale of the text. | ButtonBase | |||
Type: String CSS Inheritance: yes The rendering mode used for this text. | ButtonBase | |||
Type: Number Format: Time CSS Inheritance: no Number of milliseconds to wait after the first buttonDown event before repeating buttonDown events at each repeatInterval . | ButtonBase | |||
Type: Number Format: Time CSS Inheritance: no Number of milliseconds between buttonDown events if the user presses and holds the mouse on a button. | ButtonBase | |||
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 Name of the skin class to use for this component. | SkinnableComponent | |||
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 scroll button | CheckBox | ||
Type: String CSS Inheritance: yes Alignment of lines in the paragraph relative to the container. | ButtonBase | |||
Type: String CSS Inheritance: yes Alignment of the last (or only) line in the paragraph relative to the container in justified text. | ButtonBase | |||
Type: Number CSS Inheritance: yes Alpha (transparency) value for the text. | ButtonBase | |||
Type: String CSS Inheritance: yes Decoration on text. | ButtonBase | |||
Type: String CSS Inheritance: yes Specifies options for justifying text. | ButtonBase | |||
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: Object CSS Inheritance: yes Number in pixels (or percent of fontSize , like 120%) indicating the amount of tracking (manual kerning) to be applied to the left of each character. | ButtonBase | |||
Type: Object CSS Inheritance: yes Number in pixels (or percent of fontSize , like 120%) indicating the amount of tracking (manual kerning) to be applied to the right of each character. | ButtonBase | |||
Type: String CSS Inheritance: yes The type of typographic case used for this text. | ButtonBase | |||
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 |
This component uses skins made up of skin parts. Do not set the skin parts directly. The component's skin sets the skin parts.
To skin the component, implement a skin that defines the following states. Although you must implement all skin states, a skin state can be empty. An empty skin state specifies no changes to the default skin state.
CheckBox | () | Constructor |
public function CheckBox()
Language Version: | ActionScript 3.0 |
Product Version: | Flex 4 |
Runtime Versions: | Flash Player 10, AIR 1.5 |
Constructor.
<?xml version="1.0"?> <!-- Simple example to demonstrate the Spark 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[ [Bindable] public var totalCost:Number = 4.50; // This event handler adds/removes the cost of condiments to/from the total cost. private function modifyBurger(evt:MouseEvent):void { // Add 0.25 to the total cost for every condiment. Delete 0.25 for // every condiment removed. if(CheckBox(evt.target).selected) { totalCost += 0.25; } else { totalCost -= 0.25; } // Format the totalCost and then display it in a label. totalString.text = usdFormatter.format(totalCost); } ]]> </fx:Script> <fx:Declarations> <mx:CurrencyFormatter id="usdFormatter" precision="2" currencySymbol="$" decimalSeparatorFrom="." decimalSeparatorTo="." useNegativeSign="true" useThousandsSeparator="true" alignSymbol="left"/> </fx:Declarations> <s:Panel title="Spark CheckBox Control Example" width="75%" height="75%" horizontalCenter="0" verticalCenter="0"> <s:VGroup left="10" right="10" top="10" bottom="10"> <s:Label text="Hamburger Base Price: $4.50" /> <s:Label text="Select condiments for your hamburger (0.25 each):" /> <s:CheckBox id="lettuceCB" label="Pickles" click="modifyBurger(event);"/> <s:CheckBox id="tomatoCB" label="Tomato" click="modifyBurger(event);"/> <s:CheckBox id="pickleCB" label="Lettuce" click="modifyBurger(event);"/> <s:CheckBox id="mayoCB" label="Mayonnaise" click="modifyBurger(event);"/> <mx:Spacer height="20" /> <s:HGroup> <s:Label text="Total Price: " /> <s:Label id="totalString" text="$4.50"/> </s:HGroup> </s:VGroup> </s:Panel> </s:Application>