//======
//======
//
// Template- FORM_JS.IHT by J.Young 24-MAY-05 /  4-APR-07
//
// Purpose-
//
//	Define form control javascript functions.
//
// Modifications-
//
//	24-JUN-05	JY / SH / JY 	4=15710
//	- Created.
//
//	15-AUG-06	TH / BH / VM 	12=18564
//	- Add generic form onKeypress handler.
//	- Add function to allow suppression of form
//        submssion when ENTER is pressed and the form focus
//	  is not a submit button.
//
//	 4-DEC-06	TH / SZ / HD 	17=18749
//	- In dy_dont_submit_on_enter, allow ENTER in a textarea,
//	  as ENTER is used to drop to the next line.
//
//	 4-APR-07	TH / BH / TH 	17=18617
//	- Allow a pattern for checkbox names to be specified to
//        CheckAll and UncheckAll.
//
//	04-Jul-07	BG / BG / BG	12=18420
//	- Converted to from .iht to .js.
//
//======
//======

/*
   CheckAll (formObj,optionalPattern)
	Purpose-
	   Check all checkboxes of formObj.

   UnCheckAll(formObj,optionalPattern)
      Purpose-
	   Uncheck all checkboxes of formObj.

   Notes-
      Format of 'pat' is any valid regular expression.
*/

   Dym.ToggleCheckbox = function (formObj,value,pat) {
      if (typeof formObj.elements != "undefined") {
         var elementList = formObj.elements;
         for (var i=0; i<elementList.length; i++){
            if (elementList[i].type=="checkbox") {
               if (typeof pat != 'undefined') {
                  var re = new RegExp(pat);
                  if (re.test(elementList[i].name)) {
                     elementList[i].checked=value;
                  }
               } else {
                  elementList[i].checked=value;
               }
            }
         }
      }
   }

   function CheckAll(formObj,pat){
      Dym.ToggleCheckbox(formObj,true,pat);
   }
   function UnCheckAll(formObj,pat){
      Dym.ToggleCheckbox(formObj,false,pat);
   }

/*
   Purpose:
      Generic onkeypress/onkeydown handler for forms.

   Notes:
      - This can be used to prevent form submission on an ENTER
        event when the current focus is not a submit button.

      - By default, nothing is done.  To override default handling,
        define another version of dy_form_onkeypress.

      - Support should be at least Staff Web minimum.  onkeypress/down
        has been supported since NN/IE 4.0.
        - Browsers newer than NN2/IE3 which are not supported
          should fail silently.
	- This does not work on Netscape, but has been tested
	  and is working on IE/Firefox/Opera/Safari.

      - Returning false in an onkeypress event triggered when
	typing into a textbox will prevent the character from
	being entered into the textbox on some browsers (eg. IE).

   Example:
      // - Turn off submitting a form with ENTER.
      // - After include for JAVASCRIPT.IHT
      function dy_form_onkeypress(ev) {
         return dy_dont_submit_on_enter(ev);
      }
*/

function dy_form_onkeypress(ev) {
   return true;
}

function dy_setup_form_onkeypress() {
   // Since we use the return value of dy_xrc_onkeypress we can't
   // attach these events using dy_attach_event.
   var allElem = document.getElementsByTagName('form');
   if (allElem) {
      for (var i=0; i<allElem.length; i++) {
	 // - Internet explorer only passes alphanumeric events using
	 //   onkeypress.
	 // - Opera, which also defines window.event, has a problem with
	 //   outputing the captured key, regardless of what the
	 //   event handler returns, when using onkeydown.
	 // - Safari can't short circuit the submit using the return
	 //   value of onkeydown, onkeypress must be used.
         if (window.event && !dy_is_opera() && !dy_is_safari()) {
            allElem[i].onkeydown = dy_form_onkeypress;
         } else {
            allElem[i].onkeypress = dy_form_onkeypress;
         }
      }
   }
}

dy_attach_onload_event(dy_setup_form_onkeypress);

// This will disable all submits attempted using the [enter] button.
function dy_dont_submit_on_enter(ev) {
   ev = dy_get_event(ev);
   if (ev) {
      var evKeyCode = dy_get_event_keycode(ev);

      if (evKeyCode == 13) { // enter

         var evTarget = dy_get_event_target(ev);
         if (evTarget) {
            var evName = evTarget.tagName.toLowerCase();

	    // Currently, we disable all submits using [enter].  If we
	    // ever wish to allow submits when the keyboard focus is
	    // actually on a submit button, see the below code:
            //if (evName == 'input' ) {
            //   var inputType = evTarget.getAttribute('type').toLowerCase();
            //   if (inputType == 'submit' || inputType == 'image')
            //      return true;
            //   else
	    //      return false;
            //}

            // Allow ENTER in textareas, as it is used to drop to
            // the next line.
            if (evName == "textarea") return true;
         }
	 return false;
      }
   }
   return true;
}