Detailed Usage Instructions for Functions in "clc_fetch.js"

List of Functions

• CLC_AcontainsB
• CLC_AllDOMObjWithAttribute
• CLC_CompareLineages
• CLC_FindFocusable
• CLC_FindHighlightable
• CLC_FindScrollable
• CLC_GetAssociatedDescriptions
• CLC_GetAssociatedLabels
• CLC_GetAtomicObjectAtCursor
• CLC_GetClosestAncestorThatIs
• CLC_GetClosestAncestorWithAttribute
• CLC_GetClosestNSAttributeOf
• CLC_GetClosestAttributeOf
• CLC_GetDescendentNodesWithAttribute
• CLC_GetFirstAtomicObject
• CLC_GetLastAtomicObject
• CLC_GetLineage
• CLC_GetLogicalLineage
• CLC_GetNextAtomicObject
• CLC_GetNextAtomicTextObject
• CLC_GetPrevAtomicObject
• CLC_GetPrevAtomicTextObject
• CLC_TagInLineage

Detailed Usage Instructions

CLC_AcontainsB

bool CLC_AcontainsB(DOM-Obj_A, DOM-Obj_B)

Input parameters:

• DOM-Obj_A - DOM-Obj that is being checked to see if it contains B.
• DOM-Obj_B - DOM-Obj that is being checked to see if it contained by A.

• bool - This is true if DOM-Obj_A contains DOM-Obj_B; else it is false.

• None

• This function compares A with each element of B's lineage to determine if A is an object in B's lineage.

CLC_AllDOMObjWithAttribute

DOM-ObjArray CLC_AllDOMObjWithAttribute(DOM-ObjArray_Targ, DOM-Obj_Root, String_Attrib)

Input parameters:

• DOM-ObjArray_Targ - Array of DOM-Objs that needs to be added to if any DOM-Objs with the String_Attrib are found.
• DOM-Obj_Root - Starting DOM-Obj that is be examined to determine if it has the String_Attrib as an attribute. All of its childNodes (and their childNodes and so on) will be checked in the same manner.
• String_Attrib - String that is the text of the attribute to search for.

• DOM-ObjArray - This returns an array of DOM-Objs that contain the desired attribute.

• None

CLC_CompareLineages

int CLC_CompareLineages(Lineage_A, Lineage_B)

Input parameters:

• Lineage_A - The lineage that is used as the baseline for measuring divergence.
• Lineage_B - The lineage that is being checked to see where it diverges from the baseline.

• int - The index value of Lineage_B at which Lineage_B first diverges from Lineage_A.

• None

• If B does not diverge from A, the return value will be -1.
• If B has more objects than A and is the same as A until A runs out of objects, the return value will be the index in B for the first object that B has which A does not have.
• If B has fewer objects than A and is the same as A until B runs out of objects, the return value will the the length of B (ie, one more than the largest acceptable index value of B).

CLC_FindFocusable

DOM-Obj CLC_FindFocusable(DOM-Obj_Target)

Input parameters:

• DOM-Obj_Target - DOM-Obj that you are trying to find the most logical object to focus on since Firefox may not be able to focus on the DOM-Obj_Target directly.

• DOM-Obj - This DOM-Obj is something that Firefox can be made to focus on.

• None

• Usually, the most logical object to focus on would be the DOM-Obj closest to "DOM-Obj_Target" in the lineage for "DOM-Obj_Target." However, if there is a link element in the lineage, that will automatically take precedence in order to make the link usable.
• If there is nothing focusable, the return value will be null.

CLC_FindHighlightable

DOM-Obj CLC_FindHighlightable(DOM-Obj_Target)

Input parameters:

• DOM-Obj_Target - DOM-Obj that you are trying to find the most logical object that can be highlighted since CLC_Highlight may not be able to highlight the DOM-Obj_Target directly.

• DOM-Obj - This DOM-Obj is something that can be highlighted with CLC_Highlight.

• None

• For something to be highlightable, it must have the style attribute.
• If there is nothing highlightable, the return value will be null.

CLC_FindScrollable

DOM-Obj CLC_FindScrollable(DOM-Obj_Target)

Input parameters:

• DOM-Obj_Target - DOM-Obj that you are trying to find the most logical object that can be scrolled to since it may not be possible to scroll to the DOM-Obj_Target directly.

• DOM-Obj - This DOM-Obj is something that can be scrolled to using Firefox's built in scrollTo function.

• None

• For something to be scrollable, it must have the offsetTop attribute. Anything with an offsetTop will have an offsetLeft, so the existence of offsetLeft is assumed.
• If there is nothing scrollable, the return value will be null.

CLC_GetAssociatedDescriptions

DOM-ObjArray CLC_GetAssociatedDescriptions(DOM-Obj_Target)

Input parameters:

• DOM-Obj_Target - DOM-Obj that you are trying to find the associated WAI-ARIA descriptions for.

• DOM-ObjArray - Array of DOM-Objects which are descriptions for the specified target DOM object according to the WAI-ARIA "describedby" property.

• None

• None

CLC_GetAssociatedLabels

DOM-ObjArray CLC_GetAssociatedLabels(DOM-Obj_Target)

Input parameters:

• DOM-Obj_Target - DOM-Obj that you are trying to find the associated WAI-ARIA labels for.

• DOM-ObjArray - Array of DOM-Objects which are labels for the specified target DOM object according to the WAI-ARIA "labelledby" property.

• None

• Note that this not get HTML label elements. This is only for the WAI-ARIA "labelledby" property.

CLC_GetAtomicObjectAtCursor

DOM-Obj CLC_GetAtomicObjectAtCursor()

Input parameters:

• None

• DOM-Obj - This DOM-Obj is the atomic object that is where the cursor is at.

• None

• If there is no atomic object at the cursor, the return value will be null.

CLC_GetClosestAncestorThatIs

DOM-Obj CLC_GetClosestAncestorThatIs(DOM-Obj_Target, String_TagName)

Input parameters:

• DOM-Obj_Target - DOM-Obj that you are trying to find the closest ancestor for.
• String_TagName - The tagname that the ancestor must have.

• DOM-Obj - The ancestor that has the specified tagname and is the closest to the specified target DOM object.

• None

• If the object itself has this attribute, then the closest ancestor would be itself.
• If the tagname doesn't exist at all in the entire lineage, this function will return null.

CLC_GetClosestAncestorWithAttribute

DOM-Obj CLC_GetClosestAncestorWithAttribute(DOM-Obj_Target, String_AttributeName, String_AttributeValue)

Input parameters:

• DOM-Obj_Target - DOM-Obj that you are trying to find the closest ancestor for.
• String_AttributeName - The attribute that the ancestor must have.
• String_AttributeValue - The value of that attribute

• DOM-Obj - The ancestor that has the specified attribute with the specified value and is the closest to the specified target DOM object.

• None

• If the object itself has this attribute with this value, then the closest ancestor would be itself.
• If the tagname doesn't exist at all in the entire lineage, this function will return null.

CLC_GetClosestAttributeOf

string CLC_GetClosestAttributeOf(DOM-Obj_targ, String_targAttribute)

Input parameters:

• DOM-Obj_targ - The DOM-Object that you are trying to find the attribute value for.
• String_targAttribute - The name of the attribute that you are trying to find the attribute value for.

• string - The value of the target attribute.

• None

• If the attribute doesn't exist at all in the entire lineage, the return value will be null.

CLC_GetClosestNSAttributeOf

string CLC_GetClosestNSAttributeOf(DOM-Obj_targ, String_NameSpace, String_targAttribute)

Input parameters:

• DOM-Obj_targ - The DOM-Object that you are trying to find the attribute value for.
• String_NameSpace - The namespace of the attribute.
• String_targAttribute - The name of the attribute that you are trying to find the attribute value for.

• string - The value of the specified attribute which is under the specified namespace that is closest to the specified DOM object.

• None

• If the attribute doesn't exist at all in the entire lineage, the return value will be null.

CLC_GetDescendentNodesWithAttribute

DOM-ObjArray CLC_GetDescendentNodesWithAttribute(DOM-Obj_Target, String_AttributeName, String_AttributeValue)

Input parameters:

• DOM-Obj_Target - DOM-Obj that you are trying to find the descendents for.
• String_AttributeName - The attribute that the ancestor must have.
• String_AttributeValue - The value of that attribute

• DOM-ObjArray - An array of DOM-Objects that have the specified attribute with the specified value and are descendents of DOM-Obj_Target

• None

• None.

CLC_GetFirstAtomicObject

DOM-Obj CLC_GetFirstAtomicObject(DOM-Obj_Target)

Input parameters:

• DOM-Obj_Target - DOM-Obj that you are trying to retrieve the first atomic object from.

• DOM-Obj - This DOM-Obj is atomic and has no child nodes.

• None

• The DOM-Obj_Target may itself be atomic. If that is the case, the returned DOM-Obj will the same as what you passed in.
• The DOM-Obj_Target is not checked for validity. If you pass in an invalid DOM-Obj_Target, the return result will be the same as what you passed in.

CLC_GetLastAtomicObject

DOM-Obj CLC_GetLastAtomicObject(DOM-Obj_Target)

Input parameters:

• DOM-Obj_Target - DOM-Obj that you are trying to retrieve the last atomic object from.

• DOM-Obj - This DOM-Obj is atomic and has no child nodes.

• None

• The DOM-Obj_Target may itself be atomic. If that is the case, the returned DOM-Obj will the same as what you passed in.
• The DOM-Obj_Target is not checked for validity. If you pass in an invalid DOM-Obj_Target, the return result will be the same as what you passed in.

CLC_GetLineage

lineage CLC_GetLineage(DOM-Obj_Target)

Input parameters:

• DOM-Obj_Target - The DOM-Obj that you wish to retrieve the lineage for.

• lineage - The lineage of DOM-Obj_Target.

• None

• The lineage consists of the parentNode of "DOM-Obj_Target," the parentNode of the parentNode of "DOM-Obj_Target," etc.
• It is ordered such that "DOM-Obj_Target" will be the last element of the array.
• This is a physical lineage.

CLC_GetLogicalLineage

lineage CLC_GetLogicalLineage(DOM-Obj_Target)

Input parameters:

• DOM-Obj_Target - The DOM-Obj that you wish to retrieve the logical lineage for.

• lineage - The logical lineage of DOM-Obj_Target.

• None

• The lineage consists of the logical parent of "DOM-Obj_Target," the logical parent of the logical parent of "DOM-Obj_Target," etc.
• It is ordered such that "DOM-Obj_Target" will be the last element of the array.
• This is a logical lineage: parent-child relationships may or may not be reflected in the actual DOM. Labels are considered the parent of the inputs that they are labels for, even though there is no parent-child relationship visible in the DOM.

CLC_GetNextAtomicObject

DOM-Obj CLC_GetNextAtomicObject(DOM-Obj_CurrentAtomicObj)

Input parameters:

• DOM-Obj_CurrentAtomicObj - DOM-Obj that is the starting point. It is assumed to be atomic and the function will find and return the next DOM-Obj that is atomic.

• DOM-Obj - The next atomic object that is found within the Firefox JavaScript DOM. If there are no more atomic objects, the return value will be a 0.

• None

• The atomic object that it returns does not have to be in the same DOM-Obj that "DOM-Obj_CurrentAtomicObj" is in.
• This function assumes that the "DOM-Obj_CurrentAtomicObj" is atomic and will move on to the next object. To ensure that you do not skip any nodes, make sure that "DOM-Obj_CurrentAtomicObj" is really atomic. This function will not verify the atomicity of "DOM-Obj_CurrentAtomicObj."
• Text nodes in Firefox are atomic. Text nodes have a nodeType of 3.

CLC_GetNextAtomicTextObject

DOM-Obj CLC_GetNextAtomicTextObject(DOM-Obj_CurrentAtomicObj)

Input parameters:

• DOM-Obj_CurrentAtomicObj - DOM-Obj that is the starting point. It is assumed to be atomic and the function will find and return the next DOM-Obj that is atomic and has speakable text.

• DOM-Obj - The next atomic object with speakable text that is found within the Firefox JavaScript DOM. If there are no more atomic objects, the return value will be a 0.

• None

• The atomic object that it returns does not have to be in the same DOM-Obj that "DOM-Obj_CurrentAtomicObj" is in.
• This function assumes that the "DOM-Obj_CurrentAtomicObj" is atomic and will move on to the previous object. To ensure that you do not skip any nodes, make sure that "DOM-Obj_CurrentAtomicObj" is really atomic. This function will not verify the atomicity of "DOM-Obj_CurrentAtomicObj."

CLC_GetPrevAtomicObject

DOM-Obj CLC_GetPrevAtomicObject(DOM-Obj_CurrentAtomicObj)

Input parameters:

• DOM-Obj_CurrentAtomicObj - DOM-Obj that is the starting point. It is assumed to be atomic and the function will find and return the previous DOM-Obj that is atomic.

• DOM-Obj - The previous atomic object that is found within the Firefox JavaScript DOM. If there are no more atomic objects, the return value will be a 0.

• None

• The atomic object that it returns does not have to be in the same DOM-Obj that "DOM-Obj_CurrentAtomicObj" is in.
• This function assumes that the "DOM-Obj_CurrentAtomicObj" is atomic and will move on to the previous object. To ensure that you do not skip any nodes, make sure that "DOM-Obj_CurrentAtomicObj" is really atomic. This function will not verify the atomicity of "DOM-Obj_CurrentAtomicObj."
• Text nodes in Firefox are atomic. Text nodes have a nodeType of 3.

CLC_GetPrevAtomicTextObject

DOM-Obj CLC_GetPrevAtomicTextObject(DOM-Obj_CurrentAtomicObj)

Input parameters:

• DOM-Obj_CurrentAtomicObj - DOM-Obj that is the starting point. It is assumed to be atomic and the function will find and return the previous DOM-Obj that is atomic and has speakable text.

• DOM-Obj - The previous atomic object with speakable text that is found within the Firefox JavaScript DOM. If there are no more atomic objects, the return value will be a 0.

• None

• The atomic object that it returns does not have to be in the same DOM-Obj that "DOM-Obj_CurrentAtomicObj" is in.
• This function assumes that the "DOM-Obj_CurrentAtomicObj" is atomic and will move on to the previous object. To ensure that you do not skip any nodes, make sure that "DOM-Obj_CurrentAtomicObj" is really atomic. This function will not verify the atomicity of "DOM-Obj_CurrentAtomicObj."

CLC_TagInLineage

bool CLC_TagInLineage(Lineage_Target, String_Tag)

Input parameters:

• Lineage_Target - The lineage that holds the objects being searched for "String_Tag."
• String_Tag - The HTML tag that is being searched for.

• bool - True if there is at least one object in "Lineage_Target" that has the "String_Tag"; else, this is false.

• None

• None