パッケージmx.managers
public class HistoryManager
継承HistoryManager Inheritance Object

履歴管理を使用すると、ユーザーは Web ブラウザの [戻る] および [進む] ナビゲーション機能を使用して、Flex アプリケーション内を移動できます。

Accordion コンテナおよび TabNavigator コンテナの履歴管理は、デフォルトで有効になっています。すなわち、Accordion コントロールのいずれかのペインを選択した場合、ブラウザの [戻る] ボタンまたは [戻る] ナビゲーション機能を使用して前のペインに戻ることができます。ViewStack ナビゲータコンテナでは、履歴管理はデフォルトで無効になっています。

履歴管理を無効にするには、ナビゲータコンテナの historyManagementEnabled プロパティを false に設定します。

他のオブジェクトも、HistoryManager に登録すれば、アプリケーションで履歴管理を有効にできます。コンポーネントを HistoryManager クラスに登録するには、IHistoryManagerClient インターフェイスを実装するコンポーネントインスタンスへの参照を含む、HistoryManager クラスの register() メソッドを呼び出します。次の例では、Application コンポーネント (this) を初期化すると、Application コンポーネントが HistoryManager クラスに登録されます。

<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml" 
implements="mx.managers.IHistoryManagerClient" 
initialize="mx.managers.HistoryManager.register(this);">
  
コンポーネントの登録を完了するには、IHistoryManagerClient インターフェイスの saveState() メソッドおよび loadState() メソッドも実装する必要があります。UIComponent を拡張するコンポーネントは、自動的に loadState() メソッドを継承します。

HistoryManager のメソッドとプロパティはすべて静的なので、そのインスタンスを作成する必要はありません。

関連項目

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


パブリックプロパティ
 プロパティ定義
 Inheritedconstructor : Object
特定のオブジェクトインスタンスのクラスオブジェクトまたはコンストラクタ関数への参照です。
Object
 Inheritedprototype : Object
[static] クラスまたは関数オブジェクトのプロトタイプオブジェクトへの参照です。
Object
パブリックメソッド
 メソッド定義
 InheritedhasOwnProperty(name:String):Boolean
オブジェクトに指定されたプロパティが定義されているかどうかを示します。
Object
  initialize(sm:ISystemManager):void
[static] HistoryManager を初期化します。
HistoryManager
 InheritedisPrototypeOf(theClass:Object):Boolean
Object クラスのインスタンスが、パラメータとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。
Object
 InheritedpropertyIsEnumerable(name:String):Boolean
指定されたプロパティが存在し、列挙可能かどうかを示します。
Object
  register(obj:IHistoryManagerClient):void
[static] オブジェクトを HistoryManager に登録します。
HistoryManager
  save():void
[static] アプリケーションの現在の状態を保存して、後で復元できるようにします。
HistoryManager
 InheritedsetPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
ループ処理に対するダイナミックプロパティの可用性を設定します。
Object
 InheritedtoString():String
指定されたオブジェクトのストリング表現を返します。
Object
  unregister(obj:IHistoryManagerClient):void
[static] オブジェクトを HistoryManager から登録解除します。
HistoryManager
 InheritedvalueOf():Object
指定されたオブジェクトのプリミティブ値を返します。
Object
メソッドの詳細
initialize()メソッド
public static function initialize(sm:ISystemManager):void

HistoryManager を初期化します。通常は、このメソッドを呼び出す必要はありません。historyManagementEnabled を使用してコンポーネントを追加すると常に、このメソッドが呼び出されるためです。ただし、HistoryManager はトップレベルアプリケーションから初期化しないと、正しく機能しません。アプリケーションに HistoryManager が有効になっているコンポーネントがないため、HistoryManager が有効になっているコンポーネントを持つ別のサブアプリケーションをロードする場合は、メインアプリケーションで HistoryManager.initialize() メソッドを呼び出す必要があります。通常これは、アプリケーションの initialize イベントハンドラから行います。

パラメータ
sm:ISystemManager — このアプリケーションの SystemManager です。
register()メソッド 
public static function register(obj:IHistoryManagerClient):void

オブジェクトを HistoryManager に登録します。このオブジェクトは、IHistoryManagerClient インターフェイスを実装する必要があります。

パラメータ
obj:IHistoryManagerClient — 登録するオブジェクトです。

関連項目

save()メソッド 
public static function save():void

アプリケーションの現在の状態を保存して、後で復元できるようにします。このメソッドは、ナビゲータコンテナのナビゲーション状態が変わると、ナビゲーターコンテナによって自動的に呼び出されます。インターフェイスを HistoryManager に登録した場合は、アプリケーションの状態が変わったときに save() メソッドを呼び出す必要があります。

unregister()メソッド 
public static function unregister(obj:IHistoryManagerClient):void

オブジェクトを HistoryManager から登録解除します。

パラメータ
obj:IHistoryManagerClient — 登録解除するオブジェクトです。