--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/src/cm/media/js/lib/yui/yui_3.10.3/docs/console/console-yui-config.html Tue Jul 16 14:29:46 2013 +0200
@@ -0,0 +1,777 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+ <meta charset="utf-8">
+ <title>Example: YUI Configuration to Filter Log Messages</title>
+ <link rel="stylesheet" href="http://fonts.googleapis.com/css?family=PT+Sans:400,700,400italic,700italic">
+ <link rel="stylesheet" href="../../build/cssgrids/cssgrids-min.css">
+ <link rel="stylesheet" href="../assets/css/main.css">
+ <link rel="stylesheet" href="../assets/vendor/prettify/prettify-min.css">
+ <link rel="shortcut icon" type="image/png" href="../assets/favicon.png">
+ <script src="../../build/yui/yui-min.js"></script>
+
+</head>
+<body>
+<!--
+<a href="https://github.com/yui/yui3"><img style="position: absolute; top: 0; right: 0; border: 0;" src="https://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png" alt="Fork me on GitHub"></a>
+-->
+<div id="doc">
+ <div id="hd">
+ <h1><img src="http://yuilibrary.com/img/yui-logo.png"></h1>
+ </div>
+
+
+ <h1>Example: YUI Configuration to Filter Log Messages</h1>
+ <div class="yui3-g">
+ <div class="yui3-u-3-4">
+ <div id="main">
+ <div class="content"><style scoped>
+#console {
+ float: left;
+}
+#demo .yui3-console .yui3-console-title {
+ border: 0 none;
+ color: #000;
+ font-size: 13px;
+ font-weight: bold;
+ margin: 0;
+ text-transform: none;
+}
+
+#demo .yui3-console .yui3-console-entry-meta {
+ margin: 0;
+}
+
+.filter-controls p label {
+ display: block;
+ margin: .25em 0;
+}
+#demo input {
+ vertical-align: middle;
+}
+
+.form {
+ clear: left;
+ padding: 1em 0;
+}
+
+.form span {
+ padding-left: 3em;
+}
+
+#msg {
+ width: 50%;
+}
+
+.filter-controls {
+ width: 180px;
+ margin-left: 1em;
+ float: left;
+}
+
+#preview {
+ background: #eee;
+ border: 1px solid #999;
+ margin: 1em 0;
+ overflow: auto;
+ padding: 1em;
+ width: 480px;
+}
+</style>
+
+
+<div class="intro">
+ <p>This example illustrates how to configure your YUI instance to ignore certain log messages to aid in reducing the signal-to-noise ratio when debugging.</p>
+
+ <p>Log messages filtered out from the YUI config are permanently ignored. If you want to be able to temporarily hide and reshow messages, use the <a href="../console-filters/">ConsoleFilters plugin</a>. It is not uncommon to set up <code>logInclude</code> or <code>logExclude</code> in the YUI configuration and use the ConsoleFilters plugin.</p>
+
+ <p>Log messages can be ignored based on the source (e.g. <code>event</code> or <code>attribute</code>) or based on their log level (info, warn, error).</p>
+
+</div>
+
+<div class="example yui3-skin-sam">
+<form>
+ <div id="demo" class="yui3-skin-sam">
+ <div id="console"></div>
+
+ <div class="filter-controls">
+ <h4>Source filter</h4>
+ <p>
+ <select id="incexc">
+ <option value="logExclude" selected="selected">Exclude</option>
+ <option value="logInclude">Include</option>
+ </select>
+ <label for="filter_a"><input type="checkbox" name="src_filter" value="sourceA" id="filter_a"> <code>sourceA</code></label>
+ <label for="filter_b"><input type="checkbox" name="src_filter" value="sourceB" id="filter_b"> <code>sourceB</code></label>
+ <label for="filter_c"><input type="checkbox" name="src_filter" value="sourceC" id="filter_c" checked="checked"> <code>sourceC</code></label>
+ </p>
+ </div>
+
+ <div class="filter-controls">
+ <h4>Log level</h4>
+ <p>
+ <label for="lvl_info">
+ <input type="radio" name="log_level" id="lvl_info" value="info" checked="checked">
+ info
+ </label>
+ <label for="lvl_warn">
+ <input type="radio" name="log_level" id="lvl_warn" value="warn">
+ warn
+ </label>
+ <label for="lvl_error">
+ <input type="radio" name="log_level" id="lvl_error" value="error">
+ error
+ </label>
+ </p>
+ </div>
+
+ <div class="form">
+ <h4>Log a message</h4>
+ <div>
+ <input type="text" id="msg" value="This is a log message!">
+ <input type="submit" id="log">log message</button>
+
+ <p>
+ Source:
+ <label for="msg_src_a">
+ <input type="radio" name="msg_src" id="msg_src_a" value="sourceA" checked="checked">
+ A
+ </label>
+ <label for="msg_src_b">
+ <input type="radio" name="msg_src" id="msg_src_b" value="sourceB">
+ B
+ </label>
+ <label for="msg_src_c">
+ <input type="radio" name="msg_src" id="msg_src_c" value="sourceC">
+ C
+ </label>
+
+ <span>Category:</span>
+ <label for="msg_info">
+ <input type="radio" name="msg_cat" id="msg_info" value="info" checked="checked">
+ info
+ </label>
+ <label for="msg_warn">
+ <input type="radio" name="msg_cat" id="msg_warn" value="warn">
+ warn
+ </label>
+ <label for="msg_error">
+ <input type="radio" name="msg_cat" id="msg_error" value="error">
+ error
+ </label>
+ </p>
+ </div>
+
+ <h4>Code preview</h4>
+ <pre id="preview">// YUI instance configuration
+ var Y = YUI({
+ "logLevel": "info",
+ "logExclude": {
+ "sourceC": true
+ }
+ });
+
+ // Log statement
+ Y.log("This is a log message!", "info", "sourceA");</pre>
+ </div>
+ </div>
+</form>
+<script type="text/javascript">
+YUI().use("console", "selector-css3", "json-stringify", function (Y) {
+
+// Add the default filtering of sourceC messages
+Y.config.logExclude = {
+ sourceC : true
+};
+
+// Create and render the Console
+var yconsole = new Y.Console({
+ boundingBox: "#console",
+ style: "block"
+}).render();
+
+
+// Set up event listeners
+// Source include or exclude select
+Y.on("change", function () {
+ if (this.get("value") === "logInclude") {
+ Y.config.logInclude = Y.config.logExclude;
+ delete Y.config.logExclude;
+ } else {
+ Y.config.logExclude = Y.config.logInclude;
+ delete Y.config.logInclude;
+ }
+ updatePreview();
+}, "#incexc");
+
+// delegate all checkbox and radio group clicks via a single event subscriber
+// routing to the appropriate function based on the input name
+var clickHandlers = {
+ src_filter : updateSourceFilters,
+ log_level : updateLogLevel,
+ msg_src : updatePreview,
+ msg_cat : updatePreview
+};
+
+Y.delegate("click", function (e) {
+ var input = e.currentTarget,
+ handler = clickHandlers[ input.get("name") ];
+
+ if (handler) {
+ handler(input.get("value"), input.get("checked"));
+ }
+
+}, "#demo", "input[name]");
+
+// Log message input and radio groups
+Y.on("keyup", updatePreview, "#msg");
+
+// Log message button
+Y.on("click", function (e) {
+ var msg = Y.one("#msg").get("value"),
+ cat = Y.one("#demo input[name=msg_cat]:checked").get("value"),
+ src = Y.one("#demo input[name=msg_src]:checked").get("value");
+
+ Y.log(msg,cat,src);
+ e.preventDefault(); // Don't submit the form
+}, "#log");
+
+// Support functions
+function updateSourceFilters(source, checked) {
+ var disposition = Y.one("#incexc").get("value"),
+ cfg = Y.config[disposition]; // Y.config.logInclude or logExclude
+
+ if (checked) {
+ if (!cfg) {
+ cfg = Y.config[disposition] = {};
+ }
+ cfg[source] = true;
+ } else {
+ delete cfg[source];
+ if (!Y.Object.size(cfg)) {
+ delete Y.config[disposition];
+ }
+ }
+
+ updatePreview();
+}
+
+function updateLogLevel(level, checked) {
+ if (checked) {
+ Y.config.logLevel = level;
+ yconsole.set("logLevel", level);
+ updatePreview();
+ }
+}
+
+function updatePreview() {
+ var filters = Y.all("#demo input[name=src_filter]:checked"),
+ cfg = {
+ logLevel: Y.one("#demo input[name=log_level]:checked").get("value")
+ };
+
+ if (filters.size()) {
+ cfg[Y.one("#incexc").get("value")] = Y.Array.hash(filters.get("value"));
+ }
+
+ Y.one("#preview").set("text",Y.Lang.sub(
+ "// YUI instance configuration\n" +
+ "var Y = YUI({cfg});\n\n" +
+ "// Log statement\n" +
+ 'Y.log("{msg}", "{lvl}", "{src}");',
+ {
+ cfg: Y.JSON.stringify(cfg, null, 4),
+ msg: Y.one("#msg").get("value"),
+ lvl: Y.one("#demo input[name=msg_cat]:checked").get("value"),
+ src: Y.one("#demo input[name=msg_src]:checked").get("value")
+ }));
+}
+
+});
+</script>
+
+</div>
+
+<h3>Setting up filters in the YUI configuration</h3>
+<p>The configuration object passed to the YUI constructor supports a few settings that can help manage Console output while debugging. These configuration options are <code>logExclude</code>, <code>logInclude</code>, <code>logLevel</code>, <code>filter</code>, and <code>filters</code>.</p>
+
+<p>This example will show the use of the <code>logInclude</code>, <code>logExclude</code>, and <code>logLevel</code> configurations.</p>
+
+<p>An example configuration might look like this:</p>
+
+<pre class="code prettyprint">YUI({
+ filter : 'debug', // request -debug versions of modules for log statements
+ logExclude : {
+ event : true, // Don't broadcast log messages from the event module
+ attribute : true, // or the attribute module
+ widget : true // or the widget module
+ },
+ logLevel : 'error', // Show only errors in the Console
+ useBrowserConsole : false // Don't use the browser's native console
+}).use('overlay','anim','console', function (Y) {
+
+/* Console instances will default to logLevel = "info" */
+
+});</pre>
+
+
+<p><code>logExclude</code> and <code>logInclude</code> prevent the logging subsystem from broadcasting filtered log messages. <code>logLevel</code>, on the other hand is used by Console instances to filter messages received from the subsystem.</p>
+
+<p>Updating <code>Y.config.logExclude</code> or <code>Y.config.logInclude</code> at runtime will immediately change the subsystem filtering, but will not recover messages previously sent from that source.</p>
+
+<pre class="code prettyprint">YUI({
+ logExclude : {
+ event : true
+ }
+}).use('console', function (Y) {
+
+/* In here, Y.config refers to the config object passed to the constructor */
+
+// Stop broadcasting log messages from the attribute module
+Y.config.logExclude.attribute = true;
+
+// Start broadcasting log messages from the event module again
+delete Y.config.logExclude.event;
+
+});</pre>
+
+
+<p>When a Console is instantiated, barring explicit <code>logLevel</code> attribute configuration, the <code>logLevel</code> will be adopted from the YUI instance's configured <code>logLevel</code>, or <code>Y.Console.LOG_LEVEL_INFO</code> ("info") as a fallback. Unlike <code>logExclude</code>, changing the value in the YUI configuration will only affect instantiated Consoles from that point on. Additionally, you can manually override the <code>logLevel</code> a Console instance will display by updating its <code>logLevel</code> attribute.</p>
+
+<pre class="code prettyprint">YUI({ logLevel : "warn" }).use('console', function (Y) {
+
+var yconsole_1 = new Y.Console(); // logLevel == "warn"
+
+var yconsole_2 = new Y.Console({
+ logLevel : "info" // override at construction
+});
+
+// This will not affect yconsole_1 or yconsole_2
+Y.config.logLevel = "error";
+
+var yconsole_3 = new Y.Console(); // logLevel == "error"
+
+yconsole_1.set("logLevel", "info"); // update this instance
+
+});</pre>
+
+
+<p>The interactive portion of this example illustrates the effect of various filter settings against logged messages. In a real application, it is most likely that the logging configuration won't be changed at runtime but set once in the YUI configuration at construction.</p>
+
+<p>The most relevant portion of the <a href="#full_code_listing">code for the demo above</a> is the updating of the YUI config and Console attribute.</p>
+
+<pre class="code prettyprint">// Create and render the Console
+var yconsole = new Y.Console({
+ boundingBox: '#console', // anchored to the page for the demo
+ style: "block"
+}).render();
+
+...
+
+// Source include or exclude select
+Y.on("change", function () {
+ if (this.get("value") === "logInclude") {
+ Y.config.logInclude = Y.config.logExclude;
+ delete Y.config.logExclude;
+ } else {
+ Y.config.logExclude = Y.config.logInclude;
+ delete Y.config.logInclude;
+ }
+ updatePreview();
+}, "#incexc");
+
+// These functions are called from a delegated event handler.
+// See the Full Code Listing for how they are called.
+function updateSourceFilters(source, checked) {
+ var disposition = Y.one("#incexc").get("value"),
+ cfg = Y.config[disposition]; // Y.config.logInclude or logExclude
+
+ if (checked) {
+ if (!cfg) {
+ cfg = Y.config[disposition] = {};
+ }
+ cfg[source] = true; // e.g. Y.config.logInclude.sourceA = true;
+ } else {
+ delete cfg[source];
+
+ if (!Y.Object.size(cfg)) {
+ delete Y.config[disposition];
+ }
+ }
+
+ updatePreview();
+}
+
+function updateLogLevel(level, checked) {
+ if (checked) {
+ Y.config.logLevel = level;
+ yconsole.set("logLevel", level);
+ updatePreview();
+ }
+}</pre>
+
+
+<h3 id="full_code_listing">Full Code Listing</h3>
+
+<h4>Markup</h4>
+
+<pre class="code prettyprint"><form>
+ <div id="demo" class="yui3-skin-sam">
+ <div id="console"></div>
+
+ <div class="filter-controls">
+ <h4>Source filter</h4>
+ <p>
+ <select id="incexc">
+ <option value="logExclude" selected="selected">Exclude</option>
+ <option value="logInclude">Include</option>
+ </select>
+ <label for="filter_a"><input type="checkbox" name="src_filter" value="sourceA" id="filter_a"> <code>sourceA</code></label>
+ <label for="filter_b"><input type="checkbox" name="src_filter" value="sourceB" id="filter_b"> <code>sourceB</code></label>
+ <label for="filter_c"><input type="checkbox" name="src_filter" value="sourceC" id="filter_c" checked="checked"> <code>sourceC</code></label>
+ </p>
+ </div>
+
+ <div class="filter-controls">
+ <h4>Log level</h4>
+ <p>
+ <label for="lvl_info">
+ <input type="radio" name="log_level" id="lvl_info" value="info" checked="checked">
+ info
+ </label>
+ <label for="lvl_warn">
+ <input type="radio" name="log_level" id="lvl_warn" value="warn">
+ warn
+ </label>
+ <label for="lvl_error">
+ <input type="radio" name="log_level" id="lvl_error" value="error">
+ error
+ </label>
+ </p>
+ </div>
+
+ <div class="form">
+ <h4>Log a message</h4>
+ <div>
+ <input type="text" id="msg" value="This is a log message!">
+ <input type="submit" id="log">log message</button>
+
+ <p>
+ Source:
+ <label for="msg_src_a">
+ <input type="radio" name="msg_src" id="msg_src_a" value="sourceA" checked="checked">
+ A
+ </label>
+ <label for="msg_src_b">
+ <input type="radio" name="msg_src" id="msg_src_b" value="sourceB">
+ B
+ </label>
+ <label for="msg_src_c">
+ <input type="radio" name="msg_src" id="msg_src_c" value="sourceC">
+ C
+ </label>
+
+ <span>Category:</span>
+ <label for="msg_info">
+ <input type="radio" name="msg_cat" id="msg_info" value="info" checked="checked">
+ info
+ </label>
+ <label for="msg_warn">
+ <input type="radio" name="msg_cat" id="msg_warn" value="warn">
+ warn
+ </label>
+ <label for="msg_error">
+ <input type="radio" name="msg_cat" id="msg_error" value="error">
+ error
+ </label>
+ </p>
+ </div>
+
+ <h4>Code preview</h4>
+ <pre id="preview">// YUI instance configuration
+ var Y = YUI({
+ "logLevel": "info",
+ "logExclude": {
+ "sourceC": true
+ }
+ });
+
+ // Log statement
+ Y.log(&quot;This is a log message!&quot;, &quot;info&quot;, &quot;sourceA&quot;);</pre>
+ </div>
+ </div>
+</form></pre>
+
+
+<h4>JavaScript</h4>
+
+<pre class="code prettyprint"><script type="text/javascript">
+YUI().use("console", "selector-css3", "json-stringify", function (Y) {
+
+// Add the default filtering of sourceC messages
+Y.config.logExclude = {
+ sourceC : true
+};
+
+// Create and render the Console
+var yconsole = new Y.Console({
+ boundingBox: "#console",
+ style: "block"
+}).render();
+
+
+// Set up event listeners
+// Source include or exclude select
+Y.on("change", function () {
+ if (this.get("value") === "logInclude") {
+ Y.config.logInclude = Y.config.logExclude;
+ delete Y.config.logExclude;
+ } else {
+ Y.config.logExclude = Y.config.logInclude;
+ delete Y.config.logInclude;
+ }
+ updatePreview();
+}, "#incexc");
+
+// delegate all checkbox and radio group clicks via a single event subscriber
+// routing to the appropriate function based on the input name
+var clickHandlers = {
+ src_filter : updateSourceFilters,
+ log_level : updateLogLevel,
+ msg_src : updatePreview,
+ msg_cat : updatePreview
+};
+
+Y.delegate("click", function (e) {
+ var input = e.currentTarget,
+ handler = clickHandlers[ input.get("name") ];
+
+ if (handler) {
+ handler(input.get("value"), input.get("checked"));
+ }
+
+}, "#demo", "input[name]");
+
+// Log message input and radio groups
+Y.on("keyup", updatePreview, "#msg");
+
+// Log message button
+Y.on("click", function (e) {
+ var msg = Y.one("#msg").get("value"),
+ cat = Y.one("#demo input[name=msg_cat]:checked").get("value"),
+ src = Y.one("#demo input[name=msg_src]:checked").get("value");
+
+ Y.log(msg,cat,src);
+ e.preventDefault(); // Don't submit the form
+}, "#log");
+
+// Support functions
+function updateSourceFilters(source, checked) {
+ var disposition = Y.one("#incexc").get("value"),
+ cfg = Y.config[disposition]; // Y.config.logInclude or logExclude
+
+ if (checked) {
+ if (!cfg) {
+ cfg = Y.config[disposition] = {};
+ }
+ cfg[source] = true;
+ } else {
+ delete cfg[source];
+ if (!Y.Object.size(cfg)) {
+ delete Y.config[disposition];
+ }
+ }
+
+ updatePreview();
+}
+
+function updateLogLevel(level, checked) {
+ if (checked) {
+ Y.config.logLevel = level;
+ yconsole.set("logLevel", level);
+ updatePreview();
+ }
+}
+
+function updatePreview() {
+ var filters = Y.all("#demo input[name=src_filter]:checked"),
+ cfg = {
+ logLevel: Y.one("#demo input[name=log_level]:checked").get("value")
+ };
+
+ if (filters.size()) {
+ cfg[Y.one("#incexc").get("value")] = Y.Array.hash(filters.get("value"));
+ }
+
+ Y.one("#preview").set("text",Y.Lang.sub(
+ "// YUI instance configuration\n" +
+ "var Y = YUI({cfg});\n\n" +
+ "// Log statement\n" +
+ 'Y.log("{msg}", "{lvl}", "{src}");',
+ {
+ cfg: Y.JSON.stringify(cfg, null, 4),
+ msg: Y.one("#msg").get("value"),
+ lvl: Y.one("#demo input[name=msg_cat]:checked").get("value"),
+ src: Y.one("#demo input[name=msg_src]:checked").get("value")
+ }));
+}
+
+});
+</script></pre>
+
+
+<h4>CSS</h4>
+
+<pre class="code prettyprint"><style scoped>
+#console {
+ float: left;
+}
+#demo .yui3-console .yui3-console-title {
+ border: 0 none;
+ color: #000;
+ font-size: 13px;
+ font-weight: bold;
+ margin: 0;
+ text-transform: none;
+}
+
+#demo .yui3-console .yui3-console-entry-meta {
+ margin: 0;
+}
+
+.filter-controls p label {
+ display: block;
+ margin: .25em 0;
+}
+#demo input {
+ vertical-align: middle;
+}
+
+.form {
+ clear: left;
+ padding: 1em 0;
+}
+
+.form span {
+ padding-left: 3em;
+}
+
+#msg {
+ width: 50%;
+}
+
+.filter-controls {
+ width: 180px;
+ margin-left: 1em;
+ float: left;
+}
+
+#preview {
+ background: #eee;
+ border: 1px solid #999;
+ margin: 1em 0;
+ overflow: auto;
+ padding: 1em;
+ width: 480px;
+}
+</style></pre>
+
+
+
+</div>
+ </div>
+ </div>
+
+ <div class="yui3-u-1-4">
+ <div class="sidebar">
+
+
+
+ <div class="sidebox">
+ <div class="hd">
+ <h2 class="no-toc">Examples</h2>
+ </div>
+
+ <div class="bd">
+ <ul class="examples">
+
+
+ <li data-description="The basics of setting up a Console">
+ <a href="console-basic.html">Creating a Console for Debugging</a>
+ </li>
+
+
+
+ <li data-description="Using your YUI instance configuration to filter which messages are reported in the Console">
+ <a href="console-yui-config.html">YUI Configuration to Filter Log Messages</a>
+ </li>
+
+
+
+ <li data-description="Using the Console's logSource attribute to consolidate log messages from multiple YUI instances into one Console">
+ <a href="console-global.html">Creating a Universal Console</a>
+ </li>
+
+
+
+
+ </ul>
+ </div>
+ </div>
+
+
+
+ <div class="sidebox">
+ <div class="hd">
+ <h2 class="no-toc">Examples That Use This Component</h2>
+ </div>
+
+ <div class="bd">
+ <ul class="examples">
+
+
+
+
+
+
+
+
+ <li data-description="Adding the ConsoleFilters plugin to a Console instance for more granular run time log message filtering">
+ <a href="../console-filters/console-filters-intro.html">Using the ConsoleFilters Plugin</a>
+ </li>
+
+
+ </ul>
+ </div>
+ </div>
+
+ </div>
+ </div>
+ </div>
+</div>
+
+<script src="../assets/vendor/prettify/prettify-min.js"></script>
+<script>prettyPrint();</script>
+
+<script>
+YUI.Env.Tests = {
+ examples: [],
+ project: '../assets',
+ assets: '../assets/console',
+ name: 'console-yui-config',
+ title: 'YUI Configuration to Filter Log Messages',
+ newWindow: '',
+ auto: false
+};
+YUI.Env.Tests.examples.push('console-basic');
+YUI.Env.Tests.examples.push('console-yui-config');
+YUI.Env.Tests.examples.push('console-global');
+YUI.Env.Tests.examples.push('console-filters-intro');
+
+</script>
+<script src="../assets/yui/test-runner.js"></script>
+
+
+
+</body>
+</html>