Version 0.6.133, fix for closure compiler - ADVANCED_OPTIMIZATIONS

[pettanr/clientJs.git] / 0.6.x / js / 01_core / 14_XTimer.js

diff --git a/0.6.x/js/01_core/14_XTimer.js b/0.6.x/js/01_core/14_XTimer.js
index 7846bf3..d2dbd8f 100644 (file)
--- a/0.6.x/js/01_core/14_XTimer.js
+++ b/0.6.x/js/01_core/14_XTimer.js
@@ -1,4 +1,4 @@
-/**\r
+/*\r
  * use X.Callback\r
  */\r
 \r
@@ -34,7 +34,15 @@
 // ------------ local variables -------------------------------------------- //\r
 // ------------------------------------------------------------------------- //\r
 \r
-var X_Timer_now = Date.now || function(){ return +new Date; },\r
+var\r
+\r
+       /**\r
+        * 現在時の ms を返します。 new Date().getTime() の値です。\r
+        * @alias X.Timer.now\r
+        * @function\r
+        * @return {number} ミリ秒\r
+        */\r
+       X_Timer_now = Date.now || function(){ return +new Date; },\r
 \r
        X_Timer_SET_TIMEOUT   = window.setTimeout,\r
        X_Timer_CLEAR_TIMEOUT = window.clearTimeout,\r
@@ -76,16 +84,39 @@ var X_Timer_now = Date.now || function(){ return +new Date; },
 // ------------------------------------------------------------------------- //\r
 // --- interface ----------------------------------------------------------- //\r
 // ------------------------------------------------------------------------- //\r
+\r
+/**\r
+ * <p>setTimeout をラップします。複数のタイマーを登録しても Web ブラウザにはひとつのタイマーを登録します。\r
+ * <p>参考:<a href="http://d.hatena.ne.jp/amachang/20060924/1159084608" target="_blank">複雑で重くなった JavaScript を超高速化する方法３</a>,\r
+ * <a href="http://d.hatena.ne.jp/sawat/20070329" target="_blank">[JavaScript]setIntervalを実験する</a>\r
+ * <p>指定時間の経過したタイマーは、より過去のものから順番にコールバックされます。\r
+ * <p>setTimeout のコールバックに文字列しか指定できないブラウザがあり対策しています。\r
+ * <p>requestAnimationFrame をラップします。ベンダープレフィックス付の requestAnimationFrame もない場合、setTimeout にフォールバックします。\r
+ * \r
+ * @example X.Timer.add( 1000, 5, thisContext, onTimer );\r
+ * \r
+ * @namespace X.Timer\r
+ * @alias X.Timer\r
+ */ \r
 X.Timer = {\r
-       \r
+\r
        now : X_Timer_now,\r
        \r
+       /**\r
+        * タイマーをセットします。\r
+        * @param {number} time ミリ秒\r
+        * @param {number} opt_count 回数。省略可能。指定回数で自動でタイマーを破棄します。0 を指定した場合無限にタイマーが呼ばれます。省略した場合 0 と同じです。\r
+        * @param {*} args1 コールバックのための最大で 3 つの引数を指定します。参考:__CallbackHash__\r
+        * @param {*} args2\r
+        * @param {*} args3\r
+        * @return {number} タイマーID。1 以上の数値。タイマーの解除に使用。\r
+        */\r
        add : function( time, opt_count, args1, args2, args3 ){\r
                var list = X_Timer_TICKET_LIST,\r
                        hash, obj;\r
                time = time < X_Timer_INTERVAL_TIME ? 1 : time / X_Timer_INTERVAL_TIME | 0; // 正の数で使える「Math.floor(x)」を「(x | 0)」に;\r
                \r
-               if( !X.Type.isNumber( opt_count ) ){\r
+               if( !X_Type_isNumber( opt_count ) ){\r
                        args3 = args2;\r
                        args2 = args1;\r
                        args1 = opt_count;\r
@@ -106,10 +137,22 @@ X.Timer = {
            return X_Timer_uid;\r
        },\r
        \r
+       /**\r
+        * 1 回呼ばれたら解除されるタイマーをセットします。\r
+        * @param {number} time ミリ秒\r
+        * @param {*} args1 コールバックのための最大で 3 つの引数を指定します。参考:__CallbackHash__\r
+        * @param {*} args2\r
+        * @param {*} args3\r
+        * @return {number} タイマーID。1 以上の数値。タイマーの解除に使用。\r
+        */\r
        once : function( time, args1, args2, args3 ){\r
                return X.Timer.add( time, 1, args1, args2, args3 );\r
        },\r
        \r
+       /**\r
+        * タイマーを解除します。登録時に受け取ったタイマーIDを使用します。\r
+        * @param {number} タイマーID\r
+        */\r
        remove : function( uid ){\r
                var list = X_Timer_TICKET_LIST,\r
                        i    = list.length,\r
@@ -128,7 +171,7 @@ X.Timer = {
                                         * lazyDispatch 中の EventDispatcher の有無を調べる\r
                                         */\r
                                        if( X_EventDispatcher_LAZY_TIMERS[ uid ] ){\r
-                                               eventDispatcher = X_EventDispatcher_LAZY_TIMERS[ uid ];\r
+                                               // eventDispatcher = X_EventDispatcher_LAZY_TIMERS[ uid ];\r
                                                delete X_EventDispatcher_LAZY_TIMERS[ uid ];\r
                                                /*\r
                                                listeners = eventDispatcher[ '_listeners' ];\r
@@ -150,6 +193,14 @@ X.Timer = {
                };\r
        },\r
        \r
+       /**\r
+        * requestAnimationFrame をセットします。\r
+        * @function\r
+        * @param {*} args1 コールバックのための最大で 3 つの引数を指定します。参考:__CallbackHash__\r
+        * @param {*} args2\r
+        * @param {*} args3\r
+        * @return {number} タイマーID。1 以上の数値。タイマーの解除に使用。\r
+        */\r
        requestFrame : X_Timer_REQ_ANIME_FRAME ?\r
                (function( args1, args2, args3 ){\r
                        var i = X_Timer_REQ_FRAME_LIST.length,\r
@@ -165,7 +216,12 @@ X.Timer = {
                        f = X_Timer_REQ_FRAME_LIST[ i ] = X_Callback_classifyCallbackArgs( args1, args2, args3 );\r
                        return f.uid = ++X_Timer_uid;\r
                }),\r
-       \r
+\r
+       /**\r
+        * requestAnimationFrame を解除します。登録時に受け取ったタイマーIDを使用します。\r
+        * @function\r
+        * @param {number} タイマーID\r
+        */\r
        cancelFrame : X_Timer_CANCEL_ANIME_FRAME ?\r
                (function( uid ){\r
                        var list = X_Timer_REQ_FRAME_LIST,\r
@@ -215,7 +271,7 @@ X.Timer = {
 // --- implements ---------------------------------------------------------- //\r
 // ------------------------------------------------------------------------- //\r
 \r
-if( X_UA.IE4 || X_UA.MacIE ){\r
+if( X_UA[ 'IE4' ] || X_UA[ 'MacIE' ] ){\r
        X.Timer[ '_' ] = X_Timer_onTimeout;\r
        X_Timer_onTimeout = 'X.Timer._()';\r
 };\r
@@ -322,7 +378,7 @@ function X_Timer_compareQueue( a, b ){
 \r
 // http://havelog.ayumusato.com/develop/javascript/e528-ios6_scrolling_timer_notcall.html\r
 // iOS6 スクロール中のタイマー発火絡みのバグ備忘\r
-if( X_UA.iOS ){\r
+if( X_UA[ 'iOS' ] ){\r
        window.addEventListener( 'scroll', function(){\r
                var last, now;\r
                if( X_Timer_timerId ){\r