blob: 3031b475b81f75072c91dcdf875bad60abfd1ce2 [file] [log] [blame]
{ "type": "class",
"qname": "mx.collections.ListCollectionView",
"baseClassname": "org.apache.royale.utils.Proxy"
,
"description": "The ListCollectionView class adds the properties and methods of the <code>ICollectionView</code> interface to an object that conforms to the <code>IList</code> interface. As a result, you can pass an object of this class to anything that requires an <code>IList</code> or <code>ICollectionView</code>. <p>This class also lets you use [ ] array notation to access the <code>getItemAt()</code> and <code>setItemAt()</code> methods. If you use code such as <code>myListCollectionView[index]</code> Flex calls the <code>myListCollectionView</code> object's <code>getItemAt()</code> or <code>setItemAt()</code> method.</p> <p>The <code>&lt;mx:ListCollectionView&gt;</code> has the following attributes, which all of its subclasses inherit:</p> <pre>\\n &lt;mx:ListCollectionView\\n <b>Properties</b>\\n filterFunction=&quot;null&quot;\\n list=&quot;null&quot;\\n sort=&quot;null&quot;\\n <b>Events</b>\\n collectionChange=&quot;<i>No default</i>&quot;\\n /&gt;\\n </pre>",
"tags": [
{ "tagName": "mxml",
"values": []},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"members": [
{ "type": "field",
"qname": "localIndex",
"return": "Array",
"namespace": "protected",
"bindable": [],
"details": [],
"deprecated": {},
"description": "When the view is sorted or filtered the <code>localIndex</code> property contains an array of items in the sorted or filtered (ordered, reduced) view, in the sorted order. The ListCollectionView class uses this property to access the items in the view. The <code>localIndex</code> property should never contain anything that is not in the source, but may not have everything in the source. This property is <code>null</code> when there is no sort.",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "method",
"qname": "mx.collections.ListCollectionView",
"namespace": "",
"bindable": [],
"details": [],
"deprecated": {},
"description": "The ListCollectionView constructor.",
"tags": [
{ "tagName": "param",
"values": ["list the IList this ListCollectionView is meant to wrap."]},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"return": "",
"params": [{ "name": "list", "type": "mx.collections.IList"}]}
,
{ "type": "method",
"qname": "initialized",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Called automatically by the MXML compiler when the ListCollectionView is created using an MXML tag. If you create the ListCollectionView through ActionScript, you must call this method passing in the MXML document and <code>null</code> for the <code>id</code>.",
"tags": [
{ "tagName": "param",
"values": ["document The MXML document containing this ListCollectionView.", "id Ignored."]},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"return": "void",
"params": [{ "name": "document", "type": "Object"},
{ "name": "id", "type": "String"}]}
,
{ "type": "accessor",
"access": "read-only",
"return": "int",
"qname": "length",
"namespace": "public",
"bindable": ["collectionChange"],
"details": [],
"deprecated": {},
"description": "",
"tags": [
{ "tagName": "inheritDoc",
"values": []},
{ "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.collections.IList",
"qname": "list",
"namespace": "public",
"bindable": ["listChanged"],
"details": [],
"deprecated": {},
"description": "The IList that this collection view wraps.",
"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": "Function",
"qname": "filterFunction",
"namespace": "public",
"bindable": ["filterFunctionChanged"],
"details": [],
"deprecated": {},
"description": "",
"tags": [
{ "tagName": "inheritDoc",
"values": []},
{ "tagName": "see",
"values": ["#refresh()"]},
{ "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.collections.ISort",
"qname": "sort",
"namespace": "public",
"bindable": ["sortChanged"],
"details": [],
"deprecated": {},
"description": "",
"tags": [
{ "tagName": "inheritDoc",
"values": []},
{ "tagName": "see",
"values": ["#refresh()"]},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "method",
"qname": "contains",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "",
"tags": [
{ "tagName": "inheritDoc",
"values": []},
{ "tagName": "see",
"values": ["#enableAutoUpdate()", "mx.events.CollectionEvent"]},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"return": "Boolean",
"params": [{ "name": "item", "type": "Object"}]}
,
{ "type": "method",
"qname": "disableAutoUpdate",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "",
"tags": [
{ "tagName": "inheritDoc",
"values": []},
{ "tagName": "see",
"values": ["mx.collections.ICollectionView#enableAutoUpdate()", "mx.events.CollectionEvent"]},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"return": "void",
"params": []}
,
{ "type": "method",
"qname": "enableAutoUpdate",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "",
"tags": [
{ "tagName": "inheritDoc",
"values": []},
{ "tagName": "see",
"values": ["mx.collections.ICollectionView#disableAutoUpdate()"]},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"return": "void",
"params": []}
,
{ "type": "method",
"qname": "createCursor",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "",
"tags": [
{ "tagName": "inheritDoc",
"values": []},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"return": "mx.collections.IViewCursor",
"params": []}
,
{ "type": "method",
"qname": "itemUpdated",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "",
"tags": [
{ "tagName": "inheritDoc",
"values": []},
{ "tagName": "see",
"values": ["mx.events.CollectionEvent", "mx.core.IPropertyChangeNotifier", "mx.events.PropertyChangeEvent"]},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"return": "void",
"params": [{ "name": "item", "type": "Object"},
{ "name": "property", "type": "Object"},
{ "name": "oldValue", "type": "Object"},
{ "name": "newValue", "type": "Object"}]}
,
{ "type": "method",
"qname": "refresh",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "",
"tags": [
{ "tagName": "inheritDoc",
"values": [""]},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"return": "Boolean",
"params": []}
,
{ "type": "method",
"qname": "getItemAt",
"namespace": "public",
"bindable": ["collectionChange"],
"details": [],
"deprecated": {},
"description": "",
"tags": [
{ "tagName": "inheritDoc",
"values": [""]},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"return": "Object",
"params": [{ "name": "index", "type": "int"},
{ "name": "prefetch", "type": "int"}]}
,
{ "type": "method",
"qname": "setItemAt",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "",
"tags": [
{ "tagName": "inheritDoc",
"values": [""]},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"return": "Object",
"params": [{ "name": "item", "type": "Object"},
{ "name": "index", "type": "int"}]}
,
{ "type": "method",
"qname": "addItem",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "",
"tags": [
{ "tagName": "inheritDoc",
"values": [""]},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"return": "void",
"params": [{ "name": "item", "type": "Object"}]}
,
{ "type": "method",
"qname": "addItemAt",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "",
"tags": [
{ "tagName": "inheritDoc",
"values": [""]},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"return": "void",
"params": [{ "name": "item", "type": "Object"},
{ "name": "index", "type": "int"}]}
,
{ "type": "method",
"qname": "addAll",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Adds a list of items to the current list, placing them at the end of the list in the order they are passed.",
"tags": [
{ "tagName": "param",
"values": ["addList IList The list of items to add to the current list"]},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"return": "void",
"params": [{ "name": "addList", "type": "mx.collections.IList"}]}
,
{ "type": "method",
"qname": "addAllAt",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Adds a list of items to the current list, placing them at the position index passed in to the function. The items are placed at the index location and placed in the order they are recieved.",
"tags": [
{ "tagName": "param",
"values": ["addList IList The list of items to add to the current list", "index The location of the current list to place the new items."]},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "throws",
"values": ["RangeError if index is less than 0 or greater than the length of the list."]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"return": "void",
"params": [{ "name": "addList", "type": "mx.collections.IList"},
{ "name": "index", "type": "int"}]}
,
{ "type": "method",
"qname": "getItemIndex",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "",
"tags": [
{ "tagName": "inheritDoc",
"values": [""]},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"return": "int",
"params": [{ "name": "item", "type": "Object"}]}
,
{ "type": "method",
"qname": "getLocalItemIndex",
"namespace": "mx_internal",
"bindable": [],
"details": [],
"deprecated": {},
"description": "",
"tags": [
{ "tagName": "inheritDoc",
"values": [""]} ],
"return": "int",
"params": [{ "name": "item", "type": "Object"}]}
,
{ "type": "method",
"qname": "removeItem",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Removes the specified item from this list, should it exist. Relies on ArrayList implementation",
"tags": [
{ "tagName": "param",
"values": ["item Object reference to the item that should be removed."]},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Apache Flex 4.10"]},
{ "tagName": "return",
"values": ["Boolean indicating if the item was removed."]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"return": "Boolean",
"params": [{ "name": "item", "type": "Object"}]}
,
{ "type": "method",
"qname": "removeItemAt",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "",
"tags": [
{ "tagName": "inheritDoc",
"values": [""]},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"return": "Object",
"params": [{ "name": "index", "type": "int"}]}
,
{ "type": "method",
"qname": "removeAll",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Remove all items from the list.",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"return": "void",
"params": []}
,
{ "type": "method",
"qname": "toArray",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "",
"tags": [
{ "tagName": "inheritDoc",
"values": [""]},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"return": "Array",
"params": []}
,
{ "type": "method",
"qname": "toString",
"namespace": "public",
"bindable": [],
"details": ["override"],
"deprecated": {},
"description": "Prints the contents of this view to a string and returns it.",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "return",
"values": ["The contents of this view, in string form."]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"return": "String",
"params": []}
,
{ "type": "method",
"qname": "getProperty",
"namespace": "public",
"bindable": [],
"details": ["override"],
"deprecated": {},
"return": "*",
"params": [{ "name": "name", "type": "String"}]}
,
{ "type": "method",
"qname": "setProperty",
"namespace": "public",
"bindable": [],
"details": ["override"],
"deprecated": {},
"return": "void",
"params": [{ "name": "name", "type": "String"},
{ "name": "value", "type": "*"}]}
,
{ "type": "method",
"qname": "hasProperty",
"namespace": "public",
"bindable": [],
"details": ["override"],
"deprecated": {},
"return": "Boolean",
"params": [{ "name": "name", "type": "String"}]}
,
{ "type": "method",
"qname": "propertyNames",
"namespace": "public",
"bindable": [],
"details": ["override"],
"deprecated": {},
"return": "Array",
"params": []}
,
{ "type": "method",
"qname": "findItem",
"namespace": "mx_internal",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Find the item specified using the Sort find mode constants. If there is no sort assigned throw an error. caught",
"tags": [
{ "tagName": "param",
"values": ["values the values object that can be passed into Sort.findItem", "mode the mode to pass to Sort.findItem (see Sort)", "insertIndex true if it should find the insertion point"]},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "return",
"values": ["the index where the item is located, -1 if not found or SortError"]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"return": "int",
"params": [{ "name": "values", "type": "Object"},
{ "name": "mode", "type": "String"},
{ "name": "insertIndex", "type": "Boolean"}]}
,
{ "type": "method",
"qname": "getBookmark",
"namespace": "mx_internal",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Create a bookmark for this view. This method is called by ListCollectionViewCursor.",
"tags": [
{ "tagName": "param",
"values": ["index the index to bookmark"]},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "throws",
"values": ["a CollectionViewError if the index is out of bounds"]},
{ "tagName": "return",
"values": ["a new bookmark instance"]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"return": "ListCollectionViewBookmark",
"params": [{ "name": "index", "type": "int"}]}
,
{ "type": "method",
"qname": "getBookmarkIndex",
"namespace": "mx_internal",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Given a bookmark find the location for the value. If the view has been modified since the bookmark was created attempt to relocate the item. If the bookmark represents an item that is no longer in the view (removed or filtered out) return -1.",
"tags": [
{ "tagName": "param",
"values": ["bookmark the bookmark to locate"]},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "throws",
"values": ["CollectionViewError if the bookmark is invalid"]},
{ "tagName": "return",
"values": ["the new location of the bookmark, -1 if not in the view anymore"]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"return": "int",
"params": [{ "name": "bookmark", "type": "mx.collections.CursorBookmark"}]}
]
,
"events": [
{ "qname": "collectionChange",
"type": "mx.events.CollectionEvent"
,
"description": "Dispatched when the ICollectionView has been updated in some way.",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "eventType",
"values": ["mx.events.CollectionEvent.COLLECTION_CHANGE"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]}]
}