| 1 |
// Copyright 2012 The Closure Library Authors. All Rights Reserved. |
| 2 |
// |
| 3 |
// Licensed under the Apache License, Version 2.0 (the "License"); |
| 4 |
// you may not use this file except in compliance with the License. |
| 5 |
// You may obtain a copy of the License at |
| 6 |
// |
| 7 |
// http://www.apache.org/licenses/LICENSE-2.0 |
| 8 |
// |
| 9 |
// Unless required by applicable law or agreed to in writing, software |
| 10 |
// distributed under the License is distributed on an "AS-IS" BASIS, |
| 11 |
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 12 |
// See the License for the specific language governing permissions and |
| 13 |
// limitations under the License. |
| 14 |
|
| 15 |
/** |
| 16 |
* @fileoverview Definition of the goog.i18n.CharNameFetcher interface. This |
| 17 |
* interface is used to retrieve individual character names. |
| 18 |
*/ |
| 19 |
|
| 20 |
goog.provide('goog.i18n.uChar.NameFetcher'); |
| 21 |
|
| 22 |
|
| 23 |
|
| 24 |
/** |
| 25 |
* NameFetcher interface. Implementations of this interface are used to retrieve |
| 26 |
* Unicode character names. |
| 27 |
* |
| 28 |
* @interface |
| 29 |
*/ |
| 30 |
goog.i18n.uChar.NameFetcher = function() {}; |
| 31 |
|
| 32 |
|
| 33 |
/** |
| 34 |
* Retrieves the names of a given set of characters and stores them in a cache |
| 35 |
* for fast retrieval. Offline implementations can simply provide an empty |
| 36 |
* implementation. |
| 37 |
* |
| 38 |
* @param {string} characters The list of characters in base 88 to fetch. These |
| 39 |
* lists are stored by category and subcategory in the |
| 40 |
* goog.i18n.charpickerdata class. |
| 41 |
*/ |
| 42 |
goog.i18n.uChar.NameFetcher.prototype.prefetch = function(characters) {}; |
| 43 |
|
| 44 |
|
| 45 |
/** |
| 46 |
* Retrieves the name of a particular character. |
| 47 |
* |
| 48 |
* @param {string} character The character to retrieve. |
| 49 |
* @param {function(?string)} callback The callback function called when the |
| 50 |
* name retrieval is complete, contains a single string parameter with the |
| 51 |
* codepoint name, this parameter will be null if the character name is not |
| 52 |
* defined. |
| 53 |
*/ |
| 54 |
goog.i18n.uChar.NameFetcher.prototype.getName = function(character, callback) { |
| 55 |
}; |
| 56 |
|
| 57 |
|
| 58 |
/** |
| 59 |
* Tests whether the name of a given character is available to be retrieved by |
| 60 |
* the getName() function. |
| 61 |
* |
| 62 |
* @param {string} character The character to test. |
| 63 |
* @return {boolean} True if the fetcher can retrieve or has a name available |
| 64 |
* for the given character. |
| 65 |
*/ |
| 66 |
goog.i18n.uChar.NameFetcher.prototype.isNameAvailable = function(character) {}; |