| Package | mx.managers |
| Interface | public interface IBrowserManager extends IEventDispatcher |
| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
BrowserManager.getInstance() method.
More examples
Setting the title of the HTML wrapper
Passing request data with URL fragments
Accessing information about the current URL
Learn more
Related API Elements
| Property | Defined By | ||
|---|---|---|---|
| base : String [read-only]
The portion of current URL before the '#' as it appears
in the browser address bar. | IBrowserManager | ||
| fragment : String [read-only]
The portion of current URL after the '#' as it appears
in the browser address bar. | IBrowserManager | ||
| title : String [read-only]
The title of the application as it should appear in the
browser history. | IBrowserManager | ||
| url : String [read-only]
The current URL as it appears in the browser address bar. | IBrowserManager | ||
Hide Inherited Public Methods
Show Inherited Public Methods| Method | Defined By | ||
|---|---|---|---|
 | addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener
receives notification of an event. | IEventDispatcher | |
|
Dispatches an event into the event flow. | IEventDispatcher | |
|
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | IEventDispatcher | |
Initializes the BrowserManager. | IBrowserManager | ||
Initializes the BrowserManager. | IBrowserManager | ||
|
Removes a listener from the EventDispatcher object. | IEventDispatcher | |
Changes the fragment of the URL after the '#' in the browser. | IBrowserManager | ||
Changes the text in the browser's title bar. | IBrowserManager | ||
|
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type. | IEventDispatcher | |
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| Dispatched when the URL is changed by the browser. | IBrowserManager | |||
| Dispatched when the URL is changed either by the user interacting with the browser, invoking an application in AIR, or by setting the property programmatically. | IBrowserManager | |||
| Dispatched when the URL is changed by the application. | IBrowserManager | |||
base | property |
fragment | property |
fragment:String [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The portion of current URL after the '#' as it appears
in the browser address bar. Use the setURLFragment() method to change this value.
Implementation
public function get fragment():Stringtitle | property |
url | property |
init | () | method |
public function init(value:String = null, title:String = null):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Initializes the BrowserManager. The BrowserManager will get the initial URL. If it
has a fragment, it will dispatch a BROWSER_URL_CHANGE event.
This method sets the value of the ApplicationGlobals.application.historyManagementEnabled
property to false because the HistoryManager generally interferes with your
application's handling of URL fragments.
Parameters
value:String (default = null) | |
title:String (default = null) |
initForHistoryManager | () | method |
public function initForHistoryManager():void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Initializes the BrowserManager. The HistoryManager calls this method to
prepare the BrowserManager for further calls from the HistoryManager. You cannot use
the HistoryManager and call the setFragment() method from the application.
As a result, the init() method usually sets
the value of the ApplicationGlobals.application.historyManagementEnabled property to false to disable
the HistoryManager.
setFragment | () | method |
public function setFragment(value:String):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Changes the fragment of the URL after the '#' in the browser. An attempt will be made to track this URL in the browser's history.
If the title is set, the old title in the browser is replaced by the new title.
To store the URL, a JavaScript
method named setBrowserURL() will be called.
The application's HTML wrapper must have that method which
must implement a mechanism for taking this
value and registering it with the browser's history scheme
and address bar.
When set, the APPLICATION_URL_CHANGE event is dispatched. If the event
is cancelled, the setBrowserURL() method will not be called.
Parameters
value:String — The new fragment to use after the '#' in the URL.
|
setTitle | () | method |
public function setTitle(value:String):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Changes the text in the browser's title bar. This method does not affect the browser's history.
Parameters
value:String — The new title to use in the browser's title bar.
|
browserURLChange | Event |
mx.events.BrowserChangeEventproperty BrowserChangeEvent.type =
mx.events.BrowserChangeEvent.BROWSER_URL_CHANGE| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Dispatched when the URL is changed by the browser.
TheBrowserChangeEvent.BROWSER_URL_CHANGE constant defines the value of the
type property of the event object for a browserURLChange event.
The properties of the event object have the following values:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget. |
lastURL | The previous value of the BrowserManager's
url property. |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
url | The new value of the BrowserManager's
url property. |
change | Event |
flash.events.Eventproperty Event.type =
flash.events.Event.CHANGE| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Dispatched when the URL is changed either by the user interacting with the browser, invoking an application in AIR, or by setting the property programmatically.
TheEvent.CHANGE constant defines the value of the type property of a change event object.
This event has the following properties:
| Property | Value |
|---|---|
bubbles | true |
cancelable | false; there is no default behavior to cancel. |
currentTarget | The object that is actively processing the Event object with an event listener. |
target | The object that has had its value modified.
The target is not always the object in the display list
that registered the event listener. Use the currentTarget
property to access the object in the display list that is currently processing the event. |
urlChange | Event |
mx.events.BrowserChangeEventproperty BrowserChangeEvent.type =
mx.events.BrowserChangeEvent.URL_CHANGE| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Dispatched when the URL is changed by the application.
TheBrowserChangeEvent.URL_CHANGE constant defines the value of the
type property of the event object for a urlChange event.
The properties of the event object have the following values:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget. |
lastURL | The previous value of the BrowserManager's
url property. |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
url | The new value of the BrowserManager's
url property. |
Mon Nov 28 2011, 06:48 AM -08:00