Apache Flex 4.16.0 API Reference | All Packages | All Classes | Index | Frames No Frames |
IDataProviderEnhance

Package | spark.components.supportClasses
Interface | public interface IDataProviderEnhance extends flash.events.IEventDispatcher
Implementors | DataGrid, Grid, ListBase

Language Version : | ActionScript 3.0

Product Version : | Flex 4.10

Runtime Versions : | Flash Player 11.1, AIR 3.4

Adds functionality to list driven components.

Public Properties

| Property | Defined By
--- | --- | ---
|  | isFirstRow : Boolean [read-only] Returns if the selectedIndex is equal to the first row. | IDataProviderEnhance
|  | isLastRow : Boolean [read-only] Returns if the selectedIndex is equal to the last row. | IDataProviderEnhance

Public Methods

| Method | Defined By
--- | --- | ---
|  | findRowIndex(field:String, value:String, startingIndex:int = 0, patternType:String):int This will search through a dataprovider checking the given field and for the given value and return the index for the match. | IDataProviderEnhance
|  | findRowIndices(field:String, values:Array, patternType:String):Array This will search through a dataprovider checking the given field and for the given values and return an array of indexes that matched. | IDataProviderEnhance
|  | moveIndexFindRow(field:String, value:String, startingIndex:int = 0, patternType:String):Boolean This will search through a dataprovider checking the given field and will set the selectedIndex to a matching value. | IDataProviderEnhance
|  | moveIndexFirstRow():void Changes the selectedIndex to the first row of the dataProvider. | IDataProviderEnhance
|  | moveIndexLastRow():void Changes the selectedIndex to the last row of the dataProvider. | IDataProviderEnhance
|  | moveIndexNextRow():void Changes the selectedIndex to the next row of the dataProvider. | IDataProviderEnhance
|  | moveIndexPreviousRow():void Changes the selectedIndex to the previous row of the dataProvider. | IDataProviderEnhance

Property Detail

isFirstRow | property

`isFirstRow:Boolean` [read-only]

Language Version : | ActionScript 3.0

Product Version : | Flex 4.10

Runtime Versions : | Flash Player 11.1, AIR 3.4

Returns if the selectedIndex is equal to the first row.

Implementation
`public function get isFirstRow():Boolean`

isLastRow | property |

`isLastRow:Boolean` [read-only]

Language Version : | ActionScript 3.0

Product Version : | Flex 4.10

Runtime Versions : | Flash Player 11.1, AIR 3.4

Returns if the selectedIndex is equal to the last row.

Implementation
`public function get isLastRow():Boolean`
Method Detail

findRowIndex | () | method

`public function findRowIndex(field:String, value:String, startingIndex:int = 0, patternType:String):int`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.10

Runtime Versions : | Flash Player 11.1, AIR 3.4

This will search through a dataprovider checking the given field and for the given value and return the index for the match. It can start the find from a given startingIndex;

Parameters

| `field:String`
| `value:String`
| `startingIndex:int` (default = `0`)``
| `patternType:String` (default = `NaN`)``

Returns

| `int`

findRowIndices | () | method |

`public function findRowIndices(field:String, values:Array, patternType:String):Array`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.10

Runtime Versions : | Flash Player 11.1, AIR 3.4

This will search through a dataprovider checking the given field and for the given values and return an array of indexes that matched.

Parameters

| `field:String`
| `values:Array`
| `patternType:String` (default = `NaN`)``

Returns

| `Array`

moveIndexFindRow | () | method |

`public function moveIndexFindRow(field:String, value:String, startingIndex:int = 0, patternType:String):Boolean`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.10

Runtime Versions : | Flash Player 11.1, AIR 3.4

This will search through a dataprovider checking the given field and will set the selectedIndex to a matching value. It can start the search from the startingIndex;

Parameters

| `field:String`
| `value:String`
| `startingIndex:int` (default = `0`)``
| `patternType:String` (default = `NaN`)``

Returns

| `Boolean`

moveIndexFirstRow | () | method |

`public function moveIndexFirstRow():void`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.10

Runtime Versions : | Flash Player 11.1, AIR 3.4

Changes the selectedIndex to the first row of the dataProvider.

moveIndexLastRow | () | method |

`public function moveIndexLastRow():void`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.10

Runtime Versions : | Flash Player 11.1, AIR 3.4

Changes the selectedIndex to the last row of the dataProvider.

moveIndexNextRow | () | method |

`public function moveIndexNextRow():void`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.10

Runtime Versions : | Flash Player 11.1, AIR 3.4

Changes the selectedIndex to the next row of the dataProvider. If there isn't a current selectedIndex, it silently returns. If the selectedIndex is on the first row, it does not wrap around. However the `isFirstRow` property returns true.

moveIndexPreviousRow | () | method |

`public function moveIndexPreviousRow():void`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.10

Runtime Versions : | Flash Player 11.1, AIR 3.4

Changes the selectedIndex to the previous row of the dataProvider. If there isn't a current selectedIndex, it silently returns. If the selectedIndex is on the last row, it does not wrap around. However the `isLastRow` property returns true.

Sun Mar 5 2017, 03:42 PM +11:00