How to add keyboard functionality for Lotus Notes documents

How to add keyboard functionality for Lotus Notes documents

This JavaScript code will let users navigate Lotus Notes view documents using their keyboard "Up" and "Down" arrow keys. It will also allow them to open Lotus Notes documents with the "Enter" key.

To implement this functionality, just follow these simple steps:

Related resources from SearchDomino.com:
JavaScript Learning Guide

FAQ: Lotus Notes, Domino and JavaScript

JavaScript Reference Center

    Requires Free Membership to View

    Register today to access targeted resources from our editorial writers and independent industry experts focused on Lotus Domino, Notes, Workplace and other related technologies.

    By submitting your registration information to SearchDomino.com you agree to receive email communications from TechTarget and TechTarget partners. We encourage you to read our Privacy Policy which contains important disclosures about how we collect and use your registration and other information. If you reside outside of the United States, by submitting this registration information you consent to having your personal data transferred to and processed in the United States. Your use of SearchDomino.com is governed by our Terms of Use. You may contact us at webmaster@TechTarget.com.

  1. Create a $$ViewTemplateDefault or $$ViewTemplatefor<VIEWNAME> form.
  2. Create a <div> tag with the ID "ViewBody" and mark the <div> tag as "pass-through HTML."
  3. Embed the Lotus Notes view and select "Domino Web Access" -> "Display" -> "Using View's display property."
  4. Close the <div> tag.
  5. Create a <style> tag for setting height and scrollbar controls for the <div> tag.
  6. Add this JavaScript code in the "OnLoad()" event.
  7. view_onloadfunction();
    
  8. Add this JavaScript code in the JSHeader event of the form.
var rowid=1;
var totalrows = 0;
var keypress_scroll_limit = 20; 
// Adjust this value based on the height 
of the view var viewdivid = "ViewBody"; 
var rowhighlightimage = "/icons/expand.gif";

//function to set the keypress event and 
select the first row, this function called from 
'onload()' event function view_onloadfunction() 
{ selectRow(rowid); var viewdivobj = 
document.getElementsByName(viewdivid).item(0);
viewdivobj.onkeydown = view_keypressHandler;

// to set the table border and get the totalrows 
count var tableElements = viewdivobj.
getElementsByTagName('table');
var table = tableElements[
tableElements.length - 1] ; table.border=1;
 rows = table.getElementsByTagName("tr") ; 
totalrows = rows.length; }

// VIEW KEY PRESS HANDLER
function view_keypressHandler (evt)
{
  // make sure we have a valid event variable
  if(!evt && window.event) {
    evt = window.event;
  }
  var key = evt.keyCode;
 
  var KEYUP = 38;
  var KEYDOWN = 40;

    if (key == KEYUP) {
       if(rowid != 1) 
rowid = rowid -1;   
selectRow(rowid);   
// control the scrollbar movement while KEYUP 
if(rowid >= totalrows - keypress_scroll_limit)
return false;
 }
    if (key == KEYDOWN) {
    if(rowid>=totalrows-1) {
   rowid = rowid; }
else {
rowid = rowid + 1; } 
selectRow(rowid);
 // control the scrollbar movement while KEYDOWN
  if(rowid<=keypress_scroll_limit)   
 return false;  
 }
  return true;
}

//function to select a row
function selectRow(rownum)
{
var viewdivobj = document.
getElementsByName(viewdivid).item(0);
var tableElements = viewdivobj.
getElementsByTagName('table');
var table = tableElements[
tableElements.length - 1] ;
rows = table.getElementsByTagName("tr") ;
for( i = 1; i < rows.length; i++) {
if( i == rownum) { 
Atag = rows[i].
getElementsByTagName("A");
if(Atag.length > 0) { 
Ahref = Atag[0].href;
Atag[0].focus();
// By default domino create a 
blank image  in the first column, 
// we change the image src to our custom 
arrow image
AImage = rows[i].cells[0].
getElementsByTagName("IMG");
AImage[0].height = 10;
AImage[0].src = rowhighlightimage; 
// You can also use custom arrow image
 }
}
else {
AImage = rows[i].cells[0].
getElementsByTagName("IMG");
AImage[0].height = 0
AImage[0].src = "";
  }
 }
}

Do you have comments on this tip? Let us know.

This tip was submitted to the SearchDomino.com tip library by member Manikandan C. Please let others know how useful it is via the rating scale below. Do you have a useful Lotus Notes, Domino, Workplace or WebSphere tip or code snippet to share? Submit it to our monthly tip contest and you could win a prize.

This was first published in September 2007

Disclaimer: Our Tips Exchange is a forum for you to share technical advice and expertise with your peers and to learn from other enterprise IT professionals. TechTarget provides the infrastructure to facilitate this sharing of information. However, we cannot guarantee the accuracy or validity of the material submitted. You agree that your use of the Ask The Expert services and your reliance on any questions, answers, information or other materials received through this Web site is at your own risk.