MMIR Framework

Source: env/media/waitReadyIndicator.js

  2. /**
  3.  * Default / standard implementation for wait-/ready-indication:
  4.  *
  5.  * media-modules may signal that they are <code>preparing</code> a resource, and then that
  6.  * they are <code>ready</code> via the {@link mmir.MediaManager#_preparing} and
  7.  * {@link mmir.MediaManager#_ready}.
  8.  *
  9.  * This implementation provides a simple mechanism for showing these states to the user:
  10.  * upon <em>preparing</em> an overlay with a "please wait" message is shown, and upon
  11.  * <em>ready</em> the overlay is hidden again.
  12.  *
  13.  * See {@link #setWaitCaption} for details on setting a custom text message.
  14.  *
  15.  * In order to load this implementation, add the entry <code>"waitReadyIndicator"</code>
  16.  * to the <code>mediaManager.plugins</code> list in the MMIR configuration file
  17.  * at <code>config/configuration.json</code>:
  18.  * <pre>
  19.  * ...
  20.  *   "mediaManager": {
  21.  *    "plugins": {
  22.  *      "browser": ["waitReadyIndicator",
  23.  *                  // OR: {"mod": "waitReadyIndicator", "config": "url to css styles"},
  24.  *                  "webAudio",
  25.  *                  ...
  26.  *      ],
  27.  *      "cordova": ["waitReadyIndicator",
  28.  *                  // OR: {"mod": "waitReadyIndicator", "config": "url to css styles"},
  29.  *                  "androidAudioInput",
  30.  *                  ...
  31.  *      ]
  32.  *      ...
  33.  *    }
  34.  *  },
  35.  *  ...
  36.  * </pre>
  37.  * NOTE: the optional configuration value specifies an URL to a CSS file for styling the
  38.  *       wait-/ready-indication dialog.
  39.  *       If not specified, the default styling of stlne-wait-dlg is used.
  40.  *
  41.  * @example
  42.  *
  43.  * //starting to prepare a resource:
  44.  * mmir.MediaManager._preparing();
  45.  *
  46.  * // do something ...
  47.  *
  48.  * //... when the resouce has been prepared
  49.  * // and is ready to be used:
  50.  * mmir.MediaManager._ready();
  51.  *
  52.  * @class
  53.  * @public
  54.  * @name  WaitReadyIndicatorImpl
  55.  * @memberOf mmir.env.media
  56.  *
  57.  * @requires mmirf/waitDialog the stlne-wait-dlg implementation (waitDialog module and CSS)
  58.  */
  61. define(['mmirf/languageManager', 'mmirf/waitDialog'], function(lang, dlg){
  63. /**  @class WaitReadyIndicatorImpl */
  64. return {
  65. 	/**  @memberOf WaitReadyIndicatorImpl# */
  66. 	initialize: function(callBack, __mediaManager, ctxId, moduleConfig){
  68. 		/**  @memberOf WaitReadyIndicatorImpl# */
  69. 		var _pluginName = 'waitReadyIndicator';
  71. 		/**  @memberOf WaitReadyIndicatorImpl# */
  72. 		var _id = 'media-plugin-wait';
  74. 		/**  @memberOf WaitReadyIndicatorImpl# */
  75. 		var caption;
  77. 		/**  @memberOf WaitReadyIndicatorImpl# */
  78. 		var cssUrl = moduleConfig? moduleConfig : dlg.styleUrl;
  80. 		//load the stylesheet file for the wait-dialog
  81. 		// (does nothing, if this load-function was already called before)
  82. 		dlg._loadStyle(cssUrl);
  84. 		//create the DOM elements for the wait dialog (hidden)
  85. 		dlg.create(_id);//, {type: 'verbose', theme: 'a'});//DISABLED: these are the default options
  87. 		//invoke the passed-in initializer-callback and export the public functions:
  88. 		callBack({waitReadyImpl: {
  89. 			/**
  90. 			 * Shows wait dialog.
  91. 			 *
  92. 			 * @public
  93. 			 * @memberOf WaitReadyIndicatorImpl.prototype
  94. 			 * @see mmir.MediaManager#_preparing
  95. 			 */
  96. 			preparing: function (){
  97. 				var text = typeof caption !== 'undefined'? caption : lang.getText('loadingText');
  98. 				dlg.show(text, _id);
  99. 			},
  100. 			/**
  101. 			 * Hides wait dialog.
  102. 			 *
  103. 			 * @public
  104. 			 * @memberOf WaitReadyIndicatorImpl.prototype
  105. 			 * @see mmir.MediaManager#_ready
  106. 			 */
  107. 			ready: function(){
  108. 				dlg.hide(_id);
  109. 			},
  110. 			/**
  111. 			 * Set caption for wait dialog.
  112. 			 *
  113. 			 * <p>
  114. 			 * By default (i.e. not set), the dictionary entry for
  115. 			 * "loadingText" is used as caption / label.
  116. 			 *
  117. 			 * @param {String} text
  118. 			 * 		set the caption / label for the wait-dialog.<br>
  119. 			 * 		If <code>undefined</code>, the default caption will be used.
  120. 			 *
  121. 			 * @public
  122. 			 * @memberOf WaitReadyIndicatorImpl.prototype
  123. 			 * @see mmir.MediaManager#ready
  124. 			 * @see mmir.LanguageManager#getText
  125. 			 */
  126. 			setWaitCaption: function(text){
  127. 				caption = text;
  128. 			},
  129. 			/**
  130. 			 * Get current caption for wait dialog.
  131. 			 *
  132. 			 * NOTE if none is set, then internally the value of "loadingText"
  133. 			 * property of the current language dictionary will be used.
  134. 			 *
  135. 			 * @public
  136. 			 * @memberOf WaitReadyIndicatorImpl.prototype
  137. 			 * @see mmir.MediaManager#_ready
  138. 			 * @see #setWaitCaption
  139. 			 */
  140. 			getWaitCaption: function(){
  141. 				return caption;
  142. 			}
  143. 		}});
  145. 	}
  146. };
  148. });//END define