erabo/spiegel-keyman
1
0
Fork 0
mirror of https://github.com/keymanapp/keyman.git synced 2026-08-27 10:47:41 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 13

setActiveKeyboard is now Promise-compatible!

Browse source
This commit is contained in:
Joshua A. Horton 2018-12-17 09:09:53 +07:00
parent 723c24130f
commit 9561537101
4 changed files with 59 additions and 35 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
web/bulk_rendering/index.html
View file

@ -16,7 +16,7 @@
<!-- Your page CSS -->
<style type='text/css'>
body {font-family: Tahoma,helvetica;}
body {font-family: Tahoma,helvetica; margin-left: 0px}
h3 {font-size: 1em;font-weight:normal;color: darkred; margin-bottom: 4px}
.test {font-size: 1.5em; width:80%; min-height:30px; border: 1px solid gray;}
#KeymanWebControl {width:50%;min-width:600px;}

34
web/bulk_rendering/renderer_core.ts
View file

@ -32,11 +32,14 @@ namespace com.keyman.renderer {
private render(resolve, ele: HTMLElement, layerIndex: number, isMobile?: boolean) {
let html2canvas = window['html2canvas'];
let imgOut = document.createElement('img');
let imgOut = document.createElement('img');
let br = document.createElement('br');
document.body.appendChild(imgOut);
document.body.appendChild(br);
// Warning - needs Promises, so it'll need a polyfill for IE.
let canvasParams = {
'logging': false,
'scale': 1,
'width': window.innerWidth // Good for mobile, less-so for desktop.
}
@ -54,11 +57,14 @@ namespace com.keyman.renderer {
private processKeyboard(kbd) {
let keyman = window['keyman'];
keyman.setActiveKeyboard(kbd['InternalName']);
let p: Promise<void> = keyman.setActiveKeyboard('blah'/*kbd['InternalName']*/);
let isMobile = keyman.util.device.formFactor != 'desktop';
// A nice, closure-friendly reference for use in our callbacks.
let renderer = this;
// Really could use promises to tie these two together...
setTimeout(function() {
return p.then(function() {
let box: HTMLDivElement = keyman.osk._Box;
keyman.osk.show(true);
@ -75,14 +81,17 @@ namespace com.keyman.renderer {
layers[i].style.display = 'block';
this.render(resolve, box, i, isMobile);
}.bind(this))
}.bind(this);
renderer.render(resolve, box, i, isMobile);
})
};
return this.arrayPromiseIteration(renderLayer, layers.length).then(function() {
return renderer.arrayPromiseIteration(renderLayer, layers.length).then(function() {
console.log("All renders for the first keyboard should now be complete.");
});
}.bind(this), 2500);
}).catch(function() {
console.log("Failed to load the \"" + kbd['InternalName'] + "\" keyboard for rendering!");
return Promise.resolve();
});
}
// Synchronously performs asynchronous operations across a loop, one at a time.
@ -97,11 +106,6 @@ namespace com.keyman.renderer {
} else {
return Promise.resolve();
}
// return promise.then(function(index: number) {
// if(++index < length) {
// return iteration(index);
// } // else instantly return.
// });
}
return iteration(0);
@ -117,7 +121,9 @@ namespace com.keyman.renderer {
console.log("Unique keyboard ids detected: " + Object.keys(kbds).length);
// Temporary - just load the first keyboard.
this.processKeyboard(kbds[Object.keys(kbds)[0]]);
this.processKeyboard(kbds[Object.keys(kbds)[0]]).then(function () {
console.log("First keyboard processed!");
});
} else {
console.error("KeymanWeb not detected!");
}

6
web/source/kmwbase.ts
View file

@ -1,5 +1,7 @@
// Includes KMW-added property declaration extensions for HTML elements.
/// <reference path="kmwexthtml.ts" />
// Includes a promise polyfill (needed for IE)
/// <reference path="../node_modules/promise-polyfill/lib/polyfill.js" />
// Defines the web-page interface object.
/// <reference path="kmwdom.ts" />
// Includes KMW-added property declaration extensions for HTML elements.
@ -283,8 +285,8 @@ namespace com.keyman {
* @param {string} PInternalName Internal name
* @param {string} PLgCode Language code
*/
['setActiveKeyboard'](PInternalName: string, PLgCode: string) {
this.keyboardManager.setActiveKeyboard(PInternalName,PLgCode);
['setActiveKeyboard'](PInternalName: string, PLgCode: string): Promise<void> {
return this.keyboardManager.setActiveKeyboard(PInternalName,PLgCode);
}
/**

52
web/source/kmwkeyboards.ts
View file

@ -60,7 +60,7 @@ namespace com.keyman {
'KOskFont': KeyboardFont;
// Used when loading a stub's keyboard.
asyncLoader: any;
asyncLoader?: any;
constructor(id: string, langCode: string) {
this['KI'] = 'Keyboard_' + id;
@ -357,7 +357,7 @@ namespace com.keyman {
* @param {string} PInternalName Internal name
* @param {string} PLgCode Language code
*/
setActiveKeyboard(PInternalName: string, PLgCode: string) {
setActiveKeyboard(PInternalName: string, PLgCode: string): Promise<void> {
//TODO: This does not make sense: the callbacks should be in _SetActiveKeyboard, not here,
// since this is always called FROM the UI, which should not need notification.
// If UI callbacks are needed at all, they should be within _SetActiveKeyboard
@ -368,7 +368,7 @@ namespace com.keyman {
}
this.doBeforeKeyboardChange(PInternalName,PLgCode);
this._SetActiveKeyboard(PInternalName,PLgCode,true);
let p = this._SetActiveKeyboard(PInternalName,PLgCode,true);
if(this.keymanweb.domManager.getLastActiveElement() != null) {
this.keymanweb.domManager.focusLastActiveElement(); // TODO: Resolve without need for the cast.
}
@ -378,6 +378,8 @@ namespace com.keyman {
// PLgCode = (<KeymanBase>keymanweb).keyboardManager.activeStub['KLC'];
// }
this.doKeyboardChange(PInternalName, PLgCode);
return p;
}
/**
@ -395,7 +397,7 @@ namespace com.keyman {
* @param {string=} PLgCode
* @param {boolean=} saveCookie
*/
_SetActiveKeyboard(PInternalName: string, PLgCode?: string, saveCookie?: boolean) {
_SetActiveKeyboard(PInternalName: string, PLgCode?: string, saveCookie?: boolean): Promise<void> {
var n, Ln;
var util = this.keymanweb.util;
@ -430,7 +432,7 @@ namespace com.keyman {
if(this.activeStub && this.activeKeyboard && this.activeKeyboard['KI'] == PInternalName
&& this.activeStub['KI'] == PInternalName //this part of test should not be necessary, but keep anyway
&& this.activeStub['KLC'] == PLgCode && !this.keymanweb.mustReloadKeyboard
) return;
) return Promise.resolve();
// Check if current keyboard matches requested keyboard, but not stub
if(this.activeKeyboard && (this.activeKeyboard['KI'] == PInternalName)) {
@ -448,7 +450,7 @@ namespace com.keyman {
if(this.keymanweb.mustReloadKeyboard) {
osk._Load();
}
return;
return Promise.resolve();
}
}
}
@ -464,7 +466,7 @@ namespace com.keyman {
util.wait(false);
}
return;
return Promise.resolve();
}
// Determine if the keyboard was previously loaded but is not active and use the prior load if so.
@ -552,12 +554,14 @@ namespace com.keyman {
// It works much more reliably if deferred (KMEW-101, build 356)
// The effect of a delay can also be tested, for example, by setting the timeout to 5000
var manager = this;
window.setTimeout(function(){
manager.installKeyboard(loadingStub);
},0);
}
loadingStub.asyncLoader.promise = new Promise(function(resolve, reject) {
window.setTimeout(function(){
manager.installKeyboard(resolve, reject, loadingStub);
},0);
});
}
this.activeStub=this.keyboardStubs[Ln];
return;
return this.keyboardStubs[Ln].asyncLoader.promise;
}
}
this.keymanweb.domManager._SetTargDir(this.keymanweb.domManager.getLastActiveElement()); // I2077 - LTR/RTL timing
@ -569,15 +573,17 @@ namespace com.keyman {
// Initialize the OSK (provided that the base code has been loaded)
osk._Load();
return Promise.resolve();
}
/**
/**
* Install a keyboard script that has been downloaded from a keyboard server
* Operates as the core of a Promise, hence the 'resolve' and 'reject' parameters.
*
* @param {Object} kbdStub keyboard stub to be loaded.
*
**/
installKeyboard(kbdStub: KeyboardStub) {
installKeyboard(resolve: () => void, reject: () => void, kbdStub: KeyboardStub) {
var util = this.keymanweb.util;
var osk = this.keymanweb.osk;
@ -607,6 +613,8 @@ namespace com.keyman {
// We already know the load has failed... why wait?
kbdStub.asyncLoader.callback('Cannot find the ' + kbdName + ' keyboard for ' + kbdLang + '.', 'warn');
kbdStub.asyncLoader = null;
reject();
}, false);
@ -644,23 +652,31 @@ namespace com.keyman {
if(!manager.keymanweb.isEmbedded) {
util.wait(false);
}
kbdStub.asyncLoader = null;
resolve();
// A handler portion for cases where the new <script> block loads, but fails to process.
} else { // Output error messages even when embedded - they're useful when debugging the apps and KMEA/KMEI engines.
kbdStub.asyncLoader.callback('Error registering the ' + kbdName + ' keyboard for ' + kbdLang + '.', 'error');
kbdStub.asyncLoader = null;
reject();
}
kbdStub.asyncLoader = null;
}, false);
// IE likes to instantly start loading the file when assigned to an element, so we do this after the rest
// of our setup. This method is not relocated here (yet) b/c it varies based upon 'native' vs 'embedded'.
Lscript.src = this.keymanweb.getKeyboardPath(kbdFile);
try {
try {
document.body.appendChild(Lscript);
this.linkedScripts.push(Lscript);
}
catch(ex) {
document.getElementsByTagName('head')[0].appendChild(Lscript);
catch(ex) {
try {
document.getElementsByTagName('head')[0].appendChild(Lscript);
} catch(ex2) {
reject();
}
}
}