| Package | urlkit.rules |
| Class | public class UrlNavigatorRule |
| Inheritance | UrlNavigatorRule  UrlValueRule UrlBaseRule flash.events.EventDispatcher |
| Property | Defined by | ||
|---|---|---|---|
| accordion : Accordion | UrlNavigatorRule | ||
| active : Boolean [read-only]
| UrlNavigatorRule | ||
 | booleanValue : Boolean
Boolean property providing transparent URL encoding of values.
| UrlValueRule | |
| containerUrl : String
Set the URL for this rule based on some or all of a URL passed in from the containing browser.
| UrlBaseRule | |
| defaultValue : Object
A default value for this rule which is to be mapped to an absent or empty URL value.
| UrlValueRule | |
| doesMatchUrl : Boolean | UrlValueRule | |
| enabled : Boolean
Get the value of the enabled flag, gating whether this rule is ever
capable of reflecting or contributing state in the application .
| UrlBaseRule | |
| matchUrlBeginning : Boolean | UrlBaseRule | |
| navBar : NavBar | UrlNavigatorRule | ||
| navigatorChildRule : IUrlRule
The current child rule of the navigator's selected child's IUrlRule.
| UrlNavigatorRule | ||
| navigatorChildRuleName : String = "urls"
The name of a property which, when accessed on a selected child of
the associated navigator, will yield an IUrlRule instance mapping
a URL fragment to that child's state.
| UrlNavigatorRule | ||
| numberValue : Number
Numeric property providing transparent URL encoding of values
| UrlValueRule | |
| parent : IUrlRule
Set the parent rule of this rule.
| UrlBaseRule | |
| ready : Boolean
Get a flag indicating whether this rule is sufficiently initialized
to propagate its browser-determined state to the application.
| UrlBaseRule | |
| sourceValue : String
Provides this rule with a dot-delimited binding expression
that references a Bindable property accessible from the containing MXML document.
| UrlValueRule | |
| stringValue : String
An application state property that is bidirectionally coupled to the value-related
portion of this rule's URL, as determined by its urlPattern and urlFormat properties.
| UrlValueRule | |
| tabNavigator : TabNavigator | UrlNavigatorRule | ||
| title : String [read-only]
| UrlNavigatorRule | ||
| url : String
Get the URL component associated with this rule, representing its
encoding of the current application state.
| UrlBaseRule | |
| urlField : String = "label"
The name of a property of each selected child of the associated navigator,
which determines the String value of this rule corresponding to that child.
| UrlNavigatorRule | ||
| urlFormat : String
A string that determines the URL generated by this rule.
| UrlBaseRule | |
| urlPattern : String
A regular expression that will restrict this rule to only be active
for a URL that matches it.
| UrlBaseRule | |
| urlPatternRegEx : RegExp | UrlBaseRule | |
| useChildLabelForTitle : Boolean = false
A flag indicating that the child's label property should be used as the title component
of this rule.
| UrlNavigatorRule | ||
| viewStack : ViewStack | UrlNavigatorRule | ||
| Property | Defined by | ||
|---|---|---|---|
| defaultStringValue : String | UrlValueRule | |
| _document : UIComponent Document as passed in via IMXMLObject.initialize()
| UrlBaseRule | |
| navContainer : Object | UrlNavigatorRule | ||
| _title : String Storage property for title.
| UrlBaseRule | |
| valid : Boolean
Get a flag indicating
| UrlBaseRule | |
| Method | Defined by | ||
|---|---|---|---|
| UrlNavigatorRule | |||
|
defaultPatternFromFormat(f:String):String
[static]
| UrlBaseRule | |
|
exec(url:String):Array
| UrlBaseRule | |
|
initialized(document:Object, id:String):void
| UrlValueRule | |
|
invalidateState():void
Invalidate the application state of this rule, which ultimately requests the browser
to update its location bar from the top-level rule's URL.
| UrlBaseRule | |
|
matchUrlPrefix(url:String):String
| UrlValueRule | |
| Method | Defined by | ||
|---|---|---|---|
|
applyUrlFormat(stringValue:String):String
| UrlBaseRule | |
|
checkReadiness(e:Event):void
Check this rule to determine whether it's ready.
| UrlNavigatorRule | ||
|
commitBrowserChange():void
Override the superclass commitBrowserChange() function
to force the navigator component's index to correspond to the
rule's string value as determined from the URL.
| UrlNavigatorRule | ||
|
computeApplicationState():void
Override the computeApplicationState() function to update
this UrlValueRule's string value from the navigator prior to
URL determination.
| UrlNavigatorRule | ||
|
onCreationComplete(event:Event):void
Handle the initialization of the navigator by appropriately
syncing our rule value to its state.
| UrlNavigatorRule | ||
|
setObjectValue(o:Object):void
| UrlValueRule | |
|
setRhsSite(o:Object):void
| UrlValueRule | |
|
setupWatcher():void
| UrlValueRule | |
|
updateNavContainerIndex():void
Update the navigator's selected child index to our rule's string value
in response to a browser change or initialization action.
| UrlNavigatorRule | ||
|
updateNavigatorChildRule():void
| UrlNavigatorRule | ||
|
validateState():void
Validate this rule such that its URL and title correspond to the
application state, as determined by whatever URL/state mapping
this rule defines.
| UrlBaseRule | |
| accordion | property |
Hide Inherited Public Properties
Show Inherited Public Propertiesaccordion:Accordion [read-write]Implementation
public function get accordion():Accordion
public function set accordion(value:Accordion):void
| active | property |
active:Boolean [read-only]Implementation
public function get active():Boolean
| navBar | property |
navBar:NavBar [read-write]Implementation
public function get navBar():NavBar
public function set navBar(value:NavBar):void
| navContainer | property |
navContainer:Object [read-write]Implementation
protected function get navContainer():Object
protected function set navContainer(value:Object):void
| navigatorChildRule | property |
public var navigatorChildRule:IUrlRuleThe current child rule of the navigator's selected child's IUrlRule.
This property can be used as the source for data binding.
See also
| navigatorChildRuleName | property |
public var navigatorChildRuleName:String = "urls"The name of a property which, when accessed on a selected child of the associated navigator, will yield an IUrlRule instance mapping a URL fragment to that child's state. The default value is "urls".
This property can be used as the source for data binding.
| tabNavigator | property |
tabNavigator:TabNavigator [read-write]Implementation
public function get tabNavigator():TabNavigator
public function set tabNavigator(value:TabNavigator):void
| title | property |
title:String [read-only]This property can be used as the source for data binding.
Implementation public function get title():String
| urlField | property |
public var urlField:String = "label"The name of a property of each selected child of the associated navigator, which determines the String value of this rule corresponding to that child.
This property can be used as the source for data binding.
| useChildLabelForTitle | property |
public var useChildLabelForTitle:Boolean = falseA flag indicating that the child's label property should be used as the title component of this rule.
This property can be used as the source for data binding.
| viewStack | property |
viewStack:ViewStack [read-write]Implementation
public function get viewStack():ViewStack
public function set viewStack(value:ViewStack):void
| UrlNavigatorRule | () | constructor |
public function UrlNavigatorRule()
| checkReadiness | () | method |
protected override function checkReadiness(e:Event):voidCheck this rule to determine whether it's ready. Readiness of a navigator rule requires that its navigator be present and completely initialized.
Parameterse:Event |
| commitBrowserChange | () | method |
protected override function commitBrowserChange():voidOverride the superclass commitBrowserChange() function to force the navigator component's index to correspond to the rule's string value as determined from the URL. Also updates the navigatorChildRule property.
| computeApplicationState | () | method |
protected override function computeApplicationState():voidOverride the computeApplicationState() function to update this UrlValueRule's string value from the navigator prior to URL determination. Also updates the navigatorChildRule property.
| onCreationComplete | () | method |
protected function onCreationComplete(event:Event):voidHandle the initialization of the navigator by appropriately syncing our rule value to its state.
Parametersevent:Event |
| updateNavContainerIndex | () | method |
protected function updateNavContainerIndex():voidUpdate the navigator's selected child index to our rule's string value in response to a browser change or initialization action. Also recompute the child rule.
| updateNavigatorChildRule | () | method |
protected function updateNavigatorChildRule():void