DataGridCellEditor  - AS3 Flash

Gets or sets an Object that represents the data that is associated with a component. When this value is set, the component data is stored and the containing component is invalidated. The invalidated component is then automatically redrawn.

The data property represents an object containing the item in the DataProvider that the cell represents. Typically, the data property contains standard properties, depending on the component type. In CellRenderer in a List or ComboBox component the data contains a label, icon, and data properties; a TileList: a label and a source property; a DataGrid cell contains values for each column. The data property can also contain user-specified data relevant to the specific cell. Users can extend a CellRenderer for a component to utilize different properties of the data in the rendering of the cell.

Additionally, the labelField, labelFunction, iconField, iconFunction, sourceField, and sourceFunction elements can be used to specify which properties are used to draw the label, icon, and source respectively.

Gets or sets the list properties that are applied to the cell--for example, the index and selected values. These list properties are automatically updated after the cell is invalidated.

Indicates whether the cell is included in the indices that were selected by the owner. A value of true indicates that the cell is included in the specified indices; a value of false indicates that it is not.

Note that this value cannot be changed in the DataGrid. The DataGridCellEditor class implements the ICellRenderer interface, which specifies that this value must be defined.

The default value is false.

Related API Elements

Creates a new DataGridCellEditor instance.

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());

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;
}

Sets the current cell to a specific mouse state. This method is necessary for the DataGrid to set the mouse state on an entire row when the user interacts with a single cell.

Parameters

1. Add the DataGrid component to the library.
2. Save this code as DataGridCellEditorExample.as in the same directory as your FLA.
3. Set the DocumentClass in the FLA to DataGridCellEditorExample.

package
{
    import flash.display.Sprite;
    import flash.text.TextFormat;
    import fl.data.DataProvider;
    import fl.controls.DataGrid;
    import fl.controls.dataGridClasses.DataGridCellEditor;
    import fl.managers.StyleManager;
    
    public class DataGridCellEditorExample extends Sprite
    {
        private var dg:DataGrid;
        
        public function DataGridCellEditorExample() {
            createDataGrid();
            styleDataGrid();
        }
        private function createDataGrid():void {
            dg = new DataGrid();
            addChild(dg);
            dg.setSize(200,300);
            dg.editable = 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() } );
            }
            dg.dataProvider = dp;            
        }
        private function styleDataGrid():void {
            var georgiaFormat:TextFormat = getCustomFormat();
            georgiaFormat.font = "Georgia";
            var verdanaFormat:TextFormat = getCustomFormat();
            verdanaFormat.font = "Verdana";
            var timesFormat:TextFormat = getCustomFormat();
            timesFormat.font = "Times New Roman";
            
            var firstCellEditor:DataGridCellEditor = getCustomEditor();
            firstCellEditor.setStyle("textFormat",timesFormat);
            var secondCellEditor:DataGridCellEditor = getCustomEditor();
            secondCellEditor.setStyle("textFormat",verdanaFormat);
            var thirdCellEditor:DataGridCellEditor = getCustomEditor();;
            thirdCellEditor.setStyle("textFormat",georgiaFormat);
            
            dg.columns[0].itemEditor = firstCellEditor;
            dg.columns[1].itemEditor = secondCellEditor;
            dg.columns[2].itemEditor = thirdCellEditor;    
        }
        private function getRandomNumber():uint {
            return Math.round(Math.random()*100);
        }
        private function getCustomFormat():TextFormat {
            var tf:TextFormat = new TextFormat();
            tf.bold = true;
            tf.color = 0xFFFFFF;
            return tf;
        }
        private function getCustomEditor():DataGridCellEditor {
            var dgce:DataGridCellEditor = new DataGridCellEditor();
            dgce.textField.background = true;
            dgce.textField.backgroundColor = 0xFF0000;
            dgce.maxChars = 2;
            dgce.restrict = "1234567890";
            return dgce
        }
    }
}