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>)} candidatesCallback .
  33  * @param {function(!Array.<string>)} gestureCallback .
  34  * @constructor
  35  * @extends {EventTarget}
  36  */
  37 i18n.input.chrome.DataSource = function(numOfCanddiate, candidatesCallback,
  38     gestureCallback) {
  39   goog.base(this);
  40
  41   /**
  42    * The number of candidates to fetch.
  43    *
  44    * @type {number}
  45    */
  46   this.numOfCandidate = numOfCanddiate;
  47
  48   /** @protected {function(string, !Array.<!Object>)} */
  49   this.candidatesCallback = candidatesCallback;
  50
  51   /** @protected {function(!Array.<string>)} */
  52   this.gestureCallback = gestureCallback;
  53 };
  54 var DataSource = i18n.input.chrome.DataSource;
  55 goog.inherits(DataSource, EventTarget);
  56
  57
  58 /**
  59  * The event type.
  60  *
  61  * @enum {string}
  62  */
  63 DataSource.EventType = {
  64   CANDIDATES_BACK: goog.events.getUniqueId('cb'),
  65   GESTURES_BACK: goog.events.getUniqueId('gb'),
  66   READY: goog.events.getUniqueId('r')
  67 };
  68
  69
  70 /** @type {boolean} */
  71 DataSource.prototype.ready = false;
  72
  73
  74 /**
  75  * The correction level.
  76  *
  77  * @protected {number}
  78  */
  79 DataSource.prototype.correctionLevel = 0;
  80
  81
  82 /**
  83  * Whether user dict is enabled.
  84  *
  85  * @protected {boolean}
  86  */
  87 DataSource.prototype.enableUserDict = false;
  88
  89
  90 /**
  91  * The language code.
  92  *
  93  * @type {string}
  94  * @protected
  95  */
  96 DataSource.prototype.language;
  97
  98
  99 /**
 100  * Sets the langauge code.
 101  *
 102  * @param {string} language The language code.
 103  */
 104 DataSource.prototype.setLanguage = function(language) {
 105   this.language = language;
 106 };
 107
 108
 109 /**
 110  * True if the datasource is ready.
 111  *
 112  * @return {boolean} .
 113  */
 114 DataSource.prototype.isReady = function() {
 115   return this.ready;
 116 };
 117
 118
 119 /**
 120  * Creates the common payload for completion or prediction request.
 121  *
 122  * @return {!Object} The payload.
 123  * @protected
 124  */
 125 DataSource.prototype.createCommonPayload = function() {
 126   return {
 127     'itc': this.getInputToolCode(),
 128     'num': this.numOfCandidate
 129   };
 130 };
 131
 132
 133 /**
 134  * Gets the input tool code.
 135  *
 136  * @return {string} .
 137  */
 138 DataSource.prototype.getInputToolCode = function() {
 139   return this.language + '-t-i0-und';
 140 };
 141
 142
 143 /**
 144  * Sends completion request for a word.
 145  *
 146  * @param {string} word The word.
 147  * @param {string} context The context.
 148  */
 149 DataSource.prototype.sendCompletionRequestForWord = goog.functions.NULL;
 150
 151
 152 /**
 153  * Sends completion request.
 154  *
 155  * @param {string} query The query .
 156  * @param {string} context The context .
 157  * @param {!Object=} opt_spatialData .
 158  */
 159 DataSource.prototype.sendCompletionRequest = goog.functions.NULL;
 160
 161
 162 /**
 163  * Enables/disables user dictionary.
 164  *
 165  * @param {boolean} enabled
 166  */
 167 DataSource.prototype.setEnableUserDict = function(enabled) {
 168   this.enableUserDict = enabled;
 169 };
 170
 171
 172 /**
 173  * Sends prediciton request.
 174  *
 175  * @param {string} context The context.
 176  */
 177 DataSource.prototype.sendPredictionRequest = goog.functions.NULL;
 178
 179
 180 /**
 181  * Sets the correction level.
 182  *
 183  * @param {number} level .
 184  */
 185 DataSource.prototype.setCorrectionLevel = function(level) {
 186   this.correctionLevel = level;
 187 };
 188
 189
 190 /**
 191  * Changes frequency of word in the data source.
 192  *
 193  * @param {string} word The word to commit/change.
 194  * @param {number} frequency The change in frequency.
 195  */
 196 DataSource.prototype.changeWordFrequency = goog.functions.NULL;
 197
 198
 199 /**
 200  * Clears the data source.
 201  */
 202 DataSource.prototype.clear = goog.functions.NULL;
 203
 204
 205
 206 /**
 207  * The candidates are fetched back.
 208  *
 209  * @param {string} source The source.
 210  * @param {!Array.<!Object>} candidates The candidates.
 211  * @constructor
 212  * @extends {Event}
 213  */
 214 DataSource.CandidatesBackEvent = function(source, candidates) {
 215   DataSource.CandidatesBackEvent.base(
 216       this, 'constructor', DataSource.EventType.CANDIDATES_BACK);
 217
 218   /**
 219    * The source.
 220    *
 221    * @type {string}
 222    */
 223   this.source = source;
 224
 225   /**
 226    * The candidate list.
 227    *
 228    * @type {!Array.<!Object>}
 229    */
 230   this.candidates = candidates;
 231 };
 232 goog.inherits(DataSource.CandidatesBackEvent, Event);
 233
 234
 235
 236 /**
 237  * The gesture results are fetched back.
 238  *
 239  * @param {!Array.<!string>} results The gesture results.
 240  * @constructor
 241  * @extends {Event}
 242  */
 243 DataSource.GesturesBackEvent = function(results) {
 244   DataSource.GesturesBackEvent.base(
 245       this, 'constructor', DataSource.EventType.GESTURES_BACK);
 246
 247   /**
 248    * The gesture results list.
 249    *
 250    * @type {!Array.<!string>}
 251    */
 252   this.results = results;
 253 };
 254 goog.inherits(DataSource.GesturesBackEvent, Event);
 255
 256 });  // goog.scope