Scripts 1 0-loadCFJS

From ADF Docs
Revision as of 20:50, 13 August 2010 by Gcronkright (talk | contribs) (Usage:)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Attention: Do not change any text in the description, signature, and paramter sections.

Return to Scripts_1_0

Description

Loads the CFJS jQuery Plug-in Headers if not loaded.

Signature

public void loadCFJS ( string version )

Parameters

Required Name Type Description
optional version string [Default: 1.1.9] CFJS version to load.

Examples

CFJS is a jquery plugin written by Christopher Jordan that contains a library of "ColdFusion style" functions (ie. ArrayLen(), GetListAt() and ListFindNoCase(), etc.) for use with jQuery/JavaScript code.

Usage:

Add the ADF loadJQuery() and loadCFJS() headers to the top of your custom script page:

<cfscript>
     // load jQuery headers
     application.ADF.scripts.loadJQuery();
     // load jQuery CFJS headers
     application.ADF.scripts.loadCFJS();
</cfscript>

Using jQuery call the CFJS library functions:

<script>
     jQuery(function(){
	// define a list
        var numStrList = "One,Two,Three,Four,Five";

        // use CFJS to get the value of the item at position 3 of the list
	var numStrText = jQuery.ListGetAt(numStrList,3,','); // list,position,delimiter

        // output the value of the numStrText variable 
	jQuery('#valueDisplayA').html(numStrText); // displays the string 'Three'
        
        // use CFJS to find the position of the string 'Four' from the list
        var strPos = jQuery.ListFindNoCase(numStrList,'Four',',');

        // output the position of the string
	jQuery('#valueDisplayB').html(strPos); 
     });
</script>

HTML:

<div id="valueDisplayA"></div>
<div id="valueDisplayB"></div>

Output:

Three
4

References:

A complete CFJS Function listing:
Chris Jordan's Blog

Quick reference site for CF functions and function parameters:
cfquickdocs.com