blob: 93e65945a8244fbcd5802d80df76645520ea98d0 [file] [log] [blame]
{ "type": "class",
"qname": "mx.charts.chartClasses.InstanceCache",
"baseClassname": ""
,
"description": "InstanceCache is a utility that governs the task of creating and managing a set of <i>n</i> object instances, where <i>n</i> changes frequently.",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]},
{ "tagName": "royalesuppresspublicvarwarning",
"values": []} ],
"members": [
{ "type": "method",
"qname": "mx.charts.chartClasses.InstanceCache",
"namespace": "",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Constructor. This can be either a Class or an IFactory. to insert instances. Set to -1 to add the children to the end of the child list. finding the style manager that controls the styles for this component.",
"tags": [
{ "tagName": "param",
"values": ["type The type of object to construct.", "parent An optional DisplayObject to add new instances to.", "insertPosition Where in the parent's child list", "moduleFactory The context for using embedded fonts and for"]},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"return": "",
"params": [{ "name": "type", "type": "Object"},
{ "name": "parent", "type": "Object"},
{ "name": "insertPosition", "type": "int"},
{ "name": "moduleFactory", "type": "mx.core.IFlexModuleFactory"}]}
,
{ "type": "accessor",
"access": "read-write",
"return": "int",
"qname": "count",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "The number of items currently required in the cache.",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "field",
"qname": "creationCallback",
"return": "Function",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "A callback invoked when new instances are created. This callback has the following signature: <pre>\\n function creationCallback(<i>newInstance</i>:Object, <i>cache</i>:InstanceCache):void;\\n </pre>",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "field",
"qname": "discard",
"return": "Boolean",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Determines if unneeded instances are discarded. If set to <code>true</code>, extra elements are discarded when the cache count is reduced. Otherwise, extra elements are kept in a separate cache and reused when the count is increased.",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "accessor",
"access": "read-write",
"return": "mx.core.IFactory",
"qname": "factory",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "A factory that generates the type of object to cache. Assigning to this discards all current instances and recreate new instances of the correct type.",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "accessor",
"access": "read-write",
"return": "mx.core.UITextFormat",
"qname": "format",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "A TextFormat to apply to any instances created. If set, this format is applied as the current and default format for the contents of any instances created. This property is only relevant if the factory generates TextField instances.",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "field",
"qname": "hide",
"return": "Boolean",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Determines if unneeded instances should be hidden. If <code>true</code>, the <code>visible</code> property is set to <code>false</code> on each extra element when the cache count is reduced, and set to <code>true</code> when the count is increased. <p>This property is only relevant when the factory generates DisplayObjects. Setting this property to <code>true</code> for other factory types generates a run-time error.</p>",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "accessor",
"access": "write-only",
"return": "int",
"qname": "insertPosition",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "The position of the instance in the parent's child list.",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "accessor",
"access": "read-only",
"return": "Array",
"qname": "instances",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "The Array of cached instances. There may be more instances in this Array than currently requested. You should rely on the <code>count</code> property of the instance cache rather than the length of this Array.",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "accessor",
"access": "read-write",
"return": "Object",
"qname": "properties",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "A hashmap of properties to assign to new instances. Each key/value pair in this hashmap is assigned to each new instance created. The property hashmap is assigned to any existing instances when set. <p>The values in the hashmap are not cloned; object values are shared by all instances.</p>",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "field",
"qname": "remove",
"return": "Boolean",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Determines if unneeded instances should be removed from their parent. If <code>true</code>, the <code>removeChild()</code> method is called on the parent for each extra element when the cache count is reduced. <p>This property is only relevant when the factory generates DisplayObjects. Setting this property to <code>true</code> for other factory types generates a run-time error.</p>",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]}]
}