blob: f834c31c4c1c4c6d8c9958a2617167ec5627a585 [file] [log] [blame]
{ "type": "class",
"qname": "org.apache.royale.html.supportClasses.GraphicsItemRenderer",
"baseClassname": "org.apache.royale.svg.CompoundGraphic"
,
"description": "The GraphicsItemRenderer provides a base class for itemRenderers that use graphics rather than components.",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 10.2", "AIR 2.6"]},
{ "tagName": "productversion",
"values": ["Royale 0.0"]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"members": [
{ "type": "method",
"qname": "org.apache.royale.html.supportClasses.GraphicsItemRenderer",
"namespace": "",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Constructor.",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 10.2", "AIR 2.6"]},
{ "tagName": "productversion",
"values": ["Royale 0.0"]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"return": "",
"params": []}
,
{ "type": "accessor",
"access": "read-write",
"return": "String",
"qname": "labelField",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "The name of the field within the data to use as a label. Some itemRenderers use this field to identify the value they should show while other itemRenderers ignore this if they are showing complex information.",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 10.2", "AIR 2.6"]},
{ "tagName": "productversion",
"values": ["Royale 0.0"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "accessor",
"access": "read-write",
"return": "int",
"qname": "index",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "The position with the dataProvider being shown by the itemRenderer instance.",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 10.2", "AIR 2.6"]},
{ "tagName": "productversion",
"values": ["Royale 0.0"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "accessor",
"access": "read-write",
"return": "Boolean",
"qname": "selectable",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "<code>true</code> if the item renderer is can be selected false otherwise. Use to configure a renderer to be non selectable. Defaults to true",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 10.2", "AIR 2.6"]},
{ "tagName": "productversion",
"values": ["Royale 0.9.3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "accessor",
"access": "read-write",
"return": "Boolean",
"qname": "hoverable",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "<code>true</code> if the item renderer is can be hovered false otherwise. Use to configure a renderer to be non hoverable. Defaults to true",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 10.2", "AIR 2.6"]},
{ "tagName": "productversion",
"values": ["Royale 0.9.3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "accessor",
"access": "read-write",
"return": "Boolean",
"qname": "selected",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Whether or not the itemRenderer is in a selected state.",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 10.2", "AIR 2.6"]},
{ "tagName": "productversion",
"values": ["Royale 0.0"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "accessor",
"access": "read-write",
"return": "Boolean",
"qname": "hovered",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Whether or not the itemRenderer is in a hovered state.",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 10.2", "AIR 2.6"]},
{ "tagName": "productversion",
"values": ["Royale 0.0"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "accessor",
"access": "read-write",
"return": "Boolean",
"qname": "down",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Whether or not the itemRenderer is in a down (or pre-selected) state.",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 10.2", "AIR 2.6"]},
{ "tagName": "productversion",
"values": ["Royale 0.0"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "accessor",
"access": "read-write",
"return": "Object",
"qname": "data",
"namespace": "public",
"bindable": ["__NoChangeEvent__"],
"details": [],
"deprecated": {},
"description": "The data being represented by this itemRenderer. This can be something simple like a String or a Number or something very complex.",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 10.2", "AIR 2.6"]},
{ "tagName": "productversion",
"values": ["Royale 0.0"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "accessor",
"access": "read-write",
"return": "Object",
"qname": "listData",
"namespace": "public",
"bindable": ["__NoChangeEvent__"],
"details": [],
"deprecated": {},
"description": "Additional data about the list structure the itemRenderer may find useful.",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 10.2", "AIR 2.6"]},
{ "tagName": "productversion",
"values": ["Royale 0.0"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "accessor",
"access": "read-write",
"return": "String",
"qname": "dataField",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "The name of the field within the data the itemRenderer should use.",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 10.2", "AIR 2.6"]},
{ "tagName": "productversion",
"values": ["Royale 0.0"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "accessor",
"access": "read-write",
"return": "org.apache.royale.core.IItemRendererOwnerView",
"qname": "itemRendererOwnerView",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "The parent container for the itemRenderer instance.",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 10.2", "AIR 2.6"]},
{ "tagName": "productversion",
"values": ["Royale 0.0"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "field",
"qname": "mxmlContent",
"return": "Array",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 10.2", "AIR 2.6"]},
{ "tagName": "copy",
"values": ["org.apache.royale.core.ItemRendererClassFactory#mxmlContent"]},
{ "tagName": "productversion",
"values": ["Royale 0.0"]},
{ "tagName": "langversion",
"values": ["3.0"]},
{ "tagName": "royalesuppresspublicvarwarning",
"values": []} ]},
{ "type": "accessor",
"access": "read-only",
"return": "Array",
"qname": "MXMLDescriptor",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "",
"tags": [
{ "tagName": "private",
"values": []} ]},
{ "type": "method",
"qname": "adjustSize",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "This function is called whenever the itemRenderer changes size. Sub-classes should override this method an handle the size change.",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 10.2", "AIR 2.6"]},
{ "tagName": "productversion",
"values": ["Royale 0.0"]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"return": "void",
"params": []}
]
}