| Package | mx.containers |
| Class | public class Grid |
| Inheritance | Grid  Box Container UIComponent FlexSprite flash.display.Sprite |
| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
<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 styles 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 | ||
 | addChild(child:DisplayObject):DisplayObject [override]
Adds a child DisplayObject to this Container. | Container | |
| addChildAt(child:DisplayObject, index:int):DisplayObject [override]
Adds a child DisplayObject to this Container. | Container | |
|
Adds a visual element to this container. | Container | |
|
Adds a visual element to this container. | Container | |
| addStyleClient(styleClient:IAdvancedStyleClient):void
Adds a non-visual style client to this component instance. | UIComponent | |
| callLater(method:Function, args:Array = null):void
Queues a function to be called later. | UIComponent | |
| clearStyle(styleProp:String):void
Deletes a style property from this component instance. | UIComponent | |
| contentToGlobal(point:Point):Point [override]
Converts a Point object from content coordinates to global coordinates. | Container | |
| contentToLocal(point:Point):Point [override]
Converts a Point object from content to local coordinates. | Container | |
| createAutomationIDPart(child:IAutomationObject):Object
Returns a set of properties that identify the child within
this container. | UIComponent | |
| createAutomationIDPartWithRequiredProperties(child:IAutomationObject, properties:Array):Object
Returns a set of properties as automation IDs 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 | |
| createComponentsFromDescriptors(recurse:Boolean = true):void
Iterate through the Array of childDescriptors,
and call the createComponentFromDescriptor() method for each one. | Container | |
| createDeferredContent():void
Performs the equivalent action of calling
the createComponentsFromDescriptors(true) method for containers
that implement the IDeferredContentOwner interface to support deferred instantiation. | Container | |
| createReferenceOnParentDocument(parentDocument:IFlexDisplayObject):void
Creates an id reference to this IUIComponent object
on its parent document object. | UIComponent | |
| deleteReferenceOnParentDocument(parentDocument:IFlexDisplayObject):void
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 | |
| dispatchEvent(event:Event):Boolean [override]
Dispatches an event into the event flow. | UIComponent | |
| drawFocus(isFocused:Boolean):void
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
Programmatically draws a rectangle into this skin's Graphics object. | UIComponent | |
| effectFinished(effectInst:IEffectInstance):void
Called by the effect instance when it stops playing on the component. | UIComponent | |
| effectStarted(effectInst:IEffectInstance):void
Called by the effect instance when it starts playing on the component. | UIComponent | |
| endEffectsStarted():void
Ends all currently playing effects on the component. | UIComponent | |
| executeBindings(recurse:Boolean = false):void [override]
Executes all the data bindings on this Container. | Container | |
| executeChildBindings(recurse:Boolean):void
Executes the bindings into this Container's child UIComponent objects. | Container | |
| finishPrint(obj:Object, target:IFlexDisplayObject):void
Called after printing is complete. | UIComponent | |
| generateMXMLArray(document:Object, data:Array, recursive:Boolean = true):Array | UIComponent | |
| generateMXMLVector(document:Object, data:Array, recursive:Boolean = true):* | UIComponent | |
| getAutomationChildAt(index:int):IAutomationObject
Provides the automation object at the specified index. | UIComponent | |
| getAutomationChildren():Array
Provides the automation object list . | UIComponent | |
| getBoundsXAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number
Returns the x coordinate of the element's bounds at the specified element size. | UIComponent | |
| getBoundsYAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number
Returns the y coordinate of the element's bounds at the specified element size. | UIComponent | |
| getChildAt(index:int):DisplayObject [override]
Gets the nth child component object. | Container | |
| getChildByName(name:String):DisplayObject [override]
Returns the child whose name property is the specified String. | Container | |
| getChildIndex(child:DisplayObject):int [override]
Gets the zero-based index of a specific child. | Container | |
| getChildren():Array
Returns an Array of DisplayObject objects consisting of the content children
of the container. | Container | |
| getClassStyleDeclarations():Array
Finds the type selectors for this UIComponent instance. | UIComponent | |
| getConstraintValue(constraintName:String):*
Returns a layout constraint value, which is the same as
getting the constraint style for this component. | UIComponent | |
| getElementAt(index:int):IVisualElement
Returns the visual element at the specified index. | Container | |
| getElementIndex(element:IVisualElement):int
Returns the index position of a visual element. | Container | |
| getExplicitOrMeasuredHeight():Number
A convenience method for determining whether to use the
explicit or measured height
| UIComponent | |
| getExplicitOrMeasuredWidth():Number
A convenience method for determining whether to use the
explicit or measured width
| UIComponent | |
| getFocus():InteractiveObject
Gets the object that currently has focus. | UIComponent | |
| getLayoutBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's layout height. | UIComponent | |
| getLayoutBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's layout width. | UIComponent | |
| getLayoutBoundsX(postLayoutTransform:Boolean = true):Number
Returns the x coordinate that the element uses to draw on screen. | UIComponent | |
| getLayoutBoundsY(postLayoutTransform:Boolean = true):Number
Returns the y coordinate that the element uses to draw on screen. | UIComponent | |
| getLayoutMatrix():Matrix
Returns the transform matrix that is used to calculate the component's
layout relative to its siblings. | UIComponent | |
| getLayoutMatrix3D():Matrix3D
Returns the layout transform Matrix3D for this element. | UIComponent | |
| getMaxBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's maximum height. | UIComponent | |
| getMaxBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's maximum width. | UIComponent | |
| getMinBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's minimum height. | UIComponent | |
| getMinBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's minimum width. | UIComponent | |
| getPreferredBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's preferred height. | UIComponent | |
| getPreferredBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's preferred width. | UIComponent | |
| getRepeaterItem(whichRepeater:int = -1):Object
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 | |
| getStyle(styleProp:String):*
Gets a style property that has been set anywhere in this
component's style lookup chain. | UIComponent | |
| getVisibleRect(targetParent:DisplayObject = null):Rectangle
Get the bounds of this object that are visible to the user
on the screen. | UIComponent | |
| globalToContent(point:Point):Point [override]
Converts a Point object from global to content coordinates. | Container | |
| hasCSSState():Boolean
Returns true if currentCSSState is not null. | UIComponent | |
| hasState(stateName:String):Boolean
Determines whether the specified state has been defined on this
UIComponent. | UIComponent | |
| horizontalGradientMatrix(x:Number, y:Number, width:Number, height:Number):Matrix
Returns a box Matrix which can be passed to the
drawRoundRect() method
as the rot parameter when drawing a horizontal gradient. | UIComponent | |
| initialize():void
Initializes the internal structure of this component. | UIComponent | |
| initializeRepeaterArrays(parent:IRepeaterClient):void
Initializes various properties which keep track of repeated instances
of this component. | UIComponent | |
| invalidateDisplayList():void
Marks a component so that its updateDisplayList()
method gets called during a later screen update. | UIComponent | |
| invalidateLayering():void
Called by a component's items to indicate that their depth
property has changed. | UIComponent | |
| invalidateLayoutDirection():void
An element must call this method when its layoutDirection changes or
when its parent's layoutDirection changes. | UIComponent | |
| invalidateProperties():void
Marks a component so that its commitProperties()
method gets called during a later screen update. | UIComponent | |
| invalidateSize():void
Marks a component so that its measure()
method gets called during a later screen update. | UIComponent | |
| localToContent(point:Point):Point [override]
Converts a Point object from local to content coordinates. | Container | |
| matchesCSSState(cssState:String):Boolean
Returns true if cssState matches currentCSSState. | UIComponent | |
| matchesCSSType(cssType:String):Boolean
Determines whether this instance is the same as, or is a subclass of,
the given type. | UIComponent | |
| measureHTMLText(htmlText:String):TextLineMetrics
Measures the specified HTML text, which can 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 | |
| measureText(text:String):TextLineMetrics
Measures the specified text, assuming that it is displayed
in a single-line UITextField (or UIFTETextField) using a UITextFormat
determined by the styles of this UIComponent. | UIComponent | |
| move(x:Number, y:Number):void
Moves the component to a specified position within its parent. | UIComponent | |
| notifyStyleChangeInChildren(styleProp:String, recursive:Boolean):void
Propagates style changes to the children. | UIComponent | |
| owns(child:DisplayObject):Boolean
Returns true if the chain of owner properties
points from child to this UIComponent. | UIComponent | |
| parentChanged(p:DisplayObjectContainer):void
Called by Flex when a UIComponent object is added to or removed from a parent. | UIComponent | |
| pixelsToPercent(pxl:Number):Number
Method used to convert number of pixels to a
percentage relative to the contents of this container. | Box | |
| prepareToPrint(target:IFlexDisplayObject):Object
Prepares an IFlexDisplayObject for printing. | UIComponent | |
| regenerateStyleCache(recursive:Boolean):void
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 | |
| registerEffects(effects:Array):void
For each effect event, registers the EffectManager
as one of the event listeners. | UIComponent | |
| removeAllChildren():void
Removes all children from the child list of this container. | Container | |
| removeAllElements():void
Removes all visual elements from the container. | Container | |
| removeChild(child:DisplayObject):DisplayObject [override]
Removes a child DisplayObject from the child list of this Container. | Container | |
| removeChildAt(index:int):DisplayObject [override]
Removes a child DisplayObject from the child list of this Container
at the specified index. | Container | |
|
Removes the specified visual element from the child list of
this container. | Container | |
| removeElementAt(index:int):IVisualElement
Removes a visual element from the specified index position
in the container. | Container | |
| removeStyleClient(styleClient:IAdvancedStyleClient):void
Removes a non-visual style client from this component instance. | UIComponent | |
| replayAutomatableEvent(event:Event):Boolean
Replays the specified event. | UIComponent | |
| resolveAutomationIDPart(criteria:Object):Array
Resolves a child by using the id provided. | UIComponent | |
| resumeBackgroundProcessing():void [static]
Resumes the background processing of methods
queued by callLater(), after a call to
suspendBackgroundProcessing(). | UIComponent | |
| setActualSize(w:Number, h:Number):void
Sizes the object. | UIComponent | |
| setChildIndex(child:DisplayObject, newIndex:int):void [override]
Sets the index of a particular child. | Container | |
| setConstraintValue(constraintName:String, value:*):void
Sets a layout constraint value, which is the same as
setting the constraint style for this component. | UIComponent | |
| setCurrentState(stateName:String, playTransition:Boolean = true):void
Set the current state. | UIComponent | |
| setElementIndex(element:IVisualElement, index:int):void
Changes the position of an existing visual element in the visual container. | Container | |
| setFocus():void
Sets the focus to this component. | UIComponent | |
| setLayoutBoundsPosition(x:Number, y:Number, postLayoutTransform:Boolean = true):void
Sets the coordinates that the element uses to draw on screen. | UIComponent | |
| setLayoutBoundsSize(width:Number, height:Number, postLayoutTransform:Boolean = true):void
Sets the layout size of the element. | UIComponent | |
| setLayoutMatrix(value:Matrix, invalidateLayout:Boolean):void
Sets the transform Matrix that is used to calculate the component's layout
size and position relative to its siblings. | UIComponent | |
| setLayoutMatrix3D(value:Matrix3D, invalidateLayout:Boolean):void
Sets the transform Matrix3D that is used to calculate the component's layout
size and position relative to its siblings. | UIComponent | |
| setMXMLDescriptor(value:Array):void | UIComponent | |
| setMXMLProperties(value:Array):void | UIComponent | |
| setStyle(styleProp:String, newValue:*):void
Sets a style property on this component instance. | UIComponent | |
| setVisible(value:Boolean, noEvent:Boolean = false):void
Called when the visible property changes. | UIComponent | |
| styleChanged(styleProp:String):void
Detects changes to style properties. | UIComponent | |
| stylesInitialized():void
Flex calls the stylesInitialized() method when
the styles for a component are first initialized. | UIComponent | |
| suspendBackgroundProcessing():void [static]
Blocks the background processing of methods
queued by callLater(),
until resumeBackgroundProcessing() is called. | UIComponent | |
|
Swaps the index of the two specified visual elements. | Container | |
| swapElementsAt(index1:int, index2:int):void
Swaps the visual elements at the two specified index
positions in the container. | Container | |
| toString():String [override]
Returns a string indicating the location of this object
within the hierarchy of DisplayObjects in the Application. | FlexSprite | |
| transformAround(transformCenter:Vector3D, scale:Vector3D = null, rotation:Vector3D = null, translation:Vector3D = null, postLayoutScale:Vector3D = null, postLayoutRotation:Vector3D = null, postLayoutTranslation:Vector3D = null, invalidateLayout:Boolean = true):void
A utility method to update the rotation, scale, and translation of the
transform while keeping a particular point, specified in the component's
own coordinate space, fixed in the parent's coordinate space. | UIComponent | |
| transformPointToParent(localPosition:Vector3D, position:Vector3D, postLayoutPosition:Vector3D):void
A utility method to transform a point specified in the local
coordinates of this object to its location in the object's parent's
coordinates. | UIComponent | |
| validateDisplayList():void
Validates the position and size of children and draws other
visuals. | UIComponent | |
| validateNow():void
Validate and update the properties and layout of this object
and redraw it, if necessary. | UIComponent | |
| validateProperties():void
Used by layout logic to validate the properties of a component
by calling the commitProperties() method. | UIComponent | |
| validateSize(recursive:Boolean = false):void
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 | |
| validationResultHandler(event:ValidationResultEvent):void
Handles both the valid and invalid events from a
validator assigned to this component. | UIComponent | |
| verticalGradientMatrix(x:Number, y:Number, width:Number, height:Number):Matrix
Returns a box Matrix which can be passed to drawRoundRect()
as the rot parameter when drawing a vertical gradient. | UIComponent | |
| Method | Defined By | ||
|---|---|---|---|
| addMXMLChildren(comps:Array):void | UIComponent | |
| adjustFocusRect(obj:DisplayObject = null):void
Adjust the focus rectangle. | UIComponent | |
| applyComputedMatrix():void
Commits the computed matrix built from the combination of the layout
matrix and the transform offsets to the flash displayObject's transform. | UIComponent | |
| attachOverlay():void [override]
Used internally by the Dissolve Effect to add the overlay to the chrome of a container. | Container | |
| canSkipMeasurement():Boolean
Determines if the call to the measure() method can be skipped. | UIComponent | |
| childrenCreated():void
Performs any final processing after child objects are created. | UIComponent | |
| commitProperties():void
Processes the properties set on the component. | UIComponent | |
| createBorder():void
Creates the container's border skin
if it is needed and does not already exist. | Container | |
| createChildren():void
Create child objects of the component. | UIComponent | |
| createInFontContext(classObj:Class):Object
Creates a new object using a context
based on the embedded font being used. | UIComponent | |
| createInModuleContext(moduleFactory:IFlexModuleFactory, className:String):Object
Creates the object using a given moduleFactory. | UIComponent | |
| dispatchPropertyChangeEvent(prop:String, oldValue:*, value:*):void
Helper method for dispatching a PropertyChangeEvent
when a property is updated. | UIComponent | |
| focusInHandler(event:FocusEvent):void
The event handler called when a UIComponent object gets focus. | UIComponent | |
| focusOutHandler(event:FocusEvent):void
The event handler called when a UIComponent object loses focus. | UIComponent | |
| generateMXMLAttributes(data:Array):void | UIComponent | |
| generateMXMLInstances(document:Object, data:Array, recursive:Boolean = true):void | UIComponent | |
| generateMXMLObject(document:Object, data:Array):Object | UIComponent | |
| initAdvancedLayoutFeatures():void
Initializes the implementation and storage of some of the less frequently
used advanced layout features of a component. | UIComponent | |
| initializationComplete():void
Finalizes the initialization of this component. | UIComponent | |
| initializeAccessibility():void
Initializes this component's accessibility code. | UIComponent | |
|
Helper method to invalidate parent size and display list if
this object affects its layout (includeInLayout is true). | UIComponent | |
| isOurFocus(target:DisplayObject):Boolean
Typically overridden by components containing UITextField objects,
where the UITextField object gets focus. | UIComponent | |
| keyDownHandler(event:KeyboardEvent):void
The event handler called for a keyDown event. | UIComponent | |
| keyUpHandler(event:KeyboardEvent):void
The event handler called for a keyUp event. | UIComponent | |
| layoutChrome(unscaledWidth:Number, unscaledHeight:Number):void
Respond to size changes by setting the positions and sizes
of this container's borders. | Container | |
measure():void [override]
Calculates the preferred, minimum, and maximum sizes of the Grid. | Grid | ||
| resourcesChanged():void
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 | |
| scrollChildren():void
Positions the container's content area relative to the viewable area
based on the horizontalScrollPosition and verticalScrollPosition properties. | Container | |
| setStretchXY(stretchX:Number, stretchY:Number):void
Specifies a transform stretch factor in the horizontal and vertical direction. | UIComponent | |
| stateChanged(oldState:String, newState:String, recursive:Boolean):void
This method is called when a state changes to check whether
state-specific styles apply to this component. | UIComponent | |
updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void [override]
Sets the size and position of each child of the Grid. | Grid | ||
| Style | Description | Defined By | ||
|---|---|---|---|---|
| Type: uint Format: Color CSS Inheritance: yes Theme: spark Accent color used by component skins. | Container | ||
| Type: Number CSS Inheritance: no Theme: halo, spark 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 Theme: halo, spark Background color of a component. | Container | ||
| Type: uint Format: Color CSS Inheritance: yes Theme: halo Background color of the component when it is disabled. | Container | ||
| Type: Object Format: File CSS Inheritance: no Theme: halo Background image of a component. | Container | ||
| Type: String CSS Inheritance: no Theme: halo Scales the image specified by backgroundImage to different percentage sizes. | Container | ||
| Type: uint Format: Color CSS Inheritance: yes Theme: halo 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: Number CSS Inheritance: no Theme: spark Alpha of the border. | Container | ||
| Type: uint Format: Color CSS Inheritance: no Theme: halo, spark Color of the border. | Container | ||
| Type: String CSS Inheritance: no Theme: halo 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 Theme: halo Bounding box thickness. | Container | ||
| Type: Boolean CSS Inheritance: no Theme: spark Visibility of the border. | Container | ||
| Type: String CSS Inheritance: no The vertical distance, in pixels, from the bottom edge of the component to the bottom edge of its parent container's content area. | UIComponent | ||
| Type: uint Format: Color CSS Inheritance: yes Theme: spark The main color for a component. | UIComponent | ||
| Type: uint Format: Color CSS Inheritance: yes Color of text in the component, including the component label. | Container | ||
| Type: Number CSS Inheritance: yes Theme: spark The alpha of the content background for this component. | Container | ||
| Type: uint Format: Color CSS Inheritance: yes Theme: spark Color of the content area of the component. | Container | ||
| Type: Number Format: Length CSS Inheritance: no Theme: halo, spark Radius of component corners. | Container | ||
| Type: String CSS Inheritance: yes The directionality of the text displayed by the component. | 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 Theme: halo Color of the drop shadow. | Container | ||
| Type: Boolean CSS Inheritance: no Theme: halo Boolean property that specifies whether the component has a visible drop shadow. | Container | ||
| Type: Boolean CSS Inheritance: no Theme: spark 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: uint Format: Color CSS Inheritance: yes Theme: spark Color of focus ring when the component is in focus. | Container | ||
| Type: String CSS Inheritance: yes Sets the antiAliasType property of internal TextFields.See also flash.text.TextField flash.text.AntiAliasType | 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.See also flash.text.TextField flash.text.GridFitType | Container | ||
| Type: Number CSS Inheritance: yes Sets the sharpness property of internal TextFields that represent text in Flex controls.See also flash.text.TextField | 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.See also flash.text.TextField | 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: String CSS Inheritance: yes The primary interaction mode for this component. See also | UIComponent | ||
| Type: Boolean CSS Inheritance: yes A Boolean value that indicates whether kerning is enabled ( true) or disabled (false). | Container | ||
| Type: String CSS Inheritance: yes Specifies the desired layout direction of a component. See also | UIComponent | ||
| Type: String CSS Inheritance: no The horizontal distance, in pixels, from the left edge of the component to the left edge of its parent container's content area. | UIComponent | ||
| Type: Number CSS Inheritance: yes The number of additional pixels to appear between each character. | Container | ||
| Type: String CSS Inheritance: yes The locale of the text displayed by this component. | 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 parent container's content area. | UIComponent | ||
| Type: String CSS Inheritance: no Theme: halo Direction of the drop shadow. | Container | ||
| Type: Number Format: Length CSS Inheritance: no Theme: halo Distance of the drop shadow. | Container | ||
| Type: Boolean CSS Inheritance: yes Show the error border or skin when this component is invalid. | UIComponent | ||
| Type: Boolean CSS Inheritance: yes Show the error tip when this component is invalid and the user rolls over it. | UIComponent | ||
| Type: uint Format: Color CSS Inheritance: yes Theme: spark Color of any symbol of a component. | 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: Class CSS Inheritance: no The class implementing IUITextField that is used by this component to render text. | 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: halo Theme color of a component. | UIComponent | ||
| Type: String CSS Inheritance: no The vertical distance, in pixels, from the top edge of the component to the top edge of its parent container's content area. | 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()| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Constructor.
| measure | () | method |
override protected function measure():void| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Calculates 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):void| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Sets 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.
|
<?xml version="1.0"?>
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<!-- Simple example to demonstrate the Halo Grid layout container. -->
<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">
<s:Panel title="Grid Container Example"
width="75%" height="75%"
horizontalCenter="0" verticalCenter="0">
<s:VGroup left="10" right="10" top="10" bottom="10">
<s:Label width="100%" color="blue"
text="A 3 by 3 Grid container of Button controls."/>
<mx:Grid>
<mx:GridRow>
<mx:GridItem>
<s:Button label="Row 1 Col 1" width="100"/>
</mx:GridItem>
<mx:GridItem>
<s:Button label="Row 1 Col 2" width="100"/>
</mx:GridItem>
<mx:GridItem>
<s:Button label="Row 1 Col 3" width="100"/>
</mx:GridItem>
</mx:GridRow>
<mx:GridRow>
<mx:GridItem>
<s:Button label="Row 2 Col 1" width="100"/>
</mx:GridItem>
<mx:GridItem>
<s:Button label="Row 2 Col 2" width="100"/>
</mx:GridItem>
<mx:GridItem>
<s:Button label="Row 2 Col 3" width="100"/>
</mx:GridItem>
</mx:GridRow>
<mx:GridRow>
<mx:GridItem>
<s:Button label="Row 3 Col 1" width="100"/>
</mx:GridItem>
<mx:GridItem>
<s:Button label="Row 3 Col 2" width="100"/>
</mx:GridItem>
<mx:GridItem>
<s:Button label="Row 3 Col 3" width="100"/>
</mx:GridItem>
</mx:GridRow>
</mx:Grid>
</s:VGroup>
</s:Panel>
</s:Application>