| Package | com.soma.view |
| Class | public class PageExternal |
| Inheritance | PageExternal  Page flash.display.MovieClip |
| Implements | IPage |
Author: Romuald Quantin - www.soundstep.com
Information:
Blog page - SomaUI
How does it work - Soma Protest
Project Host - Google Code
Documentation - Soma ASDOC
Class version: 2.0
Actionscript version: 3.0
Copyright:
The contents of this file are subject to the Mozilla Public License
Version 1.1 (the "License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
Software distributed under the License is distributed on an "AS IS" basis,
WITHOUT WARRANTY OF ANY KIND, either express or implied.
See the License for the specific language governing rights and
limitations under the License.
The Original Code is Soma.
The Initial Developer of the Original Code is Romuald Quantin.
Initial Developer are Copyright (C) 2008-2009 Soundstep. All Rights Reserved.
Usage:
PageExternal is not meant to be extended, it is internally used by the PageManager to load external SWF that is going to act as a normal page.
Here is a node example, it will load a MovieName.swf at the same location of the current SWF:
<page id="external page id" type="MovieName" urlfriendly="external-page" external="true">
<title><![CDATA[External Page]]></title>
</page>
<page id="external page id" type="MovieName" path="assets/swf/" urlfriendly="external-page" external="true">
<title><![CDATA[External Page]]></title>
</page>
See also
| Property | Defined by | ||
|---|---|---|---|
 | assets : Array Get an array containing the assets created by the NodeParser instance (all assets that are DisplayObject subclasses, you wont find XML in this array)
| Page | |
| baseUI : BaseUI
BaseUI instance for layout purpose.
| Page | |
| content : XML content node (XML) of the page, it is use by the NodeParser instance.
| Page | |
| depth : int depth of the page (depth attribute in the page node).
| Page | |
| hasExternalContent : Boolean
Whether or external assets have been found (pictures for example, assets that have to be loaded).
| Page | |
| id : String id of page (attribute id of the page node).
| Page | |
| isLoaded : Boolean [read-only]
Whether or not the SWF File has been loaded.
| PageExternal | ||
| loader : SomaLoader
SomaLoader instance used by the NodeParser instance to load external assets.
| Page | |
| loaderContext : LoaderContext LoaderContext instance of the SomaLoader instance of the page (null by default).
| Page | |
| page : Page
[read-only]
Get the SWF file that has been loaded (the Main class of the SWF file must extend a the Page class).
| PageExternal | ||
| pageXML : XML page node (XML) of this page.
| Page | |
| parser : NodeParser
NodeParser instance that will be used to create and load the assets found in the content node.
| Page | |
| parserTarget : DisplayObjectContainer the target where the assets will be added to the display list (the page itself is the default but you can specify another container).
| Page | |
| type : String type of the page (type attribute in the page node).
| Page | |
| willBeRemoved : Boolean Whether or not the page is about to be removed by the PageManager.
| Page | |
| Method | Defined by | ||
|---|---|---|---|
|
PageExternal(targetID:String)
Creates a PageExternal instance
| PageExternal | ||
|
getAssetByID(id:String):DisplayObject
Get an asset created and/or loaded by the NodeParser instance using the id attribute of its XML node.
| Page | |
|
info():String
Get a String describing the page.
| Page | |
|
transitionIn():void
Method that should be overridden, beginning of the showing process.
| Page | |
|
transitionInComplete():void
Method that should be overridden, end of the showing process.
| Page | |
|
transitionOut():void
Method that should be overridden, beginning of the hiding process.
| Page | |
|
transitionOutComplete():void
Method that should be overridden, end of the hiding process.
| Page | |
| isLoaded | property |
Hide Inherited Public Properties
Show Inherited Public PropertiesisLoaded:Boolean [read-only]Whether or not the SWF File has been loaded.
Implementation public function get isLoaded():Boolean
| page | property |
page:Page [read-only]Get the SWF file that has been loaded (the Main class of the SWF file must extend a the Page class).
Implementation public function get page():Page
| PageExternal | () | constructor |
public function PageExternal(targetID:String)Creates a PageExternal instance
ParameterstargetID:String — id attribute of the page node.
|