Preamble

Possibly one of the most obvious applications of KeyTable is using it to navigate around a table, allowing a user to edit data as they go. This is an example of how that might be done through integration with the excellent jEditable plug-in for jQuery.

To edit data in the table, simply navigate to where you want to edit using the arrow keys, hit return and they make your edit. Hit return again to complete and submit the edit (note this example doesn't actually send the data to the server!) and then continue navigating.

Live example

Initialisation code

$(document).ready( function () {
	var keys = new KeyTable( {
		"table": document.getElementById('example')
	} );
	
	/* Apply a return key event to each cell in the table */
	keys.event.action( null, null, function (nCell) {
		/* Block KeyTable from performing any events while jEditable is in edit mode */
		keys.block = true;
		
		/* Initialise the Editable instance for this table */
		$(nCell).editable( function (sVal) {
			/* Submit function (local only) - unblock KeyTable */
			keys.block = false;
			return sVal;
		}, { 
			"onblur": 'submit', 
			"onreset": function(){ 
				/* Unblock KeyTable, but only after this 'esc' key event has finished. Otherwise
				 * it will 'esc' KeyTable as well
				 */
				setTimeout( function () {keys.block = false;}, 0); 
			}
		} );
		
		/* Dispatch click event to go into edit mode - Saf 4 needs a timeout... */
		setTimeout( function () { $(nCell).click(); }, 0 );
	} );
} );

Other examples

• Basic usage
• Editing a table
• Integration with an HTML form
• Integration with DataTables
• Using KeyTable with scrolling in DataTables