urlkit.rules.UrlRuleSet

Package	urlkit.rules
Class	public class UrlRuleSet
Inheritance	UrlRuleSet UrlRuleContainer UrlBaseRule flash.events.EventDispatcher

UrlRuleSet is a general container for a set of rules that act in parallel (although not necessarily at the same time). It computes a URL by concatenating the URLs provided by each of its active children, ignoring inactive rules. It parses a URL by letting each child interpret the URL as it sees fit.

There are three types of UrlRuleSet behavior, distinguished by the setting of the type property:

The ALL type maps its URL to the concatenation of each of its child rule's URLs. Every child rule must be active with its pattern restrictions satisfied, for this mapping to be valid. This is the default type of UrlRuleSet. The application-generated URL for an unsatisfied ALL-type UrlRuleSet (in which one or more child rules are inactive) is the empty string.
The ANY type maps its URL to the concatenation of each child rule's URLs, with the difference that inactive children are simply ignored. This is handy for a URL with optional elements corresponding to child rules that may or may not apply.
The ONE type maps its URL to a single active child rule. The first applicable child rule processes an entire browser-supplied URL, and the first active child rule determines the entire application-supplied URL.

A top-level rule element is usually a UrlRuleSet, but UrlRuleSets can also be used in the interior of a rule tree.

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined by
		active : Boolean	UrlBaseRule
		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
		title : String Get the title component string associated with this rule, to be used in determining the overall application window title.	UrlBaseRule
		type : String = "all"	UrlRuleSet
		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
		_urlRules : Array	UrlRuleContainer
		urlRules : Array	UrlRuleContainer

	Property	Defined by
		_document : UIComponent Document as passed in via IMXMLObject.initialize()	UrlBaseRule
		_title : String Storage property for title.	UrlBaseRule
		valid : Boolean Get a flag indicating	UrlBaseRule

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined by
		UrlRuleSet()	UrlRuleSet
		addChild(rule:IUrlRule):void	UrlRuleContainer
		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 Determine whether this rule is able to consume and interpret all or some prefix of a given URL as a valid application state.	UrlBaseRule

Protected Methods

Hide Inherited Protected Methods

Show Inherited Protected Methods

	Method		Defined by
		applyUrlFormat(stringValue:String):String	UrlBaseRule
		checkReadiness(e:Event):void Check this rule to determine whether it's ready, setting the `ready` property to reflect this.	UrlBaseRule
		commitBrowserChange():void Commit a browser-supplied URL to this rule set.	UrlRuleSet
		computeApplicationState():void Refresh the rule set's URL based on the application state.	UrlRuleSet
		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
		change		UrlRuleContainer
		change	This event is dispatched when the URL component for this value changes.	UrlBaseRule

	Constant	Defined by
		ALL : String = "all" [static]	UrlRuleSet
		ANY : String = "any" [static]	UrlRuleSet
		ONE : String = "one" [static]	UrlRuleSet
		STATE_CHANGE : String = "stateChange" [static]	UrlBaseRule

Property detail

type

property

public var type:String = "all"

This property can be used as the source for data binding.

Constructor detail

UrlRuleSet

()

constructor

public function UrlRuleSet()

Method detail

commitBrowserChange

()

method

protected override function commitBrowserChange():void

Commit a browser-supplied URL to this rule set. Overridden to implement rule-set-specific policies.

computeApplicationState

()

method

protected override function computeApplicationState():void

Refresh the rule set's URL based on the application state. Overridden to apply ALL, ANY and ONE policies.

Constant detail

ALL

constant

public static const ALL:String = "all"

ANY

constant

public static const ANY:String = "any"

ONE

constant

public static const ONE:String = "one"

API Documentation	All Packages \| All Classes \| Index \| Frames No Frames
Class UrlRuleSet	Properties \| Methods \| Events \| Constants