Tree

webskin

Prefix	webskin
Library path	/tags/webskin
CFImport

<webskin:breadcrumb ...>

XML Style	Yes

Attributes

Name	Type	Required	Default	Options	Description
separator	string	No	»		The separator for the steps in the bread crumb. Can be a snippet of html (an image tag for example)
here	string	No			set the text for the last item in the breadcrumb
linkClass	string	No
objectid	string	No	#request.navid#		This sets the starting point of the bread crumb tail. This is the attribute you are looking for. This must be a UUID of an element in the tree. To start this off, you can set an alias in the tree (for example 'mystuff') and then assign the alias uuid using something like application.navid['mystuff']. The default for this is request.navid
startLevel	string	No	1
prefix	string	No
suffix	string	No
includeSelf	string	No	0		include the current item in the bread crumb trail
linkSelf	string	No	true	true,false	should this item be a link in the bread crumb
homeNavID	string	No	#application.navid.home#		the objectId of the starting element of the breadcrumb. This UUID should be of one of the items in the navigation tree. For example, if you were to set an alias of a navigation you could set this value like: application.navid['myalias']. The default is application.navid.home.

<webskin:bubble ...>

Displays a notification message on next request end.

XML Style	Yes

Attributes

Name	Type	Required	Default	Description
title	string	No		The title of the message
message	string	No		The actual message. This can be replaced with generatedContent
pause	numeric	No	3000	How long (in milliseconds) the message appears before being removed
sticky	boolean	No	false	Keep the message displayed until the user actively closes.
image	string	No		Image to display with the message
tags	string	No		Tags to identify message categories later
rbkey	string	No	general.message.#rereplace(attributes.title,'[^\w]','','ALL')#-#rereplace(attributes.message,'[^\w]','','ALL')#	The resource path for this message.
variables	string	No	#arraynew(1)#	Variables for resource translation

<webskin:buildLink ...>

XML Style	Yes

Attributes

Name	Type	Required	Default	Description
href	string	No		the actual href to link to
objectid	string	No		Added to url parameters; navigation obj id
alias	string	No		Navigation alias to use to find the objectid
type	string	No		Added to url parameters: Typename used with type webskin views
view	string	No		Added to url parameters: Webskin name used to render the page layout
bodyView	string	No		Added to url parameters: Webskin name used to render the body content
linktext	string	No		Text used for the link
target	string	No		target window for link
externallink	string	No
id	string	No		Anchor tag ID
class	string	No		Anchor tag classes
style	string	No		Anchor tag styles
title	string	No		Anchor tag title text
urlOnly	string	No	false
r_url	string	No		Define a variable to pass the link back (instead of writting out via the tag). Note setting urlOnly invalidates this setting
xCode	string	No		eXtra code to be placed inside the anchor tag
includeDomain	string	No	false
Domain	string	No	#cgi.http_host#
stParameters	string	No	#StructNew()#
urlParameters	string	No
JSWindow	string	No	0	Default to not using a Javascript Window popup
stJSParameters	string	No	#StructNew()#
anchor	string	No		Anchor to place at the end of the URL string.
onclick	string	No		the js code to place in onclick
ampDelim	string	No	&	the default ampersand delimiter as used by getLink
rbkey	string	No		If set, FarCry will use the specified resource for @text and @title with the provided attribute values as the defaults
bModal	string	No	false	If set, FarCry will open the page as an iframed webtop modal window

<webskin:cache ...>

XML Style	Yes

Attributes

Name	Type	Required	Default
flushcache	boolean	No	false
cacheBlockName	string	No	FarCry
cacheName	string	No
cacheBlockName	string	No	FarCry
cacheName	string	No

<webskin:div ...>

A standard HTML div tag usefull when coding so that opening and closing cfoutput tags are not required thereby cleaning up output.

XML Style	Yes

Attributes

Name	Type	Required
id	string	No
class	string	No
style	string	No

<webskin:flashWrapper ...>

XML Style	Yes

Attributes

Name	Type	Required	Default
class	string	No	ruleFlashWrapper
SWFSource	string	No
SWFID	string	No	SWFID
SWFWidth	string	No	404
SWFHeight	string	No	326
SWFVersion	string	No	8
SWFBackgroundColor	string	No
SWFWMode	string	No	transparent
SWFScriptAccess	string	No	sameDomain
SWFMenu	string	No	false
containerWidth	string	No
containerHeight	string	No
RPCServiceName	string	No	facade
RPCMethod	string	No
RPCObjectID	string	No
stRPC	string	No	#structNew()#

<webskin:flexWrapper ...>

XML Style	Yes

Attributes

Name	Type	Required	Default
SWFSource	string	No
SWFID	string	No
flashVars	string	No
flexAssetsPath	string	No	#application.url.farcry#/admin/ui/flexassets
FAbridgeJS	string	No

<webskin:fuRedirect ...>

XML Style	Yes

Attributes

Name	Type	Required	Default	Options	Description
notFoundHandler	string	No

<webskin:genericNav ...>

XML Style	Yes

Attributes

Name	Type	Required	Default	Description
navID	string	No	#request.navID#
depth	string	No	1
startLevel	string	No	2
id	string	No
bFirst	string	No	0
firstClass	string	No	first	If enabled, this css class name is applied to the first list element in the nav
bLast	string	No	0
lastClass	string	No	last	If enabled, this css class name is applied to the last list element in the nav
bActive	string	No	0
activeClass	string	No	active
bIncludeHome	string	No	0
sectionObjectID	string	No	#request.navID#
functionMethod	string	No	getDescendants
functionArgs	string	No	depth=attributes.depth
bDump	string	No	0
class	string	No
style	string	No
displayStyle	string	No	unorderedList
bHideSecuredNodes	string	No	0	MJB: check if option to Hide Nav Node Items that user does't have permission to access: default to 0 for backward compatibility
afilter	string	No	#arrayNew(1)#
bSpan	string	No	false
lColumns	string	No	navType,externallink,lNavIDAlias,internalRedirectID,externalRedirectURL,target
lColumns	string	No	externallink,lNavIDAlias
homeAlias	string	No	home

<webskin:hbs ...>

XML Style	Yes

Attributes

Name	Type	Required	Default	Options	Description
template	string	No

<webskin:htmlHead ...>

XML Style	Yes

Attributes

Name	Type	Required	Default	Description
text	string	No
id	string	No	#application.fc.utils.createJavaUUID()#
library	string	No
libraryState	string	No	true
position	string	No	last	first or last

<webskin:icon ...>

XML Style	Yes

Attributes

<webskin:importCSS ...>

Name	Type	Required	Default	Options	Description
None

XML Style	Yes

Attributes

Name	Type	Required	Default	Options	Description
type	string	No	import

<webskin:include ...>

XML Style	Yes

Attributes

<webskin:listOfLinks ...>

Name	Type	Required	Default	Options	Description
None

XML Style	Yes

Attributes

Name	Type	Required	Default
qData	query	No
startLevel	integer	No	2
objectID	uuid	No	#request.navID#
lLineage	string	No
listType	string	No	ul
idList	string	No
classLIfirst	string	No
classLIlineage	string	No
classLIcurrent	string	No	current

<webskin:loadCSS ...>

XML Style	Yes

Attributes

Name	Type	Required	Description
id	string	No	The id of the library that has been registered with the application
lCombineIDs	string	No	A list of registered CSS ids, to be included in this library
baseHREF	string	No
lFiles	string	No	The files to include in that baseHREF
media	string	No	the media type to use in the style tag
condition	string	No	the condition to wrap around the style tag
prepend	string	No	any CSS to prepend to the beginning of the script block
append	string	No	any CSS to append to the end of the script block
bCombine	string	No	Should the files be combined into a single cached css file. Passing true/false will override how it was registered.

<webskin:loadJS ...>

XML Style	Yes

Attributes

Name	Type	Required	Default	Description
id	string	No		The id of the library that has been registered with the application
lCombineIDs	string	No		A list of registered JS ids, to be included in this library
baseHREF	string	No
lFiles	string	No		The files to include in that baseHREF
condition	string	No		the condition to wrap around the style tag
prepend	string	No		any JS to prepend to the beginning of the script block
append	string	No		any JS to append to the end of the script block
bCombine	string	No		Should the files be combined into a single cached js file. Passing true/false will override how it was registered.
core	string	No	false	Set to true if this JS is part of core and should be loaded after other JS

<webskin:location ...>

XML Style	Yes

Attributes

Name	Type	Required	Default	Description
url	string	No
href	string	No	#attributes.url#	the actual href to link to. Defaults to attributes.url
alias	string	No		Navigation alias to use to find the objectid
objectid	string	No		Added to url parameters; navigation obj id
type	string	No		Added to url parameters: Typename used with type webskin views
view	string	No		Added to url parameters: Webskin name used with type webskin views
bodyView	string	No		Added to url parameters: Webskin name used with type webskin views
externallink	string	No
stParameters	string	No	#StructNew()#
urlParameters	string	No
includeDomain	string	No	false
Domain	string	No	#cgi.http_host#
addToken	string	No	false
ampDelim	string	No	&
statusCode	string	No		Optional: add a status code to the cflocation redirect

<webskin:multiPageNav ...>

XML Style	Yes

Attributes

Name	Type	Required	Default
objectId	string	No
display	string	No	true
displayPageNumbers	string	No	true
displayNextPrevious	string	No	true
displayNextPreviousTitle	string	No	true
class	string	No	multiPage
r_qlinks	string	No	r_qlinks
seperator	string	No
previousArrow	string	No	«
nextArrow	string	No	»

<webskin:multiPageTOC ...>

XML Style	Yes

Attributes

Name	Type	Required	Default
objectId	string	No
display	string	No	true
class	string	No	multiPage
r_qlinks	string	No	r_qlinks

<webskin:onReady ...>

XML Style	Yes

Attributes

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

<webskin:pagination ...>

Provides the functionality to paginate through a recordset

XML Style	Yes

Attributes

Name	Type	Required	Default	Description
query	string	No		A query name that contains the objectids to loop over.
array	string	No		An array of objectids to loop over. Can be used instead of query.
typename	string	No
paginationID	string	No	page	Uniquely identifies this pagination set. Set if using sticky pages or if multiple pagination sets on a single page.
bStickyPages	string	No	false	Keeps track of the page the user is currently on in session against this key.
currentPage	string	No	0
actionURL	string	No
r_stObject	string	No	stObject	The name of the calling page structure that will contain the current row of the recordset as struct
totalRecords	string	No	0	The total number of records in the records. Used if only the current page of the recordset was passed in. 0 assumes that the recordset passed in is the entire recordset to be paginated.
maxRecordsToDisplay	numeric	No	0
pageLinks	numeric	No	10
recordsPerPage	numeric	No	10
submissionType	string	No	url
Step	numeric	No	1
top	boolean	No	true
bottom	boolean	No	true
oddRowClass	string	No	oddrow	The class name returned in stobjects for each "even" current row
evenRowClass	string	No	evenrow	The class name returned in stobjects for each "odd" current row
bDisplayTotalRecords	string	No	0	display the total records or not
linksWebskin	string	No	displayLinks	webskin to use for rendering the pagination scroll
r_pageLinksHtml	string	No		Save page links html to a variable so we can return it to the caller

<webskin:pop ...>

The pop tag is useed to handle bubble'd messages.

NOTE: Core uses the following tags in it's messages:

type
[typename]
container
rule
security
updated
created
deleted
workflow
information
warning
error
system
updateapp

XML Style	Yes

This tag has two modes: custom output and automatic output.

Custom output

<skin:pop start="<ul>" end="</ul>">
 <li><strong>#message.title#</strong> #message.message#</li>
</skin:pop>

Automatic output:

<skin:pop format="headerblock" />

Only handling messages with specific tags:

<skin:pop format="headerblock" tags="error" />

Attributes

Name	Type	Required	Default	Description
tags	string	No		Messages with any of these tags will be popped. All messages are popped by default.
variable	string	No	message	The variable that the message information will be stored in
start	string	No		String to output at the start ONLY if there is at least one matching message
end	string	No		String to output at the end ONLY if there is at least one matching message
format	string	No		Automatically process the output using "gritter" or "headerblock"

<webskin:postprocess ...>

This tag will run the specified post-processing functions on the input

XML Style	Yes

Attributes

Name	Type	Required	Default	Options	Description
input	string	No
functions	string	No

<webskin:printFriendly ...>

XML Style	Yes

Attributes

Name	Type	Required	Default	Options	Description
linktext	string	No	Printer Friendly Version

<webskin:registerCSS ...>

XML Style	Yes

Attributes

Name	Type	Required	Default	Description
id	string	No		The id of the library that has been registered with the application
lCombineIDs	string	No		A list of registered CSS ids, to be included in this library
baseHREF	string	No
lFiles	string	No		The files to include in that baseHREF
media	string	No	all	the media type to use in the style tag
condition	string	No		the condition to wrap around the style tag
prepend	string	No		any CSS to prepend to the begining of the script block
append	string	No		any CSS to append to the end of the script block
bCombine	string	No	true	Should the files be combined into a single cached css file.

<webskin:registerJS ...>

XML Style	Yes

Attributes

Name	Type	Required	Default	Description
id	string	No		The id of the library that has been registered with the application
lCombineIDs	string	No		A list of registered JS ids, to be included in this library
baseHREF	string	No
lFiles	string	No		The files to include in that baseHREF
condition	string	No		the condition to wrap around the style tag
prepend	string	No		any JS to prepend to the begining of the script block
append	string	No		any JS to append to the end of the script block
bCombine	string	No	true	Should the files be combined into a single cached js file.
aliasof	string	No		Flags this library as an alias of an existing one. The original library must already have been registered.
core	string	No		Flags this library as being a core library. This library should only be directly referenced by core.

<webskin:relatedcontent ...>

Display related content.

XML Style	Yes

Attributes

Name	Type	Required	Default	Description
objectid	uuid	No		The object for which related objects are to be found
webskin	string	No		webskin to render related content view
typename	string	No		content typename of parent; providing improves performance
arrayType	string	No		The typename containing the array property that defines the relationship we are looking for
arrayProperty	string	No		propertyname of the array to render
filter	string	No		The typename of related objects to find. Empty for ALL typenames.
rendertype	string	No	none	render options: unordered, ordered, none
alternateHTML	string	No	#attributes.webskin# template unavailable.	alternative HTML if webskin is missing
r_html	string	No		Empty will render the html inline
lValidStatus	string	No	#request.mode.lValidStatus#	Filter displayed items by their status

<webskin:relatedLinks ...>

XML Style	Yes

Attributes

Name	Type	Required	Default
aRelatedIDs	array	No
output	string	No	true
class	string	No	relatedLinks
r_qlinks	string	No	r_qlinks

<webskin:secondaryNav ...>

XML Style	Yes

Attributes

Name	Type	Required	Default
navid	string	No	#request.navid#
bIncludeParent	string	No	true
r_navQuery	string	No
bDisplay	string	No	false

<webskin:seo ...>

XML Style	Yes

Attributes

Name	Type	Required	Default	Description
stobject	struct	No		content object of page
title	string	No
image	string	No		og:image image thumb for content (optional)
description	string	No		description; google search prefers 170 chars but other services may be happy with more
type	string	No	article	og:type defaults to article
url	string	No		og:url is the fully qualified URL to the content

<webskin:simpleNav ...>

XML Style	Yes

Attributes

Name	Type	Required	Default
navID	string	No	#application.fapi.getNavID(alias=
depth	string	No	1
currentNavID	string	No	#request.navID#
bIncludeHome	string	No	true
homeAlias	string	No	home
tag	string	No	ul
id	string	No
class	string	No
style	string	No
activeClass	string	No	active
itemTag	string	No	li
itemNestedClass	string	No	parent
itemMarkupStart	string	No
itemMarkupEnd	string	No
nestedTag	string	No	ul
functionMethod	string	No	getDescendants
functionArgs	string	No	depth=attributes.depth
lColumns	string	No	externallink,lNavIDAlias
aFilter	string	No	#arrayNew(1)#

<webskin:sitemap ...>

Build s a sitemap by calling generic nav with specific parameters.

XML Style	Yes

Attributes

Name	Type	Required	Default
depth	numeric	No	4
startPoint	string	No	#application.navid.home#
bDisplay	string	No	true
r_navQuery	string	No	r_navQuery
id	string	No	sitemapNav

<webskin:tooltip ...>

Displays a tool tip on hover.

XML Style	Yes

Linking a tool tip to a DOM element using the id attribute

<skin:tooltip message="Stuff!" selector="#a-123" />
<a href="javascript:void(0);" id="a-123">Things</a>

Linking a tooltip to a DOM element using the id attribute and doing an HTML style tooltip

<skin:tooltip selector="#a-123">
  <b>THINGS!</b>
</skin:tooltip>
<a href="javascript:void(0);" id="a-123">Things</a>

Linking a tool tip to several DOM elements using the class selector

<skin:tooltip selector=".yadda">
   <b>THINGS!</b>
</skin:tooltip>
<a class="yadda" href="javascript:void(0);">Thing 1</a>
<a class="yadda" href="javascript:void(0);">Thing 2</a>
<a class="yadda" href="javascript:void(0);">Thing Red</a>
<a class="yadda" href="javascript:void(0);">Thing Blue</a>

Attributes

Name	Type	Required	Description
id	string	No	id used to ensure the tooltip is only loaded once per id.
selector	string	No	The id of the dom element that you wish to have the tooltip display on hover.
message	string	No	The actual message. If this is blank, the text between the opening and the closing tag will be used (generatedContent)
class	string	No	The css class to be assigned to the tooltip div
position	string	No	The css class to be assigned to the tooltip div

<webskin:view ...>

This tag will run the view on an object with the same objectid until it is saved to the database.

XML Style	Yes

Attributes

Name	Type	Required	Default	Description
stObject	string	No	#structNew()#	use to get an existing object that has already been fetched by the calling page.
typename	string	No		typename of the object.
objectid	string	No		used to get an existing object
key	string	No		use to generate a new object
template	string	No		can be used as an alternative to webskin. Best practice is to use webskin.
webskin	string	No		the webskin to be called with the object
onExitProcess	string	No
stProps	string	No	#structNew()#
stParam	string	No	#structNew()#
r_html	string	No		Empty will render the html inline
r_objectid	string	No		Allows the return of the objectid usefull if it is generated by the tag in the case of when passing a key.
hashKey	string	No		Pass in a key to be used to hash the objectBroker webskin cache
bAjax	string	No	0	Flag to determine whether to render an ajax call to load the webskin instead of inline.
ajaxID	string	No		The id to give the div that will call the ajaxed webskin
ajaxShowloadIndicator	string	No	false	Should the ajax loading indicator be shown
ajaxindicatorText	string	No	loading...	What should be text of the loading indicator
ajaxURLParameters	string	No		parameters to pass for ajax call
ajaxTimeout	string	No	30	parameters to pass for ajax call
bIgnoreSecurity	string	No	false	Should the getView() ignore webskin security
bAllowTrace	string	No	true	Sometimes having webskin trace information can break the integrity of a page. This allows you to turn it off.
alternateHTML	string	No

FarCry Core - p600 / webskin

webskin

webskin

<webskin:breadcrumb ...>

Attributes

<webskin:bubble ...>

Attributes

<webskin:buildLink ...>

Attributes

<webskin:cache ...>

Attributes

<webskin:div ...>

Attributes

<webskin:flashWrapper ...>

Attributes

<webskin:flexWrapper ...>

Attributes

<webskin:fuRedirect ...>

Attributes

<webskin:genericNav ...>

Attributes

<webskin:hbs ...>

Attributes

<webskin:htmlHead ...>

Attributes

<webskin:icon ...>

Attributes

<webskin:importCSS ...>

Attributes

<webskin:include ...>

Attributes

<webskin:listOfLinks ...>

Attributes

<webskin:loadCSS ...>

Attributes

<webskin:loadJS ...>

Attributes

<webskin:location ...>

Attributes

<webskin:multiPageNav ...>

Attributes

<webskin:multiPageTOC ...>

Attributes

<webskin:onReady ...>

Attributes

<webskin:pagination ...>

Attributes

<webskin:pop ...>

Attributes

<webskin:postprocess ...>

Attributes

<webskin:printFriendly ...>

Attributes

<webskin:registerCSS ...>

Attributes

<webskin:registerJS ...>

Attributes

<webskin:relatedcontent ...>

Attributes

<webskin:relatedLinks ...>

Attributes

<webskin:secondaryNav ...>

Attributes

<webskin:seo ...>

Attributes

<webskin:simpleNav ...>

Attributes

<webskin:sitemap ...>

Attributes

<webskin:tooltip ...>

Attributes

<webskin:view ...>

Attributes