1 /* ***** BEGIN LICENSE BLOCK *****
  2  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
  3  *
  4  * The contents of this file are subject to the Mozilla Public License Version
  5  * 1.1 (the "License"); you may not use this file except in compliance with
  6  * the License. You may obtain a copy of the License at
  7  * http://www.mozilla.org/MPL/
  8  *
  9  * Software distributed under the License is distributed on an "AS IS" basis,
 10  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 11  * for the specific language governing rights and limitations under the
 12  * License.
 13  *
 14  * The Original Code is gContactSync.
 15  *
 16  * The Initial Developer of the Original Code is
 17  * Josh Geenen <gcontactsync@pirules.org>.
 18  * Portions created by the Initial Developer are Copyright (C) 2008-2009
 19  * the Initial Developer. All Rights Reserved.
 20  *
 21  * Contributor(s):
 22  *
 23  * Alternatively, the contents of this file may be used under the terms of
 24  * either the GNU General Public License Version 2 or later (the "GPL"), or
 25  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 26  * in which case the provisions of the GPL or the LGPL are applicable instead
 27  * of those above. If you wish to allow use of your version of this file only
 28  * under the terms of either the GPL or the LGPL, and not to allow others to
 29  * use your version of this file under the terms of the MPL, indicate your
 30  * decision by deleting the provisions above and replace them with the notice
 31  * and other provisions required by the GPL or the LGPL. If you do not delete
 32  * the provisions above, a recipient may use your version of this file under
 33  * the terms of any one of the MPL, the GPL or the LGPL.
 34  *
 35  * ***** END LICENSE BLOCK ***** */
 36 
 37 if (!com) var com = {}; // A generic wrapper variable
 38 // A wrapper for all GCS functions and variables
 39 if (!com.gContactSync) com.gContactSync = {};
 40 
 41 /**
 42  * Contains all of the string bundles included in gContactSync and provides
 43  * a method (getStr) to find a string by looking in every bundle.
 44  * NOTE:  This requires that string bundles have unique names for strings.
 45  * NOTE:  Must be initialized when the window is loaded.
 46  * @class
 47  */
 48 com.gContactSync.StringBundle = {
 49   mBundles:     {},
 50   mInitialized: false,
 51   /**
 52    * Initializes the string bundle.
 53    */
 54   init: function StringBundle_init() {
 55     if (this.mInitialized)
 56       return true;
 57     this.mBundles.mStrings = document.getElementById("gContactSyncStringBundle");
 58     if (!this.mBundles.mStrings) {
 59       var err = "Error - com.gContactSync.StringBundle could not be initialized\n";
 60       com.gContactSync.alertError(err);
 61       throw err;
 62     }
 63     this.mInitialized = true;
 64     return true;
 65   },
 66   /**
 67    * Searches every string bundle until a string is found with the given name.
 68    * @param aName {string} The name of the string to search for.
 69    * @returns {string} The translated string.
 70    */
 71   getStr: function StringBundle_getStr(aName) {
 72     // initialize the string bundle if it wasn't already done
 73     if (!this.mInitialized)
 74       this.init();
 75     for (var i in this.mBundles) {
 76       try {
 77         return this.mBundles[i].getString(aName);
 78       } catch(e) { continue; } // if the bundle doesn't exist or if the string
 79                                // isn't in it skip to the next
 80     }
 81     // if it gets this far the string wasn't found...
 82     com.gContactSync.alertError("Could not get the string named: " + aName);
 83     return "";
 84   }
 85 };
 86