Detailed Usage Instructions for Functions in
"clc_content_main.js"
List of Functions
Detailed Usage Instructions
string CLC_GetTextContent(DOM-Obj_Targ)
Input parameters:
- DOM-Obj_Targ - DOM-Object to retrieve text content
from. This should be an atomic DOM-Object.
Return parameter:
- String - The text content that should be generated from
DOM-Obj_Targ. If there is no appropriate text content, a
null string will be returned.
Error messages:
Additional notes:
- This function usually returns the textContent of the
DOM-Obj_Targ. The reason for using this rather than
directly accessing the textContent is some of the DOM
objects do not have textContent. One noticeable example is
the input element. Input elements have no textContent, yet
they are clearly important and some information should be
given for them. This function solves this problem by
returning their label (or, if that is not possible, their
ID) as their text content.
string CLC_Content_FindLabelText(DOM-Obj_Targ)
Input parameters:
- DOM-Obj_Targ - DOM-Object to retrieve the label text
for.
Return parameter:
- String - The label text that is associated with the
DOM-Obj_Targ. If there are no labels, a null string will be
returned.
Error messages:
Additional notes:
string
CLC_Content_FindRadioButtonDirectContent(DOM-Obj_RadioTypeInput)
Input parameters:
- DOM-Obj_RadioTypeInput - Radio button type Input element to
retrieve the content directly from.
Return parameter:
- String - The text content that should be generated from
DOM-Obj_RadioTypeInput itself.
Error messages:
Additional notes:
- This should only be used when there are no labels
available.
- Currently it only returns the ID of the element. It may
return more in the future.
string
CLC_Content_FindTextBlankDirectContent(DOM-Obj_TextTypeInput)
Input parameters:
- DOM-Obj_TextTypeInput - Text type Input element to
retrieve the content directly from.
Return parameter:
- String - The text content that should be generated from
DOM-Obj_TextTypeInput itself.
Error messages:
Additional notes:
- This should only be used when there are no labels
available.
- Currently it only returns the ID of the element. It may
return more in the future.
string
CLC_Content_FindCheckboxDirectContent(DOM-Obj_CheckboxTypeInput)
Input parameters:
- DOM-Obj_CheckboxTypeInput - Checkbox type Input element
to retrieve the content directly from.
Return parameter:
- String - The text content that should be generated from
DOM-Obj_CheckboxTypeInput itself.
Error messages:
Additional notes:
- This should only be used when there are no labels
available.
- Currently it only returns the ID of the element. It may
return more in the future.
string
CLC_Content_FindLanguage(DOM-Obj_target)
Input parameters:
- DOM-Obj_target - The DOM object that you are trying to find the language of.
Return parameter:
Error messages:
Additional notes: