Class PTFormUtil

Object
   |
   +--PTFormUtil

class PTFormUtil

Static class containing form utility methods.

Usage:	
 	PTFormUtil.fillSelect(select, {'One': 1, 'Two': 2});
 

Field Detail

VERSION

<static> <final> Object VERSION

See Also:

Constant Field Values

PTFormUtil

PTFormUtil()

PTFormUtil static object constructor

Returns:
New PTFormUtil object. Author Legacy Code

addItemToSelect

<static> Number addItemToSelect(sel,val,txt,idx)

Insert new option into select at a given index. Note: a bug in MSIE 5.0 causes this method to fail with errors if the select object is not within the same document as the script.

Parameters:
sel - Select object to fill options (HTML Select)
val - Value of new option (string)
txt - Text label for new option (string)
idx - Index at which to create new option (integer)

Returns:
the index the item was added to

clearSelect

<static> void clearSelect(sel)

Remove all options from a select object. Note: a bug in MSIE 5.0 causes this method to fail with errors if the select object is not within the same document as the script.

Parameters:
sel - Select object to fill options (HTML Select)

disableAllSelects

<static> void disableAllSelects(elem)

Disable all select object within a given document.

Parameters:
elem - Element containing selects to disable (DOM Element)

enableAllSelects

<static> void enableAllSelects(elem,useSelectStateCache)

Enable all select object within a given document.

Parameters:
elem - Element containing selects to disable (DOM Element)
useSelectStateCache - Whether or not to check against selectStateCache before making select enabled (boolean)

fillSelect

<static> void fillSelect(sel,optionsInfo)

Fill the options in a select menu from an array of text/value data. Often a good idea to call clearSelect before using this method. Note: a bug in MSIE 5.0 causes this method to fail with errors if the select object is not within the same document as the script.

Parameters:
sel - Select object to fill options (HTML Select)
optionsInfo - Array of text/value pairs (Array)

focusAndSelectText

<static> void focusAndSelectText(input)

Move keyboard focus to a given text element and select the text within it.

Parameters:
input - Text input to focus (HTML text Input)

focusFormFieldByName

<static> void focusFormFieldByName(fieldName)

Focus a given form field by name.

Parameters:
fieldName - Name of form field (string)

getRadioValue

<static> String getRadioValue(rads)

Get the value of the currently checked radio within a radio group.

Parameters:
rads - Array of radio group elements (Array)

Returns:
the selected radio value

hideAllSelects

<static> Array hideAllSelects(elem)

Hide all select object within a given document.

Parameters:
elem - Element containing selects to hide (DOM Element)

Returns:
Array of select elements that were actually hidden (i.e. not already hidden before the method was called)

hideSelects

<static> void hideSelects(selects)

Hides all select elements that are passed in as an array.

Parameters:
Returns - the element that the mouse exited
e - the event objectArray of select elements (DOM Elements)

selectMoveItemDown

<static> void selectMoveItemDown(sel)

Re-order select options by moving currently-selected option down. Note: a bug in MSIE 5.0 causes this method to fail with errors if the select object is not within the same document as the script.

Parameters:
sel - Select object to fill options (HTML Select)

selectMoveItemUp

<static> void selectMoveItemUp(sel)

Re-order select options by moving currently-selected option up. Note: a bug in MSIE 5.0 causes this method to fail with errors if the select object is not within the same document as the script.

Parameters:
sel - Select object to fill options (HTML Select)

setRadioValue

<static> Boolean setRadioValue(rads,val)

Set the checked state by value of the radio object within a radio group.

Parameters:
rads - Array of radio group elements (Array)
val - Value of the radio to be set (string)

Returns:
boolean if the radio was found and set.

setSelectValue

<static> Boolean setSelectValue(sel,val)

Set the selected state by value of an option within a select object. Note: a bug in MSIE 5.0 causes this method to fail with errors if the select object is not within the same document as the script.

Parameters:
sel - Select object to set (HTML Select)
val - Value of the option to be selected (string)

Returns:
true if successful

setSelectVisibility

<static> Boolean setSelectVisibility(select,vis)

Set the visibility of a given select object.

Parameters:
select - Select object to show or hide (HTML Select)
vis - Visibility value for select object, 'visible' or 'hidden' (string)

Returns:
false if the select is not defined

showAllSelects

<static> Array showAllSelects(elem)

Show all select object within a given document.

Parameters:
elem - Element containing selects to show (DOM Element)

Returns:
Array of select elements that were actually made visible (i.e. all select elements that were hidden before the method was called).

showSelects

<static> void showSelects(selects)

Shows all select elements that are passed in as an array.

Parameters:
selects - Array of select elements (DOM Elements)