Package | mx.managers |
Class | public class HistoryManager |
Inheritance | HistoryManager ![]() |
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
In general, you should use the BrowserManager class and deep linking for maintaining state in an application and manipulating URLs and browser history, but the HistoryManager class can be useful under some circumstances, such as if you are maintaining a legacy Flex application. You cannot use the HistoryManager and the BrowserManager classes in the same Flex application, even though they use the same set of supporting files.
History management is enabled by default for the Accordion and TabNavigator containers. This means that if the user selects one of the panes in an Accordion control, that user can return to the previous pane by using the browser's Back button or back navigation command. History management is disabled by default for the ViewStack navigator container.
You can disable history management by setting the navigator container's
historyManagementEnabled
property to false
.
You can also enable history management for other objects
in an application by registering the objects with the HistoryManager. To register a component
with the HistoryManager class, you call the HistoryManager class's register()
method with a reference to a component instance that implements the IHistoryManagerClient interface.
In the following example, the Application component (this
) is registered with
the HistoryManager class when the Application is initialized:
<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml" implements="mx.managers.IHistoryManagerClient" initialize="mx.managers.HistoryManager.register(this);">You must also implement the
saveState()
and loadState()
methods of the
IHistoryManagerClient interface to complete the registration of the component. Components that extend
UIComponent automatically inherit the loadState()
method.
All methods and properties of the HistoryManager are static, so you do not need to create an instance of it.
Related API Elements
Method | Defined By | ||
---|---|---|---|
![]() |
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 | |
![]() |
Indicates whether the specified property exists and is enumerable. | Object | |
![]() |
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 |
Wed Nov 21 2018, 06:34 AM -08:00