Packageorg.springextensions.actionscript.collections
SVN browsingMap.as
FisheyeMap.as
Classpublic dynamic class Map
InheritanceMap Inheritance flash.utils.Dictionary
ImplementsIMap, mx.collections.ICollectionView

Basic implementation of the IMap interface.

Author: Christophe Herreman
Version: $Revision: 21 $, $Date: 2008-11-01 22:58:42 +0100 (za, 01 nov 2008) $, $Author: dmurat $
Since: 0.1


Public Properties
 PropertyDefined by
  filterFunction : Function
Map
  length : int
[read-only]
Map
  size : uint
[read-only] Returns the number of key/value pairs in the map.
Map
  sort : Sort
Map
  values : Array
[read-only] Returns an array of all values in the map.
Map
Public Methods
 MethodDefined by
  
Map()
Constructs a new Map instance.
Map
  
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Map
  
clear():void
Map
  
contains(item:Object):Boolean
Map
  
createCursor():IViewCursor
Map
  
disableAutoUpdate():void
Map
  
dispatchEvent(event:Event):Boolean
Map
  
enableAutoUpdate():void
Map
  
get(key:Object):*
Map
  
hasEventListener(type:String):Boolean
Map
  
itemUpdated(item:Object, property:Object = null, oldValue:Object = null, newValue:Object = null):void
Map
  
put(key:Object, value:Object):void
Adds an object to the map and associates it with the specified key.
Map
  
refresh():Boolean
Map
  
remove(key:Object):*
Removes the mapping for this key from this map if it is present.
Map
  
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Map
  
toString():String
Map
  
willTrigger(type:String):Boolean
Map
Events
 EventSummaryDefined by
  
collectionChange
Dispatched when the Map is changed.Map
Property detail
filterFunctionproperty
filterFunction:Function  [read-write]Implementation
    public function get filterFunction():Function
    public function set filterFunction(value:Function):void
lengthproperty 
length:int  [read-only]Implementation
    public function get length():int
sizeproperty 
size:uint  [read-only]

Returns the number of key/value pairs in the map.

Implementation
    public function get size():uint
sortproperty 
sort:Sort  [read-write]Implementation
    public function get sort():Sort
    public function set sort(value:Sort):void
valuesproperty 
values:Array  [read-only]

Returns an array of all values in the map. If no values exist in the map, then an empty Array instance will be returned.

Implementation
    public function get values():Array
Constructor detail
Map()constructor
public function Map()

Constructs a new Map instance.

Method detail
addEventListener()method
public function addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):voidParameters
type:String
 
listener:Function
 
useCapture:Boolean (default = false)
 
priority:int (default = 0)
 
useWeakReference:Boolean (default = false)
clear()method 
public function clear():void
contains()method 
public function contains(item:Object):BooleanParameters
item:Object

Returns
Boolean
createCursor()method 
public function createCursor():IViewCursor

Returns
IViewCursor
disableAutoUpdate()method 
public function disableAutoUpdate():void
dispatchEvent()method 
public function dispatchEvent(event:Event):BooleanParameters
event:Event

Returns
Boolean
enableAutoUpdate()method 
public function enableAutoUpdate():void
get()method 
public function get(key:Object):*

Parameters
key:Object

Returns
*
hasEventListener()method 
public function hasEventListener(type:String):BooleanParameters
type:String

Returns
Boolean
itemUpdated()method 
public function itemUpdated(item:Object, property:Object = null, oldValue:Object = null, newValue:Object = null):voidParameters
item:Object
 
property:Object (default = null)
 
oldValue:Object (default = null)
 
newValue:Object (default = null)
put()method 
public function put(key:Object, value:Object):void

Adds an object to the map and associates it with the specified key.

Parameters
key:Object
 
value:Object
refresh()method 
public function refresh():Boolean

Returns
Boolean
remove()method 
public function remove(key:Object):*

Removes the mapping for this key from this map if it is present. Returns the value to which the map previously associated the key, or null if the map contained no mapping for this key. (A null return can also indicate that the map previously associated null with the specified key if the implementation supports null values.) The map will not contain a mapping for the specified key once the call returns.

Parameters
key:Object — the key whose mapping is to be removed from the map

Returns
* — previous value associated with specified key, or null if there was no mapping for key
removeEventListener()method 
public function removeEventListener(type:String, listener:Function, useCapture:Boolean = false):voidParameters
type:String
 
listener:Function
 
useCapture:Boolean (default = false)
toString()method 
public function toString():String

Returns
String — String representation of the current Map instance.
willTrigger()method 
public function willTrigger(type:String):BooleanParameters
type:String

Returns
Boolean
Event detail
collectionChangeevent 
Event object type: mx.events.CollectionEvent

Dispatched when the Map is changed.




Copyright 2007-2010 Spring Actionscript.