Packagemx.managers
Interfacepublic interface IBrowserManager extends flash.events.IEventDispatcher

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.

See also

mx.managers.BrowserManager

Public Properties
 PropertyDefined 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
Public Methods
 MethodDefined by
  
init(value:String = null, title:String = null):void
Initializes the BrowserManager.
IBrowserManager
  
initForHistoryManager():void
Initializes the BrowserManager.
IBrowserManager
  
setFragment(value:String):void
Changes the fragment of the URL after the '#' in the browser.
IBrowserManager
  
setTitle(value:String):void
Changes the text in the browser's title bar.
IBrowserManager
Events
 EventSummaryDefined by
  
browserURLChange
Dispatched when the URL is changed by the browser.IBrowserManager
  
change
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
  
urlChange
Dispatched when the URL is changed by the application.IBrowserManager
Property detail
baseproperty
base:String  [read-only]

The portion of current URL before the '#' as it appears in the browser address bar.

Implementation
    public function get base():String
fragmentproperty 
fragment:String  [read-only]

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
titleproperty 
title:String  [read-only]

The title of the application as it should appear in the browser history.

Implementation
    public function get title():String
urlproperty 
url:String  [read-only]

The current URL as it appears in the browser address bar.

Implementation
    public function get url():String
Method detail
init()method
public function init(value:String = null, title:String = null):void

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 Application.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.
initForHistoryManager()method 
public function initForHistoryManager():void

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 Application.application.historyManagementEnabled property to false to disable the HistoryManager.

setFragment()method 
public function setFragment(value:String):void

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

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 detail
browserURLChangeevent 
Event object type: mx.events.BrowserChangeEvent
BrowserChangeEvent.type property = mx.events.BrowserChangeEvent.BROWSER_URL_CHANGE

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:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe 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.
lastURLThe previous value of the BrowserManager's url property.
targetThe 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.
urlThe new value of the BrowserManager's url property.
changeevent  
Event object type: flash.events.Event

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.

urlChangeevent  
Event object type: mx.events.BrowserChangeEvent
BrowserChangeEvent.type property = mx.events.BrowserChangeEvent.URL_CHANGE

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:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe 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.
lastURLThe previous value of the BrowserManager's url property.
targetThe 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.
urlThe new value of the BrowserManager's url property.



(c) Copyright 2010 DWUser.com - http://www.dwuser.com/flashslideshow/