Flex SDK Wiki

package spark.components.supportClasses
{
<a href="Exclude%28name%3D%26quot%3BcontrolBarContent%26quot%3B%2C%20kind%3D%26quot%3Bproperty%26quot%3B%29">Exclude(name="controlBarContent", kind="property")</a>
<a href="Exclude%28name%3D%26quot%3BcontrolBarGroup%26quot%3B%2C%20kind%3D%26quot%3Bproperty%26quot%3B%29">Exclude(name="controlBarGroup", kind="property")</a>
<a href="Exclude%28name%3D%26quot%3BcontrolBarLayout%26quot%3B%2C%20kind%3D%26quot%3Bproperty%26quot%3B%29">Exclude(name="controlBarLayout", kind="property")</a>
<a href="Exclude%28name%3D%26quot%3BcontrolBarVisible%26quot%3B%2C%20kind%3D%26quot%3Bproperty%26quot%3B%29">Exclude(name="controlBarVisible", kind="property")</a>
<a href="Exclude%28name%3D%26quot%3Blayout%26quot%3B%2C%20kind%3D%26quot%3Bproperty%26quot%3B%29">Exclude(name="layout", kind="property")</a>
<a href="Exclude%28name%3D%26quot%3BpreloaderChromeColor%26quot%3B%2C%20kind%3D%26quot%3Bproperty%26quot%3B%29">Exclude(name="preloaderChromeColor", kind="property")</a>
<a href="Exclude%28name%3D%26quot%3BbackgroundAlpha%26quot%3B%2C%20kind%3D%26quot%3Bstyle%26quot%3B%29">Exclude(name="backgroundAlpha", kind="style")</a>

//--------------------------------------
//  Events
//--------------------------------------

/**
 *  A cancelable event that is dispatched before the application
 *  attempts to persist its information to disk.  If preventDefault()
 *  is called on the event, the application will not persist anything
 *  to disk.
 */
<a href="Event%28name%3D%26quot%3BnavigatorStateSaving%26quot%3B%2C%20type%3D%26quot%3Bmx.events.FlexEvent%26quot%3B%29">Event(name="navigatorStateSaving", type="mx.events.FlexEvent")</a>

/**
 *  A cancelable event that is dispatched before the application
 *  restores its state from disk.  If preventDefault() is called
 *  on the event object, the application will not restore its state
 *  but start up normally.
 */
<a href="Event%28name%3D%26quot%3BnavigatorStateLoading%26quot%3B%2C%20type%3D%26quot%3Bmx.events.FlexEvent%26quot%3B%29">Event(name="navigatorStateLoading", type="mx.events.FlexEvent")</a>

/**
 *  The ViewNavigatorApplicationBase class is the base application class
 *  subclassed by all Flex mobile application objects.  This class
 *  is responsible for sets up the application infrastructure that
 *  the manages application persistence, the view navigation model,
 *  and the device integration hooks.
 */
public class ViewNavigatorApplicationBase extends Application
{
    //--------------------------------------------------------------------------
    //
    //  Skin Parts
    //
    //--------------------------------------------------------------------------

    <a href="SkinPart%28required%3D%26quot%3Bfalse%26quot%3B%29">SkinPart(required="false")</a>
    /**
     *  Dynamic skin part that defines the ViewMenu used to display the
     *  view menu when the menu button is pressed. The default skin uses 
     *  a factory that generates an ViewMenu instance. 
     */ 
    public var viewMenu:IFactory;

    //--------------------------------------------------------------------------
    //
    //  Properties
    //
    //--------------------------------------------------------------------------

    /**
     *  The persistenceManager for the application.  The persistence
     *  manager is automatically created on demand when accessed for the
     *  first time.  Override the <code>createPersistenceManager()</code>
     *  method to change the type of persistence manager that is created.
     *
     *  <p>The persistence manager will automatically save and restore
     *  the main navigator's persistence stack if the
     *  <code>persistNavigatorState</code> flag is set to true. Data stored
     *  in the persistence manager will automatically be flushed to disk
     *  when the application is suspended or exited.</p>
     *
     *  <p>The default implementation of the persistence manager uses
     *  a shared object as it's backing data store.  All information that is
     *  saved to this object must adhere to flash AMF rules for object encoding.
     *  This means that custom classes will need to be registered through the use
     *  of <code>flash.net.registerClassAlias</code></p>
     *
     *  @default Instance of a spark.core.managers.PersistenceManager
     *
     *  @langversion 3.0
     *  @playerversion Flash 10.1
     *  @playerversion AIR 2.5
     *  @productversion Flex 4.5
     */
    public function get persistenceManager():IPersistenceManager;

    /**
     *  Toggles the application session caching feature for the application.  When
     *  enabled, the application will automatically save the main navigator's view
     *  data and navigation history to the persistence manager.  When the application
     *  is relaunched, this data will automatically be read from the persistence store
     *  and applied to the application's navigator.
     *
     *  <p>When enabled, the version of the application 
     *  generated will also be added to the persistence object.  This can be
     *  accessed by using the persistence manager's <code>getProperty()</code> method
     *  using either the <code>applicationVersion</code> key.</p>
     *
     *  <p>When the persistence object is being created, the application will dispatch
     *  a cancelable <code>FlexEvent.APPLICATION_PERSISTING</code> event when the process
     *  begins and a <code>FlexEvent.APPLICATION_PERSIST</code> event when it completes.
     *  If the APPLICATION_PERSISTING event is canceled, the persistence object is not created.
     *  Similarily, when this information is being restored to the application, a cancelable
     *  <code>FlexEvent.APPLICATION_RESTORING</code> is dispatched followed by a
     *  <code>FlexEvent.APPLICATION_RESTORE</code> event.  Canceling the APPLICATION_RESTORING
     *  event will prevent the navigation data from being restored.</p>
     *
     *  <p>The <code>persistNavigatorState</code> flag must be set to true before
     *  the application initializes itself for the navigator's state to be automatically
     *  restored.</p>
     *
     *  @langversion 3.0
     *  @playerversion Flash 10.1
     *  @playerversion AIR 2.5
     *  @productversion Flex 4.5
     */
    public function get persistNavigatorState():Boolean;
    public function set persistNavigatorState(value:Boolean):void;

    //--------------------------------------------------------------------------
    //
    //  Methods
    //
    //--------------------------------------------------------------------------

    /**
     *  This method is called when the application is invoked by the
     *  OS.  This method is called in response to a InvokeEvent.INVOKE
     *  event.
     *
     *  @param event The InvokeEvent object
     *
     *  @langversion 3.0
     *  @playerversion Flash 10
     *  @playerversion AIR 2.5
     *  @productversion Flex 4.5
     */
    protected function invokeHandler(event:InvokeEvent):void
    {
    }

    /**
     *  This method is called when the application is exiting or being
     *  sent to the background by the OS.  If <code>persistNavigatorState</code>
     *  is set to true, the application will begin the state saving process
     *  here.
     *
     *  @langversion 3.0
     *  @playerversion Flash 10
     *  @playerversion AIR 2.5
     *  @productversion Flex 4.5
     */
    protected function deactivateHandler(event:Event):void

        /**
     *  This method is called when the Application's hardware back key is pressed
     *  by the user.
     *
     *  @param event The keyboard event
     *
     *  @langversion 3.0
     *  @playerversion Flash 10
     *  @playerversion AIR 2.5
     *  @productversion Flex 4.5
     */
    protected function backKeyUpHandler(event:KeyboardEvent):void

    /**
     *  Called when the menu key is pressed. By default, this opens or closes
     *  the ViewMenu.
     *
     *  @param event The keyboard event
     *
     *  @langversion 3.0
     *  @playerversion Flash 10
     *  @playerversion AIR 2.5
     *  @productversion Flex 4.5
     */
    protected function menuKeyUpHandler(event:KeyboardEvent):void

    /**
     *  Method is responsible for create the persistence manager for the application.
     *  This method will automatically be called when the persistence manager is
     *  accessed for the first time or if the <code>persistNavigatorState</code> flag
     *  is set to true on the application.
     *
     *  @langversion 3.0
     *  @playerversion Flash 10
     *  @playerversion AIR 2.5
     *  @productversion Flex 4.5
     */
    protected function createPersistenceManager():IPersistenceManager

    /**
     *  Responsible for persisting the application state to the persistence manager.
     *  This method is automatically called when <code>persistNavigatorState</code>
     *  is set to true.  By default, this method will save the version of the
     *  application to the "applicationVersion" key.
     *
     *  <p>This method will only be called if the <code>FlexEvent.NAVIGATOR_STATE_SAVING</code>
     *  event is not canceled.</p>
     *
     *  @langversion 3.0
     *  @playerversion Flash 10
     *  @playerversion AIR 2.5
     *  @productversion Flex 4.5
     */
    protected function saveNavigatorState():void

    /**
     *  Responsible for restoring the application's state when the
     *  <code>persistNavigatorState</code> flag is set to true.
     *
     *  <p>This method will only be called if the <code>FlexEvent.NAVIGATOR_STATE_LOADING</code>
     *  event is not canceled.</p>
     *
     *  @langversion 3.0
     *  @playerversion Flash 10
     *  @playerversion AIR 2.5
     *  @productversion Flex 4.5
     */
    protected function loadNavigatorState():void
}
}

package spark.components
{
<a href="DefaultProperty%28%26quot%3BnavigationStack%26quot%3B%29">DefaultProperty("navigationStack")</a>

/**
 * The main application class used for a mobile application.  This application
 * supports a single navigation stack that is provided through a ViewNavigator.
 * the developer can dispatch navigation operation on the application by
 * accessing the navigator property and calling the desired operation on
 * the view navigator.
 */
public class ViewNavigatorApplication extends ViewNavigatorApplicationBase
{
    //--------------------------------------------------------------------------
    //
    //  Skin Parts
    //
    //--------------------------------------------------------------------------

    /**
     *  The main navigator of the application.
     */
    <a href="Bindable">Bindable</a>
    <a href="SkinPart%28required%3D%26quot%3Bfalse%26quot%3B%29">SkinPart(required="false")</a>
    public var navigator:ViewNavigator;

    //--------------------------------------------------------------------------
    //
    //  Properties
    //
    //--------------------------------------------------------------------------

    /**
     *  Provides access to the main navigator's actionBar
     *  if one exists.  This property will only be valid after the
     *  navigator has been added to the display list.
     *
     *  @langversion 3.0
     *  @playerversion Flash 10
     *  @playerversion AIR 2.5
     *  @productversion Flex 4.5
     */
    public function get actionBar():ActionBar

    /**
     *  This property is the object to use to initialize the first view
     *  of the stack.
     */
    public function get firstView():Class;
    public function set firstView(value:Class):void;

    /**
     * This is the initialization data to pass to the
     * root screen when it is created.
     */
    public function get firstViewData():Object;
    public function set firstViewData(value:Object):void;

    //--------------------------------------------------------------------------
    //
    //  UI Template Properties
    //
    //--------------------------------------------------------------------------

    <a href="ArrayElementType%28%26quot%3Bmx.core.IVisualElement%26quot%3B%29">ArrayElementType("mx.core.IVisualElement")</a>
    /**
     *  Array of visual elements that are used as the ActionBar's
     *  actionContent when this view is active.
     *
     *  @default null
     */
    public function get actionContent():Array;
    public function set actionContent(value:Array):void;

    /**
     *  Layout for the ActionBar's action content group.
     *
     *  @default null
     */
    public function get actionLayout():LayoutBase;
    public function set actionLayout(value:LayoutBase):void;

    <a href="ArrayElementType%28%26quot%3Bmx.core.IVisualElement%26quot%3B%29">ArrayElementType("mx.core.IVisualElement")</a>
    /**
     *  Array of visual elements that are used as the ActionBar's
     *  navigationContent when this view is active.
     *
     *  @default null
     */
    public function get navigationContent():Array;
    public function set navigationContent(value:Array):void;

    /**
     *  Layout for the ActionBar navigation content group.
     *
     *  @default null
     */
    public function get navigationLayout():LayoutBase;
    public function set navigationLayout(value:LayoutBase):void;

    <a href="Bindable">Bindable</a>
    /**
     *
     */
    public function get title():String;
    public function set title(value:String):void;

    <a href="ArrayElementType%28%26quot%3Bmx.core.IVisualElement%26quot%3B%29">ArrayElementType("mx.core.IVisualElement")</a>
    /**
     *  Array of visual elements that are used as the ActionBar's
     *  titleContent when this view is active.
     *
     *  @default null
     */
    public function get titleContent():Array;
    public function set titleContent(value:Array):void;

    /**
     *  Layout for the ActionBar's titleContent group.
     *
     *  @default null
     */
    public function get titleLayout():LayoutBase;
    public function set titleLayout(value:LayoutBase):void;
}
}

package spark.core.managers
{
/**
 *  IPersistenceManager defines the interface that all persistence
 *  managers must follow.  These objects are responsible for
 *  persisting data between application sessions.
 */
public interface IPersistenceManager
{
    //--------------------------------------------------------------------------
    //
    //  Methods
    //
    //--------------------------------------------------------------------------

    /**
     *  Clears all the data that is being stored by the persistence
     *  manager.
     */
    function clear():void;

    /**
     *  Flushes the data being managed by the persistence manager to
     *  disk or another external storage file.
     *
     *  @return
     */
    function save():Boolean;

    /**
     *  Initializes the persistence manager.
     *
     *  @return
     */
    function load():Boolean;

    /**
     *  Returns the value of a property stored in the persistence manager.
     *
     *  @param key The property key
     */
    function getProperty(key:String):Object;

    /**
     *  Stores a value in the persistence manager.
     *
     *  @param key The key to use to store the value
     *  @param value The value object to store
     */
    function setProperty(key:String, value:Object):void;
}
}

package spark.core.managers
{
public class PersistenceManager implements IPersistenceManager
{
    // See IPersistenceManager for apis
}
}

class ViewNavigatorBase extends SkinnableContainer
{
    /**
     *  This method is responsible for serializing all data related to
     *  the navigator's children into an object that can be saved
     *  by the persistence manager.  This object will be sent to the
     *  restoreViewData method when the navigator is reinstantiated.
     *
     *  @return The object that represents the navigators state
     */
    public function saveViewData():Object;

    /**
     *  This method is responsible for restoring the navigator's view
     *  data based on the object that is passed in.
     *
     *  @param value The saved object that should be used to restore
     *  the navigators state
     */
    public function loadViewData(value:Object):void;
}

class View extends Group implements IDataRenderer
{
/**
*  Deserializes the data object that this view previous persisted
*  when the application's session has been restored.
*
*  By default, this method will set the passed value as the
*  data property of the view.
*
*  @return
*/
public function deserializeData(value:Object):void;

/**
*  Serializes the data object into something that can be properly
*  written to file or a shared object.
*
*  By default, this method will return the data property of the
*  view.
*
*  @return The serialized object
*/
public function serializeData():Object;
}

<?xml version="1.0" encoding="utf-8"?>
<s:ViewNavigatorApplication xmlns:fx="http://ns.adobe.com/mxml/2009"
                     xmlns:s="library://ns.adobe.com/flex/spark"
                     persistNavigatorState="true"
                     firstView="ColorView"
                     firstViewData="0xFF0000"/>

    <!-- No visual children can exist inside a mobile application tag -->

</s:ViewNavigatorApplication>

<?xml version="1.0" encoding="utf-8"?>
<s:View xmlns:fx="http://ns.adobe.com/mxml/2009"
        xmlns:s="library://ns.adobe.com/flex/spark">

    <!-- Set the background color to the color stored in the data property -->
    <s:Rect left="0" right="0" top="0" bottom="0">
        <s:fill>
            <s:SolidColor color="{data}"/>
        </s:fill>
    </s:Rect>

    <s:VGroup>
        <s:Button label="Push Red" click="navigator.pushView(ColorView, 0xFF0000)"/>
        <s:Button label="Push Green" click="navigator.pushView(ColorView, 0x00FF00)"/>
        <s:Button label="Push Blue" click="navigator.pushView(ColorView, 0x0000FF)"/>
    </s:VGroup>
</s:View>