blob: 6f654d6a2ec22ddad773b5fbcec116a69c726fe6 [file] [log] [blame]
{ "type": "class",
"qname": "org.apache.royale.collections.ArrayListView",
"baseClassname": "org.apache.royale.events.EventDispatcher"
,
"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 ArrayListView 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 10.2", "AIR 2.6"]},
{ "tagName": "productversion",
"values": ["Royale 0.0"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "method",
"qname": "org.apache.royale.collections.ArrayListView",
"namespace": "",
"bindable": [],
"details": [],
"deprecated": {},
"description": "The ArrayListView constructor.",
"tags": [
{ "tagName": "param",
"values": ["list the IArrayList this ArrayListView is meant to wrap."]},
{ "tagName": "playerversion",
"values": ["Flash 10.2", "AIR 2.6"]},
{ "tagName": "productversion",
"values": ["Royale 0.0"]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"return": "",
"params": [{ "name": "initialSource", "type": "org.apache.royale.collections.ArrayList"}]}
,
{ "type": "accessor",
"access": "read-write",
"return": "String",
"qname": "id",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 10.2", "AIR 2.6"]},
{ "tagName": "copy",
"values": ["org.apache.royale.core.UIBase#id"]},
{ "tagName": "productversion",
"values": ["Royale 0.0"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "accessor",
"access": "read-only",
"return": "int",
"qname": "length",
"namespace": "public",
"bindable": ["lengthChanged"],
"details": [],
"deprecated": {},
"description": "The number of items currently in this view of the source ArrayList's data.",
"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.collections.ArrayList",
"qname": "list",
"namespace": "public",
"bindable": ["listChanged"],
"details": [],
"deprecated": {},
"description": "The IArrayList that this collection view wraps.",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 10.2", "AIR 2.6"]},
{ "tagName": "productversion",
"values": ["Royale 0.0"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "method",
"qname": "toggleListListeners",
"namespace": "protected",
"bindable": [],
"details": [],
"deprecated": {},
"return": "void",
"params": [{ "name": "list", "type": "org.apache.royale.collections.ArrayList"},
{ "name": "toggleOn", "type": "Boolean"}]}
,
{ "type": "accessor",
"access": "read-write",
"return": "Array",
"qname": "source",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "The array of raw data needing conversion.",
"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": "Function",
"qname": "filterFunction",
"namespace": "public",
"bindable": ["filterFunctionChanged"],
"details": [],
"deprecated": {},
"description": "",
"tags": [
{ "tagName": "inheritDoc",
"values": []},
{ "tagName": "see",
"values": ["#refresh()"]},
{ "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.collections.ISort",
"qname": "sort",
"namespace": "public",
"bindable": ["sortChanged"],
"details": [],
"deprecated": {},
"description": "",
"tags": [
{ "tagName": "inheritDoc",
"values": []},
{ "tagName": "see",
"values": ["#refresh()"]},
{ "tagName": "playerversion",
"values": ["Flash 10.2", "AIR 2.6"]},
{ "tagName": "productversion",
"values": ["Royale 0.0"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "method",
"qname": "contains",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "verify if the item is contained within this ArrayListView",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 10.2", "AIR 2.6"]},
{ "tagName": "productversion",
"values": ["Royale 0.0"]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"return": "Boolean",
"params": [{ "name": "item", "type": "Object"}]}
,
{ "type": "method",
"qname": "disableAutoUpdate",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "stop processing update events from the source list.",
"tags": [
{ "tagName": "see",
"values": ["mx.collections.IArrayListView#enableAutoUpdate()", "mx.events.CollectionEvent"]},
{ "tagName": "playerversion",
"values": ["Flash 10.2", "AIR 2.6"]},
{ "tagName": "productversion",
"values": ["Royale 0.0"]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"return": "void",
"params": []}
,
{ "type": "method",
"qname": "enableAutoUpdate",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "restore updates from the source list",
"tags": [
{ "tagName": "see",
"values": ["mx.collections.IArrayListView#disableAutoUpdate()"]},
{ "tagName": "playerversion",
"values": ["Flash 10.2", "AIR 2.6"]},
{ "tagName": "productversion",
"values": ["Royale 0.0"]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"return": "void",
"params": []}
,
{ "type": "method",
"qname": "itemUpdated",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "trigger notification events that the item has been updated.",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 10.2", "AIR 2.6"]},
{ "tagName": "productversion",
"values": ["Royale 0.0"]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"return": "void",
"params": [{ "name": "item", "type": "Object"}]}
,
{ "type": "method",
"qname": "itemUpdatedAt",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "trigger notification events that the item has been updated.",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 10.2", "AIR 2.6"]},
{ "tagName": "productversion",
"values": ["Royale 0.0"]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"return": "void",
"params": [{ "name": "index", "type": "int"}]}
,
{ "type": "method",
"qname": "refresh",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Forces an update of this ArrayListView contents from the source ArrayList, by applying the current filter function and Sort.",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 10.2", "AIR 2.6"]},
{ "tagName": "productversion",
"values": ["Royale 0.0"]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"return": "Boolean",
"params": []}
,
{ "type": "method",
"qname": "getItemAt",
"namespace": "public",
"bindable": ["collectionChanged"],
"details": [],
"deprecated": {},
"description": "Fetches an item from the collection at a given index",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 10.2", "AIR 2.6"]},
{ "tagName": "productversion",
"values": ["Royale 0.0"]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"return": "Object",
"params": [{ "name": "index", "type": "int"}]}
,
{ "type": "method",
"qname": "setItemAt",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Replaces the item at the given index with a new item and returns the old item, or adds an item to end of the source list if the index is the same as this ArrayListView's current length, returning null",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 10.2", "AIR 2.6"]},
{ "tagName": "productversion",
"values": ["Royale 0.0"]},
{ "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 10.2", "AIR 2.6"]},
{ "tagName": "productversion",
"values": ["Royale 0.0"]},
{ "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 10.2", "AIR 2.6"]},
{ "tagName": "productversion",
"values": ["Royale 0.0"]},
{ "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 IArrayList The list of items to add to the current list"]},
{ "tagName": "playerversion",
"values": ["Flash 10.2", "AIR 2.6"]},
{ "tagName": "productversion",
"values": ["Royale 0.0"]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"return": "void",
"params": [{ "name": "addList", "type": "org.apache.royale.collections.IArrayList"}]}
,
{ "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 IArrayList 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 10.2", "AIR 2.6"]},
{ "tagName": "productversion",
"values": ["Royale 0.0"]},
{ "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": "org.apache.royale.collections.IArrayList"},
{ "name": "index", "type": "int"}]}
,
{ "type": "method",
"qname": "getItemIndex",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 10.2", "AIR 2.6"]},
{ "tagName": "productversion",
"values": ["Royale 0.0"]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"return": "int",
"params": [{ "name": "item", "type": "Object"}]}
,
{ "type": "method",
"qname": "getLocalItemIndex",
"namespace": "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 10.2", "AIR 2.6"]},
{ "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 10.2", "AIR 2.6"]},
{ "tagName": "productversion",
"values": ["Royale 0.0"]},
{ "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 10.2", "AIR 2.6"]},
{ "tagName": "productversion",
"values": ["Royale 0.0"]},
{ "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 10.2", "AIR 2.6"]},
{ "tagName": "productversion",
"values": ["Royale 0.0"]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"return": "Array",
"params": []}
,
{ "type": "method",
"qname": "findItem",
"namespace": "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 10.2", "AIR 2.6"]},
{ "tagName": "productversion",
"values": ["Royale 0.0"]},
{ "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"}]}
]
,
"events": [
{ "qname": "collectionChanged",
"type": "org.apache.royale.events.CollectionEvent"
,
"description": "Dispatched when the IArrayListView has been updated in some way.",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 10.2", "AIR 2.6"]},
{ "tagName": "eventType",
"values": ["org.apache.royale.events.CollectionEvent.COLLECTION_CHANGED"]},
{ "tagName": "productversion",
"values": ["Royale 0.0"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "qname": "itemAdded",
"type": "org.apache.royale.events.CollectionEvent"
,
"description": "Dispatched when the collection has added an item.",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 10.2", "AIR 2.6"]},
{ "tagName": "productversion",
"values": ["Royale 0.0"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "qname": "itemRemoved",
"type": "org.apache.royale.events.CollectionEvent"
,
"description": "Dispatched when the collection has removed an item.",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 10.2", "AIR 2.6"]},
{ "tagName": "productversion",
"values": ["Royale 0.0"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "qname": "allItemsRemoved",
"type": "org.apache.royale.events.CollectionEvent"
,
"description": "Dispatched when the collection has updated an item.",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 10.2", "AIR 2.6"]},
{ "tagName": "productversion",
"values": ["Royale 0.0"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "qname": "itemUpdated",
"type": "org.apache.royale.events.CollectionEvent"
,
"description": "Dispatched when the collection has updated an item.",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 10.2", "AIR 2.6"]},
{ "tagName": "productversion",
"values": ["Royale 0.0"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]}]
}