Flash Player 6.

dataGridInstance.addColumn(gridColumn)

gridColumn A reference to the FGridColumn object.

Nothing.

Method; adds an FGridColumn object to the right side of the grid.

The following example adds a column named newColumn at the last position in the grid and sets its width to 40:

function gridAddColumn() { var myColumn = new FGridColumn("newColumn"); grid.addColumn(myColumn); myColumn.setWidth(40); }

FGridColumn.getHeader, FDataGrid.addColumnAt

Flash Player 6.

dataGridInstance.addColumnAt(index, gridColumn)

index An integer.

gridColumn An instance of the FGridColumn object.

Nothing.

Method; adds an FGridColumn object to the grid at the column specified by the index parameter.

FGridColumn.getHeader, FDataGrid.addColumn

Flash Player 6.

dataGridInstance.addItem(item)

item A data item object.

Nothing.

Method; adds a data item to the end of the grid. A data item is an object that can include multiple name-value pairs. The name indicates the column, and the value is the data entered in the specified cell of the column. The following code contains two data items, each with three name-value pairs:

var item1 = { From:"Nigel", Subject:"Getting items is fun!", Date:"06.09.02" } var item2 = { From:"Jody", Subject:"I agree", Date:"06.09.02" }

FDataGrid.addItemAt, FDataGrid.setDataProvider

Flash Player 6.

dataGridInstance.addItemAt(index, object)

index An integer.

object A data item object.

Nothing.

Method; adds a data item to the grid at the location specified by the index parameter.

A data item is an object that can include multiple name-value pairs. The name indicates the column, and the value is the data entered in the specified cell of the column. The following code contains two data items, each with three name-value pairs:

var item1 = { From:"Nigel", Subject:"Getting items is fun!", Date:"06.09.02" } var item2 = { From:"Jody", Subject:"I agree", Date:"06.09.02" }

FDataGrid.addItem

Flash Player 6.

dataGridInstance.alternateRowColors(color1, color2)

color1 A hexadecimal column value such as

color2 A hexadecimal value such as .

Nothing.

Method; sets the colors of alternating rows. This method overrides any formatting created with the FStyleFormat object.

The following example configures a grid with alternating row colors:

function configureGrid() { grid.alternateRowColors(0xFFFFFF, 0xCCCCCC); grid.getColumnAt(0).setWidth(40); grid.getColumnAt(2).setWidth(40); }

Flash Player 6.

dataGridInstance.getColumnAt(index)

index An integer.

An FGridColumn object.

Method; returns the FGridColumn object at the column specified by the index parameter.

The following example uses FDataGrid.getColumnAt to set the width of two columns in a grid:

function configureGrid() { grid.alternateRowColors(0xFFFFFF, 0xCCCCCC); grid.getColumnAt(0).setWidth(40); grid.getColumnAt(2).setWidth(40); }

FGridColumn.getHeader

Flash Player 6.

dataGridInstance.getColumnCount()

None.

An integer.

Method; returns the total number of columns in the grid.

FDataGrid.getColumnIndex

Flash Player 6.

dataGridInstance.getColumnIndex(name)

name A string.

An integer.

Method; returns the index number of the column name specified by the name parameter.

FDataGrid.getColumnCount

Flash Player 6.

dataGridInstance.getEnabled()

None.

A Boolean value: true if the data grid is enabled, false otherwise.

Method; indicates whether the data grid is enabled.

Flash Player 6.

dataGridInstance.getItemAt(index)

index An integer.

A data item.

Method; returns the data item at the specified index.

var item1= { From:"Nigel", Subject:"Getting items is fun!", Date:"06.09.02" } var item2= { From:"Jody", Subject:"I agree", Date:"06.09.02" }

If the data grid myGrid is filled with data from the items above, the following code returns :

myGrid.getItemAt(0);

FDataGrid.addItem, FDataGrid.addItemAt

Flash Player 6.

dataGridInstance.getLength()

None.

An integer.

Method; returns the number of data items in the grid.

Flash Player 6.

dataGridInstance.getOriginalCellData()

None.

A data item.

Method; returns the original data displayed in the last edited cell.

Flash Player 6.

dataGridInstance.getRowCount()

None.

An integer.

Method; gets the number of rows in the data grid.

Flash Player 6.

dataGridInstance.getScrollPosition()

None.

An integer.

Method; returns the current scroll position.

FDataGrid.setScrollPosition

Flash Player 6.

dataGridInstance.getSelectedCell()

None.

An object with the properties index (an integer) and colName (a string).

Method; specifies the row index and the column name of the last selected cell if the data grid is editable.

Flash Player 6.

dataGridInstance.getSelectedIndex()

None.

An integer.

Method; returns the index of the data item that is currently selected.

myDP[0] = { From:"Nigel", Subject:"Getting items is fun!", Date:"06.09.02" } myDP[1] = { From:"Jody", Subject:"I agree", Date:"06.09.02" }

For example, if the cell containing the value "I agree" was selected, a call to would return the index 1.

FDataGrid.getSelectedIndices

Flash Player 6.

dataGridInstance.getSelectedIndices()

None.

An array.

Method; returns an array of indexes corresponding to the selected items.

myDP[0] = { From:"Nigel", Subject:"Getting items is fun!", Date:"06.09.02" } myDP[1] = { From:"Jody", Subject:"I agree", Date:"06.09.02" }

Users can select multiple rows in a data grid. If both of the above rows were selected, a call to would return an array with the values 0 and 1.

FDataGrid.getSelectedIndex

Flash Player 6.

dataGridInstance.getSelectedItem()

None.

A data item.

Method; returns the item that is currently selected.

var dataItem = { From:"Nigel", Subject:"Getting items is fun!" }

The following code is a function called chooseSample which is called when a user selects an item in a grid. The FDataGrid.getSelectedItem method is called inside the function and the result is assigned to the variable itm. Two properties of itm, Description and Link, are used to display a description of the sample and to add a link from which to download the sample file.

function chooseSample(grid){ var itm = grid.getSelectedItem(); bodyText.htmlText = itm.Description; fileName_txt.text = itm.Link; }

FDataGrid.getSelectedItems

Flash Player 6.

dataGridInstance.getSelectedItems()

None.

An array.

Method; returns an array of the items that are currently selected.

myDP[0] = { From:"Nigel", Subject:"Getting items is fun!", Date:"06.09.02" } myDP[1] = { From:"Jody", Subject:"I agree", Date:"06.09.02" }

FDataGrid.getSelectedItem

Flash Player 6.

dataGridInstance.removeAllColumns()

None.

Nothing.

Method; removes all the columns from the data grid but does not remove the data.

The following function removes all data and columns from a grid:

function removeEverything() { grid.removeAllItems(); grid.removeAllColumns(); }

FDataGrid.removeColumnAt

Flash Player 6.

dataGridInstance.removeAllItems()

None.

Nothing.

Method; removes all data items from the data grid.

The following function removes all data and columns from a grid:

function removeEverything() { grid.removeAllItems(); grid.removeAllColumns(); }

FDataGrid.removeItemAt, FDataGrid.replaceItemAt

Flash Player 6.

dataGridInstance.removeColumnAt(index)

index An integer.

The deleted column.

Method; removes an FGridColumn object at the position specified by the index parameter.

FDataGrid.removeAllColumns

Flash Player 6.

dataGridInstance.removeItemAt(index)

index An integer that specifies the item to remove.

The deleted item.

Method; removes the data item at the position specified by the index parameter.

myDP[0] = { From:"Nigel", Subject:"Getting items is fun!", Date:"06.09.02" } myDP[1] = { From:"Jody", Subject:"I agree", Date:"06.09.02" }

FDataGrid.removeAllItems

Flash Player 6.

dataGridInstance.replaceItemAt(item, index)

item A data item that replaces the item at the specified index.

index An integer that specifies the item to remove.

Nothing.

Method; replaces the data item at the specified index.

myDP[0] = { From:"Nigel", Subject:"Getting items is fun!", Date:"06.09.02" } myDP[1] = { From:"Jody", Subject:"I agree", Date:"06.09.02" }

Flash Player 6.

dataGridInstance.setCellData(index, colName, data)

index An integer.

colName

data

Nothing.

Method; replaces the data at the specified cell.

Flash Player 6.

dataGridInstance.setChangeHandler(funcName, obj)

funcName The name of a function.

obj The object that the specified function belongs to. The default value is _parent. This parameter is optional.

Nothing.

Method; sets the function that is called when the user makes a selection in the data grid.

The following example sets the change handler for the data grid instance grid to the function chooseSample. When a sample is chosen from a list in the grid, a description of the sample and a link to download the sample are displayed.

grid.setChangeHandler("chooseSample"); function chooseSample(grid){ var itm = grid.getSelectedItem(); bodyText.htmlText = itm.Description; fileName_txt.text = itm.Link; }

FDataGrid.setEditHandler

Flash Player 6.

dataGridInstance.setColumns(colNme1, colNme2...)

colNme1 A string.

colNme2

Nothing.

Method; creates FGridColumn objects in the order specified by the parameters. If you don't create columns before you set a data provider, each name-value pair creates a column. Use FDataGrid.setColumns if you want to create your own columns so that you don't have to display all the data in an application.

The following code creates three columns with the names "Name", "Size", and "Date":

grid.setColumns("Name", "Size", "Date");

FGridColumn.getHeader, FDataGrid.setDataProvider

Flash Player 6.

dataGridInstance.setDataProvider(dataProvider)

dataProvider An object that specifies a data provider. This object can be a recordset returned from a Flash Remoting function call, an array, or an instance of the DataProvider class. For information about Flash Remoting, see the Flash Remoting website.

Nothing.

Method; specifies the data provider from which to obtain data for the grid. Whether the data provider is a Flash Remoting recordset, an array, or an instance of the DataProvider class, the data in Flash is in the following format, where myDP is the dataProvider parameter for the FDataGrid.setDataProvider method:

myDP[0] = { From:"Nigel", Subject:"Getting items is fun!", Date:"06.09.02" } myDP[1] = { From:"Jody", Subject:"I agree", Date:"06.09.02" }

If you don't set up grid columns before you call this method, the 0th element of the data provider array is used to create the columns of the grid. If you do set up columns before you call this method, the column headers are filled with the names that match the property names in the data provider array (unless you use FGridColumn.setHeader to specify different headers). For example, unless different columns and headers are set up, the data provider myDP would create three columns with the headings "From", "Subject", and "Date", as follows:

myDP[0] = { From:"Nigel", Subject:"Getting items is fun!", Date:"06.09.02" } myDP[1] = { From:"Jody", Subject:"I agree", Date:"06.09.02" }

Flash creates the rows of a data grid by displaying each item of data. An item of data consists of the contents of each array element-that is, everything between { and }. The data provider myDP would generate two rows, one for each of its elements, and fill in the cells under each column with the value of each property. For example, row 1 reads "Nigel", "Getting items is fun!", "06.09.02". Row 2 reads "Jody", "I agree", "06.09.02".

If you want to create a grid with hidden columns (for example, a message ID), set up the columns in the grid before you call the FDataGrid.setDataProvider method, and don't create a column for the name-value pair that you don't want to display. For example, each element of the following data provider object myData also contains the property Msg_ID. If you write the code grid.setColumns("From", "Subject", "Date") to create grid columns named "From", "Subject", and "Date", but do not create a column named "Msg_ID", the values of Msg_ID in the following data items do not display.

myData[0] = { From:"Nigel", Subject:"Getting items is fun!", Date:"06.09.02", Msg_ID:"106_a"} myData[1] = { From:"Jody", Subject:"I agree", Date:"06.09.02", Msg_ID:"213_d"}

The following example defines a local data set dP within a function called setData. An instance of the FDataGrid component, named grid, is on the Stage. The last line of code in the function calls the setDataProvider method of the grid instance and passes it the parameter dP.

Flash Player 6.

dataGridInstance.setEditHandler(funcName, obj)

funcName A string that indicates the name of a function.

obj The object that the specified function belongs to. The default value is _parent.

Nothing.

Method; sets the function that is called when a user has edited a cell. The function should have the following three parameters:

grid The data grid instance.

index The row position.

colName The name of the column.

The following example defines a function called onEdit that sends information to the Output window about which cell was edited and what the original cell data was:

myGrid.setEditHandler("onEdit", _root); function onEdit(grid, index, colName) { trace("cell row " + index + " and column name " + colName + " was edited."); trace(grid.getOriginalCellData()); }

FDataGrid.setChangeHandler

Flash Player 6.

dataGridInstance.setEditable(trueOrFalse)

trueOrFalse A Boolean value: true indicates that the grid is editable. The default value is false.

Nothing.

Method; allows users to edit data in the grid. You can use this method to make the entire grid editable, and then you can use FGridColumn.setEditable to make individual columns uneditable.

FGridColumn.setEditable

Flash Player 6.

dataGridInstance.setEnabled(trueOrFalse)

trueOrFalse A Boolean value. The default value is true.

Nothing.

Method; enables or disables the data grid. For example, if you display a dialog box or window over a grid, you may want to disable the grid.

Flash Player 6.

dataGridInstance.setResizableColumns(trueOrFalse)

trueOrFalse A Boolean value.

Nothing.

Method; allows users to resize columns. The default value is true.

Flash Player 6.

dataGridInstance.setRowCount(rows)

rows An integer.

Nothing.

Method; sets the height of the data grid, based on the number of rows.

Flash Player 6.

dataGridInstance.setRowHeight(height)

height An integer.

Nothing.

Method; sets the minimum row height (fonts larger than height will increase the row height).

FDataGrid.setRowCount

Flash Player 6.

dataGridInstance.setScrollPosition(index)

index An integer.

Nothing.

Method; sets the scroll position (the index of the item in the top row).

FDataGrid.getScrollPosition

Flash Player 6.

dataGridInstance.setSelectable(trueOrFalse)

trueOrFalse A Boolean value: true if selectable, false otherwise.

Nothing.

Method; allows users to make selections in the data grid. The default value is true.

Flash Player 6.

dataGridInstance.setSelectedCell(index, colName)

index An integer.

colName The name of the column.

Nothing.

Method; gives keyboard focus to the editable cell at the specified item index and column name in edit mode.

Flash Player 6.

dataGridInstance.setSelectedIndex(index)

index An integer.

Nothing.

Method; sets the index of an item to select.

FDataGrid.setSelectedIndices

Flash Player 6.

dataGridInstance.setSelectedIndices(indexArray)

indexArray An array.

Nothing.

Method; sets the indexes of the items to select when the grid is set to select multiple rows.

FDataGrid.setSelectMultiple

Flash Player 6.

dataGridInstance.setSelectMultiple(trueOrFalse)

trueOrFalse A Boolean value: true if multiple rows are selectable, false otherwise. The default value is false.

Nothing.

Method; specifies whether the user can select multiple rows.

Flash Player 6.

dataGridInstance.setSize(width, height)

width An integer.

height An integer.

Nothing.

Method; sets the pixel width and height of the data grid.

Flash Player 6.

dataGridInstance.setSortableColumns(trueOrFalse)

trueOrFalse A Boolean value. The default value is true.

Nothing.

Method; allows users to sort columns in a data grid. While the value is true, your application can turn the sorting capability of individual columns off or on using the FGridColumn.setSortable method.

FGridColumn.setSortable

Flash Player 6.

dataGridInstance.setVScroll(trueFalseOrAuto)

trueFalseOrAuto A Boolean value or the string auto. The default value is true.

Nothing.

Method; shows or hides the vertical scroll bar. You can pass the string auto to show a vertical scroll bar if it is needed. When the trueFalseOrAuto parameter is set to false, scrolling still works.

Flash Player 6.

dataGridInstance.showBorder(trueOrFalse)

trueOrFalse A Boolean value. The default value is true.

Nothing.

Method; shows or hides the border around the whole grid.

Flash Player 6.

dataGridInstance.showColumnHeaders(trueOrFalse)

trueOrFalse A Boolean value. The default value is true.

Nothing.

Method; shows or hides the column headers.

Flash Player 6.

dataGridInstance.showGridLines(trueOrFalse)

trueOrFalse A Boolean value. The default value is true.

Nothing.

Method; shows or hides the grid lines.

Flash Player 6.

dataGridInstance.sort(compareFunction)

compareFunction A function name.

Nothing.

Method; sorts the grid according to a comparison function.

FDataGrid.sortItemsBy

Flash Player 6.

dataGridInstance.sortItemsBy(columnName, direction)

columnName

direction The string asc (ascending) or desc (descending). The default value is asc.

Nothing.

Method; sorts the items in the grid by column name and direction.

FDataGrid.sort

Flash Player 6.

dataGridInstance.spaceColumnsEqually()

None.

Nothing.

Method; sizes the columns equally to fill the width of the data grid.

Flash Player 6.

gridColumnInstance.getHeader()

None.

A string.

Method; gets the header text of a column.

FGridColumn.setHeader

Flash Player 6.

gridColumnInstance.getWidth()

None.

An integer.

Method; gets the width of the column, in pixels.

FGridColumn.setWidth

Flash Player 6.

gridColumnInstance.setCellSymbol(linkID)

linkID A movie clip's symbol linkage ID.

Nothing.

Method; chooses an external movie clip to be used as a display for the column data.

Flash Player 6.

gridColumnInstance.setEditable(trueOrFalse)

trueOrFalse A Boolean value.

Nothing.

Method; makes a column uneditable. First make the whole grid editable by calling FDataGrid.setEditable; then call FGridColumn.setEditable(false) to make an individual column uneditable.

FDataGrid.setEditable

Flash Player 6.

gridColumnInstance.setHeader(text)

text A string.

Nothing.

Method; sets the text to appear in the column header. The default text is the column name.

FGridColumn.getHeader

Flash Player 6.

gridColumnInstance.setHeaderSymbol(linkID)

linkID A movie clip's symbol linkage ID.

Nothing.

Method; sets a movie clip as a substitute header for the column.

Flash Player 6.

gridColumnInstance.setResizable(trueOrFalse)

trueOrFalse A Boolean value.

Nothing.

Method; specifies whether the column can be resized.

Flash Player 6.

gridColumnInstance.setSortable(trueOrFalse)

trueOrFalse A Boolean value.

Nothing.

Method; specifies whether the column header is a button that the user can click to sort the column.

FGridColumn.setSortFunction

Flash Player 6.

gridColumnInstance.setSortFunction(function)

function A reference to a comparison function for sorting the column.

Nothing.

Method; allows you to assign a sort comparison function for a column in the grid. The function, written in the same format as the comparison function for FDataGrid.sort, is used to sort the grid every time the column header is clicked.

FDataGrid.sort

Flash Player 6.

gridColumnInstance.setWidth(pixels)

pixels

Nothing.

Method; sets the width of the column, in pixels.

FGridColumn.getWidth