| Package | mx.controls.dataGridClasses |
| Class | public class DataGridBase |
| Inheritance | DataGridBase  ListBase ScrollControlBase UIComponent FlexSprite Sprite DisplayObjectContainer InteractiveObject DisplayObject EventDispatcher Object |
| Implements | IFontContextComponent |
| Subclasses | DataGrid |
| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Show MXML Syntax
Hide MXML SyntaxThe DataGridBase class inherits all the properties of its parent classes and adds the following properties:
<mx:tagname
headerHeight="depends on styles and header renderer"
showHeaders="true|false"
/>
Public Properties
| 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 | |
| accessibilityImplementation : AccessibilityImplementation
The current accessibility implementation (AccessibilityImplementation)
for this InteractiveObject instance. | InteractiveObject | |
| accessibilityName : String
A convenience accessor for the name property
in this UIComponent's accessibilityProperties object. | UIComponent | |
| accessibilityProperties : AccessibilityProperties
The current accessibility options for this display object. | DisplayObject | |
| 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 | |
| allowDragSelection : Boolean = false
A flag that indicates whether drag-selection is enabled. | ListBase | |
| allowMultipleSelection : Boolean
A flag that indicates whether you can allow more than one item to be
selected at the same time. | ListBase | |
| alpha : Number
Indicates the alpha transparency value of the object specified. | DisplayObject | |
| 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 [read-only]
The y-coordinate of the baseline
of the first line of text of the component. | UIComponent | |
| blendMode : String
A value from the BlendMode class that specifies which blend mode to use. | DisplayObject | |
| blendShader : Shader [write-only]
Sets a shader that is used for blending the foreground and background. | DisplayObject | |
| borderMetrics : EdgeMetrics [read-only]
Returns an EdgeMetrics object that has four properties:
left, top, right,
and bottom. | ScrollControlBase | |
| bottom : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| buttonMode : Boolean
Specifies the button mode of this sprite. | Sprite | |
| cacheAsBitmap : Boolean
If set to true, Flash runtimes cache an internal bitmap representation of the
display object. | DisplayObject | |
| cacheAsBitmapMatrix : Matrix
If non-null, this Matrix object defines how a display object is rendered when
cacheAsBitmap is set to true. | DisplayObject | |
| 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 | |
| columnCount : int
The number of columns to be displayed in a TileList control or items
in a HorizontalList control. | ListBase | |
| columnWidth : Number
The width of the control's columns. | ListBase | |
| constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| 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 | |
| contextMenu : NativeMenu
Specifies the context menu associated with this object. | InteractiveObject | |
| 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 | |
| data : Object
The item in the data provider this component should render when
this component is used as an item renderer or item editor. | ListBase | |
| dataProvider : Object
Set of data to be viewed. | ListBase | |
| dataTipField : String
Name of the field in the data provider items to display as the
data tip. | ListBase | |
| dataTipFunction : Function
User-supplied function to run on each item to determine its dataTip. | ListBase | |
| 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 | |
| dragEnabled : Boolean
A flag that indicates whether you can drag items out of
this control and drop them on other controls. | ListBase | |
| dragMoveEnabled : Boolean
A flag that indicates whether items can be moved instead
of just copied from the control as part of a drag-and-drop
operation. | ListBase | |
| dropEnabled : Boolean
A flag that indicates whether dragged items can be dropped onto the
control. | ListBase | |
| dropTarget : DisplayObject [read-only]
Specifies the display object over which the sprite is being dragged, or on
which the sprite was dropped. | Sprite | |
| 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 | |
| filters : Array
An indexed array that contains each filter object currently associated with the display object. | DisplayObject | |
| 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 | |
| focusRect : Object
Specifies whether this object displays a focus rectangle. | InteractiveObject | |
| fontContext : IFlexModuleFactory
The module factory that provides the font context for this component. | DataGridBase | ||
| graphics : Graphics [read-only]
Specifies the Graphics object that belongs to this sprite where vector
drawing commands can occur. | Sprite | |
| 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 | |
| headerHeight : Number
The height of the header cell of the column, in pixels. | DataGridBase | ||
| height : Number [override]
Number that specifies the height of the component, in pixels,
in the parent's coordinates. | UIComponent | |
| hitArea : Sprite
Designates another sprite to serve as the hit area for a sprite. | Sprite | |
| horizontalCenter : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| horizontalScrollPolicy : String
A property that indicates whether the horizontal scroll
bar is always on, always off,
or automatically changes based on the parameters passed to the
setScrollBarProperties() method. | ScrollControlBase | |
| horizontalScrollPosition : Number
The offset into the content from the left edge. | ScrollControlBase | |
| iconField : String
The name of the field in the data provider object that determines what to
display as the icon. | ListBase | |
| iconFunction : Function
A user-supplied function to run on each item to determine its icon. | ListBase | |
| 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 | |
| itemRenderer : IFactory
The custom item renderer for the control. | ListBase | |
| labelField : String
The name of the field in the data provider items to display as the label. | ListBase | |
| labelFunction : Function
A user-supplied function to run on each item to determine its label. | ListBase | |
| 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 | |
| listData : BaseListData
When a component is used as a drop-in item renderer or drop-in
item editor, Flex initializes the listData property
of the component with the additional data from the list control. | ListBase | |
| liveScrolling : Boolean = true
A flag that indicates whether scrolling is live as the
scrollbar thumb is moved
or the view is not updated until the thumb is released. | ScrollControlBase | |
| loaderInfo : LoaderInfo [read-only]
Returns a LoaderInfo object containing information about loading the file
to which this display object belongs. | DisplayObject | |
| lockedColumnCount : int
The index of the first column in the control that scrolls. | DataGridBase | ||
| lockedRowCount : int
The index of the first row in the control that scrolls. | DataGridBase | ||
| maintainProjectionCenter : Boolean
When true, the component keeps its projection matrix centered on the
middle of its bounding box. | UIComponent | |
| mask : DisplayObject
The calling display object is masked by the specified mask object. | DisplayObject | |
| maxHeight : Number
The maximum recommended height of the component to be considered
by the parent during layout. | UIComponent | |
| maxHorizontalScrollPosition : Number
The maximum value for the horizontalScrollPosition property. | ScrollControlBase | |
| maxVerticalScrollPosition : Number
The maximum value for the verticalScrollPosition property. | ScrollControlBase | |
| 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 | |
| menuSelectionMode : Boolean = false
A flag that indicates whether menu-style selection
should be used. | ListBase | |
| metaData : Object
Obtains the meta data object of the DisplayObject instance if meta data was stored alongside the
the instance of this DisplayObject in the SWF file through a PlaceObject4 tag. | DisplayObject | |
| 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 | |
| mouseChildren : Boolean
Determines whether or not the children of the object are mouse, or user input device, enabled. | DisplayObjectContainer | |
| mouseEnabled : Boolean
Specifies whether this object receives mouse, or other user input, messages. | InteractiveObject | |
| mouseFocusEnabled : Boolean
Whether you can receive focus when clicked on. | UIComponent | |
| mouseX : Number [read-only]
Indicates the x coordinate of the mouse or user input device position, in pixels. | DisplayObject | |
| mouseY : Number [read-only]
Indicates the y coordinate of the mouse or user input device position, in pixels. | DisplayObject | |
| name : String
Indicates the instance name of the DisplayObject. | DisplayObject | |
| needsSoftKeyboard : Boolean
Specifies whether a virtual keyboard (an on-screen, software keyboard) should display
when this InteractiveObject instance receives focus. | InteractiveObject | |
| 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 | |
| nullItemRenderer : IFactory
The custom item renderer for the control. | ListBase | |
| numAutomationChildren : int [read-only]
The number of automation children this container has. | UIComponent | |
| numChildren : int [read-only]
Returns the number of children of this object. | DisplayObjectContainer | |
| offscreenExtraRowsOrColumns : int
The target number of extra rows or columns of item renderers to be used
in the layout of the control. | ListBase | |
| opaqueBackground : Object
Specifies whether the display object is opaque with a certain background color. | DisplayObject | |
| 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 : mx.geom: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 | |
| right : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| root : DisplayObject [read-only]
For a display object in a loaded SWF file, the root property is the
top-most display object in the portion of the display list's tree structure represented by that SWF file. | DisplayObject | |
| rotation : Number [override]
Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation. | 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]
Indicates the z-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container. | UIComponent | |
| rowCount : int
Number of rows to be displayed. | ListBase | |
| rowHeight : Number
The height of the rows in pixels. | ListBase | |
| scale9Grid : Rectangle
The current scaling grid that is in effect. | DisplayObject | |
| 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 | |
| scrollRect : Rectangle
The scroll rectangle bounds of the display object. | DisplayObject | |
| scrollTipFunction : Function
A function that computes the string to be displayed as the ScrollTip. | ScrollControlBase | |
| selectable : Boolean
A flag that indicates whether the list shows selected items
as selected. | ListBase | |
| selectedIndex : int
The index in the data provider of the selected item. | ListBase | |
| selectedIndices : Array
An array of indices in the data provider of the selected items. | ListBase | |
| selectedItem : Object
A reference to the selected item in the data provider. | ListBase | |
| selectedItems : Array
An array of references to the selected items in the data provider. | ListBase | |
| selectedItemsCompareFunction : Function
A function used to compare items in the selectedItems property
against items in the data provider. | ListBase | |
| showDataTips : Boolean
A flag that indicates whether dataTips are displayed for text in the rows. | ListBase | |
| showHeaders : Boolean
A flag that indicates whether the control should show
column headers. | DataGridBase | ||
| showInAutomationHierarchy : Boolean
A flag that determines if an automation object
shows in the automation hierarchy. | UIComponent | |
| showScrollTips : Boolean = false
A flag that indicates whether a tooltip should appear
near the scroll thumb when it is being dragged. | ScrollControlBase | |
| softKeyboard : String
Controls the appearance of the soft keyboard. | InteractiveObject | |
| softKeyboardInputAreaOfInterest : Rectangle
Defines the area that should remain on-screen when a soft keyboard is displayed (not available on iOS). | InteractiveObject | |
| soundTransform : flash.media:SoundTransform
Controls sound within this sprite. | Sprite | |
| stage : Stage [read-only]
The Stage of the display object. | DisplayObject | |
| 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 | |
| tabChildren : Boolean
Determines whether the children of the object are tab enabled. | DisplayObjectContainer | |
| tabEnabled : Boolean
Specifies whether this object is in the tab order. | InteractiveObject | |
| 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 | |
| tabIndex : int
Specifies the tab ordering of objects in a SWF file. | InteractiveObject | |
| textSnapshot : flash.text:TextSnapshot [read-only]
Returns a TextSnapshot object for this DisplayObjectContainer instance. | DisplayObjectContainer | |
| 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 : flash.geom: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 | |
| useHandCursor : Boolean
A Boolean value that indicates whether the pointing hand (hand cursor) appears when the pointer rolls
over a sprite in which the buttonMode property is set to true. | Sprite | |
| validationSubField : String
Used by a validator to associate a subfield with this component. | UIComponent | |
| value : Object [read-only]
The selected item, or the data or label field of the selected item. | ListBase | |
| variableRowHeight : Boolean
A flag that indicates whether the individual rows can have different
height. | ListBase | |
| verticalCenter : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| verticalScrollPolicy : String
A property that indicates whether the vertical scroll bar is always on, always off,
or automatically changes based on the parameters passed to the
setScrollBarProperties() method. | ScrollControlBase | |
| verticalScrollPosition : Number
The offset into the content from the top edge. | ScrollControlBase | |
| viewMetrics : EdgeMetrics [read-only]
An EdgeMetrics object taking into account the scroll bars,
if visible. | ScrollControlBase | |
| visible : Boolean [override]
Whether or not the display object is visible. | UIComponent | |
| width : Number [override]
Number that specifies the width of the component, in pixels,
in the parent's coordinates. | UIComponent | |
| wordWrap : Boolean
A flag that indicates whether text in the row should be word wrapped. | ListBase | |
| 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]
Indicates the z coordinate position along the z-axis of the DisplayObject
instance relative to the 3D parent container. | UIComponent | |
Protected Properties
| Property | Defined By | ||
|---|---|---|---|
| actualCollection : ICollectionView
A copy of the value normally stored in collection
used while running data changes effects. | ListBase | |
| actualIterator : IViewCursor
A copy of the value normally stored in iterator
used while running data changes effects. | ListBase | |
| allowItemSizeChangeNotification : Boolean [write-only]
If false, renderers cannot invalidate size of List. | ListBase | |
| anchorBookmark : CursorBookmark
A bookmark to the item that is the anchor. | ListBase | |
| anchorIndex : int = -1
The offset of the item in the data provider that is the selection
anchor point. | ListBase | |
| border : IFlexDisplayObject
The border object. | ScrollControlBase | |
| cachedItemsChangeEffect : IEffect = null
The effect that plays when changes occur in the data
provider for the control, set through the itemsChangeEffect
style. | ListBase | |
| caretBookmark : CursorBookmark
A bookmark to the item under the caret. | ListBase | |
| caretIndex : int = -1
The offset of the item in the data provider that is the selection
caret point. | ListBase | |
| caretIndicator : Sprite
The DisplayObject that contains the graphics that indicate
which renderer is the caret. | ListBase | |
| caretItemRenderer : IListItemRenderer
The renderer for the item under the caret. | ListBase | |
| caretUID : String
The UID of the item under the caret. | ListBase | |
| collection : ICollectionView
An ICollectionView that represents the data provider. | ListBase | |
| columnCaretIndicator : Sprite
The DisplayObject that contains the graphics that indicates
which renderer is the caret for lockedColumns. | DataGridBase | ||
| columnHighlightIndicator : Sprite
The DisplayObject that contains the graphics that indicates
which renderer is highlighted for lockedColumns. | DataGridBase | ||
| columnMap : Object
A map of item renderes to columns. | DataGridBase | ||
| currentCSSState : String [read-only]
The state to be used when matching CSS pseudo-selectors. | UIComponent | |
| dataEffectCompleted : Boolean = false
A flag that indicates that the a data change effect has
just completed. | ListBase | |
| dataItemWrappersByRenderer : Dictionary
A dictionary mapping item renderers to the ItemWrappers
used to supply their data. | ListBase | |
| defaultColumnCount : int = 4
The default number of columns to display. | ListBase | |
| defaultRowCount : int = 4
The default number of rows to display. | ListBase | |
| dragImage : IUIComponent [read-only]
Gets an instance of a class that displays the visuals
during a drag and drop operation. | ListBase | |
| dragImageOffsets : Point [read-only]
Gets the offset of the drag image for drag and drop. | ListBase | |
| explicitColumnCount : int = -1
The column count requested by explicitly setting the
columnCount property. | ListBase | |
| explicitColumnWidth : Number
The column width requested by explicitly setting the
columnWidth. | ListBase | |
| explicitRowCount : int = -1
The row count requested by explicitly setting
rowCount. | ListBase | |
| explicitRowHeight : Number
The row height requested by explicitly setting
rowHeight. | ListBase | |
| factoryMap : Dictionary
A map of item renderers by factory. | ListBase | |
| freeItemRenderers : Array
A stack of unused item renderers. | ListBase | |
| freeItemRenderersByFactory : Dictionary
A map of free item renderers by factory. | ListBase | |
| freeItemRenderersTable : Dictionary
A per-column table of unused item renderers. | DataGridBase | ||
| hasComplexLayoutMatrix : Boolean [read-only]
Returns true if the UIComponent has any non-translation (x,y) transform properties. | UIComponent | |
| header : DataGridHeaderBase
The header sub-component. | DataGridBase | ||
| headerMask : Shape
The header mask. | DataGridBase | ||
| highlightIndicator : Sprite
The DisplayObject that contains the graphics that indicates
which renderer is highlighted. | ListBase | |
| highlightItemRenderer : IListItemRenderer
The renderer that is currently rolled over or under the caret. | ListBase | |
| highlightUID : String
The UID of the item that is current rolled over or under the caret. | ListBase | |
| horizontalScrollBar : ScrollBar
The horizontal scroll bar. | ScrollControlBase | |
| itemsNeedMeasurement : Boolean = true
A flag that indicates whether the columnWidth
and rowHeight properties need to be calculated. | ListBase | |
| itemsSizeChanged : Boolean = false
A flag that indicates that the size of the renderers may have changed. | ListBase | |
| iterator : IViewCursor
The main IViewCursor used to fetch items from the
data provider and pass the items to the renderers. | ListBase | |
| iteratorValid : Boolean = true
A flag that indicates that a page fault as occurred and that
the iterator's position is not valid (not positioned at the topmost
item being displayed). | ListBase | |
| keySelectionPending : Boolean = false
A flag that indicates if keyboard selection was interrupted by
a page fault. | ListBase | |
| lastDropIndex : int
The most recently calculated index where the drag item
should be added to the drop target. | ListBase | |
| lastSeekPending : ListBaseSeekPending
The most recent seek that caused a page fault. | ListBase | |
| listContent : ListBaseContentHolder
An internal display object that parents all of the item renderers,
selection and highlighting indicators and other supporting graphics. | ListBase | |
| listContentStyleFilters : Object [read-only]
The set of styles to pass from the ListBase to the listContent. | ListBase | |
| listItems : Array [read-only]
An Array of Arrays that contains
the itemRenderer instances that render each data provider item. | ListBase | |
| lockedColumnAndRowContent : DataGridLockedRowContentHolder
The sub-component that contains locked rows for locked columns. | DataGridBase | ||
| lockedColumnContent : ListBaseContentHolder
The sub-component that contains locked columns. | DataGridBase | ||
| lockedColumnHeader : DataGridHeaderBase
The header sub-component for locked columns. | DataGridBase | ||
| lockedRowContent : DataGridLockedRowContentHolder
The sub-component that contains locked rows. | DataGridBase | ||
| maskShape : Shape
The mask. | ScrollControlBase | |
| modifiedCollectionView : ModifiedCollectionView
The collection view that temporarily preserves previous
data provider state to facilitate running data change effects. | ListBase | |
| offscreenExtraColumns : int = 0
The target number of extra columns of item renderers used in the
layout of the control. | ListBase | |
| offscreenExtraColumnsLeft : int = 0
The number of offscreen columns currently to the left of the
leftmost visible column. | ListBase | |
| offscreenExtraColumnsRight : int = 0
The number of offscreen columns currently to the right of the
right visible column. | ListBase | |
| offscreenExtraRows : int = 0
The target number of extra rows of item renderers to be used in
the layout of the control. | ListBase | |
| offscreenExtraRowsBottom : int = 0
The number of offscreen rows currently below the bottom visible
item renderer. | ListBase | |
| offscreenExtraRowsOrColumnsChanged : Boolean = false
A flag indicating that the number of offscreen rows or columns
may have changed. | ListBase | |
| offscreenExtraRowsTop : int = 0
The number of offscreen rows currently above the topmost visible
row. | ListBase | |
| rendererChanged : Boolean = false
A flag that indicates that the renderer changed. | ListBase | |
| reservedItemRenderers : Object
A hash map of currently unused item renderers that may be
used again in the near future. | ListBase | |
| resourceManager : IResourceManager [read-only]
A reference to the object which manages
all of the application's localized resources. | UIComponent | |
| rowInfo : Array [read-only]
An array of ListRowInfo objects that cache row heights and
other tracking information for the rows in listItems. | ListBase | |
| rowMap : Object
A hash map of item renderers to their respective ListRowInfo object. | ListBase | |
| runDataEffectNextUpdate : Boolean = false
A flag that indicates if a data effect should be initiated
the next time the display is updated. | ListBase | |
| runningDataEffect : Boolean = false
A flag indicating if a data change effect is currently running. | ListBase | |
| scrollAreaChanged : Boolean
A flag that the scrolling area changed due to the appearance or disappearance of
scrollbars. | ScrollControlBase | |
| selectedData : Object
A hash table of ListBaseSelectionData objects that track which
items are currently selected. | ListBase | |
| selectionIndicators : Object
A hash table of selection indicators. | ListBase | |
| selectionLayer : Sprite
The layer in listContent where all selection
and highlight indicators are drawn. | ListBase | |
| selectionTweens : Object
A hash table of selection tweens. | ListBase | |
| showCaret : Boolean
A flag that indicates whether to show caret. | ListBase | |
| unconstrainedRenderers : Dictionary
A hash map of item renderers that are not subject
to the layout algorithms of the list. | ListBase | |
| unscaledHeight : Number [read-only]
A convenience method for determining the unscaled height
of the component. | UIComponent | |
| unscaledWidth : Number [read-only]
A convenience method for determining the unscaled width
of the component
All of a component's drawing and child layout should be done
within a bounding rectangle of this width, which is also passed
as an argument to updateDisplayList(). | UIComponent | |
| verticalScrollBar : ScrollBar
The vertical scroll bar. | ScrollControlBase | |
| visibleData : Object [read-only]
A hash table of data provider item renderers currently in view. | ListBase | |
| wordWrapChanged : Boolean = false
A flag that indicates whether the value of the wordWrap
property has changed since the last time the display list was updated. | ListBase | |
Public Methods
| Method | Defined By | ||
|---|---|---|---|
Constructor. | DataGridBase | ||
|
Adds a child DisplayObject instance to this DisplayObjectContainer instance. | DisplayObjectContainer | |
|
Adds a child DisplayObject instance to this DisplayObjectContainer
instance. | DisplayObjectContainer | |
|
Adds an item renderer if a data change effect is running. | ListBase | |
| addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener
receives notification of an event. | EventDispatcher | |
|
Adds a non-visual style client to this component instance. | UIComponent | |
|
Indicates whether the security restrictions
would cause any display objects to be omitted from the list returned by calling
the DisplayObjectContainer.getObjectsUnderPoint() method
with the specified point point. | DisplayObjectContainer | |
|
Returns the index where the dropped items should be added
to the drop target. | ListBase | |
|
Queues a function to be called later. | UIComponent | |
|
Deletes a style property from this component instance. | UIComponent | |
|
Determines whether the specified display object is a child of the DisplayObjectContainer instance or
the instance itself. | DisplayObjectContainer | |
|
Converts a Point object from content coordinates to global coordinates. | UIComponent | |
|
Converts a Point object from content to local coordinates. | UIComponent | |
|
Returns a set of properties that identify the child within
this container. | UIComponent | |
|
Returns a set of properties that identify the child within
this container. | UIComponent | |
Returns the item renderer for a column cell or for a column header. | DataGridBase | ||
|
Creates an item renderer given the data object. | ListBase | |
|
Creates an id reference to this IUIComponent object
on its parent document object. | UIComponent | |
|
Deletes the id reference to this IUIComponent object
on its parent document object. | UIComponent | |
|
Returns a UITextFormat object corresponding to the text styles
for this UIComponent. | UIComponent | |
| [override]
Dispatches an event into the event flow. | UIComponent | |
|
Shows or hides the focus indicator around this component. | UIComponent | |
| drawRoundRect(x:Number, y:Number, w:Number, h:Number, r:Object = null, c:Object = null, alpha:Object = null, rot:Object = null, gradient:String = null, ratios:Array = null, hole:Object = null):void
Programmatically draws a rectangle into this skin's Graphics object. | UIComponent | |
|
Called by the effect instance when it stops playing on the component. | UIComponent | |
|
Called by the effect instance when it starts playing on the component. | UIComponent | |
|
Ends all currently playing effects on the component. | UIComponent | |
|
Executes all the bindings for which the UIComponent object is the destination. | UIComponent | |
|
Finds an item in the list based on a String,
and moves the selection to it. | ListBase | |
|
Called after printing is complete. | UIComponent | |
|
Provides the automation object at the specified index. | UIComponent | |
|
Provides the automation object list . | UIComponent | |
|
Returns a rectangle that defines the area of the display object relative to the coordinate system
of the targetCoordinateSpace object. | DisplayObject | |
|
Returns the x coordinate of the element's bounds at the specified element size. | UIComponent | |
|
Returns the y coordinate of the element's bounds at the specified element size. | UIComponent | |
|
Returns the child display object instance that exists at the specified index. | DisplayObjectContainer | |
|
Returns the child display object that exists with the specified name. | DisplayObjectContainer | |
|
Returns the index position of a child DisplayObject instance. | DisplayObjectContainer | |
|
Finds the type selectors for this UIComponent instance. | UIComponent | |
|
Returns a layout constraint value, which is the same as
getting the constraint style for this component. | UIComponent | |
|
A convenience method for determining whether to use the
explicit or measured height
| UIComponent | |
|
A convenience method for determining whether to use the
explicit or measured width
| UIComponent | |
|
Gets the object that currently has focus. | UIComponent | |
|
Return the appropriate factory, using the default factory if none specified. | ListBase | |
|
Returns the element's layout height. | UIComponent | |
|
Returns the element's layout width. | UIComponent | |
|
Returns the x coordinate that the element uses to draw on screen. | UIComponent | |
|
Returns the y coordinate that the element uses to draw on screen. | UIComponent | |
|
Returns the transform matrix that is used to calculate the component's
layout relative to its siblings. | UIComponent | |
|
Returns the layout transform Matrix3D for this element. | UIComponent | |
|
Returns the element's maximum height. | UIComponent | |
|
Returns the element's maximum width. | UIComponent | |
|
Returns the element's minimum height. | UIComponent | |
|
Returns the element's minimum width. | UIComponent | |
|
Returns an array of objects that lie under the specified point and are children
(or grandchildren, and so on) of this DisplayObjectContainer instance. | DisplayObjectContainer | |
|
Returns the element's preferred height. | UIComponent | |
|
Returns the element's preferred width. | UIComponent | |
|
Returns a rectangle that defines the boundary of the display object,
based on the coordinate system defined by the targetCoordinateSpace
parameter, excluding any strokes on shapes. | DisplayObject | |
|
Returns true or false
to indicates whether the effect should play on the target. | ListBase | |
|
Returns the item in the dataProvider that was used
by the specified Repeater to produce this Repeater, or
null if this Repeater isn't repeated. | UIComponent | |
|
Gets a style property that has been set anywhere in this
component's style lookup chain. | UIComponent | |
|
Converts a Point object from global to content coordinates. | UIComponent | |
|
Converts the point object from the Stage (global) coordinates
to the display object's (local) coordinates. | DisplayObject | |
|
Converts a two-dimensional point from the Stage (global) coordinates to a
three-dimensional display object's (local) coordinates. | DisplayObject | |
|
Returns true if currentCSSState is not null. | UIComponent | |
|
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | EventDispatcher | |
|
Indicates whether an object has a specified property defined. | Object | |
|
Determines whether the specified state has been defined on this
UIComponent. | UIComponent | |
|
Hides the drop indicator under the mouse pointer that indicates that a
drag and drop operation is allowed. | ListBase | |
|
Evaluates the bounding box of the display object to see if it overlaps or intersects with the
bounding box of the obj display object. | DisplayObject | |
|
Evaluates the display object to see if it overlaps or intersects with the
point specified by the x and y parameters. | DisplayObject | |
|
Returns a box Matrix which can be passed to the
drawRoundRect() method
as the rot parameter when drawing a horizontal gradient. | UIComponent | |
|
Get an item renderer for the index of an item in the data provider,
if one exists. | ListBase | |
|
Computes the offset into the data provider of the item
at colIndex, rowIndex. | ListBase | |
|
Initializes the internal structure of this component. | UIComponent | |
|
Initializes various properties which keep track of repeated instances
of this component. | UIComponent | |
|
Marks a component so that its updateDisplayList()
method gets called during a later screen update. | UIComponent | |
|
Called by a component's items to indicate that their depth
property has changed. | UIComponent | |
|
An element must call this method when its layoutDirection changes or
when its parent's layoutDirection changes. | UIComponent | |
|
Refresh all rows on the next update. | ListBase | |
|
Marks a component so that its commitProperties()
method gets called during a later screen update. | UIComponent | |
|
Marks a component so that its measure()
method gets called during a later screen update. | UIComponent | |
|
Determines if the item renderer for a data provider item
is highlighted (is rolled over via the mouse or under the caret due to keyboard navigation). | ListBase | |
|
Determines if the item renderer for a data provider item
is selectable. | ListBase | |
|
Determines if the item renderer for a data provider item
is selected. | ListBase | |
|
Determines if the item renderer for a data provider item
is the item under the caret due to keyboard navigation. | ListBase | |
|
Determines if an item is being displayed by a renderer. | ListBase | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Determines whether a renderer contains (or owns) a display object. | ListBase | |
|
Returns the index of the item in the data provider of the item
being rendered by this item renderer. | ListBase | |
|
Returns the dataTip string the renderer would display for the given
data object based on the dataTipField and dataTipFunction properties. | ListBase | |
|
Returns the class for an icon, if any, for a data item,
based on the iconField and iconFunction properties. | ListBase | |
|
Returns the item renderer for a given item in the data provider,
if there is one. | ListBase | |
|
Returns the string the renderer would display for the given data object
based on the labelField and labelFunction properties. | ListBase | |
|
Converts a three-dimensional point of the three-dimensional display
object's (local) coordinates to a two-dimensional point in the Stage (global) coordinates. | DisplayObject | |
|
Converts a Point object from local to content coordinates. | UIComponent | |
|
Converts the point object from the display object's (local) coordinates to the
Stage (global) coordinates. | DisplayObject | |
|
Returns true if cssState matches currentCSSState. | UIComponent | |
|
Determines whether this instance is the same as, or is a subclass of,
the given type. | UIComponent | |
|
Measures a set of items from the data provider using the
current item renderer and returns the sum of the heights
of those items. | ListBase | |
|
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 | |
|
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 | |
|
Measures a set of items from the data provider using
the current item renderer and returns the
maximum width found. | ListBase | |
|
Moves the component to a specified position within its parent. | UIComponent | |
|
Propagates style changes to the children. | UIComponent | |
|
Returns true if the chain of owner properties
points from child to this UIComponent. | UIComponent | |
|
Called by Flex when a UIComponent object is added to or removed from a parent. | UIComponent | |
|
Prepares an IFlexDisplayObject for printing. | UIComponent | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Builds or rebuilds the CSS style cache for this component
and, if the recursive parameter is true,
for all descendants of this component as well. | UIComponent | |
|
For each effect event, registers the EffectManager
as one of the event listeners. | UIComponent | |
|
Removes the specified child DisplayObject instance from the child list of the DisplayObjectContainer instance. | DisplayObjectContainer | |
|
Removes a child DisplayObject from the specified index position in the child list of
the DisplayObjectContainer. | DisplayObjectContainer | |
|
Removes all child DisplayObject instances from the child list of the DisplayObjectContainer instance. | DisplayObjectContainer | |
|
Removes an item renderer if a data change effect is running. | ListBase | |
|
Removes a listener from the EventDispatcher object. | EventDispatcher | |
|
Removes a non-visual style client from this component instance. | UIComponent | |
|
Replays the specified event. | UIComponent | |
|
Raises a virtual keyboard. | InteractiveObject | |
|
Resolves a child by using the id provided. | UIComponent | |
| [static]
Resumes the background processing of methods
queued by callLater(), after a call to
suspendBackgroundProcessing(). | UIComponent | |
|
Ensures that the data provider item at the given index is visible. | ListBase | |
|
Sizes the object. | UIComponent | |
|
Changes the position of an existing child in the display object container. | DisplayObjectContainer | |
|
Sets a layout constraint value, which is the same as
setting the constraint style for this component. | UIComponent | |
|
Set the current state. | UIComponent | |
|
Sets the focus to this component. | UIComponent | |
|
Sets the coordinates that the element uses to draw on screen. | UIComponent | |
|
Sets the layout size of the element. | UIComponent | |
|
Sets the transform Matrix that is used to calculate the component's layout
size and position relative to its siblings. | UIComponent | |
|
Sets the transform Matrix3D that is used to calculate the component's layout
size and position relative to its siblings. | UIComponent | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Sets a style property on this component instance. | UIComponent | |
|
Called when the visible property changes. | UIComponent | |
|
Displays a drop indicator under the mouse pointer to indicate that a
drag and drop operation is allowed and where the items will
be dropped. | ListBase | |
|
Lets the user drag the specified sprite. | Sprite | |
|
Lets the user drag the specified sprite on a touch-enabled device. | Sprite | |
|
Recursively stops the timeline execution of all MovieClips rooted at this object. | DisplayObjectContainer | |
|
Ends the startDrag() method. | Sprite | |
|
Ends the startTouchDrag() method, for use with touch-enabled devices. | Sprite | |
|
Detects changes to style properties. | UIComponent | |
|
Flex calls the stylesInitialized() method when
the styles for a component are first initialized. | UIComponent | |
| [static]
Blocks the background processing of methods
queued by callLater(),
until resumeBackgroundProcessing() is called. | UIComponent | |
|
Swaps the z-order (front-to-back order) of the two specified child objects. | DisplayObjectContainer | |
|
Swaps the z-order (front-to-back order) of the child objects at the two specified index positions in the
child list. | DisplayObjectContainer | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
| [override]
Returns a string indicating the location of this object
within the hierarchy of DisplayObjects in the Application. | FlexSprite | |
| 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 | |
|
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 | |
|
Called by an UnconstrainItemAction effect
as part of a data change effect if the item renderers corresponding
to certain data items need to move outside the normal positions
of item renderers in the control. | ListBase | |
|
Validates the position and size of children and draws other
visuals. | UIComponent | |
|
Validate and update the properties and layout of this object
and redraw it, if necessary. | UIComponent | |
|
Used by layout logic to validate the properties of a component
by calling the commitProperties() method. | UIComponent | |
|
Validates the measured size of the component
If the LayoutManager.invalidateSize() method is called with
this ILayoutManagerClient, then the validateSize() method
is called when it's time to do measurements. | UIComponent | |
|
Handles both the valid and invalid events from a
validator assigned to this component. | UIComponent | |
|
Returns the primitive value of the specified object. | Object | |
|
Returns a box Matrix which can be passed to drawRoundRect()
as the rot parameter when drawing a vertical gradient. | UIComponent | |
|
Checks whether an event listener is registered with this EventDispatcher object or any of
its ancestors for the specified event type. | EventDispatcher | |
Protected Methods
| Method | Defined By | ||
|---|---|---|---|
|
Adds the selected items to the DragSource object as part of a
drag-and-drop operation. | ListBase | |
|
Adds a renderer to the recycled renderer list,
making it invisible and cleaning up references to it. | ListBase | |
|
Add a blank row to the beginning of the arrays that store references to the rows. | ListBase | |
|
Adjust the focus rectangle. | UIComponent | |
|
Called from the updateDisplayList() method to adjust the size and position of
listContent. | ListBase | |
Adjusts the size and positions of the renderers for the given rowNum, row position and height. | DataGridBase | ||
|
Commits the computed matrix built from the combination of the layout
matrix and the transform offsets to the flash displayObject's transform. | UIComponent | |
|
Sets up the effect for applying the selection indicator. | ListBase | |
|
This is an internal method used by the Flex framework
to support the Dissolve effect. | UIComponent | |
|
Calculates the y position of the drop indicator
when performing a drag-and-drop operation. | ListBase | |
Calculates the row height of columns in a row. | DataGridBase | ||
|
Determines if the call to the measure() method can be skipped. | UIComponent | |
|
Performs any final processing after child objects are created. | UIComponent | |
|
Clears the caret indicator into the given Sprite. | ListBase | |
|
Clears the highlight indicator in the given Sprite. | ListBase | |
|
Removes all selection and highlight and caret indicators. | ListBase | |
Removes renderers from a row that should be empty for the given rowNum. | DataGridBase | ||
|
Clears the set of selected items and removes all graphics
depicting the selected state of those items. | ListBase | |
|
Empty the visibleData hash table. | ListBase | |
|
Handles CollectionEvents dispatched from the data provider
as the data changes. | ListBase | |
| [override]
Calculates the column width and row height and number of rows and
columns based on whether properties like columnCount
columnWidth, rowHeight and
rowCount were explicitly set. | ListBase | |
|
Configures the ScrollBars based on the number of rows and columns and
viewable rows and columns. | ListBase | |
|
Makes a deep copy of the object by calling the
ObjectUtil.copy() method, and replaces
the copy's uid property (if present) with a
new value by calling the UIDUtil.createUID() method. | ListBase | |
|
Copies the selected items in the order that they were selected. | ListBase | |
|
Creates the border for this component. | ScrollControlBase | |
| [override]
Creates objects that are children of this ListBase; in this case,
the listContent object that will hold all the item
renderers. | ListBase | |
|
Creates a new object using a context
based on the embedded font being used. | UIComponent | |
|
Creates the object using a given moduleFactory. | UIComponent | |
|
Recycle a row that is no longer needed, and remove its indicators. | ListBase | |
|
Helper method for dispatching a PropertyChangeEvent
when a property is updated. | UIComponent | |
|
Handles DragEvent.DRAG_COMPLETE events. | ListBase | |
|
Handles DragEvent.DRAG_DROP events. | ListBase | |
|
Handles DragEvent.DRAG_ENTER events. | ListBase | |
|
Handles DragEvent.DRAG_EXIT events. | ListBase | |
|
Handles DragEvent.DRAG_OVER events. | ListBase | |
|
Interval function that scrolls the list up or down
if the mouse goes above or below the list. | ListBase | |
|
The default handler for the dragStart event. | ListBase | |
| drawCaretIndicator(indicator:Sprite, x:Number, y:Number, width:Number, height:Number, color:uint, itemRenderer:IListItemRenderer):void
Draws the caret indicator into the given Sprite
at the position, width and height specified using the
color specified. | ListBase | |
| drawHighlightIndicator(indicator:Sprite, x:Number, y:Number, width:Number, height:Number, color:uint, itemRenderer:IListItemRenderer):void
Draws the highlight indicator into the given Sprite
at the position, width and height specified using the
color specified. | ListBase | |
| drawItem(item:IListItemRenderer, selected:Boolean = false, highlighted:Boolean = false, caret:Boolean = false, transition:Boolean = false):void
Draws the renderer with indicators
that it is highlighted, selected, or the caret. | ListBase | |
|
Draws any alternating row colors, borders and backgrounds for the rows. | ListBase | |
| drawSelectionIndicator(indicator:Sprite, x:Number, y:Number, width:Number, height:Number, color:uint, itemRenderer:IListItemRenderer):void
Draws the selection indicator into the given Sprite
at the position, width and height specified using the
color specified. | ListBase | |
drawVisibleItem(uid:String, selected:Boolean = false, highlighted:Boolean = false, caret:Boolean = false, transition:Boolean = false):void
Draws an item if it is visible. | DataGridBase | ||
|
Tries to find the next item in the data provider that
starts with the character in the eventCode parameter. | ListBase | |
|
Cleans up after a data change effect has finished running
by restoring the original collection and iterator and removing
any cached values used by the effect. | ListBase | |
[override]
Sets selected items based on the caretIndex and
anchorIndex properties. | DataGridBase | ||
|
The event handler called when a UIComponent object gets focus. | UIComponent | |
|
The event handler called when a UIComponent object loses focus. | UIComponent | |
|
Retrieves an already-created item renderer not currently in use. | ListBase | |
|
The column for the data provider item at the given index. | ListBase | |
|
The row for the data provider item at the given index. | ListBase | |
|
Initializes the implementation and storage of some of the less frequently
used advanced layout features of a component. | UIComponent | |
|
Finalizes the initialization of this component. | UIComponent | |
|
Initializes this component's accessibility code. | UIComponent | |
|
Initiates a data change effect when there have been changes
in the data provider. | ListBase | |
|
Helper method to invalidate parent size and display list if
this object affects its layout (includeInLayout is true). | UIComponent | |
|
Typically overridden by components containing UITextField objects,
where the UITextField object gets focus. | UIComponent | |
|
Returns true if an item renderer is no longer being positioned
by the list's layout algorithm while a data change effect is
running as a result of a call to the unconstrainRenderer() method. | ListBase | |
[override]
Returns a Point object that defines the columnIndex and rowIndex properties of an
item renderer. | DataGridBase | ||
|
Determines the UID for a data provider item. | ListBase | |
|
The event handler called for a keyDown event. | UIComponent | |
|
The event handler called for a keyUp event. | UIComponent | |
|
Responds to size changes by setting the positions and sizes
of this control's borders. | ScrollControlBase | |
Sizes and temporarily positions an itemRenderer for a column, returning its size as a Point. | DataGridBase | ||
makeListData(data:Object, uid:String, rowNum:int, columnNum:int, column:DataGridColumn):BaseListData
Creates a new DataGridListData instance and populates the fields based on
the input data provider item. | DataGridBase | ||
makeRow(contentHolder:ListBaseContentHolder, rowNum:int, left:Number, right:Number, yy:Number, data:Object, uid:String):Number
Creates the renderers for the given rowNum, dataObject and uid. | DataGridBase | ||
| makeRowsAndColumns(left:Number, top:Number, right:Number, bottom:Number, firstColumn:int, firstRow:int, byCount:Boolean = false, rowsNeeded:uint = 0):Point
Make enough rows and columns to fill the area
described by left, top, right, bottom. | ListBase | |
| [override]
Calculates the measured width and height of the component based
on the rowCount,
columnCount, rowHeight and
columnWidth properties. | ListBase | |
|
Handles MouseEvent.MOUSE_CLICK events from any mouse
targets contained in the list including the renderers. | ListBase | |
|
Handles MouseEvent.MOUSE_DOUBLE_CLICK events from any
mouse targets contained in the list including the renderers. | ListBase | |
|
Handles MouseEvent.MOUSE_DOWN events from any mouse
targets contained in the list including the renderers. | ListBase | |
|
Determines which item renderer is under the mouse. | ListBase | |
|
Handles MouseEvent.MOUSE_MOVE events from any mouse
targets contained in the list including the renderers. | ListBase | |
|
Handles MouseEvent.MOUSE_OUT events from any mouse targets
contained in the list including the renderers. | ListBase | |
|
Handles MouseEvent.MOUSE_OVER events from any mouse
targets contained in the list, including the renderers. | ListBase | |
|
Handles MouseEvent.MOUSE_DOWN events from any mouse
targets contained in the list including the renderers. | ListBase | |
| [override]
Handles mouseWheel events by changing scroll positions. | ListBase | |
|
Move the selection and highlight indicators horizontally. | ListBase | |
|
Move the selection and highlight indicators vertically. | ListBase | |
|
Move a row vertically, and update the rowInfo record. | ListBase | |
|
Moves the selection in a horizontal direction in response
to the user selecting items using the left arrow or right arrow
keys and modifiers such as the Shift and Ctrl keys. | ListBase | |
[override]
Moves the selection in a vertical direction in response
to the user selecting items with the up arrow or down arrow
keys and modifiers such as the Shift and Ctrl keys. | DataGridBase | ||
|
Prepares the data effect for the collection event. | ListBase | |
Ensures that there is a slot in the row arrays for the given row number. | DataGridBase | ||
|
Called by the updateDisplayList() method to remove existing item renderers
and clean up various caching structures when the renderer changes. | ListBase | |
|
Update the keys in the visibleData hash table. | ListBase | |
Removes extra row from the end of the contentHolder. | DataGridBase | ||
|
Remove a row from the arrays that store references to the row. | ListBase | |
|
Cleans up selection highlights and other associated graphics
for a given item in the data provider. | ListBase | |
|
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 | |
|
Remove the requested number of rows from the beginning of the
arrays that store references to the rows. | ListBase | |
|
Determines if there is enough space in this component to display
a given scrollbar. | ScrollControlBase | |
|
Default event handler for the scroll event. | ScrollControlBase | |
|
Adjusts the renderers in response to a change
in scroll position. | ListBase | |
|
Returns the data provider index for the item at the first visible
row and column for the given scroll positions. | ListBase | |
|
Adjusts the renderers in response to a change
in scroll position. | ListBase | |
|
The default failure handler when a seek fails due to a page fault. | ListBase | |
|
The default result handler when a seek fails due to a page fault. | ListBase | |
|
Seek to a position, and handle an ItemPendingError if necessary. | ListBase | |
| selectItem(item:IListItemRenderer, shiftKey:Boolean, ctrlKey:Boolean, transition:Boolean = true):Boolean
Updates the set of selected items given that the item renderer provided
was clicked by the mouse and the keyboard modifiers are in the given
state. | ListBase | |
|
Sets the rowCount property without causing
invalidation or setting the explicitRowCount
property, which permanently locks in the number of rows. | ListBase | |
|
Sets the rowHeight property without causing invalidation or
setting of explicitRowHeight which
permanently locks in the height of the rows. | ListBase | |
Sets the rowInfo for the given rowNum, row position and height. | DataGridBase | ||
|
Causes the ScrollControlBase to show or hide scrollbars based
on the parameters passed in. | ScrollControlBase | |
|
Specifies a transform stretch factor in the horizontal and vertical direction. | UIComponent | |
setupColumnItemRenderer(c:DataGridColumn, contentHolder:ListBaseContentHolder, rowNum:int, colNum:int, data:Object, uid:String):IListItemRenderer
Sets up an item renderer for a column and put it in the listItems array
at the requested position. | DataGridBase | ||
|
Shift a row in the arrays that reference rows. | ListBase | |
|
This method is called when a state changes to check whether
state-specific styles apply to this component. | UIComponent | |
|
Determine the height of the requested set of rows. | ListBase | |
|
Remove all remaining rows from the end of the
arrays that store references to the rows. | ListBase | |
|
Find an item renderer based on its UID if it is visible. | ListBase | |
| [override]
Adds or removes item renderers if the number of displayable items
changed. | ListBase | |
|
Refreshes all rows. | ListBase | |
Redraws the renderer synchronously. | DataGridBase | ||
Styles
Styles are either common or associated with a specific theme. If the style is common, it can be used with any theme. If a style is associated with a specific theme, it can only be used if your application uses that theme.
Common Styles
Spark Theme Styles
Halo Theme Styles
Public Constants
Property Detail
columnCaretIndicator | property |
protected var columnCaretIndicator:Sprite| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The DisplayObject that contains the graphics that indicates which renderer is the caret for lockedColumns.
columnHighlightIndicator | property |
protected var columnHighlightIndicator:Sprite| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The DisplayObject that contains the graphics that indicates which renderer is highlighted for lockedColumns.
columnMap | property |
protected var columnMap:Object| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
A map of item renderes to columns.
Like ListBase.rowMap, this property contains
a hash map of item renderers and the columns they belong to.
Item renderers are indexed by their DisplayObject name.
Related API Elements
fontContext | property |
fontContext:IFlexModuleFactory| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The module factory that provides the font context for this component.
Implementation
public function get fontContext():IFlexModuleFactory public function set fontContext(value:IFlexModuleFactory):voidfreeItemRenderersTable | property |
protected var freeItemRenderersTable:Dictionary| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
A per-column table of unused item renderers. Most list classes recycle item renderers that they have already created as they scroll off screen. The recycled renderers are stored here. The table is a Dictionary where the entries are Arrays indexed by the actual DataGridColumn (not the column's dataField or other properties), and each array is a stack of currently unused renderers.
header | property |
protected var header:DataGridHeaderBase| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The header sub-component.
headerHeight | property |
headerHeight:Number| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The height of the header cell of the column, in pixels. If set explicitly, that height will be used for all of the headers. If not set explicitly, the height will based on style settings and the header renderer.
This property can be used as the source for data binding. When this property is modified, it dispatches the resize event.
Implementation
public function get headerHeight():Number public function set headerHeight(value:Number):voidheaderMask | property |
protected var headerMask:Shape| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The header mask.
lockedColumnAndRowContent | property |
protected var lockedColumnAndRowContent:DataGridLockedRowContentHolder| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The sub-component that contains locked rows for locked columns.
lockedColumnContent | property |
protected var lockedColumnContent:ListBaseContentHolder| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The sub-component that contains locked columns.
lockedColumnCount | property |
lockedColumnCount:int| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The index of the first column in the control that scrolls. Columns with indexes that are lower than this value remain fixed in view. Not supported by all list classes.
The default value is 0.
Implementation
public function get lockedColumnCount():int public function set lockedColumnCount(value:int):voidlockedColumnHeader | property |
protected var lockedColumnHeader:DataGridHeaderBase| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The header sub-component for locked columns.
lockedRowContent | property |
protected var lockedRowContent:DataGridLockedRowContentHolder| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The sub-component that contains locked rows.
lockedRowCount | property |
lockedRowCount:int| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The index of the first row in the control that scrolls. Rows above this one remain fixed in view.
The default value is 0.
Implementation
public function get lockedRowCount():int public function set lockedRowCount(value:int):voidshowHeaders | property |
showHeaders:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
A flag that indicates whether the control should show
column headers.
If true, the control shows column headers.
The default value is true.
This property can be used as the source for data binding. When this property is modified, it dispatches the showHeadersChanged event.
Implementation
public function get showHeaders():Boolean public function set showHeaders(value:Boolean):voidConstructor Detail
DataGridBase | () | Constructor |
public function DataGridBase()| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Constructor.
Method Detail
adjustRow | () | method |
protected function adjustRow(contentHolder:ListBaseContentHolder, rowNum:int, yy:Number, hh:Number):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Adjusts the size and positions of the renderers for the given rowNum, row position and height.
Parameters
contentHolder:ListBaseContentHolder — The set of rows (locked rows, regular rows).
| |
rowNum:int — The row number.
| |
yy:Number — The y position of the row.
| |
hh:Number — The height of the row.
|
calculateRowHeight | () | method |
protected function calculateRowHeight(data:Object, hh:Number, skipVisible:Boolean = false):Number| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Calculates the row height of columns in a row.
If skipVisible is true>,
the DataGridBase already knows the height of
the renderers for the column that do fit in the display area
so this method only needs to calculate for the item renderers
that would exist if other columns in that row were in the
display area. This is needed so that if the user scrolls
horizontally, the height of the row does not adjust as different
columns appear and disappear.
Parameters
data:Object — The data provider item for the row.
| |
hh:Number — The current height of the row.
| |
skipVisible:Boolean (default = false)true, there is no need to measure item
renderers in visible columns.
|
Number — The row height, in pixels.
|
clearRow | () | method |
protected function clearRow(contentHolder:ListBaseContentHolder, rowNum:int):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Removes renderers from a row that should be empty for the given rowNum.
Parameters
contentHolder:ListBaseContentHolder — The set of rows (locked rows, regular rows).
| |
rowNum:int — The row number.
|
createColumnItemRenderer | () | method |
public function createColumnItemRenderer(c:DataGridColumn, forHeader:Boolean, data:Object):IListItemRenderer| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Returns the item renderer for a column cell or for a column header. This method returns the default item renderer if no custom render is assigned to the column.
This method is public so that is can be accessed by the DataGridHeader class, and is primarily used in subclasses of the DataGrid control.
Parameters
c:DataGridColumn — The DataGridColumn instance of the item renderer.
| |
forHeader:Boolean — true to return the header item renderer,
and false to return the item render for the column cells.
| |
data:Object — If forHeader is false,
the data Object for the item renderer.
If forHeader is true,
the DataGridColumn instance.
|
IListItemRenderer — The item renderer.
|
drawVisibleItem | () | method |
protected function drawVisibleItem(uid:String, selected:Boolean = false, highlighted:Boolean = false, caret:Boolean = false, transition:Boolean = false):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Draws an item if it is visible.
Parameters
uid:String — The uid used to find the renderer.
| |
selected:Boolean (default = false)true if the renderer should be drawn in
its selected state.
| |
highlighted:Boolean (default = false)true if the renderer should be drawn in
its highlighted state.
| |
caret:Boolean (default = false)true if the renderer should be drawn as if
it is the selection caret.
| |
transition:Boolean (default = false)true if the selection state should fade in
via an effect.
|
finishKeySelection | () | method |
override protected function finishKeySelection():void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Sets selected items based on the caretIndex and
anchorIndex properties.
This method is called by the keyboard selection handlers
and by the updateDisplayList() method in case the
keyboard selection handler received a page fault while scrolling to get more items.
itemRendererToIndices | () | method |
override protected function itemRendererToIndices(item:IListItemRenderer):Point| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Returns a Point object that defines the columnIndex and rowIndex properties of an
item renderer. Because item renderers are only created for items
within the set of viewable rows, you cannot use this method to get the indices for items
that are not visible. Also, item renderers
are recycled so the indices that you get for an item might change
if that item renderer is reused to display a different item.
Usually, this method is called during mouse and keyboard handling
when the set of data displayed by the item renderers has not yet changed.
Parameters
item:IListItemRenderer — An item renderer.
|
Point — A Point object. The x property is the columnIndex
and the y property is the rowIndex.
|
layoutColumnItemRenderer | () | method |
protected function layoutColumnItemRenderer(c:DataGridColumn, item:IListItemRenderer, xx:Number, yy:Number):Point| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Sizes and temporarily positions an itemRenderer for a column, returning its size as a Point. The final position might be adjusted later due to alignment settings.
Parameters
c:DataGridColumn — The DataGridColumn for the renderer.
| |
item:IListItemRenderer — The renderer.
| |
xx:Number — The x position.
| |
yy:Number — The y position.
|
Point — Size of the renderer as a Point.
|
makeListData | () | method |
protected function makeListData(data:Object, uid:String, rowNum:int, columnNum:int, column:DataGridColumn):BaseListData| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Creates a new DataGridListData instance and populates the fields based on the input data provider item.
Parameters
data:Object — The data provider item used to populate the ListData.
| |
uid:String — The UID for the item.
| |
rowNum:int — The index of the item in the data provider.
| |
columnNum:int — The columnIndex associated with this item.
| |
column:DataGridColumn — The column associated with this item.
|
BaseListData — A newly constructed ListData object.
|
makeRow | () | method |
protected function makeRow(contentHolder:ListBaseContentHolder, rowNum:int, left:Number, right:Number, yy:Number, data:Object, uid:String):Number| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Creates the renderers for the given rowNum, dataObject and uid.
Parameters
contentHolder:ListBaseContentHolder — The set of rows (locked rows, regular rows).
| |
rowNum:int — The row number.
| |
left:Number — The offset from the left side for the first column.
| |
right:Number — The offset from the right side for the last column.
| |
yy:Number — The y position of the row.
| |
data:Object — The data for the row.
| |
uid:String — The uid for the data.
|
Number — Height of the row.
|
moveSelectionVertically | () | method |
override protected function moveSelectionVertically(code:uint, shiftKey:Boolean, ctrlKey:Boolean):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Moves the selection in a vertical direction in response
to the user selecting items with the up arrow or down arrow
keys and modifiers such as the Shift and Ctrl keys. This method
might change the horizontalScrollPosition,
verticalScrollPosition, and caretIndex
properties, and call the finishKeySelection()method
to update the selection.
Parameters
code:uint — The key that was pressed (for example, Keyboard.DOWN).
| |
shiftKey:Boolean — true if the Shift key was held down when
the keyboard key was pressed.
| |
ctrlKey:Boolean — true if the Ctrl key was held down when
the keyboard key was pressed
|
prepareRowArray | () | method |
protected function prepareRowArray(contentHolder:ListBaseContentHolder, rowNum:int):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Ensures that there is a slot in the row arrays for the given row number.
Parameters
contentHolder:ListBaseContentHolder — The set of rows (locked rows, regular rows).
| |
rowNum:int — The row number.
|
removeExtraRow | () | method |
protected function removeExtraRow(contentHolder:ListBaseContentHolder):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Removes extra row from the end of the contentHolder.
Parameters
contentHolder:ListBaseContentHolder — The set of rows (locked rows, regular rows).
|
setRowInfo | () | method |
protected function setRowInfo(contentHolder:ListBaseContentHolder, rowNum:int, yy:Number, hh:Number, uid:String):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Sets the rowInfo for the given rowNum, row position and height.
Parameters
contentHolder:ListBaseContentHolder — The set of rows (locked rows, regular rows).
| |
rowNum:int — The row number.
| |
yy:Number — The y position of the row.
| |
hh:Number — The height of the row.
| |
uid:String — The UID for the data.
|
setupColumnItemRenderer | () | method |
protected function setupColumnItemRenderer(c:DataGridColumn, contentHolder:ListBaseContentHolder, rowNum:int, colNum:int, data:Object, uid:String):IListItemRenderer| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Sets up an item renderer for a column and put it in the listItems array at the requested position.
Parameters
c:DataGridColumn — The DataGridColumn for the renderer.
| |
contentHolder:ListBaseContentHolder — The set of rows (locked rows, regular rows).
| |
rowNum:int — The row number.
| |
colNum:int — The column number.
| |
data:Object — The data for the row.
| |
uid:String — The uid for the data.
|
IListItemRenderer — The renderer for this column and row.
|
updateRendererDisplayList | () | method |
protected function updateRendererDisplayList(r:IListItemRenderer):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Redraws the renderer synchronously.
Parameters
r:IListItemRenderer — The renderer;
|
Mon Apr 10 2017, 12:28 PM -07:00