| Package | urlkit.rules |
| Class | public class UrlDelegateRule |
| Inheritance | UrlDelegateRule  UrlBaseRule flash.events.EventDispatcher |
This is useful when the children of a navigation container such as a ViewStack contain rule subtrees, and only the selected child's subtree should participate in the URL/state mapping.
| Property | Defined by | ||
|---|---|---|---|
| active : Boolean [read-only]
A delegate rule's active status is delegated to its child rule.
| UrlDelegateRule | ||
 | containerUrl : String
Set the URL for this rule based on some or all of a URL passed in from the containing browser.
| UrlBaseRule | |
| doesMatchUrl : Boolean | UrlBaseRule | |
| 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 | |
| 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 | |
| rule : IUrlRule
| UrlDelegateRule | ||
| strictMatching : Boolean = false
If set, this flag enables strict matching against the child rule.
| UrlDelegateRule | ||
| title : String
Get the title component string associated with this rule, to be used
in determining the overall application window title.
| UrlBaseRule | |
| url : String
Get the URL component associated with this rule, representing its
encoding of the current application state.
| UrlBaseRule | |
| 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 | |
| Method | Defined by | ||
|---|---|---|---|
| UrlDelegateRule | |||
|
defaultPatternFromFormat(f:String):String
[static]
| UrlBaseRule | |
|
exec(url:String):Array
| UrlBaseRule | |
|
initialized(document:Object, id:String):void
Notify this rule that it has been completely initialized by its owning document.
| UrlBaseRule | |
|
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
A delegate rule's URL prefix matching is delegated to its child rule.
| UrlDelegateRule | ||
| Method | Defined by | ||
|---|---|---|---|
|
applyUrlFormat(stringValue:String):String
| UrlBaseRule | |
|
checkReadiness(e:Event):void
Check this rule to determine whether it's ready.
| UrlDelegateRule | ||
|
commitBrowserChange():void
Commit a new delegate rule's state by propagating its URL to the child.
| UrlDelegateRule | ||
|
computeApplicationState():void
Compute a delegate rule's state by copying its child rule's state.
| UrlDelegateRule | ||
|
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 | |
| Event | Summary | Defined by | ||
|---|---|---|---|---|
| UrlDelegateRule | ||||
| This event is dispatched when the URL component for this value changes. | UrlBaseRule | ||
| UrlDelegateRule | ||||
| active | property |
Hide Inherited Public Properties
Show Inherited Public Propertiesactive:Boolean [read-only]A delegate rule's active status is delegated to its child rule.
Implementation public function get active():Boolean
See also
| rule | property |
rule:IUrlRule [read-write]
This property can be used as the source for data binding.
Implementation public function get rule():IUrlRule
public function set rule(value:IUrlRule):void
| strictMatching | property |
public var strictMatching:Boolean = falseIf set, this flag enables strict matching against the child rule. Normally this is disabled, because a delegate rule's child is often changed dynamically by a sibling rule.
This property can be used as the source for data binding.
| UrlDelegateRule | () | constructor |
public function UrlDelegateRule()
| checkReadiness | () | method |
protected override function checkReadiness(e:Event):voidCheck this rule to determine whether it's ready. Readiness of a delegate rule requires that it have a child rule to which it can delegate.
Parameterse:Event |
| commitBrowserChange | () | method |
protected override function commitBrowserChange():voidCommit a new delegate rule's state by propagating its URL to the child.
| computeApplicationState | () | method |
protected override function computeApplicationState():voidCompute a delegate rule's state by copying its child rule's state.
| matchUrlPrefix | () | method |
public override function matchUrlPrefix(url:String):StringA delegate rule's URL prefix matching is delegated to its child rule.
Parametersurl:String |
String |
See also
| change | event |
| ruleChanged | event |