asdoc/spark/components/gridClasses/IGridVisualElement.js.json

{ "type": "interface",
  "qname": "spark.components.gridClasses.IGridVisualElement",
    "description": "This interface provides a method that dynamically created visual elements can use to configure themselves before they're displayed. It's called as needed when a factory generated visual element is created or reused.  It is not intended to be called directly.  <p>This is an optional interface for all of the factory-generated visual elements except itemRenderers: <code>caretIndicator</code>, <code>hoverIndicator</code>, <code>editorIndicator</code>, <code>selectionIndicator</code>, <code>columnSeparator</code>, <code>rowSeparator</code>, <code>alternatingRowColorsBackground</code> (see DataGrid), <code>sortIndicator</code> (see GridColumnHeaderGroup).  It's typically used to configure generated visual elements with DataGrid's style values.  For example, to use the value of the DataGrid's &quot;symbolColor&quot; style for the caret's fill color, one would define the <code>prepareGridVisualElement()</code> method like this:</p>  <p> <pre>\\n public function prepareGridVisualElement(grid:Grid, rowIndex:int, columnIndex:int):void\\n {\\n caretStroke.color = grid.dataGrid.getStyle(&quot;caretColor&quot;);\\n }\\n </pre> </p>  <p>The <code>rowIndex</code> and <code>columnIndex</code> parameters specify the the cell the visual element will occupy.  If <code>columnIndex</code> = -1 then the visual element occupies a Grid row. If <code>rowIndex</code> = -1 then the visual element occupies a Grid column.</p>  <p>There are many more examples like this in DataGridSkin.mxml.  Note that custom DataGrid skin visual elements can choose not to implement this interface if the the added flexibility isn't needed.</p>",
  "tags": [
  {  "tagName": "playerversion",
         "values": ["Flash 10", "AIR 2.0"]},
      {  "tagName": "productversion",
         "values": ["Flex 4.5"]},
      {  "tagName": "langversion",
         "values": ["3.0"]}  ],
  "members": [
  { "type": "method",
    "qname": "prepareGridVisualElement",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "This method is called before a visual element of the Grid is rendered to give the element a chance to configure itself.  The method's parameters specify what cell, or row (if columnIndex = -1), or column (if rowIndex = -1) the visual element will occupy.  <p>If the visual element is generated by a factory valued DataGrid skin part, like selectionIndicator or hoverIndicator, then <code>grid.dataGrid</code> will be the DataGrid for which grid is a skin part.</p>",
    "tags": [
    {  "tagName": "param",
           "values": ["grid The Grid associated with this visual element.", "rowIndex The row coordinate of the cell the visual element will occupy, or -1", "columnIndex The column coordinate of the cell the visual element will occupy, or -1"]},
        {  "tagName": "playerversion",
           "values": ["Flash 10", "AIR 2.0"]},
        {  "tagName": "productversion",
           "values": ["Flex 4.5"]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ],
      "return": "void",
      "params": [{ "name": "grid", "type": "spark.components.Grid"},
    { "name": "rowIndex", "type": "int"},
    { "name": "columnIndex", "type": "int"}]}
  ]
  }