(Preview)
| Package | spark.components |
| Class | public class Form |
| Inheritance | Form  SkinnableContainer SkinnableContainerBase SkinnableComponent UIComponent FlexSprite Sprite DisplayObjectContainer InteractiveObject DisplayObject EventDispatcher Object |
| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4.5 |
| Runtime Versions: | Flash Player 10, AIR 2.5 |
 | Because this component does not define a skin for the mobile theme, Adobe recommends that you not use it in a mobile application. Alternatively, you can define your own mobile skin for the component. For more information, see Basics of mobile skinning. |
The Spark Form container lets you control the layout of a form, mark form fields as required or optional, handle error messages, and bind your form data to the Flex data model to perform data checking and validation. It also lets you use style sheets to configure the appearance of your forms.
The following table describes the components you use to create forms in Flex:
| Component | Tag | Description |
|---|---|---|
| Form |
<s:Form>
| Defines the container for the entire form, including the overall form layout. Use the FormHeading control and FormItem control to define content. You can also insert other types of components in a Form container. |
| FormHeading |
<s:FormHeading>
| Defines a heading within your form. |
| FormItem |
<s:FormItem>
| Contains one or more form children arranged horizontally or vertically. Children can be controls or other containers. A single Form container can hold multiple FormItem containers. |
| FormLayout |
<s:FormLayout>
| Defines the default layout for Spark Form skins. |
Show MXML Syntax
Hide MXML SyntaxThe <s:Form> tag inherits all the tag
attributes of its superclass and adds no new tag attributes:
<s:Form>
...
child tags
...
</s:Form>
Default MXML PropertymxmlContentFactory
More examples
Related API Elements
spark.components.FormHeading
spark.components.FormItem
spark.layouts.FormLayout
spark.skins.spark.FormSkin
spark.components.FormItem
spark.layouts.FormLayout
spark.skins.spark.FormSkin
Public Properties
| Property | Defined By | ||
|---|---|---|---|
 | accessibilityImplementation : AccessibilityImplementation
The current accessibility implementation (AccessibilityImplementation)
for this InteractiveObject instance. | InteractiveObject | |
| accessibilityProperties : AccessibilityProperties
The current accessibility options for this display object. | DisplayObject | |
| alpha : Number
Indicates the alpha transparency value of the object specified. | DisplayObject | |
| blendMode : String
A value from the BlendMode class that specifies which blend mode to use. | DisplayObject | |
| blendShader : Shader [write-only]
Sets a shader that is used for blending the foreground and background. | DisplayObject | |
| buttonMode : Boolean
Specifies the button mode of this sprite. | Sprite | |
| cacheAsBitmap : Boolean
If set to true, Flash runtimes cache an internal bitmap representation of the
display object. | DisplayObject | |
| cacheAsBitmapMatrix : Matrix
If non-null, this Matrix object defines how a display object is rendered when
cacheAsBitmap is set to true. | DisplayObject | |
| constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| contextMenu : NativeMenu
Specifies the context menu associated with this object. | InteractiveObject | |
| dropTarget : DisplayObject [read-only]
Specifies the display object over which the sprite is being dragged, or on
which the sprite was dropped. | Sprite | |
| filters : Array
An indexed array that contains each filter object currently associated with the display object. | DisplayObject | |
| focusRect : Object
Specifies whether this object displays a focus rectangle. | InteractiveObject | |
| graphics : Graphics [read-only]
Specifies the Graphics object that belongs to this sprite where vector
drawing commands can occur. | Sprite | |
| hitArea : Sprite
Designates another sprite to serve as the hit area for a sprite. | Sprite | |
| loaderInfo : LoaderInfo [read-only]
Returns a LoaderInfo object containing information about loading the file
to which this display object belongs. | DisplayObject | |
| mask : DisplayObject
The calling display object is masked by the specified mask object. | DisplayObject | |
| metaData : Object
Obtains the meta data object of the DisplayObject instance if meta data was stored alongside the
the instance of this DisplayObject in the SWF file through a PlaceObject4 tag. | DisplayObject | |
| mouseChildren : Boolean
Determines whether or not the children of the object are mouse, or user input device, enabled. | DisplayObjectContainer | |
| mouseEnabled : Boolean
Specifies whether this object receives mouse, or other user input, messages. | InteractiveObject | |
| mouseX : Number [read-only]
Indicates the x coordinate of the mouse or user input device position, in pixels. | DisplayObject | |
| mouseY : Number [read-only]
Indicates the y coordinate of the mouse or user input device position, in pixels. | DisplayObject | |
| name : String
Indicates the instance name of the DisplayObject. | DisplayObject | |
| needsSoftKeyboard : Boolean
Specifies whether a virtual keyboard (an on-screen, software keyboard) should display
when this InteractiveObject instance receives focus. | InteractiveObject | |
| opaqueBackground : Object
Specifies whether the display object is opaque with a certain background color. | DisplayObject | |
| root : DisplayObject [read-only]
For a display object in a loaded SWF file, the root property is the
top-most display object in the portion of the display list's tree structure represented by that SWF file. | DisplayObject | |
| scale9Grid : Rectangle
The current scaling grid that is in effect. | DisplayObject | |
| scrollRect : Rectangle
The scroll rectangle bounds of the display object. | DisplayObject | |
| softKeyboard : String
Controls the appearance of the soft keyboard. | InteractiveObject | |
| softKeyboardInputAreaOfInterest : Rectangle
Defines the area that should remain on-screen when a soft keyboard is displayed (not available on iOS). | InteractiveObject | |
| soundTransform : flash.media:SoundTransform
Controls sound within this sprite. | Sprite | |
| stage : Stage [read-only]
The Stage of the display object. | DisplayObject | |
| tabChildren : Boolean
Determines whether the children of the object are tab enabled. | DisplayObjectContainer | |
| tabEnabled : Boolean
Specifies whether this object is in the tab order. | InteractiveObject | |
| tabIndex : int
Specifies the tab ordering of objects in a SWF file. | InteractiveObject | |
| textSnapshot : flash.text:TextSnapshot [read-only]
Returns a TextSnapshot object for this DisplayObjectContainer instance. | DisplayObjectContainer | |
| useHandCursor : Boolean
A Boolean value that indicates whether the pointing hand (hand cursor) appears when the pointer rolls
over a sprite in which the buttonMode property is set to true. | Sprite | |
Protected Properties
Public Methods
| Method | Defined By | ||
|---|---|---|---|
| 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 | |
|
Determines whether the specified display object is a child of the DisplayObjectContainer instance or
the instance itself. | DisplayObjectContainer | |
|
Returns a rectangle that defines the area of the display object relative to the coordinate system
of the targetCoordinateSpace object. | DisplayObject | |
|
Returns the child display object that exists with the specified name. | DisplayObjectContainer | |
|
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 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 | |
|
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 | |
|
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 | |
|
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 the point object from the display object's (local) coordinates to the
Stage (global) coordinates. | DisplayObject | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Removes all child DisplayObject instances from the child list of the DisplayObjectContainer instance. | DisplayObjectContainer | |
|
Removes a listener from the EventDispatcher object. | EventDispatcher | |
|
Raises a virtual keyboard. | InteractiveObject | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Lets the user drag the specified sprite. | Sprite | |
|
Lets the user drag the specified sprite on a touch-enabled device. | Sprite | |
|
Recursively stops the timeline execution of all MovieClips rooted at this object. | DisplayObjectContainer | |
|
Ends the startDrag() method. | Sprite | |
|
Ends the startTouchDrag() method, for use with touch-enabled devices. | Sprite | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
|
Returns the primitive value of the specified object. | Object | |
|
Checks whether an event listener is registered with this EventDispatcher object or any of
its ancestors for the specified event type. | EventDispatcher | |
Protected Methods
Styles
Styles are either common or associated with a specific theme. If the style is common, it can be used with any theme. If a style is associated with a specific theme, it can only be used if your application uses that theme.
Common Styles
Spark Theme Styles
Mobile Theme Styles
Skin Parts
This component uses skins made up of skin parts. Do not set the skin parts directly. The component's skin sets the skin parts.
Skin States
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.
Public Constants
Property Detail
Constructor Detail
Examples How to use this example
FormExample.mxml
<?xml version="1.0" encoding="utf-8"?>
<!-- Simple example to demonstrate the Spark Form control skins -->
<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/mx">
<fx:Script>
<![CDATA[
import mx.controls.Alert;
import mx.validators.Validator;
protected function sbmt_clickHandler(evt:MouseEvent):void {
var arr:Array = Validator.validateAll(valArr);
if (arr.length == 0) {
Alert.show("Form is valid!");
}
}
]]>
</fx:Script>
<fx:Declarations>
<fx:Array id="valArr">
<mx:StringValidator id="fNameVal" source="{fName}" property="text" required="true" maxLength="64" />
<mx:StringValidator id="usrnmVal" source="{usrnm}" property="text" required="true" maxLength="32" />
<mx:StringValidator id="psswdVal" source="{psswd}" property="text" required="true" maxLength="32" />
<mx:SocialSecurityValidator id="ssnVal" source="{ssn}" property="text" required="false" />
</fx:Array>
</fx:Declarations>
<s:Panel title="Spark Form Control Example"
width="75%" height="75%"
horizontalCenter="0" verticalCenter="0">
<s:Scroller width="100%" height="100%">
<s:Group left="10" right="10" top="10" bottom="10">
<s:Form id="frm" defaultButton="{sbmt}">
<s:FormHeading label="SPARK FORM" backgroundColor="haloSilver" />
<s:FormItem sequenceLabel="i)" label="First name:" required="true">
<s:TextInput id="fName" maxChars="64" />
</s:FormItem>
<s:FormItem sequenceLabel="ii)" label="Last name:">
<s:TextInput id="lName" maxChars="64" />
</s:FormItem>
<s:FormItem sequenceLabel="iii)" label="User name:" required="true">
<s:TextInput id="usrnm" maxChars="32" />
</s:FormItem>
<s:FormItem sequenceLabel="iv)" label="Password:" required="true">
<s:TextInput id="psswd" maxChars="32" displayAsPassword="true" />
</s:FormItem>
<s:FormItem sequenceLabel="v)" label="SSN:">
<s:helpContent>
<s:Label text="###-##-####" />
</s:helpContent>
<s:TextInput id="ssn" maxChars="11" />
</s:FormItem>
<s:FormItem>
<s:Button id="sbmt" label="Submit" click="sbmt_clickHandler(event);" />
</s:FormItem>
</s:Form>
</s:Group>
</s:Scroller>
</s:Panel>
</s:Application>
StackedFormSkinExample.mxml
<?xml version="1.0" encoding="utf-8"?>
<!-- Simple example to demonstrate the Spark Form control skins -->
<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/mx">
<fx:Script>
<![CDATA[
import mx.controls.Alert;
import mx.validators.Validator;
protected function sbmt_clickHandler(evt:MouseEvent):void {
var arr:Array = Validator.validateAll(valArr);
if (arr.length == 0) {
Alert.show("Form is valid!");
}
}
]]>
</fx:Script>
<fx:Style>
@namespace s "library://ns.adobe.com/flex/spark";
s|Form {
skinClass: ClassReference("spark.skins.spark.StackedFormSkin");
}
s|FormHeading {
skinClass: ClassReference("spark.skins.spark.StackedFormHeadingSkin");
}
s|FormItem {
skinClass: ClassReference("spark.skins.spark.StackedFormItemSkin");
}
</fx:Style>
<fx:Declarations>
<fx:Array id="valArr">
<mx:StringValidator id="fNameVal" source="{fName}" property="text" required="true" maxLength="64" />
<mx:StringValidator id="usrnmVal" source="{usrnm}" property="text" required="true" maxLength="32" />
<mx:StringValidator id="psswdVal" source="{psswd}" property="text" required="true" maxLength="32" />
<mx:SocialSecurityValidator id="ssnVal" source="{ssn}" property="text" required="false" />
</fx:Array>
</fx:Declarations>
<s:Panel title="Spark Form Control skinClass Example"
width="75%" height="75%"
horizontalCenter="0" verticalCenter="0">
<s:Scroller width="100%" height="100%">
<s:Group left="10" right="10" top="10" bottom="10">
<s:Form id="frm" defaultButton="{sbmt}">
<s:FormHeading label="STACKED SPARK FORM" backgroundColor="haloSilver" />
<s:FormItem sequenceLabel="i)" label="First name:" required="true">
<s:TextInput id="fName" maxChars="64" />
</s:FormItem>
<s:FormItem sequenceLabel="ii)" label="Last name:">
<s:TextInput id="lName" maxChars="64" />
</s:FormItem>
<s:FormItem sequenceLabel="iii)" label="User name:" required="true">
<s:TextInput id="usrnm" maxChars="32" />
</s:FormItem>
<s:FormItem sequenceLabel="iv)" label="Password:" required="true">
<s:TextInput id="psswd" maxChars="32" displayAsPassword="true" />
</s:FormItem>
<s:FormItem sequenceLabel="v)" label="SSN:">
<s:helpContent>
<s:Label text="###-##-####" />
</s:helpContent>
<s:TextInput id="ssn" maxChars="11" />
</s:FormItem>
<s:FormItem>
<s:Button id="sbmt" label="Submit" click="sbmt_clickHandler(event);" />
</s:FormItem>
</s:Form>
</s:Group>
</s:Scroller>
</s:Panel>
</s:Application>
Wed Nov 21 2018, 06:34 AM -08:00