RouteOrganizer

Inherit:Organizer

RouteOrganizer handles the application routings. It can be used to do route-specific jobs.

The RouteOrganizer references routes setting that describes what routes exist in the “routes” section of the component settings. This route setting and the current URL are used to determine the current route. Below is example settings:

"routes": [
  {
    "name": "list",
    "path": "/:resource/list/",
    "specName": "{{:resource}}",
  },
  {
    "name": "top",
    "path":　"/",
    "specName": "top",
  }
]

The current route is determined by checking through each route settings whether it matches the following rules. The first matched one is adopted as the current route.

1. Matches origin (if an origin is specified)
2. Matches path (if a path is specified)

The RouteOrganizer can load an additional settings file specific to the current route. This additional settings file is called a spec file. The settings format in the spec file is as same as the usual component settings.

Transfer to the new route by calling openRoute() method. openRoute() process as the following:

1. Transfers to a new route with a page load when options[“jump”] is True or new route information is not specified.
2. Call history.pushState() and adds a new URL to the browser's history. (optional)
3. Call updateRoute() method when a new route requires a different spec file. (not implemented yet)
4. Validate a URL.
5. Call attaching component's refresh() method.
6. Normalize URL.

When a page load occurs, openRoute() method is called automatically for the new URL and URL validation and beyond will be performed.

The RouteOrganizer handles popstate events triggered by such as pressing the forward/back button.

When an event occurs, openRoute() method is called for the new route just like the normal loading process. Also, since the “beforePopstate” and “afterPopstate” events are triggered for attaching components, it is possible to do your own processes by writing event handlers on the component.

RouteOrganizer has a mechanism for URL validation and modification. However, RouteOrganizer does not perform any specific work, but only triggers events. Describes the logic for validation and modification in the event handlers.

This is done by calling the validateRoute() method, which is automatically called in the openRoute() method.

validateRoute() performs the following flow.

1. Triggers beforeValidate event.
2. Triggers doCheckValidity organizer event.
3. Fix the URL if validation failed and “settings.autoFixURL” option is True/
4. Triggers ValidateURL event.
5. Triggers afterValidate event.
6. Throws an error when validation still fails.

The RouteOrganizer loads route settings from the “routes” section and add them to the current route settings. These processes are done in beforeStart and afterSpecLoad timings.

• routes

• beforeStart
• afterSpecLoad

{
    "system": {
        "specPath": <specPath>,
    }
}

Type:String

Specify a spec file path.

The routing settings are placed in the “routes” section. The “routes” section is an array, allowing multiple routes to be configured. Some settings are also placed in the “settings” section.

{
    "settings": {
        "autoFixURL": <autoFixURL>,
        "validationName": <validationName>,
    },
    "routes": [{
        "name": <name>,
        "origin": <origin>,
        "path": <path>,
        "specName": <specName>,
    }],
}

Type:Boolean

Whether to fix the URL automatically when URL validation failed.

Type:String

A name of the route.

Type:String

An origin of the route.

Type:String

A path of the route with regular expressions that can be used with path-to-regexp. When not specified, all URLs match.

Type:String

A name of the spec file for the route. The spec file of the matched route will be loaded.

Type:String

A validation pattern name to use when validating the URL.

Some settings can be specified in tag attributes. Tag attributes have higher priority than settings.

Type:String

A path to the spec file. Same as "system.specPath".

Triggered after doNormallizeURL event.

None

Triggered in popstate handling, after the router calls openRoute() method and redraw.

None

Triggered right after a spec file is loaded.

Triggered after doValidate event.

None

Triggered when normalizeURL()　method is called.

None

Triggered in popstate handling, before the router calls openRoute() method to redraw.

None

Triggered when validateRoute() method is called.

None

Triggered after beforeNormalizeURL event.

None

Triggered after auto fixation of the URL when validating.

None

Type:Object Inject:component get

Returns an object that holds information about the current route.

Type:Object Inject:component get

Returns an object that holds settings specific to the current route. That is spec file JSON contents converted to an object.

Type:undefined Inject:component

Trasfers to a route according to the route information passed to the parameter. It causes a page load.

undefined

Type:Object Inject:component

Creates an object from the current URL query.

E.g. If a URL query is “?limit=10&offset=30” then the object returned is:

{
  "limit": 10,
  "offset": 30
}

A query parameter object.

Type:undefined Asynchronous Inject:component

Normalizes a URL passed to the parameter. This method only triggers events and the actual process is done by event handlers triggered.

undefined

• beforeNormalizeURL
• doNormalizeURL
• afterNormalizeURL

Type:undefined Asynchronous Inject:component

Transfers to a route according to the route information passed to the parameter. One of jumpRoute (), updateRoute (), refreshRoute () is called based on the route information passed and the current route information.

If the “name” of the current route information and the destination is different, jumpRoute () is called, if the “specName” is different, updateRoute () is called, and if both are the same, refreshRoute () is called.

undefined

Type:undefined Asynchronous Inject:component

Redraws the current route by calling attaching component's refresh() method.

undefined

Type:undefined Inject:component

Overwrites the route according to the route information passed to the parameter. Replaces the current URL without leaving the browser history.

undefined

Type:undefined Asynchronous Inject:component

Loads another spec file and switches to it.

undefined

• system.specPath

Inject:component

It transfers to the route according to the route information passed to the parameter without causing page load.

Type:undefined Asynchronous Inject:component

Validates the URL passed to the parameter. This method only triggers an event; the actual validation work is done in the event handler of the triggered events.

In the event handler, if the validation fails set this.validationResult[“result”] to false. If the validation fails and “settings.autoFix” is True, an attempt is made to automatically fix the URL. If the problem is not finally resolved, an exception is thrown.

undefined

• beforeValidate
• doValidate
• afterValidate

• doCheckValidity

• settings.validationName
• settings.autoFixURL