Open Source

Class Index | File Index

Classes


Namespace fiveui


Defined in: prelude.js.

Namespace Summary
Constructor Attributes Constructor Name and Description
 

The FiveUI Prelude.

Method Summary
Method Attributes Method Name and Description
<static>  
fiveui.isString(o)

Determine if a given value is a string or not.

<static>  
fiveui.query(sel, context)

fiveui.query is a wrapper around the jQuery $() function.

Namespace Detail
fiveui

The FiveUI Prelude.

The prelude provides a collection of utilities to ease the conversion from human-readable guideline documents (such as the Web Accessibilty Guidelines, or Apple Human Interface Guidelines) to executable Rules.

Method Detail
<static> {!boolean} fiveui.isString(o)

Determine if a given value is a string or not.

Parameters:
{*} o Optional
A value of some type that may or may not be defined.
Returns:
{!boolean} true if the object is a defined, non-null string, false otherwise.

<static> {Object} fiveui.query(sel, context)

fiveui.query is a wrapper around the jQuery $() function.

In most respects fiveui.query behaves just like jQuery. But it recurses into iframes and frames, whereas $(...) stops when it encounters internal frames. fiveui.query also skips over page elements that are added by FiveUI.

Generally, rules written for FiveUI will want to cover the entire visible page, and as such, should use fiveui.query; however, $(...) is available if recursing into frames is not necessary.

$5() is an alias for fiveui.query.

Parameters:
{string} sel
The jQuery selector string.
{Object} context Optional
The context to run the query within. This is often a DOM object/tree.
Returns:
{Object} A jQuery object, suitable for chaining.