blob: beed8f64e8983ea354d55ef2abbb23b1b1f5c3b5 [file] [log] [blame]
{ "type": "class",
"qname": "spark.components.supportClasses.ItemRenderer",
"baseClassname": "spark.components.DataRenderer"
,
"description": "The ItemRenderer class is the base class for Spark item renderers. <p>Item renderers support optional view states. You typically use view states in MXML item renderers to control the appearance of a data item based on user interaction with the item. The ItemRenderer class supports all views states so that you can use those item renderers with list-based classes.</p> <p>Flex defines the following view states that you can support in your item renderers: </p> <ul> <li>normal - The data item has no user interaction.</li> <li>hovered - The mouse is over the data item.</li> <li>selected - The data item is selected.</li> <li>dragging - The data item is being dragged.</li> <li>normalAndShowCaret - The data item is in the normal state, and it has focus in the item list. </li> <li>hoveredAndShowCaret - The data item is in the hovered state, and it has focus in the item list.</li> <li>selectedAndShowCaret - The data item is in the normal state, and it has focus in the item list.</li> </ul> <p>When the user interacts with a control in a way that changes the view state of the item renderer, Flex first determines if the renderer defines that view state. If the item renderer supports the view state, Flex sets the item renderer to use that view state. If the item renderer does not supports the view state, Flex does nothing.</p> <p>The <code>&lt;s:ItemRenderer&gt;</code> tag inherits all of the tag attributes of its superclass and adds the following tag attributes:</p> <pre>\\n &lt;s:ItemRenderer\\n <strong>Properties</strong>\\n autoDrawBackground=&quot;true&quot;\\n selected=&quot;false&quot;\\n showsCaret=&quot;false&quot;\\n /&gt;\\n </pre>",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 10", "AIR 1.5"]},
{ "tagName": "mxml",
"values": []},
{ "tagName": "productversion",
"values": ["Royale 0.9.4"]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"members": [
{ "type": "method",
"qname": "spark.components.supportClasses.ItemRenderer",
"namespace": "",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Constructor.",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 10", "AIR 1.5"]},
{ "tagName": "productversion",
"values": ["Royale 0.9.4"]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"return": "",
"params": []}
,
{ "type": "accessor",
"access": "read-write",
"return": "Boolean",
"qname": "down",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Set to <code>true</code> when the user is pressing down on an item renderer.",
"tags": [
{ "tagName": "default",
"values": ["false"]},
{ "tagName": "playerversion",
"values": ["Flash 10", "AIR 1.5"]},
{ "tagName": "productversion",
"values": ["Royale 0.9.4"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "accessor",
"access": "read-write",
"return": "Boolean",
"qname": "hovered",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Set to <code>true</code> when the user is hovered over the item renderer.",
"tags": [
{ "tagName": "default",
"values": ["false"]},
{ "tagName": "playerversion",
"values": ["Flash 10", "AIR 1.5"]},
{ "tagName": "productversion",
"values": ["Royale 0.9.4"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "accessor",
"access": "read-write",
"return": "Boolean",
"qname": "hoverable",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Set to <code>true</code> when the user is hovered over the item renderer.",
"tags": [
{ "tagName": "default",
"values": ["false"]},
{ "tagName": "playerversion",
"values": ["Flash 10", "AIR 1.5"]},
{ "tagName": "productversion",
"values": ["Royale 0.9.4"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "accessor",
"access": "read-write",
"return": "Boolean",
"qname": "selected",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "",
"tags": [
{ "tagName": "inheritDoc",
"values": [""]},
{ "tagName": "default",
"values": ["false"]},
{ "tagName": "playerversion",
"values": ["Flash 10", "AIR 1.5"]},
{ "tagName": "productversion",
"values": ["Royale 0.9.4"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "accessor",
"access": "read-write",
"return": "Boolean",
"qname": "selectable",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "",
"tags": [
{ "tagName": "inheritDoc",
"values": [""]},
{ "tagName": "default",
"values": ["false"]},
{ "tagName": "playerversion",
"values": ["Flash 10", "AIR 1.5"]},
{ "tagName": "productversion",
"values": ["Royale 0.9.4"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]}]
}