third_party/google_input_tools/src/chrome/os/datasource.js

   1 // Copyright 2014 The ChromeOS IME Authors. All Rights Reserved.
   2 // limitations under the License.
   3 // See the License for the specific language governing permissions and
   4 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   5 // distributed under the License is distributed on an "AS-IS" BASIS,
   6 // Unless required by applicable law or agreed to in writing, software
   7 //
   8 //      http://www.apache.org/licenses/LICENSE-2.0
   9 //
  10 // You may obtain a copy of the License at
  11 // you may not use this file except in compliance with the License.
  12 // Licensed under the Apache License, Version 2.0 (the "License");
  13 //
  14 goog.provide('i18n.input.chrome.DataSource');
  15
  16 goog.require('goog.events');
  17 goog.require('goog.events.Event');
  18 goog.require('goog.events.EventTarget');
  19 goog.require('goog.functions');
  20
  21
  22 goog.scope(function() {
  23 var Event = goog.events.Event;
  24 var EventTarget = goog.events.EventTarget;
  25
  26
  27
  28 /**
  29  * The data source.
  30  *
  31  * @param {number} numOfCanddiate The number of canddiate to fetch.
  32  * @param {function(string, !Array.<!Object>)} callback .
  33  * @constructor
  34  * @extends {EventTarget}
  35  */
  36 i18n.input.chrome.DataSource = function(numOfCanddiate, callback) {
  37   goog.base(this);
  38
  39   /**
  40    * The number of candidates to fetch.
  41    *
  42    * @type {number}
  43    */
  44   this.numOfCandidate = numOfCanddiate;
  45
  46   /** @protected {function(string, !Array.<!Object>)} */
  47   this.callback = callback;
  48 };
  49 var DataSource = i18n.input.chrome.DataSource;
  50 goog.inherits(DataSource, EventTarget);
  51
  52
  53 /**
  54  * The event type.
  55  *
  56  * @enum {string}
  57  */
  58 DataSource.EventType = {
  59   CANDIDATES_BACK: goog.events.getUniqueId('cb'),
  60   READY: goog.events.getUniqueId('r')
  61 };
  62
  63
  64 /** @type {boolean} */
  65 DataSource.prototype.ready = false;
  66
  67
  68 /**
  69  * The correction level.
  70  *
  71  * @protected {number}
  72  */
  73 DataSource.prototype.correctionLevel = 0;
  74
  75
  76 /**
  77  * Whether user dict is enabled.
  78  *
  79  * @protected {boolean}
  80  */
  81 DataSource.prototype.enableUserDict = false;
  82
  83
  84 /**
  85  * The language code.
  86  *
  87  * @type {string}
  88  * @protected
  89  */
  90 DataSource.prototype.language;
  91
  92
  93 /**
  94  * Sets the langauge code.
  95  *
  96  * @param {string} language The language code.
  97  */
  98 DataSource.prototype.setLanguage = function(language) {
  99   this.language = language;
 100 };
 101
 102
 103 /**
 104  * True if the datasource is ready.
 105  *
 106  * @return {boolean} .
 107  */
 108 DataSource.prototype.isReady = function() {
 109   return this.ready;
 110 };
 111
 112
 113 /**
 114  * Creates the common payload for completion or prediction request.
 115  *
 116  * @return {!Object} The payload.
 117  * @protected
 118  */
 119 DataSource.prototype.createCommonPayload = function() {
 120   return {
 121     'itc': this.getInputToolCode(),
 122     'num': this.numOfCandidate
 123   };
 124 };
 125
 126
 127 /**
 128  * Gets the input tool code.
 129  *
 130  * @return {string} .
 131  */
 132 DataSource.prototype.getInputToolCode = function() {
 133   return this.language + '-t-i0-und';
 134 };
 135
 136
 137 /**
 138  * Sends completion request for a word.
 139  *
 140  * @param {string} word The word.
 141  * @param {string} context The context.
 142  */
 143 DataSource.prototype.sendCompletionRequestForWord = goog.functions.NULL;
 144
 145
 146 /**
 147  * Sends completion request.
 148  *
 149  * @param {string} query The query .
 150  * @param {string} context The context .
 151  * @param {!Object=} opt_spatialData .
 152  */
 153 DataSource.prototype.sendCompletionRequest = goog.functions.NULL;
 154
 155
 156 /**
 157  * Enables/disables user dictionary.
 158  *
 159  * @param {boolean} enabled
 160  */
 161 DataSource.prototype.setEnableUserDict = function(enabled) {
 162   this.enableUserDict = enabled;
 163 };
 164
 165
 166 /**
 167  * Sends prediciton request.
 168  *
 169  * @param {string} context The context.
 170  */
 171 DataSource.prototype.sendPredictionRequest = goog.functions.NULL;
 172
 173
 174 /**
 175  * Sets the correction level.
 176  *
 177  * @param {number} level .
 178  */
 179 DataSource.prototype.setCorrectionLevel = function(level) {
 180   this.correctionLevel = level;
 181 };
 182
 183
 184 /**
 185  * Changes frequency of word in the data source.
 186  *
 187  * @param {string} word The word to commit/change.
 188  * @param {number} frequency The change in frequency.
 189  */
 190 DataSource.prototype.changeWordFrequency = goog.functions.NULL;
 191
 192
 193 /**
 194  * Clears the data source.
 195  */
 196 DataSource.prototype.clear = goog.functions.NULL;
 197
 198
 199
 200 /**
 201  * The candidates is fetched back.
 202  *
 203  * @param {string} source The source.
 204  * @param {!Array.<!Object>} candidates The candidates.
 205  * @constructor
 206  * @extends {Event}
 207  */
 208 DataSource.CandidatesBackEvent = function(source, candidates) {
 209   DataSource.CandidatesBackEvent.base(
 210       this, 'constructor', DataSource.EventType.CANDIDATES_BACK);
 211
 212   /**
 213    * The source.
 214    *
 215    * @type {string}
 216    */
 217   this.source = source;
 218
 219   /**
 220    * The candidate list.
 221    *
 222    * @type {!Array.<!Object>}
 223    */
 224   this.candidates = candidates;
 225 };
 226 goog.inherits(DataSource.CandidatesBackEvent, Event);
 227
 228 });  // goog.scope