| Package | spark.components |
| Class | public class GridColumnHeaderGroup |
| Inheritance | GridColumnHeaderGroup  Group GroupBase UIComponent FlexSprite flash.display.Sprite |
| Implements | IDataGridElement |
| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4.5 |
| Runtime Versions : | Flash Player 10, AIR 2.0 |
Headers are rendered by the class specified by the headerRenderer property.
Separators are rendered by the class specified by the columnSeparator property.
The layout, which cannot be changed, is virtual; that means renderers and separators that have been
scrolled out of view are reused.
Hide MXML SyntaxThe <s:GridColumnHeaderGroup> tag inherits all of the tag
attributes of its superclass and adds the following tag attributes:
Show MXML Syntax
<s:GridColumnHeaderGroup
Properties
columnSeperator="null"
dataGrid="null"
downColumnIndex="-1"
headerRenderer="null"
hoverColumnIndex="-1"
selectedColumnIndex="-1"
highlightSelectedColumn="false"
visibleSortIndicatorIndices="empty Vector.<int>"
Styles
paddingBottom="0"
paddingLeft="0"
paddingRight="0"
paddingTop="0"
separatorAffordance="5"
Events
gridClick="No default"
gridDoubleClick="No default"
gridMouseDown="No default"
gridMouseDrag="No default"
gridMouseUp="No default"
gridMouseRollOut="No default"
gridMouseRollOver="No default"
separatorClick="No default"
separatorDoubleClick="No default"
separatorMouseDrag="No default"
separatorMouseUp="No default"
separatorMouseRollOut="No default"
separatorMouseRollOver="No default"
/>
Default MXML PropertymxmlContent
See also
| Property | Defined By | ||
|---|---|---|---|
 | accessibilityDescription : String
A convenience accessor for the description property
in this UIComponent's accessibilityProperties object. | UIComponent | |
| accessibilityEnabled : Boolean
A convenience accessor for the silent property
in this UIComponent's accessibilityProperties object. | UIComponent | |
| accessibilityName : String
A convenience accessor for the name property
in this UIComponent's accessibilityProperties object. | UIComponent | |
| accessibilityShortcut : String
A convenience accessor for the shortcut property
in this UIComponent's accessibilityProperties object. | UIComponent | |
| activeEffects : Array [read-only]
The list of effects that are currently playing on the component,
as an Array of EffectInstance instances. | UIComponent | |
| autoLayout : Boolean
If true, measurement and layout are done
when the position or size of a child is changed. | GroupBase | |
| automationDelegate : Object
The delegate object that handles the automation-related functionality. | UIComponent | |
| automationEnabled : Boolean [read-only]
True if this component is enabled for automation, false
otherwise. | UIComponent | |
| automationName : String
Name that can be used as an identifier for this object. | UIComponent | |
| automationOwner : DisplayObjectContainer [read-only]
The owner of this component for automation purposes. | UIComponent | |
| automationParent : DisplayObjectContainer [read-only]
The parent of this component for automation purposes. | UIComponent | |
| automationTabularData : Object [read-only]
An implementation of the IAutomationTabularData interface, which
can be used to retrieve the data. | UIComponent | |
| automationValue : Array [read-only]
This value generally corresponds to the rendered appearance of the
object and should be usable for correlating the identifier with
the object as it appears visually within the application. | UIComponent | |
| automationVisible : Boolean [read-only]
True if this component is visible for automation, false
otherwise. | UIComponent | |
| baseline : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| baselinePosition : Number [override] [read-only]
The y-coordinate of the baseline
of the first line of text of the component. | Group | |
| baselinePositionElement : IVisualElement
The element used to calculate the GroupBase's baselinePosition
| Group | |
| blendMode : String [override]
A value from the BlendMode class that specifies which blend mode to use. | Group | |
| bottom : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| cacheHeuristic : Boolean [write-only]
Used by Flex to suggest bitmap caching for the object. | UIComponent | |
| cachePolicy : String
Specifies the bitmap caching policy for this object. | UIComponent | |
| className : String [read-only]
The name of this instance's class, such as "Button". | UIComponent | |
| clipAndEnableScrolling : Boolean
If true, specifies to clip the children to the boundaries of the viewport. | GroupBase | |
| columnSeparator : IFactory
A visual element that's displayed between each column. | GridColumnHeaderGroup | ||
| contentHeight : Number [read-only]
The height of the viewport's content. | GroupBase | |
| contentMouseX : Number [read-only]
Returns the x position of the mouse, in the content coordinate system. | UIComponent | |
| contentMouseY : Number [read-only]
Returns the y position of the mouse, in the content coordinate system. | UIComponent | |
| contentWidth : Number [read-only]
The width of the viewport's contents. | GroupBase | |
| currentState : String
The current view state of the component. | UIComponent | |
| cursorManager : ICursorManager [read-only]
Gets the CursorManager that controls the cursor for this component
and its peers. | UIComponent | |
| dataGrid : DataGrid
The DataGrid control that defines the column layout and
horizontal scroll position for this component. | GridColumnHeaderGroup | ||
| depth : Number
Determines the order in which items inside of containers
are rendered. | UIComponent | |
| descriptor : UIComponentDescriptor
Reference to the UIComponentDescriptor, if any, that was used
by the createComponentFromDescriptor() method to create this
UIComponent instance. | UIComponent | |
| designLayer : DesignLayer
Specifies the optional DesignLayer instance associated with this visual
element. | UIComponent | |
| document : Object
A reference to the document object associated with this UIComponent. | UIComponent | |
| doubleClickEnabled : Boolean [override]
Specifies whether the UIComponent object receives doubleClick events. | UIComponent | |
| downColumnIndex : int
Specifies the column index of the header renderer currently
being pressed down by the user. | GridColumnHeaderGroup | ||
| enabled : Boolean
Whether the component can accept user interaction. | UIComponent | |
| errorString : String
The text that displayed by a component's error tip when a
component is monitored by a Validator and validation fails. | UIComponent | |
| explicitHeight : Number
Number that specifies the explicit height of the component,
in pixels, in the component's coordinates. | UIComponent | |
| explicitMaxHeight : Number
The maximum recommended height of the component to be considered
by the parent during layout. | UIComponent | |
| explicitMaxWidth : Number
The maximum recommended width of the component to be considered
by the parent during layout. | UIComponent | |
| explicitMinHeight : Number
The minimum recommended height of the component to be considered
by the parent during layout. | UIComponent | |
| explicitMinWidth : Number
The minimum recommended width of the component to be considered
by the parent during layout. | UIComponent | |
| explicitWidth : Number
Number that specifies the explicit width of the component,
in pixels, in the component's coordinates. | UIComponent | |
| flexContextMenu : IFlexContextMenu
The context menu for this UIComponent. | UIComponent | |
| focusEnabled : Boolean
Indicates whether the component can receive focus when tabbed to. | UIComponent | |
| focusManager : IFocusManager
Gets the FocusManager that controls focus for this component
and its peers. | UIComponent | |
| focusPane : Sprite
The focus pane associated with this object. | UIComponent | |
| hasFocusableChildren : Boolean
A flag that indicates whether child objects can receive focus. | UIComponent | |
| hasLayoutMatrix3D : Boolean [read-only]
Contains true if the element has 3D Matrix. | UIComponent | |
| headerRenderer : IFactory
The IGridItemRenderer class used to renderer each column header. | GridColumnHeaderGroup | ||
| height : Number [override]
Number that specifies the height of the component, in pixels,
in the parent's coordinates. | UIComponent | |
| highlightSelectedColumn : Boolean
The DefaultGridHeaderRenderer only highlights the selected column when selectedColumnIndex is
valid and highlightSelectedColumn is true. | GridColumnHeaderGroup | ||
| horizontalCenter : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| horizontalScrollPosition : Number
The x coordinate of the origin of the viewport in the component's coordinate system,
where the default value is (0,0) corresponding to the upper-left corner of the component. | GroupBase | |
| hoverColumnIndex : int
Specifies the column index of the header renderer currently
being hovered over by the user. | GridColumnHeaderGroup | ||
| id : String
ID of the component. | UIComponent | |
| includeInLayout : Boolean
Specifies whether this component is included in the layout of the
parent container. | UIComponent | |
| inheritingStyles : Object
The beginning of this component's chain of inheriting styles. | UIComponent | |
| initialized : Boolean
A flag that determines if an object has been through all three phases
of layout: commitment, measurement, and layout (provided that any were required). | UIComponent | |
| instanceIndex : int [read-only]
The index of a repeated component. | UIComponent | |
| instanceIndices : Array
An Array containing the indices required to reference
this UIComponent object from its parent document. | UIComponent | |
| is3D : Boolean [read-only]
Contains true when the element is in 3D. | UIComponent | |
| isDocument : Boolean [read-only]
Contains true if this UIComponent instance is a document object. | UIComponent | |
| isPopUp : Boolean
Set to true by the PopUpManager to indicate
that component has been popped up. | UIComponent | |
| layout : LayoutBase
The layout object for this container. | GroupBase | |
| layoutMatrix3D : Matrix3D [write-only]
The transform matrix that is used to calculate a component's layout
relative to its siblings. | UIComponent | |
| left : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| luminosityClip : Boolean
A property that controls whether the luminosity
mask clips the masked content. | GroupBase | |
| luminosityInvert : Boolean
A property that controls the calculation of the RGB
color value of a graphic element being masked by
a luminosity mask. | GroupBase | |
| maintainProjectionCenter : Boolean
When true, the component keeps its projection matrix centered on the
middle of its bounding box. | UIComponent | |
| mask : DisplayObject [override]
Sets the mask. | GroupBase | |
| maskType : String
The mask type. | GroupBase | |
| maxHeight : Number
The maximum recommended height of the component to be considered
by the parent during layout. | UIComponent | |
| maxWidth : Number
The maximum recommended width of the component to be considered
by the parent during layout. | UIComponent | |
| measuredHeight : Number
The default height of the component, in pixels. | UIComponent | |
| measuredMinHeight : Number
The default minimum height of the component, in pixels. | UIComponent | |
| measuredMinWidth : Number
The default minimum width of the component, in pixels. | UIComponent | |
| measuredWidth : Number
The default width of the component, in pixels. | UIComponent | |
| minHeight : Number
The minimum recommended height of the component to be considered
by the parent during layout. | UIComponent | |
| minWidth : Number
The minimum recommended width of the component to be considered
by the parent during layout. | UIComponent | |
| moduleFactory : IFlexModuleFactory
A module factory is used as context for using embedded fonts and for
finding the style manager that controls the styles for this
component. | UIComponent | |
| mouseEnabledWhereTransparent : Boolean
When true, this property
ensures that the entire bounds of the Group respond to
mouse events such as click and roll over. | GroupBase | |
| mouseFocusEnabled : Boolean
Whether you can receive focus when clicked on. | UIComponent | |
| mxmlContent : Array [write-only]
The visual content children for this Group. | Group | |
| MXMLDescriptor : Array [read-only] | UIComponent | |
| MXMLProperties : Array [read-only] | UIComponent | |
| nestLevel : int
Depth of this object in the containment hierarchy. | UIComponent | |
| nonInheritingStyles : Object
The beginning of this component's chain of non-inheriting styles. | UIComponent | |
| numAutomationChildren : int [read-only]
The number of automation children this container has. | UIComponent | |
| numElements : int [read-only]
The number of visual elements in this container. | GroupBase | |
| overlay : DisplayLayer [read-only]
The overlay plane for this group. | GroupBase | |
| owner : DisplayObjectContainer
The owner of this IVisualElement object. | UIComponent | |
| parent : DisplayObjectContainer [override] [read-only]
The parent container or component for this component. | UIComponent | |
| parentApplication : Object [read-only]
A reference to the Application object that contains this UIComponent
instance. | UIComponent | |
| parentDocument : Object [read-only]
A reference to the parent document object for this UIComponent. | UIComponent | |
| percentHeight : Number
Specifies the height of a component as a percentage
of its parent's size. | UIComponent | |
| percentWidth : Number
Specifies the width of a component as a percentage
of its parent's size. | UIComponent | |
| postLayoutTransformOffsets : TransformOffsets
Defines a set of adjustments that can be applied to the object's
transform in a way that is invisible to its parent's layout. | UIComponent | |
| processedDescriptors : Boolean
Set to true after immediate or deferred child creation,
depending on which one happens. | UIComponent | |
| repeater : IRepeater [read-only]
A reference to the Repeater object
in the parent document that produced this UIComponent. | UIComponent | |
| repeaterIndex : int [read-only]
The index of the item in the data provider
of the Repeater that produced this UIComponent. | UIComponent | |
| repeaterIndices : Array
An Array containing the indices of the items in the data provider
of the Repeaters in the parent document that produced this UIComponent. | UIComponent | |
| repeaters : Array
An Array containing references to the Repeater objects
in the parent document that produced this UIComponent. | UIComponent | |
| resizeMode : String
The ResizeMode for this container. | GroupBase | |
| right : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| rotation : Number [override] | UIComponent | |
| rotationX : Number [override]
Indicates the x-axis rotation of the DisplayObject instance, in degrees, from its original orientation
relative to the 3D parent container. | UIComponent | |
| rotationY : Number [override]
Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation
relative to the 3D parent container. | UIComponent | |
| rotationZ : Number [override]
| UIComponent | |
| scaleGridBottom : Number
Specifies the bottom coordinate of the scale grid. | Group | |
| scaleGridLeft : Number
Specifies the left coordinate of the scale grid. | Group | |
| scaleGridRight : Number
Specifies the right coordinate of the scale grid. | Group | |
| scaleGridTop : Number
Specifies the top coordinate of the scale grid. | Group | |
| scaleX : Number [override]
Number that specifies the horizontal scaling factor. | UIComponent | |
| scaleY : Number [override]
Number that specifies the vertical scaling factor. | UIComponent | |
| scaleZ : Number [override]
Number that specifies the scaling factor along the z axis. | UIComponent | |
| screen : Rectangle [read-only]
Returns an object that contains the size and position of the base
drawing surface for this object. | UIComponent | |
| selectedColumnIndex : int
Specifies the column index of the header renderer currently selected by the user. | GridColumnHeaderGroup | ||
| showInAutomationHierarchy : Boolean
A flag that determines if an automation object
shows in the automation hierarchy. | UIComponent | |
| states : Array
The view states that are defined for this component. | UIComponent | |
| styleDeclaration : CSSStyleDeclaration
Storage for the inline inheriting styles on this object. | UIComponent | |
| styleManager : IStyleManager2 [read-only]
Returns the StyleManager instance used by this component. | UIComponent | |
| styleName : Object
The class style used by this component. | UIComponent | |
| styleParent : IAdvancedStyleClient
A component's parent is used to evaluate descendant selectors. | UIComponent | |
| systemManager : ISystemManager
Returns the SystemManager object used by this component. | UIComponent | |
| tabFocusEnabled : Boolean
A flag that indicates whether this object can receive focus
via the TAB key
This is similar to the tabEnabled property
used by the Flash Player.
This is usually true for components that
handle keyboard input, but some components in controlbars
have them set to false because they should not steal
focus from another component like an editor. | UIComponent | |
| toolTip : String
Text to display in the ToolTip. | UIComponent | |
| top : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| transform : Transform [override]
An object with properties pertaining to a display object's matrix, color transform,
and pixel bounds. | UIComponent | |
| transformX : Number
Sets the x coordinate for the transform center of the component. | UIComponent | |
| transformY : Number
Sets the y coordinate for the transform center of the component. | UIComponent | |
| transformZ : Number
Sets the z coordinate for the transform center of the component. | UIComponent | |
| transitions : Array
An Array of Transition objects, where each Transition object defines a
set of effects to play when a view state change occurs. | UIComponent | |
| tweeningProperties : Array
Array of properties that are currently being tweened on this object. | UIComponent | |
| uid : String
A unique identifier for the object. | UIComponent | |
| updateCompletePendingFlag : Boolean
A flag that determines if an object has been through all three phases
of layout validation (provided that any were required). | UIComponent | |
| validationSubField : String
Used by a validator to associate a subfield with this component. | UIComponent | |
| verticalCenter : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| verticalScrollPosition : Number
The y coordinate of the origin of the viewport in the component's coordinate system,
where the default value is (0,0) corresponding to the upper-left corner of the component. | GroupBase | |
| visible : Boolean [override]
Whether or not the display object is visible. | UIComponent | |
| visibleSortIndicatorIndices : Vector.<int>
A vector of column indices corresponding to the header renderers
which currently have their sort indicators visible. | GridColumnHeaderGroup | ||
| width : Number [override]
Number that specifies the width of the component, in pixels,
in the parent's coordinates. | UIComponent | |
| x : Number [override]
Number that specifies the component's horizontal position,
in pixels, within its parent container. | UIComponent | |
| y : Number [override]
Number that specifies the component's vertical position,
in pixels, within its parent container. | UIComponent | |
| z : Number [override]
| UIComponent | |
| Method | Defined By | ||
|---|---|---|---|
Constructor. | GridColumnHeaderGroup | ||
|
Adds a visual element to this container. | Group | |
|
Adds a visual element to this container. | Group | |
| 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 | |
Create and/or configure the GridColumnHeaderViews. | GridColumnHeaderGroup | ||
| containsElement(element:IVisualElement):Boolean
Determines whether the specified IVisualElement is a
child of the container instance or the instance
itself. | GroupBase | |
| contentToGlobal(point:Point):Point
Converts a Point object from content coordinates to global coordinates. | UIComponent | |
| contentToLocal(point:Point):Point
Converts a Point object from content to local coordinates. | UIComponent | |
| 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 | |
| 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
Executes all the bindings for which the UIComponent object is the destination. | UIComponent | |
| 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 | |
| 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. | GroupBase | |
| getElementIndex(element:IVisualElement):int
Returns the index position of a visual element. | GroupBase | |
| 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 | |
getHeaderBounds(columnIndex:int):Rectangle
Returns the current pixel bounds of the specified header (renderer), or null if
no such column exists. | GridColumnHeaderGroup | ||
getHeaderIndexAt(x:Number, y:Number):int
Returns the column index corresponding to the specified coordinates,
or -1 if the coordinates are out of bounds. | GridColumnHeaderGroup | ||
getHeaderRendererAt(columnIndex:int):IGridItemRenderer
If the requested header renderer is visible, returns a reference to
the header renderer currently displayed for the specified column. | GridColumnHeaderGroup | ||
| getHorizontalScrollPositionDelta(navigationUnit:uint):Number
Returns the change to the horizontal scroll position to handle
different scrolling options. | GroupBase | |
| 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 | |
getSeparatorIndexAt(x:Number, y:Number):int
Returns the column separator index corresponding to the specified
coordinates, or -1 if the coordinates don't overlap a separator. | GridColumnHeaderGroup | ||
| getStyle(styleProp:String):*
Gets a style property that has been set anywhere in this
component's style lookup chain. | UIComponent | |
| getVerticalScrollPositionDelta(navigationUnit:uint):Number
Returns the change to the vertical scroll position to handle
different scrolling options. | GroupBase | |
| getVirtualElementAt(index:int, eltWidth:Number, eltHeight:Number):IVisualElement
Layouts that honor the useVirtualLayout flag will use this
method at updateDisplayList() time to get layout elements that are "in view",
i.e. | GroupBase | |
| 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
Converts a Point object from global to content coordinates. | UIComponent | |
| 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 | |
| invalidateGraphicElementDisplayList(element:IGraphicElement):void
Notify the host component that an element has changed and needs to be redrawn. | Group | |
| invalidateGraphicElementProperties(element:IGraphicElement):void
Notify the host component that an element changed and needs to validate properties. | Group | |
| invalidateGraphicElementSharing(element:IGraphicElement):void
Notify the host that an element layer has changed. | Group | |
| invalidateGraphicElementSize(element:IGraphicElement):void
Notify the host component that an element size has changed. | Group | |
| 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 | |
isSortIndicatorVisible(columnIndex:int):Boolean
Returns true if the sort indicator for the specified column
is visible. | GridColumnHeaderGroup | ||
| localToContent(point:Point):Point
Converts a Point object from local to content coordinates. | UIComponent | |
| 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 | |
| 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 | |
| removeAllElements():void
Removes all visual elements from the container. | Group | |
|
Removes the specified visual element from the child list of
this container. | Group | |
| removeElementAt(index:int):IVisualElement
Removes a visual element from the specified index position
in the container. | Group | |
| 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 | |
| setConstraintValue(constraintName:String, value:*):void
Sets a layout constraint value, which is the same as
setting the constraint style for this component. | UIComponent | |
| setContentSize(width:Number, height:Number):void
Sets the contentWidth and contentHeight
properties. | GroupBase | |
| 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. | Group | |
| 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. | Group | |
| swapElementsAt(index1:int, index2:int):void
Swaps the visual elements at the two specified index
positions in the container. | Group | |
| 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 | |
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| Dispatched when the component is added to a container as a content child by using the addChild(), addChildAt(), addElement(), or addElementAt() method. | UIComponent | ||
| Dispatched when the component has finished its construction, property processing, measuring, layout, and drawing. | UIComponent | ||
| Dispatched after the view state has changed. | UIComponent | ||
| Dispatched after the currentState property changes, but before the view state changes. | UIComponent | ||
| Dispatched by the drag initiator (the component that is the source of the data being dragged) when the drag operation completes, either when you drop the dragged data onto a drop target or when you end the drag-and-drop operation without performing a drop. | UIComponent | ||
| Dispatched by the drop target when the user releases the mouse over it. | UIComponent | ||
| Dispatched by a component when the user moves the mouse over the component during a drag operation. | UIComponent | ||
| Dispatched by the component when the user drags outside the component, but does not drop the data onto the target. | UIComponent | ||
| Dispatched by a component when the user moves the mouse while over the component during a drag operation. | UIComponent | ||
| Dispatched by the drag initiator when starting a drag operation. | UIComponent | ||
| Dispatched after an effect ends. | UIComponent | ||
| Dispatched just before an effect starts. | UIComponent | ||
| Dispatched after an effect is stopped, which happens only by a call to stop() on the effect. | UIComponent | ||
| Dispatched when a visual element is added to the content holder. | Group | ||
| Dispatched when a visual element is removed from the content holder. | Group | ||
| Dispatched after the component has entered a view state. | UIComponent | ||
| Dispatched just before the component exits a view state. | UIComponent | ||
| Dispatched when the mouse is clicked over a column header. | GridColumnHeaderGroup | |||
| Dispatched when the mouse is double-clicked over a column header. | GridColumnHeaderGroup | |||
| Dispatched when the mouse button is pressed over a column header. | GridColumnHeaderGroup | |||
| Dispatched after a gridMouseDown event if the mouse moves before the button is released. | GridColumnHeaderGroup | |||
| Dispatched after a gridMouseDown event when the mouse button is released, even if the mouse is no longer within the GridColumnHeaderGroup. | GridColumnHeaderGroup | |||
| Dispatched when the mouse leaves a column header. | GridColumnHeaderGroup | |||
| Dispatched when the mouse enters a column header. | GridColumnHeaderGroup | |||
| Dispatched when an object's state changes from visible to invisible. | UIComponent | ||
| Dispatched when the component has finished its construction and has all initialization properties set. | UIComponent | ||
| Dispatched when a component is monitored by a Validator and the validation failed. | UIComponent | ||
| Dispatched from a component opened using the PopUpManager when the user clicks outside it. | UIComponent | ||
| Dispatched from a component opened using the PopUpManager when the user scrolls the mouse wheel outside it. | UIComponent | ||
| Dispatched when the object has moved. | UIComponent | ||
| Dispatched at the beginning of the component initialization sequence. | UIComponent | ||
| Dispatched when the component is removed from a container as a content child by using the removeChild(), removeChildAt(), removeElement(), or removeElementAt() method. | UIComponent | ||
| Dispatched when the component is resized. | UIComponent | ||
| Dispatched when the mouse is clicked over a column header separator. | GridColumnHeaderGroup | |||
| Dispatched when the mouse is double-clicked over a column header separator. | GridColumnHeaderGroup | |||
| Dispatched after a separatorMouseDown event if the mouse moves before the button is released. | GridColumnHeaderGroup | |||
| Dispatched after a separatorMouseDown event when the mouse button is released, even if the mouse is no longer within the separator affordance. | GridColumnHeaderGroup | |||
| Dispatched when the mouse leaves the area defined by a column separator and separatorMouseWidth. | GridColumnHeaderGroup | |||
| Dispatched when the mouse enters the area defined by a column separator and separatorMouseWidth. | GridColumnHeaderGroup | |||
| Dispatched when an object's state changes from invisible to visible. | UIComponent | ||
| Dispatched after the component has entered a new state and any state transition animation to that state has finished playing. | UIComponent | ||
| Dispatched when a component interrupts a transition to its current state in order to switch to a new state. | UIComponent | ||
| Dispatched by the component when it is time to create a ToolTip. | UIComponent | ||
| Dispatched by the component when its ToolTip has been hidden and is to be discarded soon. | UIComponent | ||
| Dispatched by the component when its ToolTip is about to be hidden. | UIComponent | ||
| Dispatched by the component when its ToolTip is about to be shown. | UIComponent | ||
| Dispatched by the component when its ToolTip has been shown. | UIComponent | ||
| Dispatched by a component whose toolTip property is set, as soon as the user moves the mouse over it. | UIComponent | ||
| A non-cancellable event, dispatched by a component when it is done responding to a touch interaction user gesture. | UIComponent | ||
| A non-cancellable event, dispatched by a component when it starts responding to a touch interaction user gesture. | UIComponent | ||
| A cancellable event, dispatched by a component in an attempt to respond to a touch interaction user gesture. | UIComponent | ||
| Dispatched when an object has had its commitProperties(), measure(), and updateDisplayList() methods called (if needed). | UIComponent | ||
| Dispatched when a component is monitored by a Validator and the validation succeeded. | UIComponent | ||
| Dispatched when values are changed programmatically or by user interaction. | UIComponent | ||
| Style | Description | Defined By | ||
|---|---|---|---|---|
| Type: uint Format: Color CSS Inheritance: yes Theme: spark, mobile Accent color used by component skins. | GroupBase | ||
| Type: String CSS Inheritance: yes Specifies the baseline to which the dominant baseline aligns. See also | GroupBase | ||
| Type: Array Format: Color CSS Inheritance: yes Theme: spark, mobile The colors to use for the backgrounds of the items in the list. | GroupBase | ||
| Type: String CSS Inheritance: no The vertical distance in pixels from the top edge of the content area to the control's baseline position. | UIComponent | ||
| Type: Object CSS Inheritance: yes Amount to shift the baseline. See also | GroupBase | ||
| Type: String CSS Inheritance: yes Specifies a vertical or horizontal progression of line placement. See also | GroupBase | ||
| 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: String CSS Inheritance: yes Controls where lines are allowed to break when breaking wrapping text into multiple lines. See also | GroupBase | ||
| Type: String CSS Inheritance: yes The type of CFF hinting used for this text. See also | GroupBase | ||
| Type: uint Format: Color CSS Inheritance: yes Theme: spark, mobile The main color for a component. | GroupBase | ||
| Type: String CSS Inheritance: yes Controls how text wraps around a float. See also | GroupBase | ||
| Type: uint Format: Color CSS Inheritance: yes Color of the text. See also | GroupBase | ||
| Type: String CSS Inheritance: yes Controls column break after the element. See also | GroupBase | ||
| Type: String CSS Inheritance: yes Controls column break before the element. See also | GroupBase | ||
| Type: String CSS Inheritance: yes Controls container break after the element. See also | GroupBase | ||
| Type: String CSS Inheritance: yes Controls container break before the element. See also | GroupBase | ||
| Type: Number CSS Inheritance: yes Theme: spark, mobile The alpha of the content background for this component. | GroupBase | ||
| Type: uint Format: Color CSS Inheritance: yes Theme: spark, mobile The color of the content background for this component. | GroupBase | ||
| Type: String CSS Inheritance: yes The type of digit case used for this text. See also | GroupBase | ||
| Type: String CSS Inheritance: yes Type of digit width used for this text. See also | GroupBase | ||
| Type: String CSS Inheritance: yes Specifies the default bidirectional embedding level of the text. See also | GroupBase | ||
| Type: Number CSS Inheritance: no Theme: spark, mobile The alpha value when the container is disabled. | GroupBase | ||
| Type: String CSS Inheritance: yes Specifies which element baseline snaps to the alignmentBaseline to determine the vertical position of the element on the line.See also | GroupBase | ||
| Type: uint Format: Color CSS Inheritance: yes Theme: mobile Color of the background of an item renderer when it is being pressed down If The default value for the Spark theme is | GroupBase | ||
| Type: uint Format: Color CSS Inheritance: yes Color of the component highlight when validation fails. | UIComponent | ||
| Type: Object CSS Inheritance: yes Specifies the baseline position of the first line in the container. See also | GroupBase | ||
| Type: uint Format: Color CSS Inheritance: yes Theme: spark, mobile Color of focus ring when the component is in focus. | GroupBase | ||
| Type: uint Format: Color CSS Inheritance: yes The color of text when the component is enabled and has focus. | GroupBase | ||
| Type: Class CSS Inheritance: no Skin used to draw the focus rectangle. | UIComponent | ||
| Type: String CSS Inheritance: yes The name of the font to use, or a comma-separated list of font names. See also | GroupBase | ||
| Type: String CSS Inheritance: yes Font lookup to use. See also | GroupBase | ||
| Type: Number Format: Length CSS Inheritance: yes Height of the text, in pixels. See also | GroupBase | ||
| Type: String CSS Inheritance: yes Determines whether the text is italic font. See also | GroupBase | ||
| Type: String CSS Inheritance: yes Determines whether the text is boldface. See also | GroupBase | ||
| Type: String CSS Inheritance: no The horizontal distance in pixels from the center of the component's content area to the center of the component. | UIComponent | ||
| Type: uint Format: Color CSS Inheritance: yes The color of text when the component is disabled. | GroupBase | ||
| Type: String CSS Inheritance: yes The primary interaction mode for this component. See also | UIComponent | ||
| Type: String CSS Inheritance: yes Rule used to justify text in a paragraph. See also | GroupBase | ||
| Type: String CSS Inheritance: yes The style used for justification of the paragraph. See also | GroupBase | ||
| Type: String CSS Inheritance: yes The style used for justification of the paragraph. See also | GroupBase | ||
| Type: String CSS Inheritance: yes Specifies the desired layout direction of a component. See also | UIComponent | ||
| Type: Number Format: Length CSS Inheritance: yes Theme: mobile Additional vertical space between lines of text. See also | GroupBase | ||
| Type: String CSS Inheritance: yes Specifies the leading model, which is a combination of leading basis and leading direction. See also | GroupBase | ||
| 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 Theme: mobile The number of additional pixels to appear between each character. See also | GroupBase | ||
| Type: String CSS Inheritance: yes Controls which of the ligatures that are defined in the font may be used in the text. See also | GroupBase | ||
| Type: Object CSS Inheritance: yes Leading controls for the text. See also | GroupBase | ||
| Type: Boolean CSS Inheritance: yes If true, applies strikethrough, a line drawn through the middle of the text. See also | GroupBase | ||
| Type: Number Format: length CSS Inheritance: yes This specifies an auto indent for the start edge of lists when the padding value of the list on that side is auto.See also | GroupBase | ||
| Type: String CSS Inheritance: yes This controls the placement of a list item marker relative to the list item. See also | GroupBase | ||
| Type: String CSS Inheritance: yes This controls the appearance of items in a list. See also | GroupBase | ||
| Type: String CSS Inheritance: yes The locale of the text. See also | GroupBase | ||
paddingBottom | Type: Number Format: Length CSS Inheritance: no Bottom inset, in pixels, for all header renderers. The default value is 0. | GridColumnHeaderGroup | ||
paddingLeft | Type: Number Format: Length CSS Inheritance: no Left inset, in pixels, for the first header renderer. The default value is 0. | GridColumnHeaderGroup | ||
paddingRight | Type: Number Format: Length CSS Inheritance: no Right inset, in pixels, for the last header renderer. The default value is 0. | GridColumnHeaderGroup | ||
paddingTop | Type: Number Format: Length CSS Inheritance: no Top inset, in pixels, for all header renderers. The default value is 0. | GridColumnHeaderGroup | ||
| Type: Number Format: length CSS Inheritance: yes The amount to indent the paragraph's end edge. See also | GroupBase | ||
| Type: Number Format: length CSS Inheritance: yes The amount of space to leave after the paragraph. See also | GroupBase | ||
| Type: Number Format: length CSS Inheritance: yes The amount of space to leave before the paragraph. See also | GroupBase | ||
| Type: Number Format: length CSS Inheritance: yes The amount to indent the paragraph's start edge. See also | GroupBase | ||
| Type: String CSS Inheritance: yes The rendering mode used for this text which applies only to embedded fonts. See also | GroupBase | ||
| 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: uint Format: Color CSS Inheritance: yes Theme: spark Color of the highlights when the mouse is over the component. | GroupBase | ||
separatorAffordance | Type: Number Format: Length CSS Inheritance: no Horizontal space on either side of a column separator that's considered to be part of the separator for the sake of mouse event dispatching. Separators are often just one pixel wide which makes interacting with them difficult.
This value is used by 5. | GridColumnHeaderGroup | ||
| 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, mobile Color of any symbol of a component. | GroupBase | ||
| Type: String CSS Inheritance: yes Specifies the tab stops associated with the paragraph. See also | GroupBase | ||
| Type: String CSS Inheritance: yes Alignment of text within a container. See also | GroupBase | ||
| Type: String CSS Inheritance: yes Alignment of the last line in the paragraph relative to the container in justified text. See also | GroupBase | ||
| Type: Number CSS Inheritance: yes Alpha (transparency) value for the text. See also | GroupBase | ||
| Type: String CSS Inheritance: yes Determines whether the text is underlined. See also | GroupBase | ||
| Type: Number Format: Length CSS Inheritance: yes Offset of first line of text from the left side of the container. See also | GroupBase | ||
| Type: String CSS Inheritance: yes Specifies options for justifying text. See also | GroupBase | ||
| Type: String CSS Inheritance: yes Determines the number of degrees to rotate this text. See also | GroupBase | ||
| Type: Number CSS Inheritance: yes Theme: mobile Alpha of text shadows. | Group | ||
| Type: uint Format: Color CSS Inheritance: yes Theme: mobile Color of text shadows. | Group | ||
| 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: Number Format: Time CSS Inheritance: yes When in touch interaction mode, the number of milliseconds to wait after the user interaction has occured before showing the component in a visually down state. | GroupBase | ||
| Type: Object CSS Inheritance: yes The amount of tracking (manual kerning) to be applied to the left of each character. See also | GroupBase | ||
| Type: Object CSS Inheritance: yes The amount of tracking (manual kerning) to be applied to the right of each character. See also | GroupBase | ||
| Type: String CSS Inheritance: yes The type of typographic case used for this text. See also | GroupBase | ||
| Type: uint Format: Color CSS Inheritance: yes The color of text when the component is enabled but does not have focus. | GroupBase | ||
| 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 | ||
| Type: String CSS Inheritance: yes Collapses or preserves whitespace when importing text into a TextFlow. See also | GroupBase | ||
| Type: Object CSS Inheritance: yes Specifies the spacing between words to use during justification. See also | GroupBase | ||
| columnSeparator | property |
columnSeparator:IFactory| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4.5 |
| Runtime Versions : | Flash Player 10, AIR 2.0 |
A visual element that's displayed between each column.
The default value is null.
This property can be used as the source for data binding.
public function get columnSeparator():IFactory public function set columnSeparator(value:IFactory):void| dataGrid | property |
dataGrid:DataGrid| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4.5 |
| Runtime Versions : | Flash Player 10, AIR 2.0 |
The DataGrid control that defines the column layout and
horizontal scroll position for this component.
This property is set by the DataGrid control after
its grid skin part has been added.
The default value is null.
This property can be used as the source for data binding.
public function get dataGrid():DataGrid public function set dataGrid(value:DataGrid):void| downColumnIndex | property |
downColumnIndex:int| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4.5 |
| Runtime Versions : | Flash Player 10, AIR 2.0 |
Specifies the column index of the header renderer currently being pressed down by the user.
Setting downColumnIndex to -1 (the default) means
that the column index is undefined, and the header renderer has
its down property set to false.
The default value is -1.
This property can be used as the source for data binding.
public function get downColumnIndex():int public function set downColumnIndex(value:int):void| headerRenderer | property |
headerRenderer:IFactory| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4.5 |
| Runtime Versions : | Flash Player 10, AIR 2.0 |
The IGridItemRenderer class used to renderer each column header.
The default value is null.
This property can be used as the source for data binding.
public function get headerRenderer():IFactory public function set headerRenderer(value:IFactory):void| highlightSelectedColumn | property |
highlightSelectedColumn:Boolean| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4.5 |
| Runtime Versions : | Flash Player 10, AIR 2.0 |
The DefaultGridHeaderRenderer only highlights the selected column when selectedColumnIndex is valid and highlightSelectedColumn is true. If this property is set to true and the selectedColumnIndex is -1, then the selectedColumnIndex is set to the hoverColumnIndex, and if that's -1, then the first visible column.
The default value is false.
This property can be used as the source for data binding.
public function get highlightSelectedColumn():Boolean public function set highlightSelectedColumn(value:Boolean):void| hoverColumnIndex | property |
hoverColumnIndex:int| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4.5 |
| Runtime Versions : | Flash Player 10, AIR 2.0 |
Specifies the column index of the header renderer currently being hovered over by the user.
Setting hoverColumnIndex to -1, the default, means that
the column index is undefined, and the header renderer has its
hovered property set to false.
The default value is -1.
This property can be used as the source for data binding.
public function get hoverColumnIndex():int public function set hoverColumnIndex(value:int):void| selectedColumnIndex | property |
selectedColumnIndex:int| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4.5 |
| Runtime Versions : | Flash Player 10, AIR 2.0 |
Specifies the column index of the header renderer currently selected by the user. The selected property of the header renderer for selectedColumnIndex will be true and false for all other header renderers.
Setting selectedColumnIndex to -1, the default, means that no column is selected and selected property for all header renderers will be false.
The default value is -1.
This property can be used as the source for data binding.
public function get selectedColumnIndex():int public function set selectedColumnIndex(value:int):void| visibleSortIndicatorIndices | property |
visibleSortIndicatorIndices:Vector.<int>| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4.5 |
| Runtime Versions : | Flash Player 10, AIR 2.0 |
A vector of column indices corresponding to the header renderers which currently have their sort indicators visible.
The default value is an empty Vector.<int>.
This property can be used as the source for data binding.
public function get visibleSortIndicatorIndices():Vector.<int> public function set visibleSortIndicatorIndices(value:Vector.<int>):void| GridColumnHeaderGroup | () | Constructor |
public function GridColumnHeaderGroup()| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4.5 |
| Runtime Versions : | Flash Player 10, AIR 2.0 |
Constructor.
| configureGridColumnHeaderViews | () | method |
public function configureGridColumnHeaderViews():voidCreate and/or configure the GridColumnHeaderViews. We're assuming that the DataGrid's GridViews have already been created.
| getHeaderBounds | () | method |
public function getHeaderBounds(columnIndex:int):Rectangle| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4.5 |
| Runtime Versions : | Flash Player 10, AIR 2.0 |
Returns the current pixel bounds of the specified header (renderer), or null if no such column exists. Header bounds are reported in GridColumnHeaderGroup coordinates.
If all of the visible columns preceding the specified column have not
yet been scrolled into view, the returned bounds may only be an approximation,
based on all of the Grid's typicalItems.
Parameters
columnIndex:int — The 0-based index of the column.
|
Rectangle — A Rectangle that represents the column header's pixel bounds, or null.
|
| getHeaderIndexAt | () | method |
public function getHeaderIndexAt(x:Number, y:Number):int| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4.5 |
| Runtime Versions : | Flash Player 10, AIR 2.0 |
Returns the column index corresponding to the specified coordinates, or -1 if the coordinates are out of bounds. The coordinates are resolved with respect to the GridColumnHeaderGroup layout target.
If all of the columns or rows for the grid have not yet been scrolled
into view, the returned index may only be an approximation,
based on the typicalItem property of all columns.
Parameters
x:Number — The pixel's x coordinate relative to the columnHeaderGroup.
| |
y:Number — The pixel's y coordinate relative to the columnHeaderGroup.
|
int — the index of the column or -1 if the coordinates are out of bounds.
|
| getHeaderRendererAt | () | method |
public function getHeaderRendererAt(columnIndex:int):IGridItemRenderer| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4.5 |
| Runtime Versions : | Flash Player 10, AIR 2.0 |
If the requested header renderer is visible, returns a reference to the header renderer currently displayed for the specified column. Note that once the returned header renderer is no longer visible it may be recycled and its properties reset.
If the requested header renderer is not visible then, each time this method is called, a new header renderer is created. The new item renderer is not visible
The width of the returned renderer is the same as for item renderers returned by DataGrid/getItemRendererAt().
Parameters
columnIndex:int — The 0-based column index of the header renderer's column.
|
IGridItemRenderer — The item renderer or null if the column index is invalid.
|
| getSeparatorIndexAt | () | method |
public function getSeparatorIndexAt(x:Number, y:Number):int| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4.5 |
| Runtime Versions : | Flash Player 10, AIR 2.0 |
Returns the column separator index corresponding to the specified coordinates, or -1 if the coordinates don't overlap a separator. The coordinates are resolved with respect to the GridColumnHeaderGroup layout target.
A separator is considered to "overlap" the specified location if the
x coordinate is within separatorMouseWidth of separator's
horizontal midpoint.
The separator index is the same as the index of the column on the left,
assuming that this component's layoutDirection is "ltr".
That means all column headers are flanked by two separators, except for the first
visible column, which just has a separator on the right, and the last visible
column, which just has a separator on the left.
If all of the columns or rows for the grid have not yet been scrolled
into view, the returned index may only be an approximation,
based on the typicalItem property of all columns.
Parameters
x:Number — The pixel's x coordinate relative to the columnHeaderGroup.
| |
y:Number — The pixel's y coordinate relative to the columnHeaderGroup.
|
int — the index of the column or -1 if the coordinates don't overlap a separator.
|
| isSortIndicatorVisible | () | method |
public function isSortIndicatorVisible(columnIndex:int):Boolean| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4.5 |
| Runtime Versions : | Flash Player 10, AIR 2.0 |
Returns true if the sort indicator for the specified column
is visible.
This is just a more efficient version of:
visibleSortIndicatorIndices.indexOf(columnIndex) != -1
Parameters
columnIndex:int — The 0-based column index of the header renderer's column.
|
Boolean — true if the sort indicator for the specified column
is visible.
|
| gridClick | Event |
spark.events.GridEventspark.events.GridEvent.GRID_CLICK| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4.5 |
| Runtime Versions : | Flash Player 10, AIR 2.0 |
Dispatched when the mouse is clicked over a column header.
The value of thetype property for a gridClick GridEvent.
The properties of the event object have the following values:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget. |
column | The column where the event occurred, or null if the event did not occur over a column. |
columnIndex | The index of the column where the event occurred, or -1 if the event did not occur over a grid column. |
grid | The Grid associated with this event. |
item | The data provider item for this row, or null if the event did not occur over a grid row. |
itemRenderer | The The item renderer that displayed this cell, or null if the event did not occur over a visible cell. |
rowIndex | The index of the row where the event occurred, or -1 if the event did not occur over a grid row. |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
type | GirdEvent.GRID_CLICK |
| gridDoubleClick | Event |
spark.events.GridEventspark.events.GridEvent.GRID_DOUBLE_CLICK| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4.5 |
| Runtime Versions : | Flash Player 10, AIR 2.0 |
Dispatched when the mouse is double-clicked over a column header.
The value of thetype property for a gridDoubleClick GridEvent.
The properties of the event object have the following values:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget. |
column | The column where the event occurred, or null if the event did not occur over a column. |
columnIndex | The index of the column where the event occurred, or -1 if the event did not occur over a grid column. |
grid | The Grid associated with this event. |
item | The data provider item for this row, or null if the event did not occur over a grid row. |
itemRenderer | The The item renderer that displayed this cell, or null if the event did not occur over a visible cell. |
rowIndex | The index of the row where the event occurred, or -1 if the event did not occur over a grid row. |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
type | GirdEvent.GRID_DOUBLE_CLICK |
| gridMouseDown | Event |
spark.events.GridEventspark.events.GridEvent.GRID_MOUSE_DOWN| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4.5 |
| Runtime Versions : | Flash Player 10, AIR 2.0 |
Dispatched when the mouse button is pressed over a column header.
The value of thetype property for a gridMouseDown GridEvent.
The properties of the event object have the following values:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget. |
column | The column where the event occurred, or null if the event did not occur over a column. |
columnIndex | The index of the column where the event occurred, or -1 if the event did not occur over a grid column. |
grid | The Grid associated with this event. |
item | The data provider item for this row, or null if the event did not occur over a grid row. |
itemRenderer | The The item renderer that displayed this cell, or null if the event did not occur over a visible cell. |
rowIndex | The index of the row where the event occurred, or -1 if the event did not occur over a grid row. |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
type | GirdEvent.GRID_MOUSE_DOWN |
| gridMouseDrag | Event |
spark.events.GridEventspark.events.GridEvent.GRID_MOUSE_DRAG| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4.5 |
| Runtime Versions : | Flash Player 10, AIR 2.0 |
Dispatched after a gridMouseDown event
if the mouse moves before the button is released.
type property for a gridMouseDrag GridEvent.
This event is only dispatched when a listener has handled a mouseDown event,
and then only while the mouse moves with the button held down.
The properties of the event object have the following values:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget. |
column | The column where the event occurred, or null if the event did not occur over a column. |
columnIndex | The index of the column where the event occurred, or -1 if the event did not occur over a grid column. |
grid | The Grid associated with this event. |
item | The data provider item for this row, or null if the event did not occur over a grid row. |
itemRenderer | The The item renderer that displayed this cell, or null if the event did not occur over a visible cell. |
rowIndex | The index of the row where the event occurred, or -1 if the event did not occur over a grid row. |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
type | GirdEvent.GRID_MOUSE_DRAG |
| gridMouseUp | Event |
spark.events.GridEventspark.events.GridEvent.GRID_MOUSE_UP| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4.5 |
| Runtime Versions : | Flash Player 10, AIR 2.0 |
Dispatched after a gridMouseDown event
when the mouse button is released, even
if the mouse is no longer within the GridColumnHeaderGroup.
type property for a gridMouseUp GridEvent.
The properties of the event object have the following values:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget. |
column | The column where the event occurred, or null if the event did not occur over a column. |
columnIndex | The index of the column where the event occurred, or -1 if the event did not occur over a grid column. |
grid | The Grid associated with this event. |
item | The data provider item for this row, or null if the event did not occur over a grid row. |
itemRenderer | The The item renderer that displayed this cell, or null if the event did not occur over a visible cell. |
rowIndex | The index of the row where the event occurred, or -1 if the event did not occur over a grid row. |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
type | GirdEvent.GRID_MOUSE_UP |
| gridRollOut | Event |
spark.events.GridEventspark.events.GridEvent.GRID_ROLL_OUT| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4.5 |
| Runtime Versions : | Flash Player 10, AIR 2.0 |
Dispatched when the mouse leaves a column header.
The value of thetype property for a gridRollOut GridEvent.
The properties of the event object have the following values:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget. |
column | The column where the event occurred, or null if the event did not occur over a column. |
columnIndex | The index of the column where the event occurred, or -1 if the event did not occur over a grid column. |
grid | The Grid associated with this event. |
item | The data provider item for this row, or null if the event did not occur over a grid row. |
itemRenderer | The The item renderer that displayed this cell, or null if the event did not occur over a visible cell. |
rowIndex | The index of the row where the event occurred, or -1 if the event did not occur over a grid row. |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
type | GirdEvent.GRID_ROLL_OUT |
| gridRollOver | Event |
spark.events.GridEventspark.events.GridEvent.GRID_ROLL_OVER| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4.5 |
| Runtime Versions : | Flash Player 10, AIR 2.0 |
Dispatched when the mouse enters a column header.
The value of thetype property for a gridRollOver GridEvent.
The properties of the event object have the following values:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget. |
column | The column where the event occurred, or null if the event did not occur over a column. |
columnIndex | The index of the column where the event occurred, or -1 if the event did not occur over a grid column. |
grid | The Grid associated with this event. |
item | The data provider item for this row, or null if the event did not occur over a grid row. |
itemRenderer | The The item renderer that displayed this cell, or null if the event did not occur over a visible cell. |
rowIndex | The index of the row where the event occurred, or -1 if the event did not occur over a grid row. |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
type | GirdEvent.GRID_ROLL_OVER |
| separatorClick | Event |
spark.events.GridEventspark.events.GridEvent.SEPARATOR_CLICK| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4.5 |
| Runtime Versions : | Flash Player 10, AIR 2.0 |
Dispatched when the mouse is clicked over a column header separator.
The value of thetype property for a separatorClick GridEvent.
The properties of the event object have the following values:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget. |
column | The column where the event occurred, or null if the event did not occur over a column. |
columnIndex | The index of the column where the event occurred, or -1 if the event did not occur over a grid column. |
grid | The Grid associated with this event. |
item | The data provider item for this row, or null if the event did not occur over a grid row. |
itemRenderer | The The item renderer that displayed this cell, or null if the event did not occur over a visible cell. |
rowIndex | The index of the row where the event occurred, or -1 if the event did not occur over a grid row. |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
type | GirdEvent.SEPARATOR_CLICK |
| separatorDoubleClick | Event |
spark.events.GridEventspark.events.GridEvent.SEPARATOR_DOUBLE_CLICK| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4.5 |
| Runtime Versions : | Flash Player 10, AIR 2.0 |
Dispatched when the mouse is double-clicked over a column header separator.
The value of thetype property for a separatorDoubleClick GridEvent.
The properties of the event object have the following values:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget. |
column | The column where the event occurred, or null if the event did not occur over a column. |
columnIndex | The index of the column where the event occurred, or -1 if the event did not occur over a grid column. |
grid | The Grid associated with this event. |
item | The data provider item for this row, or null if the event did not occur over a grid row. |
itemRenderer | The The item renderer that displayed this cell, or null if the event did not occur over a visible cell. |
rowIndex | The index of the row where the event occurred, or -1 if the event did not occur over a grid row. |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
type | GirdEvent.SEPARATOR_DOUBLE_CLICK |
| separatorMouseDrag | Event |
spark.events.GridEventspark.events.GridEvent.SEPARATOR_MOUSE_DRAG| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4.5 |
| Runtime Versions : | Flash Player 10, AIR 2.0 |
Dispatched after a separatorMouseDown event
if the mouse moves before the button is released.
type property for a separatorMouseDrag GridEvent.
The properties of the event object have the following values:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget. |
column | The column where the event occurred, or null if the event did not occur over a column. |
columnIndex | The index of the column where the event occurred, or -1 if the event did not occur over a grid column. |
grid | The Grid associated with this event. |
item | The data provider item for this row, or null if the event did not occur over a grid row. |
itemRenderer | The The item renderer that displayed this cell, or null if the event did not occur over a visible cell. |
rowIndex | The index of the row where the event occurred, or -1 if the event did not occur over a grid row. |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
type | GirdEvent.SEPARATOR_MOUSE_DRAG |
| separatorMouseUp | Event |
spark.events.GridEventspark.events.GridEvent.SEPARATOR_MOUSE_UP| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4.5 |
| Runtime Versions : | Flash Player 10, AIR 2.0 |
Dispatched after a separatorMouseDown event
when the mouse button is released, even if the mouse is
no longer within the separator affordance.
type property for a separatorMouseUp GridEvent.
The properties of the event object have the following values:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget. |
column | The column where the event occurred, or null if the event did not occur over a column. |
columnIndex | The index of the column where the event occurred, or -1 if the event did not occur over a grid column. |
grid | The Grid associated with this event. |
item | The data provider item for this row, or null if the event did not occur over a grid row. |
itemRenderer | The The item renderer that displayed this cell, or null if the event did not occur over a visible cell. |
rowIndex | The index of the row where the event occurred, or -1 if the event did not occur over a grid row. |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
type | GirdEvent.SEPARATOR_MOUSE_UP |
| separatorRollOut | Event |
spark.events.GridEventspark.events.GridEvent.SEPARATOR_ROLL_OUT| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4.5 |
| Runtime Versions : | Flash Player 10, AIR 2.0 |
Dispatched when the mouse leaves the area defined by a column
separator and separatorMouseWidth.
type property for a separatorRollOut GridEvent.
The properties of the event object have the following values:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget. |
column | The column where the event occurred, or null if the event did not occur over a column. |
columnIndex | The index of the column where the event occurred, or -1 if the event did not occur over a grid column. |
grid | The Grid associated with this event. |
item | The data provider item for this row, or null if the event did not occur over a grid row. |
itemRenderer | The The item renderer that displayed this cell, or null if the event did not occur over a visible cell. |
rowIndex | The index of the row where the event occurred, or -1 if the event did not occur over a grid row. |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
type | GirdEvent.SEPARATOR_ROLL_OUT |
| separatorRollOver | Event |
spark.events.GridEventspark.events.GridEvent.SEPARATOR_ROLL_OVER| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4.5 |
| Runtime Versions : | Flash Player 10, AIR 2.0 |
Dispatched when the mouse enters the area defined by a column
separator and separatorMouseWidth.
type property for a separatorRollOver GridEvent.
The properties of the event object have the following values:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget. |
column | The column where the event occurred, or null if the event did not occur over a column. |
columnIndex | The index of the column where the event occurred, or -1 if the event did not occur over a grid column. |
grid | The Grid associated with this event. |
item | The data provider item for this row, or null if the event did not occur over a grid row. |
itemRenderer | The The item renderer that displayed this cell, or null if the event did not occur over a visible cell. |
rowIndex | The index of the row where the event occurred, or -1 if the event did not occur over a grid row. |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
type | GirdEvent.SEPARATOR_ROLL_OVER |