JavaScript Library | Episerver Developer Community

formatters

Summary

Static module that defines miscellaneous formatter methods for use with the dgrid.

Location

epi-cms/dgrid/formatters

Properties

defaultIconClass

Methods

public method contentIcon ( typeIdentifier )

Adds an icon as specified for the type or a default object icon

Parameters

Name	Summary	Type	Usage
typeIdentifier	key for the type	undefined	required

public method contentItem ( typeIdentifier , missingLanguageBranch , text , title , menuSettings , thumbnailUrl , isEncoded )

Formats a content object with icon missing language indicator and an optional menu

Parameters

Name	Summary	Type	Usage
typeIdentifier	content type key for selecting the icon	undefined	required
missingLanguageBranch	Content items language information	undefined	required
text	The name or description of the content	undefined	required
title	The name or description of the content used for the title attribute. If not specified, the text value will be used	undefined	required
menuSettings	Settings information for menu	undefined	required
thumbnailUrl	The image public url of content	undefined	required
isEncoded	The flag which is used to enale/disable encode mode. (default true)	Boolean	required

public method contentItemFactory ( textSelector , titleSelector , iconSelector , menuSettings , thumbnailSelector , languageSelector , isEncoded )

Factory function for configuring the contentItem formatter

Parameters

Name	Summary	Type	Usage
textSelector	Selector function or property key of content object	undefined	required
titleSelector	Selector function or property key of content object	undefined	required
iconSelector	Selector function or property key of content object	undefined	required
menuSettings	Settings information for menu	undefined	required
thumbnailSelector		undefined	required
languageSelector		undefined	required
isEncoded	Flags which is used to enabled/disable encode mode. (default true)	Boolean	required

public method friendlyBoolean ( value )

Creates a div with a "checked/not checked" css class.

Parameters

Name	Summary	Type	Usage
value		undefined	required

public method languageBranch ( languageBranch )

Adds an indicator of the true langauge for the content object

Parameters

Name	Summary	Type	Usage
languageBranch	Languagebranch object.	undefined	required

public method localizedDate ( date )

Shim for the epi/date/toUserFriendlyHtml function

Parameters

Name	Summary	Type	Usage
date	The date to format.	undefined	required

public method menu ( settings )

Adds a menu icon

Parameters

Name	Summary	Type	Usage
settings	Settings information for menu	Object	required

public method secondaryText ( value , valueIsHtml )

Wrappes the value with a span with the 'epi-secondaryText' css class

Parameters

Name	Summary	Type	Usage
value		undefined	required
valueIsHtml	Pass true to skip html encoding of the value. The default is to encode the value.	undefined	required

public method userName ( userName )

Shim for the epi/username/toUserFriendlyHtml function

Parameters

Name	Summary	Type	Usage
userName	The user name.	undefined	required

public method versionStatus ( versionId )

Shim for the epi-cms/contentediting/ContentActionSupport.getVersionStatus function

Parameters

Name	Summary	Type	Usage
versionId	The value to format.	undefined	required

public method visibleLink ( value , valueIsHtml )

Wrappes the value with a span with the 'epi-visibleLink' css class

Parameters