Tree

formtools

Prefix	formtools
Library path	/tags/formtools
CFImport

<formtools:advice ...>

XML Style	Yes

Attributes

Name	Type	Required	Default
objectid	string	No
field	string	No
message	string	No
value	string	No
class	string	No	validation-advice

<formtools:bind ...>

XML Style	Yes

Attributes

Name	Type	Required	Default
field	string	No
prefix	string	No
binding	string	No
lRequiredFields	string	No	*

<formtools:break ...>

XML Style	Yes

Attributes

<formtools:button ...>

Name	Type	Required	Default	Options	Description
None

XML Style	Yes

Attributes

Name	Type	Required	Default	Description
value	string	Yes		The event submitted and captured by an ft:processForm tag.
type	string	No	submit	button or submit. Default is 'submit'.
text	string	No	#attributes.value#	The text that will appear on the button. Default is the value.
id	string	No	f-btn-#application.fapi.getUUID()#	The unique id of the button
validate	string	No		Should the form be validated before the onClick event is fired. Default is 'true' for type submit and 'false' for buttons.
SelectedObjectID	string	No		A value that will be placed in the hidden form field form.selectedObjectID on submission.
onClick	string	No		javascript that will be run when the user clicks this button
Class	string	No		Any css classes that are to be added to the button
Style	string	No		Any css styles that are to be added to the button.
ConfirmText	string	No		A confirmation message that will appear before submission
url	string	No		A URL that you would like the button to redirect the page too.
target	string	No	_self	The target for the url page to be redirected too.
bSpamProtect	string	No	false	Instantiates cfformprotection to ensure the button is not clicked by spam.
stSpamProtectConfig	string	No	#structNew()#	config data that will override the config set in the webtop.
rbkey	string	No	forms.buttons.#rereplacenocase(attributes.text,'[^\w\d]','','ALL')#	The resource path for this button. Default is forms.buttons.value.
disabled	string	No	false	Should the button be disabled
r_stButton	string	No		the name of the calling scope variable name to return the details of the farcry button
renderType	string	No	farcryButton	How should the button be rendered (button, link, farcryButton(default))
primaryAction	string	No		Is this button a primary action on the form
bDefaultAction	string	No	false	Default action when someone presses enter on a form.
icon	string	No		The jquery-ui icon to use
title	string	No		The title of the button
priority	string	No		the level of button (primary,secondary,tertiary)
textOnClick	string	No		what should the text change to when the button is clicked.
textOnSubmit	string	No		what should the text change to when the button is submitted.
disableOnSubmit	string	No	true	should the button be disabled when the form is submitted
dropdownToggle	string	No	false	used in combination with dropdownMenu to open the menu

<formtools:buttonPanel ...>

Wrapper for farcry buttons.

XML Style	Yes

Attributes

Name	Type	Required	Default	Options	Description
class	string	No	form-actions
style	string	No

<formtools:farcryButton ...>

XML Style	Yes

Attributes

Name	Type	Required	Default	Description
value	string	Yes		The event submitted and captured by an ft:processForm tag.
type	string	No		button or submit. Default is 'submit' if inside an ft:form and 'button' if not.
text	string	No	#attributes.value#	The text that will appear on the button. Default is the value.
id	string	No	f-btn-#application.fapi.getUUID()#	The unique id of the button
validate	string	No		Should the form be validated before the onClick event is fired. Default is 'true' for type submit and 'false' for buttons.
SelectedObjectID	string	No		A value that will be placed in the hidden form field form.selectedObjectID on submission.
onClick	string	No		javascript that will be run when the user clicks this button
Class	string	No		Any css classes that are to be added to the button
Style	string	No		Any css styles that are to be added to the button.
ConfirmText	string	No		A confirmation message that will appear before submission
url	string	No		A URL that you would like the button to redirect the page too.
target	string	No	_self	The target for the url page to be redirected too.
bSpamProtect	string	No	false	Instantiates cfformprotection to ensure the button is not clicked by spam.
stSpamProtectConfig	string	No	#structNew()#	config data that will override the config set in the webtop.
rbkey	string	No	forms.buttons.#rereplacenocase(attributes.value,'[^\w\d]','','ALL')#	The resource path for this button. Default is forms.buttons.value.
disabled	string	No	false	Should the button be disabled
r_stButton	string	No		the name of the calling scope variable name to return the details of the farcry button
renderType	string	No	farcryButton	How should the button be rendered (button, link)
primaryAction	string	No		Is this button a primary action on the form
bDefaultAction	string	No	false	Default action when someone presses enter on a form.
icon	string	No		The jquery-ui icon to use

<formtools:farcryButtonPanel ...>

Wrapper for farcry buttons.

XML Style	Yes

Attributes

Name	Type	Required	Default	Options	Description
id	string	No	#application.fc.utils.createJavaUUID()#
indentForLabel	string	No	true

<formtools:field ...>

Renders the field with label and hint if requested.

XML Style	Yes

Attributes

Name	Type	Required	Default	Description
label	string	No		The fields label
labelAlignment	string	No	inline	options:inline,block; Used by FarCry Form Layouts for positioning of labels. inline or block.
for	string	No		The fieldname the label is for
class	string	No	string	The class to apply to the field wrapping div.
style	string	No		The class to apply to the field wrapping div.
hint	string	No		This will place a hint below the field
errorMessage	string	No		This will place an errormessage above the field
rbkey	string	No	coapi.field.#rereplace(attributes.label,'[^\w]','','ALL')#	The resource path for this field.

<formtools:fieldHint ...>

Sets the Field Hint of the parent ft:field

XML Style	Yes

Attributes

Name	Type	Required	Default	Options	Description
hint	string	No			The hint to render.

<formtools:fieldset ...>

Renders the fieldset with correct classes

XML Style	Yes

Attributes

Name	Type	Required	Description
legend	string	No	The legend of the fieldset if required.
style	string	No	The style to apply to the fieldset.
helpTitle	string	No	The helping title for the fieldset.
helpSection	string	No	The helping text for the fieldset.

<formtools:fieldsetHelp ...>

Sets the Field Hint of the parent ft:field

XML Style	Yes

Attributes

Name	Type	Required	Default	Options	Description
helpSection	string	No			The help text to render.

<formtools:flashUpload ...>

XML Style	Yes

Attributes

Name	Type	Required	Default
fileTypes	string	No	*
fileDescription	string	No	All types
label	string	No
maxSize	string	No	-1
swf	string	No	#application.url.webtop#/facade/fileupload/fileUpload.swf
onComplete	string	No

<formtools:flashUploadInput ...>

XML Style	Yes

Attributes

Name	Type	Required	Default
value	string	No
inputWidth	string	No
buttonStyle	string	No
uploadButton	boolean	No	true
progressBar	boolean	No	true
progressInfo	boolean	No	true
progressBarStyle	string	No	border-thickness:0;corner-radius: 0;fill-colors: ##00CCFF, ##0075D9;theme-color: ##00CCFF; border-color:##00CCFF;
uploadButtonLabel	string	No	Upload
chooseButtonLabel	string	No	Choose File
required	string	No	false
message	string	No

<formtools:form ...>

XML Style	Yes

Attributes

Name	Type	Required	Default	Description
Name	string	No	farcryForm#randrange(1,999999999)#
Target	string	No
Action	string	No
method	string	No	post
onsubmit	string	No
Class	string	No
Style	string	No
Validation	string	No	1
bAjaxSubmission	string	No	false
ajaxMaskMsg	string	No	Form Submitting, please wait...
ajaxMaskCls	string	No	x-mask-loading
ajaxTimeout	string	No	30
ajaxTarget	string	No		jQuery selector specifying the target element for the form response. Defaults to the FORM element.
bAddFormCSS	string	No	true	Add relevent form layout css
bFieldHighlight	string	No	true	Highlight fields when focused
bFocusFirstField	string	No	false	Focus on first form element.
defaultAction	string	No		The default action to be used if user presses enter key on browser that doesn't fire onClick event of first button.
autoSave	string	No	false	Enter boolean to toggle default autosave values on properties
autoSaveToSessionOnly	string	No	false	If there are any autosave fields, should they save to the session only?

<formtools:object ...>

This tag is used to render a contentType on a display page

XML Style	Yes

Basic usage. Rendering a packages/forms object:

<ft:object typename="mmInquiry" /&gt;

Rendering specific fields

&lt;ft:object typename="farLogin" lFields="username,password" prefix="login" legend="" /&gt;

Separate items from the same contentType, but grouped so ft:processFormObjects only sees one object:

&lt;h1&gt;Your Stuff&lt;/h1&gt;
<ft:object typename="mmInquiry" lFields="firstname,lastname" key="thereCanBeOnlyOne" /&gt;

&lt;h1&gt;Other Stuff&lt;/h1&gt;
<ft:object typename="mmInquiry" lFields="kidsname,dogsname" key="thereCanBeOnlyOne" /&gt;

Attributes

Name	Type	Required	Default	Description
ObjectID	string	No		ObjectID of object to render
stObject	string	No		Object to render
typename	string	No		Type of Object to render
key	string	No		Used to group several ft:objects into one object. (Used to generate a new object) For example, if you have several ft:object's in an ft:form you can use this to group them into one object for ft:processFormObjects
ObjectLabel	string	No		Used to group and label rendered object if required
lFields	string	No		List of fields to render
lExcludeFields	string	No	label	List of fields to exclude from render
class	string	No		wrapper class around output
style	string	No		wrapper style around output
format	string	No	edit	edit or display
IncludeLabel	string	No	1
labelClass	string	No	control-label	The class to be applied to all labels
IncludeFieldSet	string	No
legend	string	No		the legend to output on the fieldset
helpTitle	string	No		title for the help section
helpSection	string	No		text to provide help information for the fieldset
IncludeBR	string	No	1
InTable	string	No	0
insidePLP	string	No	0	how are we rendering the form
r_stFields	string	No		the name of the structure that is to be returned with the form field information.
r_stPrefix	string	No		the name of the structure that is to be returned with the form field prefix used.
stPropMetadata	string	No	#structNew()#	This is used to override the default metadata as setup in the type.cfc
wizardID	string	No		If this object call is part of a wizard, the object will be retrieved from the wizard storage
bValidation	string	No	true	Flag to determine if client side validation classes are added to this section of the form.
lHiddenFields	string	No		List of fields to render as hidden fields that can be use to inject a value into the form post.
stPropValues	string	No	#structNew()#
bIncludeSystemProperties	string	No	false	Allow system properties to be displayed..
lock	string	No	true	Lock if editing.
bShowFieldHints	boolean	No	true	Flag to determine if the field hints are display.
prefix	string	No		Allows the developer to pass in the prefix they wish to use. Default is the objectid stripped of the dashes.
focusField	string	No		Enter the name of the field to focus on when rendering the form.
autosave	string	No		Enter boolean to toggle default autosave values on properties

<formtools:objectadmin ...>

XML Style	Yes

Attributes

Name	Type	Required	Default	Description
typename	string	No
columnlist	string	No	label,datetimelastupdated
title	string	No
ColumnList	string	No
SortableColumns	string	No
lFilterFields	string	No
bFilterValidation	boolean	No	0
description	string	No
datasource	string	No	#application.dsn#
aColumns	array	No	#arrayNew(1)#
aCustomColumns	array	No	#arrayNew(1)#
lCustomColumns	string	No		A list of column label:webskin values
aButtons	array	No	#arrayNew(1)#
bdebug	boolean	No	false
bFilterCategories	boolean	No	true
bFilterDateRange	boolean	No	true
bFilterProperties	boolean	No	true
permissionset	string	No	#attributes.typename#
defaultorderby	string	No	datetimelastupdated
defaultorder	string	No	desc
id	string	No	#attributes.typename#
sqlorderby	string	No	datetimelastupdated desc
sqlWhere	string	No
lCategories	string	No
name	string	No	objectadmin
numitems	numeric	No	#application.config.general.GENERICADMINNUMITEMS#
numPageDisplay	numeric	No	5
lButtons	string	No	*
lButtonsEmpty	string	No	add,bulk upload,undelete
bPaginateTop	boolean	No	false
bPaginateBottom	boolean	No	true
bDisplayTotalRecords	boolean	No	true
bCheckAll	boolean	No	true
bSelectCol	boolean	No	true
bEditCol	boolean	No	true
bViewCol	boolean	No	true
bFlowCol	boolean	No	true
bPreviewCol	boolean	No	true
editMethod	string	No	edit
copyMethod	string	No	copy
PackageType	string	No	types
module	string	No	customlists/#attributes.typename#.cfm
plugin	string	No
lCustomActions	string	No
stFilterMetaData	string	No	#structNew()#
bShowActionList	string	No	true
qRecordSet	string	No		Used if the developer wants to pass in their own recordset
rbkey	string	No	coapi.#attributes.typename#.objectadmin
addUrlParams	string	No	#structnew()#
copyUrlParams	string	No	#structnew()#
editUrlParams	string	No	#structnew()#
emptymessage	string	No	You do not currently have any content. Use the [Add] button above to begin.

<formtools:processform ...>

This tag is used to process form submissions. It is, in general, used at the top of a display page that is displaying a form.

This tag is used with the ft:form, ft:object and ft:button tags, and is the "action page" portion of form processing. The action attribute is a string that needs to match the ft:button's value attribute. So, for example, if you ft:button value="Submit" you'll want to have a ft:processform action="Submit" to handle the form.

XML Style	Yes

&lt;ft:processform action="Submit"&gt;
 &lt;skin:bubble title="Blarg!" message="Das Blarg Ya!" /&gt;
 &lt;cfdump var="#stobj#" /&gt;
&lt;/ft:processform&gt;

Attributes

Name	Type	Required	Default	Description
action	string	No	*	the ft:button value action this processform handles
rbkey	string	No
excludeAction	string	No
bHideForms	string	No	false
Exit	string	No	false	If set to true the ft:form on the page will not show it's contents after this process runs. Note this doesn't stop page execution, just does not render ft:form contents.
bSpamProtect	string	No	false	Instantiates cfformprotection to ensure the button is not clicked by spam.
stSpamProtectConfig	string	No	#structNew()#	config data that will override the config set in the webtop.

<formtools:processformobjects ...>

Processformobjects is used to save content objects to the database (via an ft:form and ft:processForm tag), and it can also be used to handle general FarCry forms.

XML Style	Yes

Automatically saving a contentType to the database:

<ft:processForm action="Save">
 <ft:processFormObjects objectid="#stobj.objectid#" />
</ft:processForm>

Getting access to the form fields by hand:

<ft:processform action="Submit Form">
 <ft:processFormObjects typename="mmInquiry">
  &lt;cfdump var="#stProperties#" label="Stuff in the form" />
 </ft:processFormObjects>
</ft:processform>

Attributes

Name	Type	Required	Default
stObj	string	No	#structNew()#
ObjectID	string	No
typename	string	No
stPropMetadata	string	No	#structNew()#
r_stProperties	string	No	stProperties
stPropMethods	string	No	#structNew()#
PackageType	string	No	types
lArrayListGenerate	string	No
bSessionOnly	string	No	false

<formtools:serverSideValidation ...>

XML Style	Yes

Attributes

Name	Type	Required	Default	Options	Description
lrequiredfields	string	No

<formtools:sessionOnly ...>

XML Style	Yes

Attributes

<formtools:splitButton ...>

Wrapper for farcry split buttons.

Name	Type	Required	Default	Options	Description
None

XML Style	Yes

Attributes

Name	Type	Required	Default
class	string	No
style	string	No
priority	string	No
position	string	No	bottom

<formtools:validateFormObjects ...>

XML Style	Yes

Attributes

Name	Type	Required	Default
stObj	string	No	#structNew()#
ObjectID	string	No
typename	string	No
stPropMetadata	string	No	#structNew()#
r_stProperties	string	No	stProperties
stPropMethods	string	No	#structNew()#
PackageType	string	No	types
bimageautogenerate	string	No	false
lArrayListGenerate	string	No
bSessionOnly	string	No	false

FarCry Core - p610 / formtools

formtools

formtools

<formtools:advice ...>

Attributes

<formtools:bind ...>

Attributes

<formtools:break ...>

Attributes

<formtools:button ...>

Attributes

<formtools:buttonPanel ...>

Attributes

<formtools:farcryButton ...>

Attributes

<formtools:farcryButtonPanel ...>

Attributes

<formtools:field ...>

Attributes

<formtools:fieldHint ...>

Attributes

<formtools:fieldset ...>

Attributes

<formtools:fieldsetHelp ...>

Attributes

<formtools:flashUpload ...>

Attributes

<formtools:flashUploadInput ...>

Attributes

<formtools:form ...>

Attributes

<formtools:object ...>

Attributes

<formtools:objectadmin ...>

Attributes

<formtools:processform ...>

Attributes

<formtools:processformobjects ...>

Attributes

<formtools:serverSideValidation ...>

Attributes

<formtools:sessionOnly ...>

Attributes

<formtools:splitButton ...>

Attributes

<formtools:validateFormObjects ...>

Attributes