console.js revision e0faaaef9dd138950007532eac3754c0290039b4
3cefe5340bfed84038e5816dbfbe7cec44f0df31Luke Smith * Console creates a visualization for messages logged through calls to a YUI
3cefe5340bfed84038e5816dbfbe7cec44f0df31Luke Smith * instance's <code>Y.log( message, category, source )</code> method. The
3cefe5340bfed84038e5816dbfbe7cec44f0df31Luke Smith * debug versions of YUI modules will include logging statements to offer some
3cefe5340bfed84038e5816dbfbe7cec44f0df31Luke Smith * insight into the steps executed during that module's operation. Including
3cefe5340bfed84038e5816dbfbe7cec44f0df31Luke Smith * log statements in your code will cause those messages to also appear in the
3cefe5340bfed84038e5816dbfbe7cec44f0df31Luke Smith * Console. Use Console to aid in developing your page or application.
3cefe5340bfed84038e5816dbfbe7cec44f0df31Luke Smith * Entry categories "info", "warn", and "error"
3cefe5340bfed84038e5816dbfbe7cec44f0df31Luke Smith * are also referred to as the log level, and entries are filtered against the
3cefe5340bfed84038e5816dbfbe7cec44f0df31Luke Smith * configured logLevel.
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @module console
3cefe5340bfed84038e5816dbfbe7cec44f0df31Luke Smith * @class Console
3cefe5340bfed84038e5816dbfbe7cec44f0df31Luke Smith * @extends Widget
3cefe5340bfed84038e5816dbfbe7cec44f0df31Luke Smith * @param conf {Object} Configuration object (see Configuration attributes)
3cefe5340bfed84038e5816dbfbe7cec44f0df31Luke Smith * @constructor
01a9f856a72f90fbb8197384630b97bb93dc7473Luke Smith Console.superclass.constructor.apply(this,arguments);
ed51daad3a3ab15255ca10edef69d5f703d69adbLuke Smith C_ENTRY_CONTENT = getCN(CONSOLE,ENTRY,'content'),
abf34f3b3d65331ec654c9980a6d60d7f9701bfeLuke Smith '<div class="{entry_class} {cat_class} {src_class}">'+
abf34f3b3d65331ec654c9980a6d60d7f9701bfeLuke Smith '<p class="{entry_meta_class}">'+
abf34f3b3d65331ec654c9980a6d60d7f9701bfeLuke Smith '<span class="{entry_src_class}">'+
abf34f3b3d65331ec654c9980a6d60d7f9701bfeLuke Smith '{sourceAndDetail}'+
abf34f3b3d65331ec654c9980a6d60d7f9701bfeLuke Smith '<span class="{entry_cat_class}">'+
abf34f3b3d65331ec654c9980a6d60d7f9701bfeLuke Smith '{label}</span>'+
abf34f3b3d65331ec654c9980a6d60d7f9701bfeLuke Smith '<span class="{entry_time_class}">'+
abf34f3b3d65331ec654c9980a6d60d7f9701bfeLuke Smith ' {totalTime}ms (+{elapsedTime}) {localTime}'+
abf34f3b3d65331ec654c9980a6d60d7f9701bfeLuke Smith '<pre class="{entry_content_class}">{message}</pre>'+
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * The identity of the widget.
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @property Console.NAME
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @type String
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * Static identifier for logLevel configuration setting to allow all
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * incoming messages to generate Console entries.
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @property Console.LOG_LEVEL_INFO
8652e2d20f8ea9c9bfe21217ba427cf0d85ada9aLuke Smith * @type String
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * Static identifier for logLevel configuration setting to allow only
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * incoming messages of logLevel "warn" or "error"
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * to generate Console entries.
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @property Console.LOG_LEVEL_WARN
8652e2d20f8ea9c9bfe21217ba427cf0d85ada9aLuke Smith * @type String
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * Static identifier for logLevel configuration setting to allow only
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * incoming messages of logLevel "error" to generate
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * Console entries.
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @property Console.LOG_LEVEL_ERROR
8652e2d20f8ea9c9bfe21217ba427cf0d85ada9aLuke Smith * @type String
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * Map (object) of classNames used to populate the placeholders in the
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * Console.ENTRY_TEMPLATE markup when rendering a new Console entry.
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * <p>By default, the keys contained in the object are:</p>
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * <li>entry_class</li>
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * <li>entry_meta_class</li>
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * <li>entry_cat_class</li>
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * <li>entry_src_class</li>
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * <li>entry_time_class</li>
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * <li>entry_content_class</li>
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @property Console.ENTRY_CLASSES
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @type Object
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * Map (object) of classNames used to populate the placeholders in the
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * Console.HEADER_TEMPLATE, Console.BODY_TEMPLATE, and
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * Console.FOOTER_TEMPLATE markup when rendering the Console UI.
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * <p>By default, the keys contained in the object are:</p>
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * <li>console_hd_class</li>
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * <li>console_bd_class</li>
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * <li>console_ft_class</li>
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * <li>console_controls_class</li>
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * <li>console_checkbox_class</li>
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * <li>console_pause_class</li>
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * <li>console_pause_label_class</li>
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * <li>console_button_class</li>
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * <li>console_clear_class</li>
ed51daad3a3ab15255ca10edef69d5f703d69adbLuke Smith * <li>console_collapse_class</li>
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * <li>console_title_class</li>
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @property Console.CHROME_CLASSES
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @type Object
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * Markup template used to generate the DOM structure for the header
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * section of the Console when it is rendered. The template includes
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * these {placeholder}s:
c36390194c43d30adc1059a74fdf9f51a235b8a9Luke Smith * <li>console_button_class - contributed by Console.CHROME_CLASSES</li>
c36390194c43d30adc1059a74fdf9f51a235b8a9Luke Smith * <li>console_collapse_class - contributed by Console.CHROME_CLASSES</li>
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * <li>console_hd_class - contributed by Console.CHROME_CLASSES</li>
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * <li>console_title_class - contributed by Console.CHROME_CLASSES</li>
ed51daad3a3ab15255ca10edef69d5f703d69adbLuke Smith * <li>str_collapse - pulled from attribute strings.collapse</li>
c36390194c43d30adc1059a74fdf9f51a235b8a9Luke Smith * <li>str_title - pulled from attribute strings.title</li>
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @property Console.HEADER_TEMPLATE
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @type String
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith '<div class="{console_hd_class}">'+
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith '<h4 class="{console_title_class}">{str_title}</h4>'+
d7a66fe2de41baa56b41e8b7b254d1f6a50a5135Luke Smith '<button type="button" class="'+
d7a66fe2de41baa56b41e8b7b254d1f6a50a5135Luke Smith '{console_button_class} {console_collapse_class}">{str_collapse}'+
d7a66fe2de41baa56b41e8b7b254d1f6a50a5135Luke Smith '</button>'+
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * Markup template used to generate the DOM structure for the Console body
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * (where the messages are inserted) when it is rendered. The template
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * includes only the {placeholder} "console_bd_class", which is
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * constributed by Console.CHROME_CLASSES.
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @property Console.BODY_TEMPLATE
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @type String
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith BODY_TEMPLATE : '<div class="{console_bd_class}"></div>',
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * Markup template used to generate the DOM structure for the footer
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * section of the Console when it is rendered. The template includes
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * many of the {placeholder}s from Console.CHROME_CLASSES as well as:
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * <li>id_guid - generated unique id, relates the label and checkbox</li>
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * <li>str_pause - pulled from attribute strings.pause</li>
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * <li>str_clear - pulled from attribute strings.clear</li>
0cd29719d36de1f7e3d0043f5d6fafb990a7b9e0Luke Smith * @property Console.FOOTER_TEMPLATE
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @type String
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith '<div class="{console_ft_class}">'+
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith '<div class="{console_controls_class}">'+
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith '<label for="{id_guid}" class="{console_pause_label_class}">'+
d7a66fe2de41baa56b41e8b7b254d1f6a50a5135Luke Smith '<input type="checkbox" class="{console_checkbox_class} '+
d7a66fe2de41baa56b41e8b7b254d1f6a50a5135Luke Smith '{console_pause_class}" value="1" id="{id_guid}"> '+
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith '{str_pause}</label>' +
ed51daad3a3ab15255ca10edef69d5f703d69adbLuke Smith '<button type="button" class="'+
ed51daad3a3ab15255ca10edef69d5f703d69adbLuke Smith '{console_button_class} {console_clear_class}">{str_clear}'+
ed51daad3a3ab15255ca10edef69d5f703d69adbLuke Smith '</button>'+
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * Default markup template used to create the DOM structure for Console
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * entries. The markup contains {placeholder}s for content and classes
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * that are replaced via Y.substitute. The default template contains
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * the {placeholder}s identified in Console.ENTRY_CLASSES as well as the
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * following placeholders that will be populated by the log entry data:
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * <li>cat_class</li>
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * <li>src_class</li>
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * <li>label</li>
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * <li>totalTime</li>
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * <li>elapsedTime</li>
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * <li>localTime</li>
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * <li>sourceAndDetail</li>
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * <li>message</li>
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @property Console.ENTRY_TEMPLATE
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @type String
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * Static property used to define the default attribute configuration of
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * the Widget.
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @property Console.ATTRS
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @Type Object
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * Name of the custom event that will communicate log messages.
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @attribute logEvent
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @type String
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @default "yui:log"
16479f9c396537f36d0d9c5633b24df618eee1e6Luke Smith * Object that will emit the log events. By default the YUI instance.
16479f9c396537f36d0d9c5633b24df618eee1e6Luke Smith * To have a single Console capture events from all YUI instances, set
16479f9c396537f36d0d9c5633b24df618eee1e6Luke Smith * this to the Y.Global object.
16479f9c396537f36d0d9c5633b24df618eee1e6Luke Smith * @attribute logSource
16479f9c396537f36d0d9c5633b24df618eee1e6Luke Smith * @type EventTarget
16479f9c396537f36d0d9c5633b24df618eee1e6Luke Smith * @default Y
16479f9c396537f36d0d9c5633b24df618eee1e6Luke Smith validator : function (v) {
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * Collection of strings used to label elements in the Console UI.
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * Default collection contains the following name:value pairs:
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * <li>title : "Log Console"</li>
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * <li>pause : "Pause"</li>
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * <li>clear : "Clear"</li>
ed51daad3a3ab15255ca10edef69d5f703d69adbLuke Smith * <li>collapse : "Collapse"</li>
ed51daad3a3ab15255ca10edef69d5f703d69adbLuke Smith * <li>expand : "Expand"</li>
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @attribute strings
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @type Object
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * Boolean to pause the outputting of new messages to the console.
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * When paused, messages will accumulate in the buffer.
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @attribute paused
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @type boolean
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @default false
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * If a category is not specified in the Y.log(..) statement, this
c36390194c43d30adc1059a74fdf9f51a235b8a9Luke Smith * category will be used. Categories "info",
c36390194c43d30adc1059a74fdf9f51a235b8a9Luke Smith * "warn", and "error" are also called log level.
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @attribute defaultCategory
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @type String
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @default "info"
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * If a source is not specified in the Y.log(..) statement, this
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * source will be used.
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @attribute defaultSource
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @type String
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @default "global"
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * Markup template used to create the DOM structure for Console entries.
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @attribute entryTemplate
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @type String
abf34f3b3d65331ec654c9980a6d60d7f9701bfeLuke Smith * @default Console.ENTRY_TEMPLATE
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * Minimum entry log level to render into the Console. The initial
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * logLevel value for all Console instances defaults from the
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * Y.config.logLevel YUI configuration, or Console.LOG_LEVEL_INFO if
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * that configuration is not set.
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * Possible values are "info", "warn",
c36390194c43d30adc1059a74fdf9f51a235b8a9Luke Smith * "error" (case insensitive), or their corresponding statics
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * Console.LOG_LEVEL_INFO and so on.
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @attribute logLevel
c36390194c43d30adc1059a74fdf9f51a235b8a9Luke Smith * @type String
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @default Y.config.logLevel or Console.LOG_LEVEL_INFO
9327ef7ad1fee11b0e494b97cc07386565326c03Luke Smith setter : function (v) {
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith return this._setLogLevel(v);
c36390194c43d30adc1059a74fdf9f51a235b8a9Luke Smith * Millisecond timeout between iterations of the print loop, moving
c36390194c43d30adc1059a74fdf9f51a235b8a9Luke Smith * entries from the buffer to the UI.
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @attribute printTimeout
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @type Number
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @default 100
c36390194c43d30adc1059a74fdf9f51a235b8a9Luke Smith * Maximum number of entries printed in each iteration of the print
c36390194c43d30adc1059a74fdf9f51a235b8a9Luke Smith * loop. This is used to prevent excessive logging locking the page UI.
c31ae0e3c3d2726907b1876b5fe81cfd94527d5dLuke Smith * @attribute printLimit
c31ae0e3c3d2726907b1876b5fe81cfd94527d5dLuke Smith * @type Number
c36390194c43d30adc1059a74fdf9f51a235b8a9Luke Smith * @default 50
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * Maximum number of Console entries allowed in the Console body at one
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * time. This is used to keep acquired messages from exploding the
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * DOM tree and impacting page performance.
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @attribute consoleLimit
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @type Number
c31ae0e3c3d2726907b1876b5fe81cfd94527d5dLuke Smith * @default 300
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * New entries should display at the top of the Console or the bottom?
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @attribute newestOnTop
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @type Boolean
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @default true
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * When new entries are added to the Console UI, should they be
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * scrolled into view?
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @attribute scrollIntoView
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @type Boolean
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @default true
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * The baseline time for this Console instance, used to measure elapsed
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * time from the moment the console module is <code>use</code>d to the
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * moment each new entry is logged (not rendered).
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * This value is reset by the instance method myConsole.reset().
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @attribute startTime
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @type Date
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @default The moment the console module is <code>use</code>d
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith value : new Date()
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * The precise time the last entry was logged. Used to measure elapsed
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * time between log messages.
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @attribute lastTime
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @type Date
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @default The moment the console module is <code>use</code>d
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith value : new Date(),
ed51daad3a3ab15255ca10edef69d5f703d69adbLuke Smith * Controls the collapsed state of the Console
ed51daad3a3ab15255ca10edef69d5f703d69adbLuke Smith * @attribute collapsed
ed51daad3a3ab15255ca10edef69d5f703d69adbLuke Smith * @type Boolean
ed51daad3a3ab15255ca10edef69d5f703d69adbLuke Smith * @default false
d463aba91a07cde67f9ec9382bce464db5bcc9d3Luke Smith * String with units, or number, representing the height of the Console,
d463aba91a07cde67f9ec9382bce464db5bcc9d3Luke Smith * inclusive of header and footer. If a number is provided, the default
c36390194c43d30adc1059a74fdf9f51a235b8a9Luke Smith * unit, defined by Widget's DEF_UNIT, property is used.
d463aba91a07cde67f9ec9382bce464db5bcc9d3Luke Smith * @attribute height
d463aba91a07cde67f9ec9382bce464db5bcc9d3Luke Smith * @default "300px"
d463aba91a07cde67f9ec9382bce464db5bcc9d3Luke Smith * @type {String | Number}
d463aba91a07cde67f9ec9382bce464db5bcc9d3Luke Smith * String with units, or number, representing the width of the Console.
c36390194c43d30adc1059a74fdf9f51a235b8a9Luke Smith * If a number is provided, the default unit, defined by Widget's
d463aba91a07cde67f9ec9382bce464db5bcc9d3Luke Smith * DEF_UNIT, property is used.
d463aba91a07cde67f9ec9382bce464db5bcc9d3Luke Smith * @attribute width
d463aba91a07cde67f9ec9382bce464db5bcc9d3Luke Smith * @default "300px"
d463aba91a07cde67f9ec9382bce464db5bcc9d3Luke Smith * @type {String | Number}
e0faaaef9dd138950007532eac3754c0290039b4Luke Smith * Pass through to the YUI instance useBrowserConsole configuration.
e0faaaef9dd138950007532eac3754c0290039b4Luke Smith * By default this is set to false, which will disable logging to the
e0faaaef9dd138950007532eac3754c0290039b4Luke Smith * browser console when a Console instance is created. If the
e0faaaef9dd138950007532eac3754c0290039b4Luke Smith * logSource is not a YUI instance, this has no effect.
e0faaaef9dd138950007532eac3754c0290039b4Luke Smith * @attribute useBrowserConsole
e0faaaef9dd138950007532eac3754c0290039b4Luke Smith * @type {Boolean}
e0faaaef9dd138950007532eac3754c0290039b4Luke Smith * @default false
e0faaaef9dd138950007532eac3754c0290039b4Luke Smith getter : function () {
e0faaaef9dd138950007532eac3754c0290039b4Luke Smith setter : function (v) {
16479f9c396537f36d0d9c5633b24df618eee1e6Luke Smith * Category to prefix all event subscriptions to allow for ease of detach
16479f9c396537f36d0d9c5633b24df618eee1e6Luke Smith * during destroy.
16479f9c396537f36d0d9c5633b24df618eee1e6Luke Smith * @property _evtCat
16479f9c396537f36d0d9c5633b24df618eee1e6Luke Smith * @type string
16479f9c396537f36d0d9c5633b24df618eee1e6Luke Smith * @protected
c36390194c43d30adc1059a74fdf9f51a235b8a9Luke Smith * Reference to the Node instance containing the header contents.
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @property _head
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @type Node
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @default null
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @protected
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * Reference to the Node instance that will house the console messages.
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @property _body
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @type Node
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @default null
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @protected
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * Reference to the Node instance containing the footer contents.
c36390194c43d30adc1059a74fdf9f51a235b8a9Luke Smith * @property _foot
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @type Node
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @default null
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @protected
c36390194c43d30adc1059a74fdf9f51a235b8a9Luke Smith * Holds the object API returned from <code>Y.later</code> for the print
c36390194c43d30adc1059a74fdf9f51a235b8a9Luke Smith * loop interval.
35eeab4975a1c9e62cf466455a59e80ba5e00fb0Luke Smith * @property _printLoop
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @type Object
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @default null
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @protected
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * Array of normalized message objects awaiting printing.
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @property buffer
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @type Array
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @default null
3cefe5340bfed84038e5816dbfbe7cec44f0df31Luke Smith * @protected
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * Wrapper for <code>Y.log</code>.
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @method log
3cefe5340bfed84038e5816dbfbe7cec44f0df31Luke Smith * @param arg* {MIXED} (all arguments passed through to <code>Y.log</code>)
5800f4bbed853824dd8797caae32f78bcc9ef09bLuke Smith * @chainable
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith log : function () {
5800f4bbed853824dd8797caae32f78bcc9ef09bLuke Smith return this;
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * Clear the console of messages and flush the buffer of pending messages.
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @method clearConsole
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @chainable
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith clearConsole : function () {
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith // TODO: clear event listeners from console contents
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith return this;
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * Clears the console and resets internal timers.
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @method reset
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @chainable
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith reset : function () {
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith return this;
c36390194c43d30adc1059a74fdf9f51a235b8a9Luke Smith * Collapses the body and footer.
ed51daad3a3ab15255ca10edef69d5f703d69adbLuke Smith * @method collapse
5800f4bbed853824dd8797caae32f78bcc9ef09bLuke Smith * @chainable
ed51daad3a3ab15255ca10edef69d5f703d69adbLuke Smith collapse : function () {
5800f4bbed853824dd8797caae32f78bcc9ef09bLuke Smith return this;
c36390194c43d30adc1059a74fdf9f51a235b8a9Luke Smith * Expands the body and footer if collapsed.
c36390194c43d30adc1059a74fdf9f51a235b8a9Luke Smith * @method expand
5800f4bbed853824dd8797caae32f78bcc9ef09bLuke Smith * @chainable
ed51daad3a3ab15255ca10edef69d5f703d69adbLuke Smith expand : function () {
5800f4bbed853824dd8797caae32f78bcc9ef09bLuke Smith return this;
3cefe5340bfed84038e5816dbfbe7cec44f0df31Luke Smith * Outputs buffered messages to the console UI. This is typically called
3cefe5340bfed84038e5816dbfbe7cec44f0df31Luke Smith * from a scheduled interval until the buffer is empty (referred to as the
3cefe5340bfed84038e5816dbfbe7cec44f0df31Luke Smith * print loop). The number of buffered messages output to the Console is
3cefe5340bfed84038e5816dbfbe7cec44f0df31Luke Smith * limited to the number provided as an argument. If no limit is passed,
3cefe5340bfed84038e5816dbfbe7cec44f0df31Luke Smith * all buffered messages are rendered.
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @method printBuffer
c31ae0e3c3d2726907b1876b5fe81cfd94527d5dLuke Smith * @param limit {Number} (optional) max number of buffered entries to write
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @chainable
12193f069c735c9fa68aa22d6b4a8ff1fc5b83f1Luke Smith anchor = newestOnTop ? this._body.get('firstChild') : null,
d7a66fe2de41baa56b41e8b7b254d1f6a50a5135Luke Smith messages.splice(0, messages.length - consoleLimit);
d7a66fe2de41baa56b41e8b7b254d1f6a50a5135Luke Smith limit = Math.min(messages.length, (limit || messages.length));
ed51daad3a3ab15255ca10edef69d5f703d69adbLuke Smith // turn off logging system
12193f069c735c9fa68aa22d6b4a8ff1fc5b83f1Luke Smith entries[i] = this._createEntryHTML(messages.shift());
12193f069c735c9fa68aa22d6b4a8ff1fc5b83f1Luke Smith this._body.insertBefore(create(entries.join('')), anchor);
ed51daad3a3ab15255ca10edef69d5f703d69adbLuke Smith // restore logging system
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith return this;
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * Constructor code. Set up the buffer and entry template, publish
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * internal events, and subscribe to the configured logEvent.
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @method initializer
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @protected
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith initializer : function () {
35eeab4975a1c9e62cf466455a59e80ba5e00fb0Luke Smith this.get('logEvent'),Y.bind("_onLogEvent",this));
c36390194c43d30adc1059a74fdf9f51a235b8a9Luke Smith * Transfers a received message to the print loop buffer. Default
c36390194c43d30adc1059a74fdf9f51a235b8a9Luke Smith * behavior defined in _defEntryFn.
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @event entry
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @param event {Event.Facade} An Event Facade object with the following attribute specific properties added:
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * <dt>message</dt>
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * <dd>The message data normalized into an object literal (see _normalizeMessage)</dd>
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @preventable _defEntryFn
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith this.publish(ENTRY, { defaultFn: this._defEntryFn });
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * Triggers the reset behavior via the default logic in _defResetFn.
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @event reset
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @param event {Event.Facade} Event Facade object
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @preventable _defResetFn
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith this.publish(RESET, { defaultFn: this._defResetFn });
c36390194c43d30adc1059a74fdf9f51a235b8a9Luke Smith * Tears down the instance, flushing event subscriptions and purging the UI.
c36390194c43d30adc1059a74fdf9f51a235b8a9Luke Smith * @method destructor
c36390194c43d30adc1059a74fdf9f51a235b8a9Luke Smith * @protected
16479f9c396537f36d0d9c5633b24df618eee1e6Luke Smith destructor : function () {
16479f9c396537f36d0d9c5633b24df618eee1e6Luke Smith this.get('logSource').detach(this._evtCat + '*');
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * Generate the Console UI.
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @method renderUI
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @protected
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith renderUI : function () {
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * Sync the UI state to the current attribute state.
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @method syncUI
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith syncUI : function () {
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * Set up event listeners to wire up the UI to the internal state.
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @method bindUI
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @protected
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith bindUI : function () {
ed51daad3a3ab15255ca10edef69d5f703d69adbLuke Smith this.get(CONTENT_BOX).query('button.'+C_COLLAPSE).
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith this.get(CONTENT_BOX).query('input[type=checkbox].'+C_PAUSE).
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith // Attribute changes
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * Create the DOM structure for the header elements.
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @method _initHead
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @protected
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith _initHead : function () {
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith this._head = create(substitute(Console.HEADER_TEMPLATE,info));
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith cb.insertBefore(this._head,cb.get('firstChild'));
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * Create the DOM structure for the console body—where messages are
d463aba91a07cde67f9ec9382bce464db5bcc9d3Luke Smith * @method _initBody
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @protected
d463aba91a07cde67f9ec9382bce464db5bcc9d3Luke Smith _initBody : function () {
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * Create the DOM structure for the footer elements.
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @method _initFoot
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @protected
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith _initFoot : function () {
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith this._foot = create(substitute(Console.FOOTER_TEMPLATE,info));
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * Determine if incoming log messages are within the configured logLevel
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * to be buffered for printing.
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @method _isInLogLevel
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @protected
abdfe7cf11d34f89f17b26e4779bf6079d22a910Adam Moore _isInLogLevel : function (e) {
8652e2d20f8ea9c9bfe21217ba427cf0d85ada9aLuke Smith return false;
8652e2d20f8ea9c9bfe21217ba427cf0d85ada9aLuke Smith return true;
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * Create a log entry message from the inputs including the following keys:
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * <li>time - this moment</li>
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * <li>message - leg message</li>
8652e2d20f8ea9c9bfe21217ba427cf0d85ada9aLuke Smith * <li>category - logLevel or custom category for the message</li>
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * <li>source - when provided, the widget or util calling Y.log</li>
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * <li>sourceAndDetail - same as source but can include instance info</li>
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * <li>label - logLevel/category label for the entry</li>
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * <li>localTime - readable version of time</li>
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * <li>elapsedTime - ms since last entry</li>
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * <li>totalTime - ms since Console was instantiated or reset</li>
c36390194c43d30adc1059a74fdf9f51a235b8a9Luke Smith * @method _normalizeMessage
4db02d4b38afe802ad625f6c389e106fdc7c26faLuke Smith * @param e {Event} custom event containing the log message
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @return Object the message object
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @protected
abdfe7cf11d34f89f17b26e4779bf6079d22a910Adam Moore _normalizeMessage : function (e) {
4db02d4b38afe802ad625f6c389e106fdc7c26faLuke Smith time : new Date(),
4db02d4b38afe802ad625f6c389e106fdc7c26faLuke Smith sourceAndDetail : src || this.get('defaultSource'),
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith // Extract m.source "Foo" from m.sourceAndDetail "Foo bar baz"
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith m.source = RE_INLINE_SOURCE.test(m.sourceAndDetail) ?
c36390194c43d30adc1059a74fdf9f51a235b8a9Luke Smith * Sets an interval for buffered messages to be output to the console.
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @method _schedulePrint
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @protected
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith _schedulePrint : function () {
d7a66fe2de41baa56b41e8b7b254d1f6a50a5135Luke Smith if (!this._printLoop && !this.get(PAUSED) && this.get('rendered')) {
c36390194c43d30adc1059a74fdf9f51a235b8a9Luke Smith * Translates message meta into the markup for a console entry.
12193f069c735c9fa68aa22d6b4a8ff1fc5b83f1Luke Smith * @method _createEntryHTML
35eeab4975a1c9e62cf466455a59e80ba5e00fb0Luke Smith * @param m {Object} object literal containing normalized message metadata
12193f069c735c9fa68aa22d6b4a8ff1fc5b83f1Luke Smith * @return String
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @protected
12193f069c735c9fa68aa22d6b4a8ff1fc5b83f1Luke Smith _createEntryHTML : function (m) {
12193f069c735c9fa68aa22d6b4a8ff1fc5b83f1Luke Smith return this.get('entryTemplate').replace(/\{(\w+)\}/g,
12193f069c735c9fa68aa22d6b4a8ff1fc5b83f1Luke Smith function (_,token) {
ed51daad3a3ab15255ca10edef69d5f703d69adbLuke Smith * Scrolls to the most recent entry
ed51daad3a3ab15255ca10edef69d5f703d69adbLuke Smith * @method scrollToLatest
ed51daad3a3ab15255ca10edef69d5f703d69adbLuke Smith * @chainable
ed51daad3a3ab15255ca10edef69d5f703d69adbLuke Smith scrollToLatest : function () {
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * Performs HTML escaping on strings in the message object.
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @method _htmlEscapeMessage
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @param m {Object} the normalized message object
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @return Object a clone of the message object with proper escapement
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @protected
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith _htmlEscapeMessage : function (m) {
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith m.sourceAndDetail = this._encodeHTML(m.sourceAndDetail);
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * Removes the oldest message entries from the UI to maintain the limit
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * specified in the consoleLimit configuration.
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @method _trimOldEntries
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @protected
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith _trimOldEntries : function () {
35eeab4975a1c9e62cf466455a59e80ba5e00fb0Luke Smith // Turn off the logging system for the duration of this operation
35eeab4975a1c9e62cf466455a59e80ba5e00fb0Luke Smith // to prevent an infinite loop
35eeab4975a1c9e62cf466455a59e80ba5e00fb0Luke Smith if (l > 0) {
ed51daad3a3ab15255ca10edef69d5f703d69adbLuke Smith for (;i < l; ++i) {
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * Returns the input string with ampersands (&), <, and > encoded
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * as HTML entities.
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @method _encodeHTML
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @param s {String} the raw string
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @return String the encoded string
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @protected
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith _encodeHTML : function (s) {
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * Clears the timeout for printing buffered messages.
35eeab4975a1c9e62cf466455a59e80ba5e00fb0Luke Smith * @method _cancelPrintLoop
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @protected
35eeab4975a1c9e62cf466455a59e80ba5e00fb0Luke Smith _cancelPrintLoop : function () {
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * Event handler for clicking on the Pause checkbox to update the paused
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * attribute.
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @method _onPauseClick
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @param e {Event} DOM event facade for the click event
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @protected
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith _onPauseClick : function (e) {
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * Event handler for clicking on the Clear button. Pass-through to
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * <code>this.clearConsole()</code>.
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @method _onClearClick
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @param e {Event} DOM event facade for the click event
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @protected
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith _onClearClick : function (e) {
ed51daad3a3ab15255ca10edef69d5f703d69adbLuke Smith * Event handler for clicking on the Collapse/Expand button. Sets the
c36390194c43d30adc1059a74fdf9f51a235b8a9Luke Smith * "collapsed" attribute accordingly.
c36390194c43d30adc1059a74fdf9f51a235b8a9Luke Smith * @method _onCollapseClick
ed51daad3a3ab15255ca10edef69d5f703d69adbLuke Smith * @param e {Event} DOM event facade for the click event
ed51daad3a3ab15255ca10edef69d5f703d69adbLuke Smith * @protected
ed51daad3a3ab15255ca10edef69d5f703d69adbLuke Smith _onCollapseClick : function (e) {
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * Setter method for logLevel attribute. Acceptable values are
c36390194c43d30adc1059a74fdf9f51a235b8a9Luke Smith * "error", "warn", and "info" (case
c36390194c43d30adc1059a74fdf9f51a235b8a9Luke Smith * insensitive). Other values are treated as "info".
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @method _setLogLevel
8652e2d20f8ea9c9bfe21217ba427cf0d85ada9aLuke Smith * @param v {String} the desired log level
8652e2d20f8ea9c9bfe21217ba427cf0d85ada9aLuke Smith * @return String One of Console.LOG_LEVEL_INFO, _WARN, or _ERROR
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @protected
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith _setLogLevel : function (v) {
d463aba91a07cde67f9ec9382bce464db5bcc9d3Luke Smith * Set the height of the Console container. Set the body height to the difference between the configured height and the calculated heights of the header and footer.
d463aba91a07cde67f9ec9382bce464db5bcc9d3Luke Smith * Overrides Widget.prototype._uiSetHeight.
d463aba91a07cde67f9ec9382bce464db5bcc9d3Luke Smith * @method _uiSetHeight
d463aba91a07cde67f9ec9382bce464db5bcc9d3Luke Smith * @param v {String|Number} the new height
d463aba91a07cde67f9ec9382bce464db5bcc9d3Luke Smith * @protected
d463aba91a07cde67f9ec9382bce464db5bcc9d3Luke Smith _uiSetHeight : function (v) {
d463aba91a07cde67f9ec9382bce464db5bcc9d3Luke Smith Console.superclass._uiSetHeight.apply(this,arguments);
d463aba91a07cde67f9ec9382bce464db5bcc9d3Luke Smith var h = this.get('boundingBox').get('offsetHeight') -
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * Updates the UI if changes are made to any of the strings in the strings
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * attribute.
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @method _afterStringsChange
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @param e {Event} Custom event for the attribute change
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @protected
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith _afterStringsChange : function (e) {
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith var prop = e.subAttrName ? e.subAttrName.split(DOT)[1] : null,
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith if ((!prop || prop === TITLE) && before.title !== after.title) {
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith if ((!prop || prop === PAUSE) && before.pause !== after.pause) {
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith if ((!prop || prop === CLEAR) && before.clear !== after.clear) {
c36390194c43d30adc1059a74fdf9f51a235b8a9Luke Smith * Updates the UI and schedules or cancels the print loop.
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @method _afterPausedChange
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @param e {Event} Custom event for the attribute change
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @protected
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith _afterPausedChange : function (e) {
35eeab4975a1c9e62cf466455a59e80ba5e00fb0Luke Smith } else if (this._printLoop) {
d463aba91a07cde67f9ec9382bce464db5bcc9d3Luke Smith * Checks or unchecks the paused checkbox
d463aba91a07cde67f9ec9382bce464db5bcc9d3Luke Smith * @method _uiUpdatePaused
d463aba91a07cde67f9ec9382bce464db5bcc9d3Luke Smith * @param on {Boolean} the new checked state
d463aba91a07cde67f9ec9382bce464db5bcc9d3Luke Smith * @protected
d463aba91a07cde67f9ec9382bce464db5bcc9d3Luke Smith var node = this._foot.queryAll('input[type=checkbox].'+C_PAUSE);
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * Calls this._trimOldEntries() in response to changes in the configured
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * consoleLimit attribute.
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @method _afterConsoleLimitChange
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @param e {Event} Custom event for the attribute change
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @protected
ed51daad3a3ab15255ca10edef69d5f703d69adbLuke Smith * Updates the className of the contentBox, which should trigger CSS to
ed51daad3a3ab15255ca10edef69d5f703d69adbLuke Smith * hide or show the body and footer sections depending on the new value.
ed51daad3a3ab15255ca10edef69d5f703d69adbLuke Smith * @method _afterCollapsedChange
ed51daad3a3ab15255ca10edef69d5f703d69adbLuke Smith * @param e {Event} Custom event for the attribute change
ed51daad3a3ab15255ca10edef69d5f703d69adbLuke Smith * @protected
ed51daad3a3ab15255ca10edef69d5f703d69adbLuke Smith _afterCollapsedChange : function (e) {
d463aba91a07cde67f9ec9382bce464db5bcc9d3Luke Smith * Updates the UI to reflect the new Collapsed state
d463aba91a07cde67f9ec9382bce464db5bcc9d3Luke Smith * @method _uiUpdateCollapsed
d463aba91a07cde67f9ec9382bce464db5bcc9d3Luke Smith * @param v {Boolean} true for collapsed, false for expanded
d463aba91a07cde67f9ec9382bce464db5bcc9d3Luke Smith * @protected
d463aba91a07cde67f9ec9382bce464db5bcc9d3Luke Smith _uiUpdateCollapsed : function (v) {
d463aba91a07cde67f9ec9382bce464db5bcc9d3Luke Smith str = this.get('strings.'+(v ? 'expand' : 'collapse'));
d463aba91a07cde67f9ec9382bce464db5bcc9d3Luke Smith * Makes adjustments to the UI if needed when the Console is hidden or shown
d463aba91a07cde67f9ec9382bce464db5bcc9d3Luke Smith * @method _afterVisibleChange
d463aba91a07cde67f9ec9382bce464db5bcc9d3Luke Smith * @param e {Event} the visibleChange event
d463aba91a07cde67f9ec9382bce464db5bcc9d3Luke Smith * @protected
d463aba91a07cde67f9ec9382bce464db5bcc9d3Luke Smith _afterVisibleChange : function (e) {
d463aba91a07cde67f9ec9382bce464db5bcc9d3Luke Smith Console.superclass._afterVisibleChange.apply(this,arguments);
d463aba91a07cde67f9ec9382bce464db5bcc9d3Luke Smith * Recalculates dimensions and updates appropriately when shown
d463aba91a07cde67f9ec9382bce464db5bcc9d3Luke Smith * @method _uiUpdateFromHideShow
d463aba91a07cde67f9ec9382bce464db5bcc9d3Luke Smith * @param v {Boolean} true for visible, false for hidden
d463aba91a07cde67f9ec9382bce464db5bcc9d3Luke Smith * @protected
d463aba91a07cde67f9ec9382bce464db5bcc9d3Luke Smith _uiUpdateFromHideShow : function (v) {
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * Responds to log events by normalizing qualifying messages and passing
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * them along through the entry event for buffering etc.
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @method _onLogEvent
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @param msg {String} the log message
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @param cat {String} OPTIONAL the category or logLevel of the message
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @param src {String} OPTIONAL the source of the message (e.g. widget name)
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @protected
abdfe7cf11d34f89f17b26e4779bf6079d22a910Adam Moore _onLogEvent : function (e) {
abdfe7cf11d34f89f17b26e4779bf6079d22a910Adam Moore if (!this.get(DISABLED) && this._isInLogLevel(e)) {
abdfe7cf11d34f89f17b26e4779bf6079d22a910Adam Moore /* TODO: needed? */
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * Clears the console, resets the startTime attribute, enables and
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * unpauses the widget.
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @method _defResetFn
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @protected
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith _defResetFn : function () {
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * Buffers incoming message objects and schedules the printing.
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @method _defEntryFn
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @param e {Event} The Custom event carrying the message in its payload
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith * @protected
b32d148b0052e1f874e9bc9803bef729bf859d97Luke Smith _defEntryFn : function (e) {