app-base.js revision 091fd26b4b1680660e7fc48e1a45f9f52f9c0239
assumed to be on the `Y` object; e.g. `"SomeView"` -> `Y.SomeView`. * `preserve`: Boolean for whether the view instance should be retained. By default, the view instance will be destroyed when it is no longer the `activeView`. If `true` the view instance will simply be `removed()` from the DOM when it is no longer active. This is useful when the view is frequently used and may be expensive to re-create. * `parent`: String to another named view in this hash that represents parent view within the application's view hierarchy; e.g. a `"photo"` view could have `"album"` has its `parent` view. This parent/child relationship is a useful cue for things like transitions. * `instance`: Used internally to manage the current instance of this named view. This can be used if your view instance is created up-front, or if you would rather manage the View lifecycle, but you probably should just let this be handled for you. If `views` are specified at instantiation time, the metadata in the `views` Object here will be used as defaults when creating the instance's `views`. Every `Y.App` instance gets its own copy of a `views` object so this Object on the prototype will not be polluted. // Imagine that `Y.UsersView` and `Y.UserView` have been defined. // -- Protected Properties ------------------------------------------------- Map of view instance id (via `Y.stamp()`) to view-info object in `views`. This mapping is used to tie a specific view instance back to its metadata by adding a reference to the the related view info on the `views` object. // -- Lifecycle Methods ---------------------------------------------------- // Merges-in specified view metadata into local `views` object. // First, each view in the `views` prototype object has its metadata // merged-in, providing the defaults. // Then, each view in the specified in the `config.views` object has its // The resulting hodgepodge of metadata is then stored as the instance's // `views` object, and no one's objects were harmed in the making. // PjaxBase will bind click events when `html5` is `true`, so this just // forces the binding when `serverRouting` and `html5` are both falsy. if (!
this.
get(
'serverRouting')) {
// TODO: `destructor` to destory the `activeView`? // -- Public Methods ------------------------------------------------------- Creates and returns this apps's container node from the specified selector string, DOM element, or existing `Y.Node` instance. This method is called internally when the app is initialized. This node is also stamped with the CSS class specified by By default, the created node is _not_ added to the DOM automatically. @param {String|Node|HTMLElement} container Selector string, `Y.Node` instance, or DOM element to use as the container node. @return {Node} Node instance of the created container node. Creates and returns a new view instance using the provided `name` to look up the view info metadata defined in the `views` object. The passed-in `config` object is passed to the view constructor function. This function also maps a view instance back to its view info metadata. @param {String} name The name of a view defined on the `views` object. @param {Object} [config] The configuration object passed to the view constructor function when creating the new view instance. @return {View} The new view instance. // Create the view instance and map it with its metadata. Creates and returns this app's view-container node from the specified selector string, DOM element, or existing `Y.Node` instance. This method is called internally when the app is initialized. This node is also stamped with the CSS class specified by `Y.App.Base.VIEWS_CSS_CLASS`. By default, the created node is appended to the `container` node by the @method createViewContainer @param {String|Node|HTMLElement} viewContainer Selector string, `Y.Node` instance, or DOM element to use as the view-container node. @return {Node} Node instance of the created view-container node. Returns the metadata associated with a view instance or view name defined on @param {View|String} view View instance, or name of a view defined on the @return {Object} The metadata for the view, or `undefined` if the view is Renders this application by appending the `viewContainer` node to the `container` node, and showing the `activeView`. You should call this method at least once, usually after the initialization of your `Y.App` instance. You may override this method to customize the app's rendering, but it is expected that the `viewContainer` is reserved for the app to manage its This will set the application's `activeView` attribute to the specified view instance, or when a registered view-name is provided, the `activeView` attribute will be set to either the preserved instance, or a new view instance created using the specified `config`. A callback function can be specified as either the third or fourth argument, and this function will be called after the new `view` is the `activeView` // Imagine that `Y.UsersView` has been defined. app.route('/users/', function () { app.navigate('/uses/'); // => Creates a new `Y.UsersView` and shows it. @param {String|View} view The name of a view defined in the `views` object, @param {Object} [config] Optional configuration to use when creating a new @param {Object} [options] Optional object containing any of the following @param {Boolean} [options.prepend] Whether the new view should be prepended instead of appended to the `viewContainer`. @param {Function} [callback] Optional callback Function to call after the new `activeView` is ready to use, the function will be passed: @param {View} callback.view // Use the preserved view instance, or create a new view. // Make sure there's a mapping back to the view metadata. // TODO: Add options.update to update to view with the `config`, if // needed. This could also call `setAttrs()` when the specified `view` // already a View instance. Is this be too much overloading of the API? // TODO: Should the `callback` _always_ be called, even when the // `activeView` does not change? // -- Protected Methods ---------------------------------------------------- Helper method to attach the view instance to the application by making the app a bubble target of the view, append the view to the `viewContainer`, and assign it to the `instance` property of the associated view info metadata. @param {View} view View to attach. @param {Boolean} prepend Whether the view should be prepended instead of appended to the `viewContainer`. // TODO: Attach events here for perseved Views? See TODO in _detachView. // Insert view into the DOM. Overrides View's container destruction to deal with `viewContainer` and checks to make sure not to remove and purge the `<body>`. @method _destroyContainer // We do not want to remove or destroy the `<body>`. // Just clean-up our events listeners. // Clean-up `yui3-app` CSS class on the `container`. // Clean-up `yui3-app-views` CSS class on the `container`. // Destroy and purge the `viewContainer`. // Remove and purge events from both containers. Helper method to detach the view instance from the application by removing the application as a bubble target of the view, and either just removing the view if it is intended to be preserved, or destroying the instance @param {View} view View to detach. // TODO: Detach events here for perserved Views? It is possible that // some event subscriptions are made on elements other than the // Remove from view to view-info map. // Remove from view-info instance property. Provides the default value for the `html5` attribute. The value returned is dependent on the value of the `serverRouting` attribute. When `serverRouting` is explicit set to `false` (not just falsy), the default value for `html5` will be set to `false` for *all* browsers. When `serverRouting` is `true` or `undefined` the returned value will be dependent on the browser's capability of using HTML5 history. @return {Boolean} Whether or not HTML5 history should be used. // When `serverRouting` is explicitly set to `false` (not just falsy), // forcing hash-based URLs in all browsers. if (
this.
get(
'serverRouting') ===
false) {
Determines if the specified `view` is configured as a child of the specified `parent` view. This requires both views to be either named-views, or view instances created using configuration data that exists in the `views` object, e.g. created by the `createView()` or `showView()` method. @param {View|String} view The name of a view defined in the `views` object, @param {View|String} parent The name of a view defined in the `views` object, or a view instance. @return {Boolean} Whether the view is configured as a child of the parent. Determines if the specified `view` is configured as the parent of the specified `child` view. This requires both views to be either named-views, or view instances created using configuration data that exists in the `views` object, e.g. created by the `createView()` or `showView()` method. @param {View|String} view The name of a view defined in the `views` object, @param {View|String} parent The name of a view defined in the `views` object, or a view instance. @return {Boolean} Whether the view is configured as the parent of the child. Navigates to the specified URL if there is a route-handler that matches. In browsers capable of using HTML5 history or when `serverRouting` is falsy, the navigation will be enhanced by firing the `navigate` and having the app handle the "request". When `serverRouting` is `true`, non-HTML5 browsers will navigate to the new URL via manipulation of `window.location`. Overrides PjaxBase's `_navigate()` method to first upgrade any hash-based URLs that has a path-like hash (i.e. hashes that start with '/'), and when `serverRouting` is falsy, force the navigation to be handled by the app. The applied changes are then delegated back to PjaxBase's `_navigate()` method to complete the navigation. When there is a route-handler for the specified URL and it is being navigated to, this method will return `true`, otherwise it will return @param {String} url The fully-resolved URL that the app should dispatch to its route handlers to fulfill the enhanced navigation "request", or use to update `window.location` in non-HTML5 history capable browsers when `serverRouting` is `true`. @param {Object} [options] Additional options to configure the navigation, these are mixed into the `navigate` event facade. @param {Boolean} [options.replace] Whether or not the current history entry will be replaced, or a new entry will be created. Will default to `true` if the specified `url` is the same as the current URL. @param {Boolean} [options.force=false] Whether the enhanced navigation should occur even in browsers without HTML5 history. @see PjaxBase._navigate() if (!
this.
get(
'serverRouting')) {
// Force navigation to be enhanced and handled by the app when // `serverRouting` is falsy because the server might not be able to // handle the request properly. // Determine if the current history entry should be replaced. Since // we're upgrading hash-based URL to a full-path URL, we'll do the // same for the current URL before comparing the two URLs. Will either save a history entry using `pushState()` or the location hash, or gracefully-degrade to sending a request to the server causing a full-page Overrides Router's `_save()` method to preform graceful-degradation when the app's `serverRouting` is `true` and `html5` is `false` by updating the full URL via standard assignment to `window.location` or by calling `window.location.replace()`; both of which will cause a request to the server resulting in a full-page reload. Otherwise this will just delegate off to Router's `_save()` method allowing the client-side enhanced routing to occur. @param {String} [url] URL for the history entry. @param {Boolean} [replace=false] If `true`, the current history entry will be replaced instead of a new one being added. // Forces full-path URLs to always be used by modifying // `window.location` in non-HTML5 history capable browsers. if (
this.
get(
'serverRouting') && !
this.
get(
'html5')) {
// Perform same-origin check on the specified URL. Y.
error(
'Security error: The new URL must be of the same origin as the current URL.');
// Results in the URL's full path starting with '/'. // Either replace the current history entry or create a new one // while navigating to the `url`. Upgrades a hash-based URL to a full-path URL, if necessary. The specified `url` will be upgraded if its of the same origin as the current URL and has a path-like hash. URLs that don't need upgrading will be @param {String} url The URL to upgrade from hash-based to full-path. @return {String} The upgraded URL, or the specified URL untouched. // We should not try to upgrade paths for external URLs. // TODO: Should the `root` be removed first, and the hash only // considered if in the form of '/#/'? // Strip any hash prefix, like hash-bangs. // If the hash looks like a URL path, assume it is, and upgrade it! // Re-join with configured `root` before resolving. // -- Protected Event Handlers --------------------------------------------- Handles the application's `activeViewChange` event (which is fired when the `activeView` attribute changes) by detaching the old view, attaching the new The `activeView` attribute is read-only, so the public API to change its value is through the `showView()` method. @method _afterActiveViewChange // Prevent detaching (thus removing) the view we want to show. // Also hard to animate out and in, the same view. // TODO: Remove `viewContainer` before making DOM updates? This attribute is read-only, to set the `activeView` use the Container node which represents the application's bounding-box. @type HTMLElement|Node|String Whether or not this browser is capable of using HTML5 history. This value is dependent on the value of `serverRouting` and will default Setting this to `false` will force the use of hash-based history even on HTML5 browsers, but please don't do this unless you understand the This attribute is provided by `PjaxBase`, but the default value is overridden to match all links on the page. Whether or not this application's server is capable of properly routing all requests and rendering the initial state in the HTML responses. This can have three different values, each having particular implications on how the app will handle routing and navigation: * `undefined`: The best form of URLs will be chosen based on the capabilities of the browser. Given no information about the server environment a balanced approach to routing and navigation is chosen. The server should be capable of handling full-path requests, since full-URLs will be generated by browsers using HTML5 history. If this is a client-side-only app the server could handle full-URL requests by sending a redirect back to the root with a hash-based URL, e.g: * `true`: The server is *fully* capable of properly handling requests to all full-path URLs the app can produce. This is the best option for progressive-enhancement because it will cause *all URLs to always have full-paths*, which means the server will be able to accurately handle all URLs this app produces. e.g. To meet this strict full-URL requirement, browsers which are not capable of using HTML5 history will make requests to the server resulting in full-page reloads. * `false`: The server is *not* capable of properly handling requests to all full-path URLs the app can produce, therefore all routing will be handled by this App instance. Be aware that this will cause *all URLs to always be hash-based*, even in browsers that are capable of using HTML5 history. e.g. A single-page or client-side-only app where the server sends a "shell" page with JavaScript to the client might have this restriction. If you're setting this to `false`, read the following: **Note:** When this is set to `false`, the server will *never* receive the full URL because browsers do not send the fragment-part to the server, that is everything after and including the '#'. Consider the following example: You should feel bad about hurting our precious web if you forcefully set either `serverRouting` or `html5` to `false`, because you're basically punching the web in the face here with your lossy URLs! Please make sure you know what you're doing and that you understand the implications. Ideally you should always prefer full-path URLs (not /#/foo/), and want full-page reloads when the client's browser is not capable of enhancing the experience using the HTML5 history APIs. Setting this to `true` is the best option for progressive-enhancement (and graceful-degradation). Container node into which all application views will be rendered. @type HTMLElement|Node|String @default `Y.Node.create('<div/>')` setter :
'createViewContainer',
// -- Namespace ----------------------------------------------------------------