Language Version: | ActionScript 3.0 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
The interface that the shared instance of the BrowserManager
implements. Applications listen for events,
call methods, and access properties on the shared instance
which is accessed with the
BrowserManager.getInstance()
method.
base:String
[read-only]
Language Version: | ActionScript 3.0 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
The portion of current URL before the '#' as it appears
in the browser address bar.
Implementation public function get base():String
fragment:String
[read-only]
Language Version: | ActionScript 3.0 |
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():String
title:String
[read-only]
Language Version: | ActionScript 3.0 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
The title of the application as it should appear in the
browser history.
Implementation public function get title():String
url:String
[read-only]
Language Version: | ActionScript 3.0 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
The current URL as it appears in the browser address bar.
Implementation public function get url():String
public function init(value:String = null, title:String = null):void
Language Version: | ActionScript 3.0 |
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 ) — The fragment to use if no fragment is in the initial URL.
|
|
| title:String (default = null ) — The title to use if no fragment is in the initial URL.
|
public function initForHistoryManager():void
Language Version: | ActionScript 3.0 |
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.
public function setFragment(value:String):void
Language Version: | ActionScript 3.0 |
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.
|
public function setTitle(value:String):void
Language Version: | ActionScript 3.0 |
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.
|
Event Object Type: mx.events.BrowserChangeEvent
property BrowserChangeEvent.type = mx.events.BrowserChangeEvent.BROWSER_URL_CHANGE
Language Version: | ActionScript 3.0 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Dispatched when the URL is changed
by the browser.
The
BrowserChangeEvent.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. |
Event Object Type: flash.events.Event
property Event.type = flash.events.Event.CHANGE
Language Version: | ActionScript 3.0 |
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.
The
Event.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. |
Event Object Type: mx.events.BrowserChangeEvent
property BrowserChangeEvent.type = mx.events.BrowserChangeEvent.URL_CHANGE
Language Version: | ActionScript 3.0 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Dispatched when the URL is changed
by the application.
The
BrowserChangeEvent.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. |