パッケージmx.managers
インターフェイスpublic interface IHistoryManagerClient
インプリメンタAccordion, ViewStack

History Manager に登録されたオブジェクトによって実装されるインターフェイス。このインターフェイスのメソッドは、アプリケーションの履歴状態を保管およびロードするときに呼び出されます。

このインターフェイスは、Flex ナビゲータコンテナである TabNavigator、Accordion、および ViewStack によって実装されます。また、HistoryManager に登録されたこれ以外のコンポーネントによっても実装される必要があります。

関連項目

mx.managers.HistoryManager
標準履歴管理の使用


パブリックメソッド
 メソッド定義
  loadState(state:Object):void
このオブジェクトの状態をロードします。
IHistoryManagerClient
  saveState():Object
このオブジェクトの状態を保存します。
IHistoryManagerClient
  toString():String
このオブジェクトを一意のストリングに変換します。
IHistoryManagerClient
メソッドの詳細
loadState()メソッド
public function loadState(state:Object):void

このオブジェクトの状態をロードします。

パラメータ
state:Object — ロードする、このオブジェクトの状態です。アプリケーションの初期状態をロードしているとき、これは null になります。


以下のコードは、保存された状態から、選択されたインデックスおよび検索ストリングをロードします。
public function loadState(state:Object):void
   {
// 最初に、状態が null であるかどうかを確認します。アプリケーションが
// 初期状態にリセットされると、loadState() が null で渡されます。
if (state == null)
    {
myList.selectedIndex = -1;
mySearchInput.text = "";
    }
else
    {
myList.selectedIndex = state.selectedIndex;
mySearchInput.text = state.searchString;
    }
   }
   

saveState()メソッド 
public function saveState():Object

このオブジェクトの状態を保存します。オブジェクトには、状態とともに保存される、各プロパティの名前と値のペアが含まれます。

History Manager は、すべてのコンポーネントから状態情報を収集し、その情報を URL 形式でエンコードします。ほとんどのブラウザで URL の長さに制限があるため、返される状態情報は、可能な限り短くする必要があります。

戻り値
Object — このオブジェクトの状態です。


以下のコードは、リストで選択されたインデックス、および検索ストリングを保存します。
public function saveState():Object
   {
var state:Object = {};
state.selectedIndex = myList.selectedIndex;
state.searchString = mySearchInput.text;
return state;
  }
  

toString()メソッド 
public function toString():String

このオブジェクトを一意のストリングに変換します。UIComponent によって実装されます。

戻り値
String — このオブジェクトの一意の ID です。