Packagecom.google.code.as3webstorage
Classpublic class LocalStorage
InheritanceLocalStorage Inheritance Object

ActionScriptからWeb Storage API(localStorage)を簡単に利用できるラッパーユーティリティです.

以下のインターフェース仕様に従ってラッパーを提供していますが, 一部独自に追加しているものがあります.

Ref. W3C Web Storage - 4.1 The Storage interface

	 interface Storage {
	   readonly attribute unsigned long length;
	   getter DOMString key(in unsigned long index);
	   getter any getItem(in DOMString key);
	   setter creator void setItem(in DOMString key, in any data);
	   deleter void removeItem(in DOMString key);
	   void clear();
	 };



Public Methods
 MethodDefined By
  
addStorageEventListener(func:Function, useCapture:Boolean = false):void
[static] storage eventのリスナーを追加します.
LocalStorage
  
avaliable():Boolean
[static] as3webstorageが実行中のブラウザで機能するかどうか返します.
LocalStorage
  
clear():void
[static] Storageのデータを全て消去します.
LocalStorage
  
getItem(key:String):*
[static] キーに対するデータを返します.
LocalStorage
  
key(index:uint):*
[static] index番目のデータのキーを返します.
LocalStorage
  
length():uint
[static] Storageに格納されているデータの数を返します.
LocalStorage
  
removeItem(key:String):void
[static] Storageからキーに対するデータを削除します.
LocalStorage
  
setItem(key:String, data:*):void
[static] Storageにデータをセットします.
LocalStorage
Method Detail
addStorageEventListener()method
public static function addStorageEventListener(func:Function, useCapture:Boolean = false):void

storage eventのリスナーを追加します.

Parameters

func:Function — JavaScript側のwindowオブジェクトからstorage eventが発行された場合に, 実行される関数
 
useCapture:Boolean (default = false)


Example
Storageのデータが追加/削除された際に, reloadData()関数を呼ぶようにします.
         LocalStorage.addStorageEventListener(reloadData);
         ...
         private function reloadData(event:null):void
         {
           ...
         }
         
avaliable()method 
public static function avaliable():Boolean

as3webstorageが実行中のブラウザで機能するかどうか返します.

Returns
Boolean — as3webstorageが機能する場合はtrue, 機能しない場合はfalse
clear()method 
public static function clear():void

Storageのデータを全て消去します.

getItem()method 
public static function getItem(key:String):*

キーに対するデータを返します.

Parameters

key:String — キー

Returns
* — キーに対するアイテム
key()method 
public static function key(index:uint):*

index番目のデータのキーを返します.

Parameters

index:uint — インデックス

Returns
* — キー
length()method 
public static function length():uint

Storageに格納されているデータの数を返します.

Returns
uint — Storageに格納されているアイテムの数
removeItem()method 
public static function removeItem(key:String):void

Storageからキーに対するデータを削除します.

Parameters

key:String — データに対するキー

setItem()method 
public static function setItem(key:String, data:*):void

Storageにデータをセットします.

Parameters

key:String — データに対するキー
 
data:* — データ