asdoc/spark/components/supportClasses/IDataProviderEnhance.swf.json

{ "type": "interface",
  "qname": "spark.components.supportClasses.IDataProviderEnhance",
"baseInterfaceNames": [
"org.apache.royale.events.IEventDispatcher"]
,
    "description": "Adds functionality to list driven components.",
  "tags": [
  {  "tagName": "playerversion",
         "values": ["Flash 11.1", "AIR 3.4"]},
      {  "tagName": "productversion",
         "values": ["Flex 4.10"]},
      {  "tagName": "langversion",
         "values": ["3.0"]}  ],
  "members": [
  { "type": "accessor",
    "access": "read-only",
    "return": "Boolean",
    "qname": "isFirstRow",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "Returns if the selectedIndex is equal to the first row.",
    "tags": [
    {  "tagName": "playerversion",
           "values": ["Flash 11.1", "AIR 3.4"]},
        {  "tagName": "productversion",
           "values": ["Flex 4.10"]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ]},
  { "type": "accessor",
    "access": "read-only",
    "return": "Boolean",
    "qname": "isLastRow",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "Returns if the selectedIndex is equal to the last row.",
    "tags": [
    {  "tagName": "playerversion",
           "values": ["Flash 11.1", "AIR 3.4"]},
        {  "tagName": "productversion",
           "values": ["Flex 4.10"]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ]},
  { "type": "method",
    "qname": "findRowIndex",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "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;",
    "tags": [
    {  "tagName": "playerversion",
           "values": ["Flash 11.1", "AIR 3.4"]},
        {  "tagName": "productversion",
           "values": ["Flex 4.10"]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ],
      "return": "int",
      "params": [{ "name": "field", "type": "String"},
    { "name": "value", "type": "String"},
    { "name": "startingIndex", "type": "int"},
    { "name": "patternType", "type": "String"}]}
  ,
  { "type": "method",
    "qname": "findRowIndices",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "This will search through a dataprovider checking the given field and for the given values and return an array of indexes that matched.",
    "tags": [
    {  "tagName": "playerversion",
           "values": ["Flash 11.1", "AIR 3.4"]},
        {  "tagName": "productversion",
           "values": ["Flex 4.10"]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ],
      "return": "Array",
      "params": [{ "name": "field", "type": "String"},
    { "name": "values", "type": "Array"},
    { "name": "patternType", "type": "String"}]}
  ,
  { "type": "method",
    "qname": "moveIndexFirstRow",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "Changes the selectedIndex to the first row of the dataProvider.",
    "tags": [
    {  "tagName": "playerversion",
           "values": ["Flash 11.1", "AIR 3.4"]},
        {  "tagName": "productversion",
           "values": ["Flex 4.10"]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ],
      "return": "void",
      "params": []}
  ,
  { "type": "method",
    "qname": "moveIndexLastRow",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "Changes the selectedIndex to the last row of the dataProvider.",
    "tags": [
    {  "tagName": "playerversion",
           "values": ["Flash 11.1", "AIR 3.4"]},
        {  "tagName": "productversion",
           "values": ["Flex 4.10"]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ],
      "return": "void",
      "params": []}
  ,
  { "type": "method",
    "qname": "moveIndexNextRow",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "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 <code>isFirstRow</code> property returns true.",
    "tags": [
    {  "tagName": "playerversion",
           "values": ["Flash 11.1", "AIR 3.4"]},
        {  "tagName": "productversion",
           "values": ["Flex 4.10"]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ],
      "return": "void",
      "params": []}
  ,
  { "type": "method",
    "qname": "moveIndexPreviousRow",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "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 <code>isLastRow</code> property returns true.",
    "tags": [
    {  "tagName": "playerversion",
           "values": ["Flash 11.1", "AIR 3.4"]},
        {  "tagName": "productversion",
           "values": ["Flex 4.10"]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ],
      "return": "void",
      "params": []}
  ,
  { "type": "method",
    "qname": "moveIndexFindRow",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "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;",
    "tags": [
    {  "tagName": "playerversion",
           "values": ["Flash 11.1", "AIR 3.4"]},
        {  "tagName": "productversion",
           "values": ["Flex 4.10"]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ],
      "return": "Boolean",
      "params": [{ "name": "field", "type": "String"},
    { "name": "value", "type": "String"},
    { "name": "startingIndex", "type": "int"},
    { "name": "patternType", "type": "String"}]}
  ]
  }