Guide de référence ActionScript® 3.0 pour la plate-forme Adobe® Flash®
Accueil  |  Masquer la liste des packages et des classes |  Packages  |  Classes  |  Nouveautés  |  Index  |  Annexes  |  Pourquoi existe-t-il du contenu en anglais ?
Filtres : Récupération des données du serveur...
Récupération des données du serveur...
mx.managers 

HistoryManager  - AS3 Flex

Packagemx.managers
Classepublic class HistoryManager
HéritageHistoryManager Inheritance Object

Version du langage: ActionScript 3.0
Version du produit: Flex 3
Versions du moteur d’exécution: Flash Player 9, AIR 1.1

Le gestionnaire d’historique permet aux utilisateurs de parcourir une application Flex avec les commandes de navigation Précédent et Suivant du navigateur Web.

En général, la classe BrowserManager et la liaison profonde vous permettent de conserver un état dans une application et de manipuler les URL et l’historique de navigation, mais la classe HistoryManager peut être utile dans d’autres circonstances, comme dans la gestion d’une application Flex héritée. Vous ne pouvez pas utiliser les classes HistoryManager et BrowserManager dans la même application Flex, même si elles utilisent le même jeu de fichiers de support.

La gestion d’historique est activée par défaut dans les conteneurs Accordion et TabNavigator. Cela signifie que si l’utilisateur sélectionne un des volets d’un contrôle Accordion, il peut renvoyer dans le volet précédent à l’aide du bouton Précédent du navigateur ou de la commande de navigation Précédent. La gestion d’historique est désactivée par défaut pour le conteneur de navigation ViewStack.

Vous pouvez désactiver la gestion d’historique en définissant la propriété historyManagementEnabled du conteneur de navigation sur false.

Vous pouvez également activer la gestion d’historique pour d’autres objets d’une application en enregistrant les objets avec la classe HistoryManager. Pour enregistrer un composant avec la classe HistoryManager, appelez la méthode register() de la classe HistoryManager avec une référence à une instance de composant qui implémente l’interface IHistoryManagerClient. Dans l’exemple suivant, le composant Application (this) est enregistré avec la classe HistoryManager lorsque l’application est initialisée :

  <mx:Application xmlns:mx="http://www.adobe.com/2006/mxml" 
    implements="mx.managers.IHistoryManagerClient" 
    initialize="mx.managers.HistoryManager.register(this);">
  
Vous devez également implémenter les méthodes saveState() et loadState() de l’interface IHistoryManagerClient pour terminer l’enregistrement du composant. Les composants qui étendent l’objet UIComponent héritent automatiquement de la méthode loadState().

Toutes les méthodes et propriétés de la classe HistoryManager sont statiques. Vous n’avez donc pas besoin de leur créer une instance.

Eléments de l’API associés



Propriétés publiques
 PropriétéDéfini par
 Inheritedconstructor : Object
Référence à l’objet de classe ou à la fonction constructeur d’une occurrence donnée d’un objet.
Object
Méthodes publiques
 MéthodeDéfini par
 Inherited
Indique si la propriété spécifiée d’un objet est définie.
Object
  
[statique] DECONSEILLE. Initialise la classe HistoryManager.
HistoryManager
 Inherited
Indique si une occurrence de la classe Object figure dans la chaîne de prototype de l’objet spécifié en tant que paramètre.
Object
 Inherited
Indique si la propriété spécifiée existe et est énumérable.
Object
  
[statique] Enregistre un objet avec la classe HistoryManager.
HistoryManager
  
[statique] Enregistre l’état actuel de l’application afin de pouvoir le restaurer ultérieurement.
HistoryManager
 Inherited
Définit la disponibilité d’une propriété dynamique pour les opérations en boucle.
Object
 Inherited
Renvoie la représentation de chaîne de cet objet, formatée selon les paramètres régionaux en vigueur.
Object
 Inherited
Renvoie la représentation sous forme de chaîne de l’objet spécifié.
Object
  
[statique] Annule l’enregistrement d’un objet avec la classe HistoryManager.
HistoryManager
 Inherited
Renvoie la valeur primitive de l’objet spécifié.
Object
Détails de la méthode

initialize

()méthode
public static function initialize(sm:ISystemManager):void

Version du langage: ActionScript 3.0
Version du produit: Flex 3
Versions du moteur d’exécution: Flash Player 9, AIR 1.1

DECONSEILLE. Initialise la classe HistoryManager. En général, il n’est pas nécessaire d’appeler cette méthode, car à chaque fois que vous ajoutez un composant avec historyManagementEnabled, Flex l’appelle. Toutefois, la classe HistoryManager ne fonctionne pas correctement si elle n’est pas initialisée à partir de l’application de niveau supérieur. Ainsi, si votre application ne comporte pas de composants activés par la classe HistoryManager et si elle charge d’autres sous-applications qui en comportent, vous devez appeler la méthode HistoryManager.initialize() dans l’application principale, généralement à partir d’un gestionnaire d’événement initialize de l’application.

Paramètres

sm:ISystemManager — SystemManager de cette application.

register

()méthode 
public static function register(obj:IHistoryManagerClient):void

Version du langage: ActionScript 3.0
Version du produit: Flex 3
Versions du moteur d’exécution: Flash Player 9, AIR 1.1

Enregistre un objet avec la classe HistoryManager. L’objet doit implémenter l’interface IHistoryManagerClient.

Paramètres

obj:IHistoryManagerClient — Objet à enregistrer.

Eléments de l’API associés

save

()méthode 
public static function save():void

Version du langage: ActionScript 3.0
Version du produit: Flex 3
Versions du moteur d’exécution: Flash Player 9, AIR 1.1

Enregistre l’état actuel de l’application afin de pouvoir le restaurer ultérieurement. Cette méthode est appelée automatiquement par les conteneurs de navigation à chaque fois que leur état de navigation change. Si vous avez enregistré une interface avec la classe HistoryManager, il est de votre ressort d’appeler la méthode save() lorsque l’état de l’application change.

unregister

()méthode 
public static function unregister(obj:IHistoryManagerClient):void

Version du langage: ActionScript 3.0
Version du produit: Flex 3
Versions du moteur d’exécution: Flash Player 9, AIR 1.1

Annule l’enregistrement d’un objet avec la classe HistoryManager.

Paramètres

obj:IHistoryManagerClient — Objet dont l’enregistrement doit être annulé.





[ X ]Pourquoi existe-t-il du contenu en anglais ?
Certaines parties du Guide de référence ActionScript 3.0 sont en anglais

Tout le contenu du Guide de référence ActionScript 3.0 n’a pas été traduit dans toutes les langues. Si un élément de langage n’est pas traduit, il s’affiche en anglais. Par exemple, la classe ga.controls.HelpBox n’est traduite dans aucune langue. Ainsi, dans la version française du guide de référence, la classe ga.controls.HelpBox apparaît en anglais.