| Package | mx.containers |
| Class | public class Grid |
| Inheritance | Grid  Box Container UIComponent FlexSprite Sprite DisplayObjectContainer InteractiveObject DisplayObject EventDispatcher Object |
<mx:Grid> tag defines a Grid container.<mx:GridRow> tag defines a grid row,
which has one or more cells. The grid row must be a child of the
<Grid> tag.<mx:GridItem> tag defines a grid cell,
and must be a child of the <GridRow> tag.
The <mx:GridItem> tag can contain
any number of children.The height of all the cells in a single row is the same, but each row can have a different height. The width of all cells in a single column is the same, but each column can have a different width. You can define a different number of cells for each row or each column of the Grid container. In addition, a cell can span multiple columns or multiple rows of the container.
The Grid, GridRow, and GridItem containers have the following default sizing characteristics:
| Characteristic | Description |
|---|---|
| Grid height | The sum of the default or explicit heights of all rows plus the gaps between rows. |
| Grid width | The sum of the default or explicit width of all columns plus the gaps between columns. |
| Height of each row and each cell | The default or explicit height of the tallest item in the row. If a GridItem container does not have an explicit size, its default height is the default or explicit height of the child in the cell. |
| Width of each column and each cell | The default or explicit width of the widest item in the column. If a GridItem container does not have an explicit width, its default width is the default or explicit width of the child in the cell. |
| Gap between rows and columns | Determined by the horizontalGap and verticalGap properties of the Grid class. The default value for both gaps is 6 pixels. |
| Default padding | 0 pixels for the top, bottom, left, and right values, for all three container classes. |
Hide MXML SyntaxThe <mx:Grid> tag inherits all of the tag
attributes of its superclass, except the Box.direction
property, and adds the following tag attributes:
Show MXML Syntax
<mx:Grid
Styles
horizontalGap="8"
verticalGap="6"
>
...
These child tags are examples only:
<mx:GridRow id="row1">
<mx:GridItem
rowSpan="1"
colSpan="1">
<mx:Button label="Button 1"/>
</mx:GridItem>
...
</mx:GridRow>
...
</mx:Grid>
See also
| Method | Defined By | ||
|---|---|---|---|
Grid()
Constructor. | Grid | ||
 | [override]
Adds a child DisplayObject to this Container. | Container | |
| [override]
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 | |
| [override]
Converts a Point object from content coordinates to global coordinates. | Container | |
| [override]
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 | |
| [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 | |
| [override]
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 | |
| [override]
Gets the nth child component object. | Container | |
| [override]
Returns the child whose name property is the specified String. | Container | |
| [override]
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 | |
|
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 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 | |
| [override]
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 | |
|
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 | |
|
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 three-dimensional point of the three-dimensional display
object's (local) coordinates to a two-dimensional point in the Stage (global) coordinates. | DisplayObject | |
| [override]
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 | |
|
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 | |
|
Method used to convert number of pixels to a
percentage relative to the contents of this container. | Box | |
|
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 all children from the child list of this container. | Container | |
| [override]
Removes a child DisplayObject from the child list of this Container. | Container | |
| [override]
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 | |
| [override]
Sets the index of a particular child. | Container | |
|
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 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 | |
|
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 | |
| [override]
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 | |
|
Creates a new object using a context
based on the embedded font being used. | UIComponent | |
|
Creates the object using a given moduleFactory. | 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 | |
[override]
Calculates the preferred, minimum, and maximum sizes of the Grid. | Grid | ||
|
This method is called when a UIComponent is constructed,
and again whenever the ResourceManager dispatches
a "change" Event to indicate
that the localized resources have changed in some way. | UIComponent | |
|
Positions the container's content area relative to the viewable area
based on the horizontalScrollPosition and verticalScrollPosition properties. | Container | |
[override]
Sets the size and position of each child of the Grid. | Grid | ||
| 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: 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 Color of the border. | Container | ||
| Type: String CSS Inheritance: no Bounding box sides. | Container | ||
| Type: Class CSS Inheritance: no The border skin class 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: 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. | 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: String CSS Inheritance: no Horizontal alignment of children in the container. | Box | ||
| 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 | ||
horizontalGap | Type: Number Format: Length CSS Inheritance: no Number of pixels between children in the horizontal direction. The default value is 8. | Grid | ||
| Type: String CSS Inheritance: no The name of the horizontal scrollbar style. | Container | ||
| Type: Boolean CSS Inheritance: yes A Boolean value that indicates whether kerning is enabled ( true) or disabled (false). | Container | ||
| 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. | Container | ||
| Type: Number Format: Length CSS Inheritance: no Number of pixels between the container's bottom border and the bottom of its content area. | Box | ||
| Type: Number Format: Length CSS Inheritance: no Number of pixels between the component's left border and the left edge of its content area. | Container | ||
| Type: Number Format: Length CSS Inheritance: no Number of pixels between the component's right border and the right edge of its content area. | Container | ||
| Type: Number Format: Length CSS Inheritance: no Number of pixels between the container's top border and the top of its content area. | Box | ||
| 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: 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: yes 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: 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: String CSS Inheritance: no Vertical alignment of children in the container. | Box | ||
| 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 | ||
verticalGap | Type: Number Format: Length CSS Inheritance: no Number of pixels between children in the vertical direction. The default value is 6. | Grid | ||
| Type: String CSS Inheritance: no The name of the vertical scrollbar style. | Container | ||
| Grid | () | Constructor |
public function Grid()Constructor.
| measure | () | method |
override protected function measure():voidCalculates the preferred, minimum, and maximum sizes of the Grid.
You should not call this method directly; it is an advanced
method for use in subclassing.
The Flex LayoutManger calls the measure() method
at the appropriate time.
At application startup, the Flex LayoutManager attempts
to measure all components from the children to the parents
before setting them to their final sizes.
To understand how the Grid container calculates its measurements,
assume that every GridItem container has its rowSpan
property and colSpan property set to 1.
The measured width of the first column of the Grid container
is equal to the maximum among of the measured widths
of all GridItem containers in the first column.
Similarly, the measured width of the second column is
the maximum of all measured widths among the GridItem containers
in the second column, and so on.
The measuredWidth of the entire Grid container
is the sum of all columns' measured widths, plus the thickness
of the border, plus the left and right padding, plus room
for the horizontal gap between adjacent grid cells.
The measuredHeight, minWidth,
minHeight, maxWidth, and
maxHeight properties' values are all calculated
in a similar manner, by adding together the values of the
GridItem containers' measuredHeight properties,
minWidth properties, and so on.
If a GridItem container's colSpan property is 3,
that GridItem container's measuredWidth is divided
among 3 columns.
If the measuredWidth is divided equally,
each of the three columns calculates its measured width
as if the GridItem container were only in that column
and the GridItem container's measuredWidth
were one-third of its actual value.
However, the GridItem container's measuredWidth
property is not always divided equally among all the columns it spans.
If some of the columns have a property with a percentage value
of width, the GridItem container's
measuredWidth property is divided accordingly,
attempting to give each column the requested percentage
of the Grid container.
All of the values described previously are the measured widths and heights of Grid. The user can override the measured values by explicitly supplying a value for the following properties:
minHeightminWidthmaxHeightmaxWidthheightwidthIf you override this method, your implementation must call the
super.measure() method or set the
measuredHeight and measuredWidth properties.
You may also optionally set the following properties:
measuredMinWidthmeasuredMinHeightThese properties correspond to the layout properties listed previously and, therefore, are not documented separately.
| updateDisplayList | () | method |
override protected function updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):voidSets the size and position of each child of the Grid.
You should not call this method directly; it is an advanced
method for use in subclassing.
The Flex LayoutManager calls the updateDisplayList
method at the appropriate time.
At application startup, the Flex LayoutManager calls
the updateDisplayList() method on every component,
starting with the root and working downward.
The Grid container follows the same layout rules as the VBox container. The positions and sizes of the GridRow containers are calculated the same way that a VBox container determines the positions and sizes of its children. Similarly, a GridRow container positions its GridItem containers using a similar layout algorithm of an HBox container.
The only difference is that the GridRow containers all coordinate with one another, so they all choose the same positions and sizes for their children (so that the columns of the Grid container align).
If you override this method, your implementation should call
the super.updateDisplayList() method
and call the move() and the setActualSize()
methods on each of the children.
For the purposes of performing layout, you should get the size
of this container from the unscaledWidth
and unscaledHeight properties, not the
width and height properties.
The width and height properties do not
take into account the values of the scaleX
and scaleY properties for this container.
Parameters
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.
|
