| Package | spark.core |
| Class | public class ContentCache |
| Inheritance | ContentCache  EventDispatcher Object |
| Implements | IContentLoader |
| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4.5 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Hide Inherited Public Properties
Show Inherited Public Properties| Property | Defined By | ||
|---|---|---|---|
 | constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| enableCaching : Boolean
Enables caching behavior and functionality. | ContentCache | ||
| enableQueueing : Boolean
Enables queuing behavior and functionality. | ContentCache | ||
| maxActiveRequests : int
Maximum simultaneous active requests when queuing is
enabled. | ContentCache | ||
| maxCacheEntries : int
Maximum size of MRU based cache. | ContentCache | ||
| numCacheEntries : int [read-only]
Count of active/in-use cache entries. | ContentCache | ||
| prototype : Object [static]
A reference to the prototype object of a class or function object. | Object | |
| Property | Defined By | ||
|---|---|---|---|
| activeRequests : LinkedList
List of queued CacheEntryNode instances currently executing. | ContentCache | ||
| cachedData : Dictionary
Map of source to CacheEntryNode. | ContentCache | ||
| cacheEntries : LinkedList
Ordered (MRU) list of CacheEntryNode instances. | ContentCache | ||
| priorityGroup : String = "_DEFAULT_"
Identifier of the currently prioritized content grouping. | ContentCache | ||
| requestQueue : LinkedList
List of queued CacheEntryNode instances. | ContentCache | ||
| Method | Defined By | ||
|---|---|---|---|
Constructor. | ContentCache | ||
Adds new entry to cache (or replaces existing entry). | ContentCache | ||
| addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener
receives notification of an event. | EventDispatcher | |
|
Dispatches an event into the event flow. | EventDispatcher | |
Obtain an entry for the given key if one exists. | ContentCache | ||
|
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | EventDispatcher | |
|
Indicates whether an object has a specified property defined. | Object | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
Initiates a content request for the resource identified
by the key specified. | ContentCache | ||
Promotes a content grouping to the head of the loading queue. | ContentCache | ||
|
Indicates whether the specified property exists and is enumerable. | Object | |
Resets our cache content to initial empty state. | ContentCache | ||
Resets the queue to initial empty state. | ContentCache | ||
Remove specific entry from cache. | ContentCache | ||
|
Removes a listener from the EventDispatcher object. | EventDispatcher | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
|
Returns the string representation of the specified object. | Object | |
|
Returns the primitive value of the specified object. | Object | |
|
Checks whether an event listener is registered with this EventDispatcher object or any of
its ancestors for the specified event type. | EventDispatcher | |
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| [broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active. | EventDispatcher | ||
| [broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive. | EventDispatcher | ||
| Dispatched when a cache entry is invalidated, generally this occurs when the entry is determined to be untrusted while one or more outstanding load requests are active for a given cache entry. | ContentCache | |||
| Constant | Defined By | ||
|---|---|---|---|
| UNTRUSTED : String = "untrusted" [static]
Value used to mark cached URLs that are detected as being from an
untrusted source (meaning they will no longer be shareable). | ContentCache | ||
activeRequests | property |
protected var activeRequests:LinkedList| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4.5 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
List of queued CacheEntryNode instances currently executing.
cachedData | property |
protected var cachedData:Dictionary| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4.5 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Map of source to CacheEntryNode.
cacheEntries | property |
protected var cacheEntries:LinkedList| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4.5 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Ordered (MRU) list of CacheEntryNode instances.
enableCaching | property |
enableCaching:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4.5 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Enables caching behavior and functionality. Applies only to new load() requests.
The default value is true.
Implementation
public function get enableCaching():Boolean public function set enableCaching(value:Boolean):voidenableQueueing | property |
enableQueueing:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4.5 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Enables queuing behavior and functionality. Applies only to new load() requests.
The default value is false.
Implementation
public function get enableQueueing():Boolean public function set enableQueueing(value:Boolean):voidmaxActiveRequests | property |
maxActiveRequests:int| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4.5 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Maximum simultaneous active requests when queuing is enabled.
The default value is 2.
Implementation
public function get maxActiveRequests():int public function set maxActiveRequests(value:int):voidmaxCacheEntries | property |
maxCacheEntries:int| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4.5 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Maximum size of MRU based cache. When numCacheEntries exceeds maxCacheEntries the least recently used are pruned to fit.
The default value is 100.
Implementation
public function get maxCacheEntries():int public function set maxCacheEntries(value:int):voidnumCacheEntries | property |
priorityGroup | property |
protected var priorityGroup:String = "_DEFAULT_"| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4.5 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Identifier of the currently prioritized content grouping.
The default value is "_DEFAULT_".
requestQueue | property |
protected var requestQueue:LinkedList| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4.5 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
List of queued CacheEntryNode instances.
ContentCache | () | Constructor |
public function ContentCache()| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4.5 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Constructor.
addCacheEntry | () | method |
public function addCacheEntry(source:Object, value:Object):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4.5 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Adds new entry to cache (or replaces existing entry).
Parameters
source:Object — Unique key to associate provided value with in cache.
| |
value:Object — Value to cache for given key.
|
getCacheEntry | () | method |
public function getCacheEntry(source:Object):Object| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4.5 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Obtain an entry for the given key if one exists.
Parameters
source:Object — Unique key used to represent the requested content resource.
|
Object — A value being stored by the cache for the provided key. Returns
null if not found or in the likely case the value was stored as null.
|
load | () | method |
public function load(source:Object, contentLoaderGrouping:String = null):ContentRequest| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4.5 |
| Runtime Versions: | Flash Player 10, AIR 2.5 |
Initiates a content request for the resource identified by the key specified.
Parameters
source:Object — Unique key used to represent the requested content resource.
This parameter is typically an URL or URLRequest.
| |
contentLoaderGrouping:String (default = null) |
ContentRequest — A ContentRequest instance representing the requested resource.
|
prioritize | () | method |
public function prioritize(contentLoaderGrouping:String):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4.5 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Promotes a content grouping to the head of the loading queue.
Parameters
contentLoaderGrouping:String — Name of content grouping to promote
in the loading queue. All queued requests with matching
contentLoaderGroup will be shifted to the head of the queue.
|
removeAllCacheEntries | () | method |
public function removeAllCacheEntries():void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4.5 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Resets our cache content to initial empty state.
removeAllQueueEntries | () | method |
public function removeAllQueueEntries():void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4.5 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Resets the queue to initial empty state. All requests, both active and queued, are cancelled. All cache entries associated with canceled requests are invalidated.
removeCacheEntry | () | method |
invalidateLoader | Event |
spark.events.LoaderInvalidationEventproperty LoaderInvalidationEvent.type =
spark.events.LoaderInvalidationEvent| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4.5 |
| Runtime Versions: | Flash Player 10, AIR 2.0 |
Dispatched when a cache entry is invalidated, generally this occurs when the entry is determined to be untrusted while one or more outstanding load requests are active for a given cache entry. This mechanism allows any outstanding content requests to be reset due to the fact that the cache entry has been deemed 'unshareable'. Each content request notified then attempts instead re-requests the asset.
UNTRUSTED | Constant |
protected static const UNTRUSTED:String = "untrusted"| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4.5 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Value used to mark cached URLs that are detected as being from an untrusted source (meaning they will no longer be shareable).
Mon Nov 28 2011, 06:48 AM -08:00