| Package | mx.containers |
| Class | public class Form |
| Inheritance | Form Container UIComponent FlexSprite Sprite DisplayObjectContainer InteractiveObject DisplayObject EventDispatcher Object |
The <mx:Form> tag defines the container
for the entire form.
Use the <mx:FormHeading> tag and the
<mx:FormItem> tag to define its content.
You can also insert other types of components in a Form container.
Hide MXML Syntax
The <mx:Form> tag inherits all the tag
attributes of its superclass and adds the following tag attributes:
<mx:Form
Styles
horizontalGap="8"
indicatorGap="14"
labelWidth="Calculated"
paddingBottom="16"
paddingTop="16"
verticalGap="6"
>
...
child tags
...
</mx:Form>
See also
| Method | Defined by | ||
|---|---|---|---|
|
Form()
Constructor.
| Form | ||
![]() |
Adds a child DisplayObject to this Container.
| Container | |
![]() |
Adds a child DisplayObject to this Container.
| Container | |
![]() |
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. | Container | |
![]() |
Converts a
Point object from content to local coordinates. | Container | |
![]() |
Returns a set of properties that identify the child within
this container.
| UIComponent | |
![]() |
Given a single UIComponentDescriptor, create the corresponding
component and add the component as a child of this Container.
| Container | |
![]() |
Iterate through the Array of
childDescriptors,
and call the createComponentFromDescriptor() method for each one. | Container | |
![]() |
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 | |
![]() | 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 data bindings on this Container.
| Container | |
![]() |
Executes the bindings into this Container's child UIComponent objects.
| Container | |
![]() |
Called after printing is complete.
| UIComponent | |
![]() |
Provides the automation object at the specified index.
| UIComponent | |
![]() |
Returns a rectangle that defines the area of the display object relative to the coordinate system
of the
targetCoordinateSpace object. | DisplayObject | |
![]() |
Gets the nth child component object.
| Container | |
![]() |
Returns the child whose
name property is the specified String. | Container | |
![]() |
Gets the zero-based index of a specific child.
| Container | |
![]() |
Returns an Array of DisplayObject objects consisting of the content children
of the container.
| Container | |
![]() |
Finds the type selectors for this UIComponent instance.
| 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 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 | |
![]() |
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. | Container | |
![]() |
Converts the
point object from the Stage (global) coordinates
to the 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 display object to see if it overlaps or intersects with 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 | |
![]() |
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
Point object from local to content coordinates. | Container | |
![]() |
Converts the
point object from the display object's (local) coordinates to the
Stage (global) coordinates. | DisplayObject | |
![]() |
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 | |
![]() |
Propagate 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, register the EffectManager
as one of the event listeners.
| UIComponent | |
![]() |
Removes all children from the child list of this container.
| Container | |
![]() |
Removes a child DisplayObject from the child list of this Container.
| Container | |
![]() |
Removes a child DisplayObject from the child list of this Container
at the specified index.
| Container | |
![]() |
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 the index of a particular child.
| Container | |
![]() |
Set the current state.
| UIComponent | |
![]() |
Sets the focus to this component.
| 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 a string indicating the location of this object
within the hierarchy of DisplayObjects in the Application.
| FlexSprite | |
![]() |
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 | |
| Method | Defined by | ||
|---|---|---|---|
![]() |
Adjust the focus rectangle.
| UIComponent | |
![]() |
Used internally by the Dissolve Effect to add the overlay to the chrome of a container.
| Container | |
![]() |
Performs any final processing after child objects are created.
| UIComponent | |
![]() |
Processes the properties set on the component.
| UIComponent | |
![]() |
Creates the container's border skin
if it is needed and does not already exist.
| Container | |
![]() |
Create child objects of the component.
| UIComponent | |
![]() |
The event handler called when a UIComponent object gets focus.
| UIComponent | |
![]() |
The event handler called when a UIComponent object loses focus.
| UIComponent | |
![]() |
Finalizes the initialization of this component.
| UIComponent | |
![]() |
Initializes this component's accessibility code.
| UIComponent | |
![]() |
Typically overridden by components containing UITextField objects,
where the UITextField object gets focus.
| UIComponent | |
![]() |
The event handler called for a
keyDown event. | UIComponent | |
![]() |
The event handler called for a
keyUp event. | UIComponent | |
![]() |
Respond to size changes by setting the positions and sizes
of this container's borders.
| Container | |
|
Calculates the preferred, minimum and maximum sizes of the Form.
| Form | ||
![]() |
Positions the container's content area relative to the viewable area
based on the horizontalScrollPosition and verticalScrollPosition properties.
| Container | |
|
Responds to size changes by setting the positions
and sizes of this container's children.
| Form | ||
| Style | Description | Defined by | ||
|---|---|---|---|---|
![]() | Type: Number CSS Inheritance: no Alpha level of the color defined by the backgroundColor
property, of the image or SWF file defined by the backgroundImage
style. | Container | ||
![]() | Type: String CSS Inheritance: no If a background image is specified, this style specifies whether it is fixed with regard to the viewport ( "fixed")
or scrolls along with the content ("scroll"). | Container | ||
![]() | Type: uint Format: Color CSS Inheritance: no Background color of a component. | Container | ||
![]() | Type: uint Format: Color CSS Inheritance: yes Background color of the component when it is disabled. | Container | ||
![]() | Type: Object Format: File CSS Inheritance: no Background image of a component. | Container | ||
![]() | Type: String CSS Inheritance: no Scales the image specified by backgroundImage
to different percentage sizes. | Container | ||
![]() | Type: uint Format: Color CSS Inheritance: yes Determines the color of a ProgressBar. | Container | ||
![]() | Type: uint Format: Color CSS Inheritance: no Color of the border. | Container | ||
![]() | Type: String CSS Inheritance: no Bounding box sides. | Container | ||
![]() | Type: Class CSS Inheritance: no The border skin of the component. | Container | ||
![]() | Type: String CSS Inheritance: no Bounding box style. | Container | ||
![]() | Type: Number Format: Length CSS Inheritance: no Bounding box thickness. | Container | ||
![]() | Type: Number Format: Length CSS Inheritance: no The vertical distance in pixels from the lower edge of the component to the lower edge of its parent container. | UIComponent | ||
![]() | Type: uint Format: Color CSS Inheritance: yes Color of text in the component, including the component label. | Container | ||
![]() | Type: Number Format: Length CSS Inheritance: no Radius of component corners. | Container | ||
![]() | Type: uint Format: Color CSS Inheritance: yes Color of text in the component if it is disabled. | Container | ||
![]() | Type: Number CSS Inheritance: no The alpha value for the overlay that is placed on top of the container when it is disabled. | Container | ||
![]() | Type: uint Format: Color CSS Inheritance: yes Color of the drop shadow. | Container | ||
![]() | Type: Boolean CSS Inheritance: no Boolean property that specifies whether the component has a visible drop shadow. | Container | ||
![]() | Type: uint Format: Color CSS Inheritance: yes Color of the component highlight when validation fails. | UIComponent | ||
![]() | Type: String CSS Inheritance: yes Sets the antiAliasType property of internal TextFields. | Container | ||
![]() | Type: String CSS Inheritance: yes Name of the font to use. | Container | ||
![]() | Type: String CSS Inheritance: yes Sets the gridFitType property of internal TextFields that represent text in Flex controls. | Container | ||
![]() | Type: Number CSS Inheritance: yes Sets the sharpness property of internal TextFields that represent text in Flex controls. | Container | ||
![]() | Type: Number Format: Length CSS Inheritance: yes Height of the text, in pixels. | Container | ||
![]() | Type: String CSS Inheritance: yes Determines whether the text is italic font. | Container | ||
![]() | Type: Number CSS Inheritance: yes Sets the thickness property of internal TextFields that represent text in Flex controls. | Container | ||
![]() | Type: String CSS Inheritance: yes Determines whether the text is boldface. | Container | ||
![]() | Type: Number Format: Length CSS Inheritance: no The horizontal distance in pixels from the center of the component's parent container to the center of the component. | UIComponent | ||
|
horizontalGap
| Type: Number Format: Length CSS Inheritance: no Number of pixels between children in the horizontal direction. The default value depends on the component class; if not overriden for the class, the default value is 8. | Form | ||
![]() | Type: String CSS Inheritance: no The name of the horizontal scrollbar style. | Container | ||
|
indicatorGap
| Type: Number Format: Length CSS Inheritance: yes Number of pixels between the label and child components. The default value is 14. | Form | ||
![]() | Type: Boolean CSS Inheritance: yes A Boolean value that indicates whether kerning is enabled ( true) or disabled (false). | Container | ||
|
labelWidth
| Type: Number Format: Length CSS Inheritance: yes Width of the form labels. The default is the length of the longest label in the form. | Form | ||
![]() | Type: Number Format: Length CSS Inheritance: no The horizontal distance in pixels from the left edge of the component's parent container to the left edge of the component. | UIComponent | ||
![]() | Type: Number CSS Inheritance: yes The number of additional pixels to appear between each character. | Container | ||
|
paddingBottom
| Type: Number Format: Length CSS Inheritance: no Number of pixels between the container's bottom border and the bottom edge of its content area. The default value is 16. | Form | ||
![]() | Type: Number Format: Length CSS Inheritance: no Number of pixels between the container's left border and the left edge of its content area. | Container | ||
![]() | Type: Number Format: Length CSS Inheritance: no Number of pixels between the container's right border and the right edge of its content area. | Container | ||
|
paddingTop
| Type: Number Format: Length CSS Inheritance: no Number of pixels between the container's top border and the top edge of its content area. The default value is 16. | Form | ||
![]() | Type: Number Format: Length CSS Inheritance: no The horizontal distance in pixels from the right edge of the component to the right edge of its parent container. | UIComponent | ||
![]() | Type: String CSS Inheritance: no Direction of the drop shadow. | Container | ||
![]() | Type: Number Format: Length CSS Inheritance: no Distance of the drop shadow. | Container | ||
![]() | Type: String CSS Inheritance: yes Alignment of text within a container. | Container | ||
![]() | Type: String CSS Inheritance: no Determines whether the text is underlined. | Container | ||
![]() | Type: Number Format: Length CSS Inheritance: yes Offset of first line of text from the left side of the container, in pixels. | Container | ||
![]() | Type: uint Format: Color CSS Inheritance: yes Theme color of a component. | UIComponent | ||
![]() | Type: Number Format: Length CSS Inheritance: no The vertical distance in pixels from the top edge of the component's parent container to the top edge of the component. | UIComponent | ||
![]() | Type: Number Format: Length CSS Inheritance: no The vertical distance in pixels from the center of the component's parent container to the center of the component. | UIComponent | ||
|
verticalGap
| Type: Number Format: Length CSS Inheritance: no Number of pixels between children in the vertical direction. The default value depends on the component class; if not overriden for the class, the default value is 6. | Form | ||
![]() | Type: String CSS Inheritance: no The name of the vertical scrollbar style. | Container | ||
| Form | () | constructor |
public function Form()Constructor.
| measure | () | method |
protected override function measure():void
Calculates the preferred, minimum and maximum sizes of the Form.
For more information about the measure method,
see the UIComponent.measure() method.
The Form.measure() method sets the
measuredWidth property to the width of the
largest child, plus the values of the paddingLeft
and paddingRight style properties and the
width of the border.
The measuredHeight property is set to the sum
of the measuredHeightS of all children,
plus verticalGap space between each child.
The paddingTop and paddingBottom
style properties and the height of the border are also added.
The measuredMinWidth property is set to the largest
minimum width of the children.
If the child has a percentage value for width,
the minWidth property is used, otherwise the
measuredWidth property is used.
The values of the paddingLeft and
paddingRight style properties and the width
of the border are also added.
The measuredMinHeight property is set to the same value
as that of the measuredHeight property.
| updateDisplayList | () | method |
protected override function updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void
Responds to size changes by setting the positions
and sizes of this container's children.
For more information about the updateDisplayList() method,
see the UIComponent.updateDisplayList() method.
The Form.updateDisplayList() method
positions the children in a vertical column,
spaced by the verticalGap style property.
The paddingLeft, paddingRight,
paddingTop and paddingBottom
style properties are applied.
If a child has a percentage width,
it is stretched horizontally to the specified
percentage of the Form container; otherwise, it is set
to its measuredWidth property.
Each child is set to its measuredHeight property.
This method calls the super.updateDisplayList()
method before doing anything else.
unscaledWidth:Number — Specifies the width of the component, in pixels,
in the component's coordinates, regardless of the value of the
scaleX property of the component.
|
|
unscaledHeight:Number — Specifies the height of the component, in pixels,
in the component's coordinates, regardless of the value of the
scaleY property of the component.
|
<?xml version="1.0" encoding="utf-8"?>
<!-- Simple example to demonstrate Form layout container. -->
<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml">
<mx:Model id="checkModel">
<User>
<FirstName>{fname.text}</FirstName>
<DOB>{dob.text}</DOB>
<Email>{email.text}</Email>
<Age>{age.text}</Age>
<SSN>{ssn.text}</SSN>
<Zip>{zip.text}</Zip>
<Phone>{phone.text}</Phone>
</User>
</mx:Model>
<mx:Panel title="Form Container Example" height="75%" width="75%"
paddingTop="10" paddingLeft="10" paddingRight="10" paddingBottom="10">
<mx:Text width="100%" color="blue"
text="Moving from one form field to another triggers the validator."/>
<mx:Form width="100%" height="100%">
<mx:FormHeading label="Enter values into the form."/>
<mx:FormItem label="First name">
<mx:TextInput id="fname" width="200"/>
</mx:FormItem>
<mx:FormItem label="Date of birth (mm/dd/yyyy)">
<mx:TextInput id="dob" width="200"/>
</mx:FormItem>
<mx:FormItem label="E-mail address">
<mx:TextInput id="email" width="200"/>
</mx:FormItem>
<mx:FormItem label="Age">
<mx:TextInput id="age" width="200"/>
</mx:FormItem>
<mx:FormItem label="SSN">
<mx:TextInput id="ssn" width="200"/>
</mx:FormItem>
<mx:FormItem label="Zip">
<mx:TextInput id="zip" width="200"/>
</mx:FormItem>
<mx:FormItem label="Phone">
<mx:TextInput id="phone" width="200"/>
</mx:FormItem>
</mx:Form>
</mx:Panel>
<mx:StringValidator source="{fname}" property="text" minLength="4" maxLength="12"/>
<mx:PhoneNumberValidator source="{phone}" property="text"/>
<mx:DateValidator source="{dob}" property="text"/>
<mx:EmailValidator source="{email}" property="text"/>
<mx:NumberValidator source="{age}" property="text" integerError="Enter Integer value"
minValue="18" maxValue="100" domain="int"/>
<mx:SocialSecurityValidator source="{ssn}" property="text"/>
<mx:ZipCodeValidator source="{zip}" property="text"/>
</mx:Application>