Package | mx.controls.dataGridClasses |
Class | public class DataGridHeader |
Inheritance | DataGridHeader DataGridHeaderBase UIComponent FlexSprite Sprite DisplayObjectContainer InteractiveObject DisplayObject EventDispatcher Object |
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
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 | ||
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 | ||
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
The vertical distance in pixels from the anchor target to
the control's baseline position. | 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 | ||
bottom : Object
The vertical distance in pixels from the bottom edge of the component to the
anchor target's bottom edge. | UIComponent | ||
bottomOffset : Number = 0
The offset, in pixels, from the bottom of the content of the renderer. | DataGridHeader | ||
buttonMode : Boolean
Specifies the button mode of this sprite. | Sprite | ||
cacheAsBitmap : Boolean
If set to true, Flash Player or Adobe AIR caches an internal bitmap representation of the
display object. | 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 | ||
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 | ||
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 | ||
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 [override]
Whether the component can accept user interaction. | DataGridHeader | ||
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 | ||
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]
Contians true if the element has 3D Matrix. | UIComponent | ||
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
The horizontal distance in pixels from the center of the component to the
center of the anchor target's content area. | UIComponent | ||
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 | ||
layoutMatrix3D : Matrix3D [write-only]
The transform matrix that is used to calculate a component's layout
relative to its siblings. | UIComponent | ||
left : Object
The horizontal distance in pixels from the left edge of the component to the
anchor target's left edge. | UIComponent | ||
leftOffset : Number = 0
The offset, in pixels, from the left side of the content of the renderer. | DataGridHeader | ||
loaderInfo : LoaderInfo [read-only]
Returns a LoaderInfo object containing information about loading the file
to which this display object belongs. | DisplayObject | ||
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 | ||
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 | ||
mouseChildren : Boolean
Determines whether or not the children of the object are mouse enabled. | DisplayObjectContainer | ||
mouseEnabled : Boolean
Specifies whether this object receives mouse messages. | InteractiveObject | ||
mouseFocusEnabled : Boolean
Whether you can receive focus when clicked on. | UIComponent | ||
mouseX : Number [read-only]
Indicates the x coordinate of the mouse position, in pixels. | DisplayObject | ||
mouseY : Number [read-only]
Indicates the y coordinate of the mouse position, in pixels. | DisplayObject | ||
name : String
Indicates the instance name of the DisplayObject. | DisplayObject | ||
needRightSeparator : Boolean = false
Whether we need the separator on the far right
| DataGridHeader | ||
needRightSeparatorEvents : Boolean = false
Whether we need the separator events on the far right
| DataGridHeader | ||
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 | ||
numChildren : int [read-only]
Returns the number of children of this object. | DisplayObjectContainer | ||
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
Number that specifies the height of a component as a percentage
of its parent's size. | UIComponent | ||
percentWidth : Number
Number that 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 | ||
prototype : Object [static]
A reference to the prototype object of a class or function object. | Object | ||
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
The horizontal distance in pixels from the right edge of the component to the
anchor target's right edge. | UIComponent | ||
rightOffset : Number = 0
The offset, in pixels, from the right side of the content of the renderer. | DataGridHeader | ||
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 | ||
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 | ||
showInAutomationHierarchy : Boolean
A flag that determines if an automation object
shows in the automation hierarchy. | UIComponent | ||
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 [read-only]
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
The vertical distance in pixels from the top edge of the component to the
anchor target's top edge. | UIComponent | ||
topOffset : Number = 0
The offset, in pixels, from the top of the content of the renderer. | DataGridHeader | ||
transform : flash.geom:Transform
An object with properties pertaining to a display object's matrix, color transform, and pixel bounds. | DisplayObject | ||
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 mouse 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 | ||
verticalCenter : Object
The vertical distance in pixels from the center of the component to the
center of the anchor target's content area. | UIComponent | ||
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 | ||
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 |
Property | Defined By | ||
---|---|---|---|
cachedHeaderHeight : Number = 0
The cached header height, in pixels. | DataGridHeader | ||
cachedPaddingBottom : Number = 0
The cached padding for the bottom of the renderer, in pixels. | DataGridHeader | ||
cachedPaddingTop : Number = 0
The cached padding for the top of the renderer, in pixels. | DataGridHeader | ||
currentCSSState : String [read-only]
The state to be used when matching CSS pseudo-selectors. | UIComponent | ||
dataGrid : DataGrid
The DataGrid control associated with this renderer. | DataGridHeader | ||
hasComplexLayoutMatrix : Boolean [read-only]
Returns true if the UIComponent has any non-translation (x,y) transform properties. | UIComponent | ||
headerItems : Array
An Array of header renderer instances. | DataGridHeader | ||
resourceManager : IResourceManager [read-only]
A reference to the object which manages
all of the application's localized resources. | UIComponent | ||
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 |
Method | Defined By | ||
---|---|---|---|
Constructor. | DataGridHeader | ||
Adds a child DisplayObject instance to this DisplayObjectContainer instance. | DisplayObjectContainer | ||
Adds a child DisplayObject instance to this DisplayObjectContainer
instance. | DisplayObjectContainer | ||
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener
receives notification of an event. | EventDispatcher | ||
Indicates whether the security restrictions
would cause any display objects to be omitted from the list returned by calling
the DisplayObjectContainer.getObjectsUnderPoint() method
with the specified point point. | DisplayObjectContainer | ||
Queues a function to be called later. | UIComponent | ||
Deletes a style property from this component instance. | UIComponent | ||
Determines whether the specified display object is a child of the DisplayObjectContainer instance or
the instance itself. | DisplayObjectContainer | ||
Converts a Point object from content coordinates to global coordinates. | 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 | ||
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 | ||
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 | ||
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 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 | ||
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 | ||
Evaluates the bounding box of the display object to see if it overlaps or intersects with the
bounding box of the obj display object. | DisplayObject | ||
Evaluates the display object to see if it overlaps or intersects with the
point specified by the x and y parameters. | DisplayObject | ||
Returns a box Matrix which can be passed to the
drawRoundRect() method
as the rot parameter when drawing a horizontal gradient. | UIComponent | ||
Initializes the internal structure of this component. | UIComponent | ||
Initializes various properties which keep track of repeated instances
of this component. | UIComponent | ||
Marks a component so that its updateDisplayList()
method gets called during a later screen update. | UIComponent | ||
Called by a component's items to indicate that their depth
property has changed. | UIComponent | ||
Marks a component so that its commitProperties()
method gets called during a later screen update. | UIComponent | ||
Marks a component so that its measure()
method gets called during a later screen update. | UIComponent | ||
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | ||
Converts a three-dimensional point of the three-dimensional display
object's (local) coordinates to a two-dimensional point in the Stage (global) coordinates. | DisplayObject | ||
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 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 | ||
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 a listener from the EventDispatcher object. | EventDispatcher | ||
Replays the specified event. | UIComponent | ||
Resolves a child by using the id provided. | UIComponent | ||
[static]
Resumes the background processing of methods
queued by callLater(), after a call to
suspendBackgroundProcessing(). | UIComponent | ||
Sizes the object. | UIComponent | ||
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 | ||
Lets the user drag the specified sprite. | Sprite | ||
Ends the startDrag() method. | Sprite | ||
Detects changes to style properties. | UIComponent | ||
Flex calls the stylesInitialized() method when
the styles for a component are first initialized. | UIComponent | ||
[static]
Blocks the background processing of methods
queued by callLater(),
until resumeBackgroundProcessing() is called. | UIComponent | ||
Swaps the z-order (front-to-back order) of the two specified child objects. | DisplayObjectContainer | ||
Swaps the z-order (front-to-back order) of the child objects at the two specified index positions in the
child list. | DisplayObjectContainer | ||
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | ||
[override]
Returns a string indicating the location of this object
within the hierarchy of DisplayObjects in the Application. | FlexSprite | ||
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 | ||
Validates the position and size of children and draws other
visuals. | UIComponent | ||
Validate and update the properties and layout of this object
and redraw it, if necessary. | UIComponent | ||
Used by layout logic to validate the properties of a component
by calling the commitProperties() method. | UIComponent | ||
Validates the measured size of the component
If the LayoutManager.invalidateSize() method is called with
this ILayoutManagerClient, then the validateSize() method
is called when it's time to do measurements. | UIComponent | ||
Handles both the valid and invalid events from a
validator assigned to this component. | UIComponent | ||
Returns the primitive value of the specified object. | Object | ||
Returns a box Matrix which can be passed to drawRoundRect()
as the rot parameter when drawing a vertical gradient. | UIComponent | ||
Checks whether an event listener is registered with this EventDispatcher object or any of
its ancestors for the specified event type. | EventDispatcher |
Method | Defined By | ||
---|---|---|---|
Adjust the focus rectangle. | UIComponent | ||
Commits the computed matrix built from the combination of the layout
matrix and the transform offsets to the flash displayObject's transform. | UIComponent | ||
This is an internal method used by the Flex framework
to support the Dissolve effect. | UIComponent | ||
Determines if the call to the measure() method can be skipped. | UIComponent | ||
Performs any final processing after child objects are created. | UIComponent | ||
Removes column header separators that the user normally uses
to resize columns. | DataGridHeader | ||
Processes the properties set on the component. | UIComponent | ||
[override]
Create child objects of the component. | DataGridHeader | ||
Creates a new object using a context
based on the embedded font being used. | UIComponent | ||
Creates the object using a given moduleFactory. | UIComponent | ||
Helper method for dispatching a PropertyChangeEvent
when a property is updated. | UIComponent | ||
drawColumnDragOverlay(indicator:Sprite, x:Number, y:Number, width:Number, height:Number, color:uint, itemRenderer:IListItemRenderer):void
Draws the overlay on the dragged column into the given Sprite
at the position, width and height specified using the
color specified. | DataGridHeader | ||
Draws the background of the headers into the given
UIComponent. | DataGridHeader | ||
drawHeaderIndicator(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. | DataGridHeader | ||
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. | DataGridHeader | ||
Creates and displays the column header separators that the user
normally uses to resize columns. | DataGridHeader | ||
The event handler called when a UIComponent object gets focus. | UIComponent | ||
The event handler called when a UIComponent object loses focus. | UIComponent | ||
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 | ||
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 | ||
The event handler called for a keyDown event. | UIComponent | ||
The event handler called for a keyUp event. | UIComponent | ||
[override]
Calculates the default size, and optionally the default minimum size,
of the component. | DataGridHeader | ||
Draws the sort arrow graphic on the column that is the current sort key. | DataGridHeader | ||
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 | ||
Specifies a transform stretch factor in the horizontal and vertical direction. | UIComponent | ||
This method is called when a state changes to check whether
state-specific styles apply to this component. | UIComponent | ||
[override]
Draws the object and/or sizes and positions its children. | DataGridHeader |
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.
bottomOffset | property |
public var bottomOffset:Number = 0
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
The offset, in pixels, from the bottom of the content of the renderer.
cachedHeaderHeight | property |
protected var cachedHeaderHeight:Number = 0
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
The cached header height, in pixels.
cachedPaddingBottom | property |
protected var cachedPaddingBottom:Number = 0
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
The cached padding for the bottom of the renderer, in pixels.
cachedPaddingTop | property |
protected var cachedPaddingTop:Number = 0
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
The cached padding for the top of the renderer, in pixels.
dataGrid | property |
protected var dataGrid:DataGrid
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
The DataGrid control associated with this renderer.
enabled | property |
enabled:Boolean
[override] Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Whether the component can accept user interaction. After setting the enabled
property to false
, some components still respond to mouse interactions such
as mouseOver. As a result, to fully disable UIComponents,
you should also set the value of the mouseEnabled
property to false
.
If you set the enabled
property to false
for a container, Flex dims the color of the container and of all
of its children, and blocks user input to the container
and to all of its children.
Implementation
override public function get enabled():Boolean
override public function set enabled(value:Boolean):void
headerItems | property |
protected var headerItems:Array
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
An Array of header renderer instances.
leftOffset | property |
public var leftOffset:Number = 0
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
The offset, in pixels, from the left side of the content of the renderer.
needRightSeparator | property |
public var needRightSeparator:Boolean = false
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Whether we need the separator on the far right
needRightSeparatorEvents | property |
public var needRightSeparatorEvents:Boolean = false
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Whether we need the separator events on the far right
rightOffset | property |
public var rightOffset:Number = 0
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
The offset, in pixels, from the right side of the content of the renderer.
topOffset | property |
public var topOffset:Number = 0
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
The offset, in pixels, from the top of the content of the renderer.
DataGridHeader | () | Constructor |
public function DataGridHeader()
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Constructor.
clearSeparators | () | method |
protected function clearSeparators():void
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Removes column header separators that the user normally uses to resize columns.
createChildren | () | method |
override protected function createChildren():void
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Create child objects of the component. This is an advanced method that you might override when creating a subclass of UIComponent.
A component that creates other components or objects within it is called a composite component.
For example, the Flex ComboBox control is actually made up of a TextInput control
to define the text area of the ComboBox, and a Button control to define the ComboBox arrow.
Components implement the createChildren()
method to create child
objects (such as other components) within the component.
From within an override of the createChildren()
method,
you call the addChild()
method to add each child object.
You do not call this method directly. Flex calls the
createChildren()
method in response to the call to
the addChild()
method to add the component to its parent.
drawColumnDragOverlay | () | method |
protected function drawColumnDragOverlay(indicator:Sprite, x:Number, y:Number, width:Number, height:Number, color:uint, itemRenderer:IListItemRenderer):void
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Draws the overlay on the dragged column into the given Sprite at the position, width and height specified using the color specified.
Parameters
indicator:Sprite — A Sprite that should contain the graphics
that indicate that a column is being dragged.
| |
x:Number — The suggested x position for the indicator.
| |
y:Number — The suggested y position for the indicator.
| |
width:Number — The suggested width for the indicator.
| |
height:Number — The suggested height for the indicator.
| |
color:uint — The suggested color for the indicator.
| |
itemRenderer:IListItemRenderer — The item renderer that is being dragged.
|
drawHeaderBackground | () | method |
protected function drawHeaderBackground(headerBG:UIComponent):void
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Draws the background of the headers into the given UIComponent. The graphics drawn may be scaled horizontally if the component's width changes or this method will be called again to redraw at a different width and/or height
Parameters
headerBG:UIComponent — A UIComponent that will contain the header
background graphics.
|
drawHeaderIndicator | () | method |
protected function drawHeaderIndicator(indicator:Sprite, x:Number, y:Number, width:Number, height:Number, color:uint, itemRenderer:IListItemRenderer):void
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Draws the highlight indicator into the given Sprite at the position, width and height specified using the color specified.
Parameters
indicator:Sprite — A Sprite that should contain the graphics
that make a renderer look highlighted.
| |
x:Number — The suggested x position for the indicator.
| |
y:Number — The suggested y position for the indicator.
| |
width:Number — The suggested width for the indicator.
| |
height:Number — The suggested height for the indicator.
| |
color:uint — The suggested color for the indicator.
| |
itemRenderer:IListItemRenderer — The item renderer that is being highlighted.
|
drawSelectionIndicator | () | method |
protected function drawSelectionIndicator(indicator:Sprite, x:Number, y:Number, width:Number, height:Number, color:uint, itemRenderer:IListItemRenderer):void
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Draws the selection indicator into the given Sprite at the position, width and height specified using the color specified.
Parameters
indicator:Sprite — A Sprite that should contain the graphics
that make a renderer look selected.
| |
x:Number — The suggested x position for the indicator.
| |
y:Number — The suggested y position for the indicator.
| |
width:Number — The suggested width for the indicator.
| |
height:Number — The suggested height for the indicator.
| |
color:uint — The suggested color for the indicator.
| |
itemRenderer:IListItemRenderer — The item renderer that is being selected.
|
drawSeparators | () | method |
protected function drawSeparators():void
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Creates and displays the column header separators that the user
normally uses to resize columns. This implementation uses
the same Sprite as the lines and column backgrounds and adds
instances of the headerSeparatorSkin
and attaches mouse
listeners to them in order to know when the user wants
to resize a column.
measure | () | method |
override protected function measure():void
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Calculates the default size, and optionally the default minimum size, of the component. This is an advanced method that you might override when creating a subclass of UIComponent.
You do not call this method directly. Flex calls the
measure()
method when the component is added to a container
using the addChild()
method, and when the component's
invalidateSize()
method is called.
When you set a specific height and width of a component,
Flex does not call the measure()
method,
even if you explicitly call the invalidateSize()
method.
That is, Flex only calls the measure()
method if
the explicitWidth
property or the explicitHeight
property of the component is NaN.
In your override of this method, you must set the
measuredWidth
and measuredHeight
properties
to define the default size.
You can optionally set the measuredMinWidth
and
measuredMinHeight
properties to define the default
minimum size.
Most components calculate these values based on the content they are displaying, and from the properties that affect content display. A few components simply have hard-coded default values.
The conceptual point of measure()
is for the component to provide
its own natural or intrinsic size as a default. Therefore, the
measuredWidth
and measuredHeight
properties
should be determined by factors such as:
- The amount of text the component needs to display.
- The styles, such as
fontSize
, for that text. - The size of a JPEG image that the component displays.
- The measured or explicit sizes of the component's children.
- Any borders, margins, and gaps.
In some cases, there is no intrinsic way to determine default values.
For example, a simple GreenCircle component might simply set
measuredWidth = 100 and measuredHeight = 100 in its measure()
method to
provide a reasonable default size. In other cases, such as a TextArea,
an appropriate computation (such as finding the right width and height
that would just display all the text and have the aspect ratio of a Golden Rectangle)
might be too time-consuming to be worthwhile.
The default implementation of measure()
sets measuredWidth
, measuredHeight
,
measuredMinWidth
, and measuredMinHeight
to 0
.
placeSortArrow | () | method |
protected function placeSortArrow():void
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Draws the sort arrow graphic on the column that is the current sort key.
This implementation creates or reuses an instance of the skin specified
by sortArrowSkin
style property and places
it in the appropriate column header. It
also shrinks the size of the column header if the text in the header
would be obscured by the sort arrow.
updateDisplayList | () | method |
override protected function updateDisplayList(w:Number, h:Number):void
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Draws the object and/or sizes and positions its children. This is an advanced method that you might override when creating a subclass of UIComponent.
You do not call this method directly. Flex calls the
updateDisplayList()
method when the component is added to a container
using the addChild()
method, and when the component's
invalidateDisplayList()
method is called.
If the component has no children, this method
is where you would do programmatic drawing
using methods on the component's Graphics object
such as graphics.drawRect()
.
If the component has children, this method is where
you would call the move()
and setActualSize()
methods on its children.
Components can do programmatic drawing even if
they have children. In doing either, use the
component's unscaledWidth
and unscaledHeight
as its bounds.
It is important to use unscaledWidth
and
unscaledHeight
instead of the width
and height
properties.
Parameters
w:Number — Specifies the width of the component, in pixels,
in the component's coordinates, regardless of the value of the
scaleX property of the component.
| |
h:Number — Specifies the height of the component, in pixels,
in the component's coordinates, regardless of the value of the
scaleY property of the component.
|
Fri Mar 19 2010, 02:45 AM -07:00