Use screenX/screenY for touch.
[guacamole.git] / src / main / webapp / scripts / interface.js
index 8ea48a3..be79b38 100644 (file)
@@ -2,12 +2,34 @@
 // UI Definition
 var GuacamoleUI = {
 
+    /* Detection Constants */
+    
+    "LONG_PRESS_DETECT_TIMEOUT"     : 800, /* milliseconds */
+    "LONG_PRESS_MOVEMENT_THRESHOLD" : 10,  /* pixels */
+    "MENU_CLOSE_DETECT_TIMEOUT"     : 500, /* milliseconds */
+    "MENU_OPEN_DETECT_TIMEOUT"      : 325, /* milliseconds */
+    "KEYBOARD_AUTO_RESIZE_INTERVAL" : 30,  /* milliseconds */
+
+    /* Animation Constants */
+
+    "MENU_SHADE_STEPS"    : 10, /* frames */
+    "MENU_SHADE_INTERVAL" : 30, /* milliseconds */
+    "MENU_SHOW_STEPS"     : 5,  /* frames */
+    "MENU_SHOW_INTERVAL"  : 30, /* milliseconds */
+
+    /* OSK Mode Constants */
+    "OSK_MODE_NATIVE" : 1, /* "Show Keyboard" will show the platform's native OSK */
+    "OSK_MODE_GUAC"   : 2, /* "Show Keyboard" will show Guac's built-in OSK */
+
+    /* UI Elements */
+
     "viewport"    : document.getElementById("viewportClone"),
     "display"     : document.getElementById("display"),
     "menu"        : document.getElementById("menu"),
     "menuControl" : document.getElementById("menuControl"),
     "touchMenu"   : document.getElementById("touchMenu"),
     "logo"        : document.getElementById("status-logo"),
+    "eventTarget" : document.getElementById("eventTarget"),
 
     "buttons": {
 
@@ -95,24 +117,27 @@ var GuacamoleUI = {
     GuacamoleUI.hideStatus = function() {
         removeClass(document.body, "guac-error");
         GuacamoleUI.containers.state.style.visibility = "hidden";
+        GuacamoleUI.display.style.opacity = "1";
     };
     
     GuacamoleUI.showStatus = function(text) {
         removeClass(document.body, "guac-error");
         GuacamoleUI.containers.state.style.visibility = "visible";
         GuacamoleUI.state.textContent = text;
+        GuacamoleUI.display.style.opacity = "1";
     };
     
     GuacamoleUI.showError = function(error) {
         addClass(document.body, "guac-error");
         GuacamoleUI.state.textContent = error;
+        GuacamoleUI.display.style.opacity = "0.1";
     };
 
     GuacamoleUI.shadeMenu = function() {
 
         if (!menu_shaded) {
 
-            var step = Math.floor(GuacamoleUI.menu.offsetHeight / 10) + 1;
+            var step = Math.floor(GuacamoleUI.menu.offsetHeight / GuacamoleUI.MENU_SHADE_STEPS) + 1;
             var offset = 0;
             menu_shaded = true;
 
@@ -127,7 +152,7 @@ var GuacamoleUI = {
                     GuacamoleUI.menu.style.visiblity = "hidden";
                 }
 
-            }, 30);
+            }, GuacamoleUI.MENU_SHADE_INTERVAL);
         }
 
     };
@@ -136,7 +161,7 @@ var GuacamoleUI = {
 
         if (menu_shaded) {
 
-            var step = Math.floor(GuacamoleUI.menu.offsetHeight / 5) + 1;
+            var step = Math.floor(GuacamoleUI.menu.offsetHeight / GuacamoleUI.MENU_SHOW_STEPS) + 1;
             var offset = -GuacamoleUI.menu.offsetHeight;
             menu_shaded = false;
             GuacamoleUI.menu.style.visiblity = "";
@@ -153,7 +178,7 @@ var GuacamoleUI = {
 
                 GuacamoleUI.menu.style.top = offset + "px";
 
-            }, 30);
+            }, GuacamoleUI.MENU_SHOW_INTERVAL);
         }
 
     };
@@ -174,28 +199,52 @@ var GuacamoleUI = {
 
     };
 
+    // Assume no native OSK by default
+    GuacamoleUI.oskMode = GuacamoleUI.OSK_MODE_GUAC;
+
     // Show/Hide keyboard
     var keyboardResizeInterval = null;
     GuacamoleUI.buttons.showKeyboard.onclick = function() {
 
+        // If Guac OSK shown, hide it.
         var displayed = GuacamoleUI.containers.keyboard.style.display;
-        if (displayed != "block") {
+        if (displayed == "block") {
+            GuacamoleUI.containers.keyboard.style.display = "none";
+            GuacamoleUI.buttons.showKeyboard.textContent = "Show Keyboard";
+
+            window.onresize = null;
+            window.clearInterval(keyboardResizeInterval);
+        }
+        
+        // If not shown ... action depends on OSK mode.
+        else {
+
+            // If we think the platform has a native OSK, use the event target to
+            // cause it to display.
+            if (GuacamoleUI.oskMode == GuacamoleUI.OSK_MODE_NATIVE) {
+
+                // ...but use the Guac OSK if clicked again
+                GuacamoleUI.oskMode = GuacamoleUI.OSK_MODE_GUAC;
+
+                // Try to show native OSK by focusing eventTarget.
+                GuacamoleUI.eventTarget.focus();
+                return;
+
+            }
+
+            // Ensure event target is NOT focused if we are using the Guac OSK.
+            GuacamoleUI.eventTarget.blur();
+
             GuacamoleUI.containers.keyboard.style.display = "block";
             GuacamoleUI.buttons.showKeyboard.textContent = "Hide Keyboard";
 
             // Automatically update size
             window.onresize = updateKeyboardSize;
-            keyboardResizeInterval = window.setInterval(updateKeyboardSize, 30);
+            keyboardResizeInterval = window.setInterval(updateKeyboardSize, GuacamoleUI.KEYBOARD_AUTO_RESIZE_INTERVAL);
 
             updateKeyboardSize();
         }
-        else {
-            GuacamoleUI.containers.keyboard.style.display = "none";
-            GuacamoleUI.buttons.showKeyboard.textContent = "Show Keyboard";
-
-            window.onresize = null;
-            window.clearInterval(keyboardResizeInterval);
-        }
+        
 
     };
 
@@ -234,16 +283,20 @@ var GuacamoleUI = {
 
             // Wait and then show menu
             detectMenuOpenTimeout = window.setTimeout(function() {
+
+                // If menu opened via mouse, do not show native OSK
+                GuacamoleUI.oskMode = GuacamoleUI.OSK_MODE_GUAC;
+
                 GuacamoleUI.showMenu();
                 detectMenuOpenTimeout = null;
-            }, 325);
+            }, GuacamoleUI.MENU_OPEN_DETECT_TIMEOUT);
 
         }
 
     };
 
     // Initiate detection of menu close action. If not canceled through some
-    // user event, menu will close.
+    // user mouse event, menu will close.
     GuacamoleUI.startMenuCloseDetect = function() {
 
         if (!detectMenuCloseTimeout) {
@@ -255,7 +308,7 @@ var GuacamoleUI = {
             detectMenuCloseTimeout = window.setTimeout(function() {
                 GuacamoleUI.shadeMenu();
                 detectMenuCloseTimeout = null;
-            }, 500);
+            }, GuacamoleUI.MENU_CLOSE_DETECT_TIMEOUT);
 
         }
 
@@ -270,6 +323,8 @@ var GuacamoleUI = {
     // When mouse hovers over top of screen, start detection of intent to open menu
     GuacamoleUI.menuControl.addEventListener('mousemove', GuacamoleUI.startMenuOpenDetect, true);
 
+    var long_press_start_x = 0;
+    var long_press_start_y = 0;
     var menuShowLongPressTimeout = null;
 
     GuacamoleUI.startLongPressDetect = function() {
@@ -279,9 +334,12 @@ var GuacamoleUI = {
             menuShowLongPressTimeout = window.setTimeout(function() {
                 
                 menuShowLongPressTimeout = null;
+
+                // Assume native OSK if menu shown via long-press
+                GuacamoleUI.oskMode = GuacamoleUI.OSK_MODE_NATIVE;
                 GuacamoleUI.showMenu();
 
-            }, 800);
+            }, GuacamoleUI.LONG_PRESS_DETECT_TIMEOUT);
 
         }
     };
@@ -291,8 +349,52 @@ var GuacamoleUI = {
         menuShowLongPressTimeout = null;
     };
 
+    // Reset event target (add content, reposition cursor in middle.
+    GuacamoleUI.resetEventTarget = function() {
+        GuacamoleUI.eventTarget.value = "GUAC";
+        GuacamoleUI.eventTarget.selectionStart =
+        GuacamoleUI.eventTarget.selectionEnd   = 2;
+    };
+
     // Detect long-press at bottom of screen
-    document.body.addEventListener('touchstart', GuacamoleUI.startLongPressDetect, true);
+    GuacamoleUI.display.addEventListener('touchstart', function(e) {
+        
+        // Close menu if shown
+        GuacamoleUI.shadeMenu();
+        
+        // Record touch location
+        if (e.touches.length == 1) {
+            var touch = e.touches[0];
+            long_press_start_x = touch.screenX;
+            long_press_start_y = touch.screenY;
+        }
+        
+        // Start detection
+        GuacamoleUI.startLongPressDetect();
+        
+    }, true);
+
+    // Stop detection if touch moves significantly
+    GuacamoleUI.display.addEventListener('touchmove', function(e) {
+        
+        if (e.touches.length == 1) {
+
+            // If touch distance from start exceeds threshold, cancel long press
+            var touch = e.touches[0];
+            if (Math.abs(touch.screenX - long_press_start_x) >= GuacamoleUI.LONG_PRESS_MOVEMENT_THRESHOLD
+                || Math.abs(touch.screenY - long_press_start_y) >= GuacamoleUI.LONG_PRESS_MOVEMENT_THRESHOLD)
+                GuacamoleUI.stopLongPressDetect();
+
+        }
+        
+    }, true);
+
+    // Stop detection if press stops
+    GuacamoleUI.display.addEventListener('touchend', GuacamoleUI.stopLongPressDetect, true);
+
+    // Close menu on mouse movement
+    GuacamoleUI.display.addEventListener('mousemove', GuacamoleUI.startMenuCloseDetect, true);
+    GuacamoleUI.display.addEventListener('mousedown', GuacamoleUI.startMenuCloseDetect, true);
 
     // Reconnect button
     GuacamoleUI.buttons.reconnect.onclick = function() {
@@ -318,8 +420,31 @@ var GuacamoleUI = {
 // Tie UI events / behavior to a specific Guacamole client
 GuacamoleUI.attach = function(guac) {
 
+    var title_prefix = null;
+    var connection_name = null 
+    
     var guac_display = guac.getDisplay();
 
+    // Set document title appropriately, based on prefix and connection name
+    function updateTitle() {
+
+        // Use title prefix if present
+        if (title_prefix) {
+            
+            document.title = title_prefix;
+
+            // Include connection name, if present
+            if (connection_name)
+                document.title += " " + connection_name;
+
+        }
+
+        // Otherwise, just set to connection name
+        else if (connection_name)
+            document.title = connection_name;
+
+    }
+
     // When mouse enters display, start detection of intent to close menu
     guac_display.addEventListener('mouseover', GuacamoleUI.startMenuCloseDetect, true);
 
@@ -362,12 +487,6 @@ GuacamoleUI.attach = function(guac) {
             // Scroll (if necessary) to keep mouse on screen.
             window.scrollBy(scroll_amount_x, scroll_amount_y);
        
-            // Hide menu on movement
-            GuacamoleUI.startMenuCloseDetect();
-
-            // Stop detecting long presses if mouse is being used
-            GuacamoleUI.stopLongPressDetect();
-
             // Send mouse event
             guac.sendMouseState(mouseState);
             
@@ -384,6 +503,12 @@ GuacamoleUI.attach = function(guac) {
     function enableKeyboard() {
         keyboard.onkeydown = 
             function (keysym) {
+          
+                // If we're using native OSK, ensure event target is reset
+                // on each key event.
+                if (GuacamoleUI.oskMode == GuacamoleUI.OSK_MODE_NATIVE)
+                    GuacamoleUI.resetEventTarget();
+                
                 guac.sendKeyEvent(1, keysym);
             };
 
@@ -398,22 +523,26 @@ GuacamoleUI.attach = function(guac) {
 
     // Handle client state change
     guac.onstatechange = function(clientState) {
+
         switch (clientState) {
 
             // Idle
             case 0:
                 GuacamoleUI.showStatus("Idle.");
+                title_prefix = "[Idle]";
                 break;
 
             // Connecting
             case 1:
                 GuacamoleUI.shadeMenu();
                 GuacamoleUI.showStatus("Connecting...");
+                title_prefix = "[Connecting...]";
                 break;
 
             // Connected + waiting
             case 2:
                 GuacamoleUI.showStatus("Connected, waiting for first update...");
+                title_prefix = "[Waiting...]";
                 break;
 
             // Connected
@@ -424,16 +553,20 @@ GuacamoleUI.attach = function(guac) {
                     GuacamoleUI.display.className.replace(/guac-loading/, '');
 
                 GuacamoleUI.menu.className = "connected";
+
+                title_prefix = null;
                 break;
 
             // Disconnecting
             case 4:
                 GuacamoleUI.showStatus("Disconnecting...");
+                title_prefix = "[Disconnecting...]";
                 break;
 
             // Disconnected
             case 5:
                 GuacamoleUI.showStatus("Disconnected.");
+                title_prefix = "[Disconnected]";
                 break;
 
             // Unknown status code
@@ -441,11 +574,14 @@ GuacamoleUI.attach = function(guac) {
                 GuacamoleUI.showStatus("[UNKNOWN STATUS]");
 
         }
+
+        updateTitle();
     };
 
     // Name instruction handler
     guac.onname = function(name) {
-        document.title = name;
+        connection_name = name;
+        updateTitle();
     };
 
     // Error handler