CFGRID tag for the Lucee CFML engine
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
function
tag
LICENSE
README.md

README.md

cfgrid-lucee

CFGRID tag for the Lucee CFML engine

This is a BASIC cfgrid and cfgridcolumn implementation for Lucee. It is intended to make most CFGRID code cross-compatible with Adobe CF. It uses a JavaScript library called DataTables.js to mimic the functionality provided by Adobe. If you are writing new code, you should probably do your own implementation of Datatables.js instead of using this project. The real purpose of this project is to accelerate the conversion process from Adobe CF to Lucee for people who have a lot of legacy CFGRID code. I'm happy to consider requests for additions and changes. I tried to focus on the most commonly used features, and did not implement features that were purely visual (e.g. bold="yes") since those can easily be accomplished with CSS anyhow.

Installation

  1. Download and copy the files to your context directory ('/lucee-server/context/library' for server, or '/WEB-INF/lucee/library' for a single site/context). Works for both the server or an individual web context.
  2. cfgrid.cfc and cfgridcolumn.cfc go in the 'tag' directory, and QueryConvertForDatatables.cfm and QueryConvertForGrid.cfm go in the 'function' directory. See note about QueryConvertForGrid() below if you do not want to replace the native Lucee tag for this.
  3. Restart Lucee.

<CFGRID>

Supported Attributes

  • format (html only1)
  • name
  • bind
  • pageSize
  • width
  • style
  • query
  • autoWidth
  • href (see notes below)
  • hrefKey
  • maxrows (with query only)
  • onLoad
  • sort

Notes for href attribute: This can be a standard URL, or you can use href="javascript:myfunction();" to have it run your own JavaScript function on click. In addition, you can optionally use {key} to get it to pass your hrefKey into a function - href="javascript:myfunction({key});"

See http://cfdocs.org/cfgrid for usage details.

Custom Attributes for this Lucee version!

  • search="yes/no", show or hide the search box (default, yes)
  • jsAtBottom="yes/no", place JavaScript inside bottom BODY tag (default, yes)
  • cssAtBottom="yes/no", place CSS inside bottom BODY tag (default, yes)
  • includeJQuery="yes/no", if you already have jQuery on your page, set to no (default, yes)
  • includeDatatables="yes/no", if you already have DataTables.js on your page, set to no (default, yes)
  • includeDatatablesCSS="yes/no", if you already have DataTables css, or want something custom, set to no (default, yes)
  • includeBootstrap="yes/no", Use Bootstrap.js to style (default, no)
  • customJS="path or array of paths", custom JavaScript files to include on the page. For example, jQuery UI. (default, none)
  • customCSS="path or array of paths", custom CSS files to include on the page. For example, your custom Datatables styles. (default, none)
  • lengthChange="yes/no", Show the select box to pick items per page (default, yes)
  • compact="yes/no", For Datatables CSS, use the compact style, takes up less space (default, yes)
  • defaultSortColumn="column name", Default column to sort by on load. If blank, it uses the first column.
  • defaultSortDir="ASC or DESC", Sort direction on load.

You can use includeDatatablesCSS="no" and then customCSS="http://pathto/my.css", for example, to use your own style sheet or custom Datatables CSS.

<CFGRIDCOLUMN>

Supported Attributes

  • name
  • header
  • display
  • width
  • type (numeric, date, string only)
  • dataAlign

See http://cfdocs.org/cfgridcolumn for usage details.

QueryConvertForGrid()

This is a REPLACEMENT for QueryConvertForGrid() in Lucee. You will need to use this, or QueryConvertForDatatables if you are binding (using ajax) for your dataset.

You can use this if you are unable, or don't want to, change all your QueryConvertForGrid functions to QueryConvertForDatatables. In this project, it is really just a wrapper for the QueryConvertForDatatables function.

Arguments are the same as defined at http://cfdocs.org/queryconvertforgrid, but arguments 2 and 3 are basically ignored and it will use the DataTables.js form scope instead.

NOTE: If you do not want to replace the built-in Lucee tag for this, you don't have to include queryconvertforgrid.cfm in your installation. You can use queryconvertfordatatables() instead.

QueryConvertForDatatables()

This is the equivalent of QueryConvertForGrid() in Adobe CF, but uses Datatables. You will need to use this if you are binding (using ajax) for your dataset.

QueryConvertForDatatables(query,datatables form scope)

If you don't explicitly pass in the datatables form scope (second argument), it will use the form scope for the request.

It will pass in all of the Datatables parameters needed and produce the JSON object that is used by Datatables.

Binding Form Elements

This library mimics the Adobe CF binding to form elements, but not binding to columns.

Examples of binding:

  • bind="cfc:dealers.getGrid({mypickbox})", any time the form field with id="mypickbox" changes, the grid refreshes and passes that value to the CFC.
  • bind="cfc:dealers.getGrid({mytextbox@keypress})", any time a key is pressed in the form field with id="mytextbox", the grid refreshes and passes that value to the CFC.

SIMPLE QUERY EXAMPLE

<cfquery name="getdata" datasource="mydsn">
SELECT id,name,city,state
FROM dealers
</cfquery>
<cfgrid format="html"
      name="maingrid" 
      query="getdata" 
      pagesize="10" 
      autowidth="true" 
      href="thispage.cfm?action=form&amp;id="
      hrefKey="id" 
      sort="yes"
      >
      <cfgridcolumn name="id" display="no" />
      <cfgridcolumn name="name" header="Name" />
      <cfgridcolumn name="city" header="City" />
      <cfgridcolumn name="state" header="State" />
</cfgrid>

AJAX RESULTS USAGE EXAMPLE

In your cfm file...

<cfgrid format="html"
      name="maingrid" 
      bind="cfc:dealers.getGrid()" 
      pagesize="10" 
      autowidth="true" 
      href="thispage.cfm?action=form&amp;id="
      hrefKey="id" 
      sort="yes"
      >
      <cfgridcolumn name="id" display="no" />
      <cfgridcolumn name="name" header="Name" />
      <cfgridcolumn name="city" header="City" />
      <cfgridcolumn name="state" header="State" />
</cfgrid>

In dealers.cfc, you would have a function...

<cffunction name="getGrid" output="false" access="remote">

        <cfquery name="returnQry" datasource="mydsn">
        SELECT id,name,city,state FROM dealers
        ORDER BY #form.gridsortcolumn# #form.gridsortdir#
        </cfquery>
                
        <cfreturn QueryConvertForGrid(returnQry)> 
</cffunction>