| Package | fl.controls.dataGridClasses |
| Class | public class HeaderRenderer |
| Inheritance | HeaderRenderer  LabelButton BaseButton UIComponent Sprite DisplayObjectContainer InteractiveObject DisplayObject EventDispatcher Object |
| Language Version: | ActionScript 3.0 |
| Product Version: | Flash CS3 |
| Runtime Versions: | Flash Player 9.0.28.0, AIR 1.0 |
column property that associates the current header with its
DataGrid column.
See also
| Property | Defined By | ||
|---|---|---|---|
 | accessibilityProperties : AccessibilityProperties
The current accessibility options for this display object. | DisplayObject | |
| alpha : Number
Indicates the alpha transparency value of the object specified. | DisplayObject | |
| autoRepeat : Boolean
Gets or sets a Boolean value that indicates whether the buttonDown event
is dispatched more than one time when the user holds the mouse button down over the component. | BaseButton | |
| 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 | |
| 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 | |
| column : uint
The index of the column that belongs to this HeaderRenderer instance. | HeaderRenderer | ||
| constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| contextMenu : NativeMenu
Specifies the context menu associated with this object. | InteractiveObject | |
| doubleClickEnabled : Boolean
Specifies whether the object receives doubleClick events. | InteractiveObject | |
| 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]
Gets or sets a value that indicates whether the component can accept user
input. | BaseButton | |
| filters : Array
An indexed array that contains each filter object currently associated with the display object. | DisplayObject | |
| focusEnabled : Boolean
Gets or sets a Boolean value that indicates whether the component can receive focus
after the user clicks it. | UIComponent | |
| focusManager : IFocusManager
Gets or sets the FocusManager that controls focus for this component and its
peers. | 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 | |
| height : Number [override]
Gets or sets the height of the component, in pixels. | UIComponent | |
| hitArea : Sprite
Designates another sprite to serve as the hit area for a sprite. | Sprite | |
| label : String
Gets or sets the text label for the component. | LabelButton | |
| labelPlacement : String
Position of the label in relation to a specified icon. | LabelButton | |
| loaderInfo : LoaderInfo [read-only]
Returns a LoaderInfo object containing information about loading the file
to which this display object belongs. | DisplayObject | |
| mask : DisplayObject
The calling display object is masked by the specified mask object. | DisplayObject | |
| 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
Gets or sets a value that indicates whether the component can receive focus after
the user clicks it. | 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 | |
| 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 | |
| parent : DisplayObjectContainer [read-only]
Indicates the DisplayObjectContainer object that contains this display object. | DisplayObject | |
| prototype : Object [static]
A reference to the prototype object of a class or function object. | Object | |
| 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
Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation. | DisplayObject | |
| rotationX : Number
Indicates the x-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container. | DisplayObject | |
| rotationY : Number
Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container. | DisplayObject | |
| rotationZ : Number
Indicates the z-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container. | DisplayObject | |
| scale9Grid : Rectangle
The current scaling grid that is in effect. | DisplayObject | |
| scaleX : Number [override]
Multiplies the current width of the component by a scale factor. | UIComponent | |
| scaleY : Number [override]
Multiplies the current height of the component by a scale factor. | UIComponent | |
| scaleZ : Number
Indicates the depth scale (percentage) of an object as applied from the registration point of the object. | DisplayObject | |
| scrollRect : Rectangle
The scroll rectangle bounds of the display object. | DisplayObject | |
| selected : Boolean [override]
Gets or sets a Boolean value that indicates whether
a toggle button is toggled in the on or off position. | LabelButton | |
| soundTransform : flash.media:SoundTransform
Controls sound within this sprite. | Sprite | |
| stage : Stage [read-only]
The Stage of the display object. | DisplayObject | |
| 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 | |
| tabIndex : int
Specifies the tab ordering of objects in a SWF file. | InteractiveObject | |
| textField : flash.text:TextField
A reference to the component's internal text field. | LabelButton | |
| textSnapshot : flash.text:TextSnapshot [read-only]
Returns a TextSnapshot object for this DisplayObjectContainer instance. | DisplayObjectContainer | |
| toggle : Boolean
Gets or sets a Boolean value that indicates whether a button
can be toggled. | LabelButton | |
| transform : flash.geom:Transform
An object with properties pertaining to a display object's matrix, color transform, and pixel bounds. | DisplayObject | |
| 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 | |
| version : String = "3.0.0.16"
The version number of the components. | UIComponent | |
| visible : Boolean [override]
Gets or sets a value that indicates whether the current component instance is visible. | UIComponent | |
| width : Number [override]
Gets or sets the width of the component, in pixels. | UIComponent | |
| x : Number [override]
Gets or sets the x coordinate that represents the position of the component along
the x axis within its parent container. | UIComponent | |
| y : Number [override]
Gets or sets the y coordinate that represents the position of the component along
the y axis within its parent container. | UIComponent | |
| z : Number
Indicates the z coordinate position along the z-axis of the DisplayObject
instance relative to the 3D parent container. | DisplayObject | |
| Method | Defined By | ||
|---|---|---|---|
Creates a new HeaderRenderer instance. | HeaderRenderer | ||
|
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 | |
|
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 | |
|
Dispatches an event into the event flow. | EventDispatcher | |
|
Shows or hides the focus indicator on this component. | UIComponent | |
|
Initiates an immediate draw operation, without invalidating everything as invalidateNow does. | UIComponent | |
|
Returns a rectangle that defines the area of the display object relative to the coordinate system
of the targetCoordinateSpace object. | DisplayObject | |
|
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 | |
|
Retrieves the object that currently has focus. | UIComponent | |
|
Returns an array of objects that lie under the specified point and are children
(or grandchildren, and so on) of this DisplayObjectContainer instance. | DisplayObjectContainer | |
|
Returns a rectangle that defines the boundary of the display object,
based on the coordinate system defined by the targetCoordinateSpace
parameter, excluding any strokes on shapes. | DisplayObject | |
|
Retrieves a style property that is set in the style lookup
chain of the component. | UIComponent | |
[static]
Retrieves the default style map for the current component. | HeaderRenderer | ||
|
Converts the point object from the Stage (global) coordinates
to the display object's (local) coordinates. | DisplayObject | |
|
Converts a two-dimensional point from the Stage (global) coordinates to a
three-dimensional display object's (local) coordinates. | DisplayObject | |
|
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | EventDispatcher | |
|
Indicates whether an object has a specified property defined. | Object | |
|
Evaluates the bounding box of the display object to see if it overlaps or intersects with the
bounding box of the obj display object. | DisplayObject | |
|
Evaluates the display object to see if it overlaps or intersects with the
point specified by the x and y parameters. | DisplayObject | |
|
Marks a property as invalid and redraws the component on the
next frame unless otherwise specified. | 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 the point object from the display object's (local) coordinates to the
Stage (global) coordinates. | DisplayObject | |
| [static]
Merges the styles from multiple classes into one object. | UIComponent | |
|
Moves the component to the specified position within its parent. | UIComponent | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
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 | |
|
Changes the position of an existing child in the display object container. | DisplayObjectContainer | |
|
Sets the focus to this component. | UIComponent | |
|
Set the mouse state via ActionScript. | BaseButton | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Sets the component to the specified width and height. | UIComponent | |
|
Sets a style property on this component instance. | UIComponent | |
|
Lets the user drag the specified sprite. | Sprite | |
|
Ends the startDrag() method. | Sprite | |
|
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 | |
|
Returns the string representation of the specified object. | Object | |
|
Validates and updates the properties and layout of this object, redrawing it
if necessary. | UIComponent | |
|
Returns the primitive value of the specified object. | Object | |
|
Checks whether an event listener is registered with this EventDispatcher object or any of
its ancestors for the specified event type. | EventDispatcher | |
| Style | Description | Defined By | ||
|---|---|---|---|---|
| Type: Class Name of the class to use as the icon when the button is not disabled. | LabelButton | ||
| Type: Class Name of the class to use as the skin for the background and border when the button is not selected and is disabled. | LabelButton | ||
| Type: flash.text.TextFormat The TextFormat object to use to render the component label when the button is disabled. | UIComponent | ||
| Type: Class Name of the class to use as the icon when the button is not selected and the mouse button is down. | LabelButton | ||
| Type: Class Name of the class to use as the skin for the background and border when the button is not selected and the mouse button is down. | LabelButton | ||
| Type: Boolean Indicates whether embedded font outlines are used to render the text field. | LabelButton | ||
| Type: Number Format: Length The padding that separates the outside boundaries of the component from the outside edges of the focus indicator, in pixels. | UIComponent | ||
| Type: Class The skin to be used to display focus indicators. | UIComponent | ||
| Type: Class Name of the class to use as the icon when a toggle button is not selected and the mouse is not over the button. | LabelButton | ||
| Type: Class Name of the class to use as the icon when the button is not selected and the mouse is over the component. | LabelButton | ||
| Type: Class Name of the class to use as the skin for the background and border when the button is not selected and the mouse is over the component. | LabelButton | ||
| Type: Number Format: Time The number of milliseconds to wait after the buttonDown event is first dispatched before sending a second buttonDown event. | LabelButton | ||
| Type: Number Format: Time The interval, in milliseconds, between buttonDown events that are dispatched after the delay that is specified by the repeatDelay style. | LabelButton | ||
| Type: Class Name of the class to use as the icon when the button is selected and disabled. | LabelButton | ||
selectedDisabledSkin | Type: Class Name of the class to use as the skin for the background and border when a toggle button is selected and disabled. The default value is HeaderRenderer_selectedDisabledSkin. | HeaderRenderer | ||
| Type: Class Name of the class to use as the icon when the button is selected and the mouse button is down. | LabelButton | ||
selectedDownSkin | Type: Class Name of the class to use as the skin for the background and border when a toggle button is selected and the mouse button is down. The default value is HeaderRenderer_selectedDownSkin. | HeaderRenderer | ||
| Type: Class Name of the class to use as the icon when the button is selected and the mouse is over the component. | LabelButton | ||
selectedOverSkin | Type: Class Name of the class to use as the skin for the background and border when a toggle button is selected and the mouse is over the component. The default value is HeaderRenderer_selectedOverSkin. | HeaderRenderer | ||
| Type: Class Name of the class to use as the icon when the button is selected and the mouse button is up. | LabelButton | ||
selectedUpSkin | Type: Class Name of the class to use as the skin for the background and border when a toggle button is selected and the mouse is not over the component. The default value is HeaderRenderer_selectedUpSkin. | HeaderRenderer | ||
| Type: flash.text.TextFormat The TextFormat object to use to render the component label. | UIComponent | ||
| Type: Number Format: Length The spacing between the text and the edges of the component, and the spacing between the text and the icon, in pixels. | LabelButton | ||
| Type: Class Name of the class to use as the icon when a toggle button is not selected and the mouse is not over the button. | LabelButton | ||
| Type: Class Name of the class to use as the skin for the background and border when the button is not selected and the mouse is not over the component. | LabelButton | ||
| column | property |
Hide Inherited Public Properties
Show Inherited Public Properties
column:uint| Language Version: | ActionScript 3.0 |
| Product Version: | Flash CS3 |
| Runtime Versions: | Flash Player 9.0.28.0, AIR 1.0 |
The index of the column that belongs to this HeaderRenderer instance.
You do not need to know how to get or set this property because it is internal. However, if you create your own HeaderRenderer, be sure to expose it; the HeaderRenderer is used by the DataGrid to maintain a reference between the header and the related DataGridColumn.
public function get column():uint public function set column(value:uint):void| HeaderRenderer | () | Constructor |
public function HeaderRenderer()| Language Version: | ActionScript 3.0 |
| Product Version: | Flash CS3 |
| Runtime Versions: | Flash Player 9.0.28.0, AIR 1.0 |
Creates a new HeaderRenderer instance.
| getStyleDefinition | () | method |
public static function getStyleDefinition():Object| Language Version: | ActionScript 3.0 |
| Product Version: | Flash CS3 |
| Runtime Versions: | Flash Player 9.0.28.0, AIR 1.0 |
Retrieves the default style map for the current component. The style map contains
the type that is appropriate for the component, depending on the style that
the component uses. For example, the disabledTextFormat style
contains a value of null or a TextFormat object.
You can use these styles and call setStyle() on the current
component. The following code overrides the default disabledTextFormat
style on the specified component:
componentInstance.setStyle("disabledTextFormat", new TextFormat());Object — Default styles object.
|
See also
import fl.controls.*;
import fl.containers.*;
import fl.controls.listClasses.*;
import fl.controls.dataGridClasses.*;
import fl.controls.progressBarClasses.*;
import fl.core.UIComponent;
import fl.data.DataProvider;
var dp:DataProvider = new DataProvider();
dp.addItem( { label: "BaseScrollPane", data:BaseScrollPane } );
dp.addItem( { label: "Button", data:Button } );
dp.addItem( { label: "CellRenderer", data:CellRenderer } );
dp.addItem( { label: "CheckBox", data:CheckBox } );
dp.addItem( { label: "ColorPicker", data:ColorPicker } );
dp.addItem( { label: "ComboBox", data:ComboBox } );
dp.addItem( { label: "DataGrid", data:DataGrid } );
dp.addItem( { label: "HeaderRenderer", data:HeaderRenderer } );
dp.addItem( { label: "ImageCell", data:ImageCell } );
dp.addItem( { label: "IndeterminateBar",data:IndeterminateBar } );
dp.addItem( { label: "Label", data:Label } );
dp.addItem( { label: "List", data:List } );
dp.addItem( { label: "NumericStepper", data:NumericStepper } );
dp.addItem( { label: "ProgressBar", data:ProgressBar } );
dp.addItem( { label: "RadioButton", data:RadioButton } );
dp.addItem( { label: "ScrollPane", data:ScrollPane } );
dp.addItem( { label: "Slider", data:Slider } );
dp.addItem( { label: "TextArea", data:TextArea } );
dp.addItem( { label: "TextInput", data:TextInput } );
dp.addItem( { label: "TileList", data:TileList } );
dp.addItem( { label: "UILoader", data:UILoader } );
dp.addItem( { label: "UIComponent", data:UIComponent } );
var cb:ComboBox = new ComboBox();
cb.move(10,10);
cb.setSize(300,25);
cb.prompt = "Select a component to view its styles";
cb.rowCount = 12;
cb.dataProvider = dp;
cb.addEventListener(Event.CHANGE, showStyleDefinition);
addChild(cb);
var dg:DataGrid = new DataGrid();
dg.setSize(425,300);
dg.move(10,50);
dg.columns = [ new DataGridColumn("StyleName"), new DataGridColumn("DefaultValue") ];
addChild(dg);
function showStyleDefinition(e:Event):void {
var componentClass:Class = e.target.selectedItem.data as Class;
var styles:Object = componentClass["getStyleDefinition"].call(this);
trace(styles.toString());
var styleData:DataProvider = new DataProvider();
for(var i:* in styles) {
trace(i + " : " + styles[i]);
styleData.addItem( { StyleName:i, DefaultValue:styles[i] } );
}
styleData.sortOn("StyleName");
dg.dataProvider = styleData;
}
To run the example, follow these steps:
package
{
import fl.controls.DataGrid;
import fl.controls.dataGridClasses.DataGridColumn;
import fl.controls.dataGridClasses.HeaderRenderer;
import fl.data.DataProvider;
import fl.events.DataGridEvent;
import flash.display.Sprite;
public class HeaderRendererExample extends Sprite
{
private var dg:DataGrid;
public function HeaderRendererExample() {
createDataGrid();
}
private function createDataGrid():void {
dg = new DataGrid();
addChild(dg);
dg.setSize(500,300);
dg.sortableColumns = true;
var dp:DataProvider = new DataProvider();
var i:uint;
var totalRows:uint = 42;
for(i=0; i<totalRows; i++) {
dp.addItem( { col1:getRandomNumber(),
col2:getRandomNumber(),
col3:getRandomNumber(),
col4:getRandomNumber(),
col5:getRandomNumber(),
col6:getRandomNumber(),
col7:getRandomNumber(),
col8:getRandomNumber() } );
}
dg.dataProvider = dp;
dg.addEventListener(DataGridEvent.COLUMN_STRETCH, announceColumnStretch);
dg.addEventListener(DataGridEvent.HEADER_RELEASE, announceHeaderClick);
}
private function announceColumnStretch(e:DataGridEvent):void {
var hr:HeaderRenderer = e.itemRenderer as HeaderRenderer;
var column:DataGridColumn = dg.columns[hr.column];
trace(column.headerText + " has been stretched");
}
private function announceHeaderClick(e:DataGridEvent):void {
var hr:HeaderRenderer = e.itemRenderer as HeaderRenderer;
var column:DataGridColumn = dg.columns[hr.column];
trace(column.headerText + " header has been clicked");
}
private function getRandomNumber():uint {
return Math.round(Math.random()*100);
}
}
}