CFLib.org – Common Function Library Project

ListNext(currentItem, theList[, theDelim])

Last updated October 10, 2002

author

Shawn Seley

Version: 1 | Requires: CF5 | Library: StrLib

Description:
Given the current list item, returns the next item within a list of unique values. If current item is the last value in the list or is not found in the list, then returns the first item. Will not work correctly if the list contains duplicate values (comparisons are case sensitive).

Return Values:
Returns a string.

Example:

<cfoutput>
ListNext("breakfast", "breakfast,lunch,dinner"):<br>
#ListNext("breakfast", "breakfast,lunch,dinner")#<br>
<br>
ListNext("", "breakfast,lunch,dinner"):<br>
#ListNext("", "breakfast,lunch,dinner")#<br>
<br>
ListNext("lunch", "breakfast|lunch|dinner", "|"):<br>
#ListNext("lunch", "breakfast|lunch|dinner", "|")#<br>
<br>
<br>
Working independently in a loop:<br>
ListNext(currentColor, "dimgray,gray,darkgray,silver,lightgrey,ghostwhite")<br>
<cfset currentColor = "">
<cfloop index="x" from="1" to="10">
	<cfset currentColor = ListNext(currentColor, "dimgray,gray,darkgray,silver,lightgrey,ghostwhite")>
	<font color="#currentColor#">#currentColor#</font><br>
</cfloop>
</cfoutput>

Parameters:

Name Description Required
currentItem The current item in the list. Yes
theList The list to examine. Yes
theDelim List delimiter. Defaults to a comma. No

Full UDF Source:

/**
 * Given the current list item, returns the next item within a list of unique values.
 * Mods by RCamden to make current_pos see if it was equal to OR greater than list lenth, plus original code didn't use custom delim for the listlen check.
 * 
 * @param currentItem 	 The current item in the list. (Required)
 * @param theList 	 The list to examine. (Required)
 * @param theDelim 	 List delimiter. Defaults to a comma. (Optional)
 * @return Returns a string. 
 * @author Shawn Seley (shawnse@aol.com) 
 * @version 1, October 10, 2002 
 */
function ListNext(currentItem, theList){
	var current_pos   = 0;
	var theDelim      = ",";

	if(ArrayLen(Arguments) GTE 3) theDelim = Arguments[3];

	current_pos = ListFind(theList, currentItem, theDelim);

	if(current_pos eq ListLen(theList, theDelim)) return ListFirst(theList, theDelim) ;
	else return ListGetAt(theList, current_pos+1, theDelim);
}
blog comments powered by Disqus

Search CFLib.org


Latest Additions

Kevin Cotton added
date2ExcelDate
May 5, 2016

Raymond Camden added
CapFirst
April 25, 2016

Chris Wigginton added
loremIpsum
January 18, 2016

Gary Stanton added
calculateArrival...
November 19, 2015

Sebastiaan Naafs - van Dijk added
getDaysInQuarter
November 13, 2015

Created by Raymond Camden / Design by Justin Johnson