mura.content

Class contentRendererUtility

lucee.Component
    extended by mura.cfobject
      extended by mura.content.contentRendererUtility

This provides content rendering utiility methods

Class Attributes:
  • output : false
  •  
  • synchronized : false
  •  
  • accessors : false
  •  
  • persistent : false
  •  
    Constructor Summary
    init()
    Method Summary
    any addCompletePath([string str], [string siteID])
    any addlink(any type, any filename, any title, [string target=''], [string targetParams=''], any contentid, any siteid, string querystring='', string context='[runtime expression]', string stub='[runtime expression]', string indexFile='', string showMeta='0', string showCurrent='1', string class='', boolean complete='false', string id='', any aHasKidsClass='[runtime expression]', any aHasKidsAttributes='[runtime expression]', any aCurrentClass='[runtime expression]', any aCurrentAttributes='[runtime expression]', any isParent='false', any aNotCurrentClass='[runtime expression]', [any secure='false'], [any isBreadCrumb='false'], [any renderer])
    any addToHTMLFootQueue([any text], [any action='append'], [any renderer])
    any addToHTMLHeadQueue([any text], [any action='append'], [any renderer])
    boolean allowLink([numeric restrict='0'], [string restrictgroups=''], [numeric loggedIn='0'], [query rspage], [any renderer])
    any createCSSHook(string text)
    any createCSSID(string title='', [any renderer])
    any createHREF(any type='Page', any filename, any siteid='', any contentid='', any target='', any targetParams='', any querystring='', string context='[runtime expression]', string stub='[runtime expression]', string indexFile='', boolean complete='false', string showMeta='0', [any bean], [any secure='false'], [any renderer], [any hashURLS])
    any createHREFForImage([any siteID], [any fileID], [any fileExt], any size='undefined', any direct='[runtime expression]', boolean complete='false', [any height=''], [any width=''], [any secure='false'])
    any createHREFforRSS(any type='Page', any filename, any siteid, any contentid='', any target='', any targetParams='', [string context='[runtime expression]'], [string stub='[runtime expression]'], [string indexFile=''], [string showMeta='0'], string fileExt='', [any secure='false'], [any renderer])
    any dspCrumblistLinks([string id='crumblist'], [string separator=''], [string class='[runtime expression]'], [any renderer])
    any dspMultiPageContent([any body], [any renderer])
    any dspObject([string object], string objectid='', string siteid='', any params='', string assignmentID='', any regionID='0', any orderno='0', any hasConfigurator='false', any assignmentPerm='none', [boolean allowEditable='false'], [string cacheKey=''], [any renderer], [any showEditableObjects], [any layoutmanager], [any objectname], any bodyRender='false', any include='false', any returnFormat='html')
    any dspObjects(numeric columnID='1', string ContentHistID='[runtime expression]', [any returnFormat='string'], [any renderer], [any layoutmanager], [any allowInheritance='true'])
    any dspSection(any level='1', [any renderer])
    any dspZoom(array crumbdata, [string fileExt=''], [boolean ajax='false'], [string class='breadcrumb'], [numeric charLimit='0'], [numeric minLevels='0'], [numeric maxLevels='0'], [any renderer])
    any dspZoomNoLinks(array crumbdata, [string fileExt=''], [string class='breadcrumb'], [numeric charLimit='0'], [numeric minLevels='0'], [numeric maxLevels='0'], [any renderer])
    any dspZoomText(array crumbdata, any separator='>', [any renderer])
    any generateEditableHook([any renderer])
    any generateEditableObjectControl(any editLink='', [any isConfigurator='false'], [any showEditableObjects='false'], [any enableFrontEndTools='false'], [any renderer])
    any generateListImageStyles([any size='small'], [any height='auto'], [any width='auto'], [any padding='[runtime expression]'], [any setHeight='true'], [any setWidth='true'], [any renderer])
    any getContentListAttributes([any property=''], [any class=''], [any contentListPropertyMap], [any renderer])
    any getContentListLabel([any property=''], [any renderer], [any contentListPropertyMap])
    any getContentListProperty([any property=''], [any contentListPropertyMap], [any renderer])
    any getContentListPropertyValue([any property=''], [any value=''], [any renderer], [any contentListPropertyMap])
    any getCrumbVarByLevel(String theVar='', numeric level='1', [any renderer])
    any getCurrentURL(boolean complete='true', string injectVars='', boolean filterVars='true', [any domain='[runtime expression]'], [any renderer], [any filterVarsList=''])
    any getCurrentURLArray([any renderer])
    any getListFormat([any contentListPropertyMap], [any renderer])
    any getMetaDesc([any renderer])
    any getMetaKeyWords([any renderer])
    any getPagesQuery([any str])
    any getPersonalizationID([any renderer])
    any getTemplate([any renderer])
    any getTopId(any useNavOffset='false', [any renderer])
    any getTopVar(String topVar='', boolean useNavOffset='false', [any renderer])
    any iconClassByContentType([any type], [any subtype='Default'], [any siteid=''])
    any loadShadowboxJS([any renderer])
    any lookupCustomContentTypeBody([any $])
         This is for looking up overrides in dspBody.
    any renderEditableAttribute([any attribute], [any type='text'], [any required='false'], [any validation=''], [any message=''], [any label], [any value], [any enableMuraTag='true'], [any renderer])
    any renderEditableObjectfooter(any control='', [any showEditableObjects='false'], [any enableFrontEndTools='false'], [any renderer])
    any renderEditableObjectHeader(any class='', any customWrapperString='', [any showEditableObjects='false'], [any enableFrontEndTools='false'], [any renderer])
    any renderIcon([any data], [any renderer])
    any renderIntervalDesc([any content], [any renderer], [any showTitle='true'])
    any renderObjectClassOption([any object], [any objectid=''], [any objectname=''], [any objectlabel], [any objecticonclass='mi-cog'])
    any renderObjectInManager([any object], [any objectid], [any content], [any objectParams='[runtime expression]'], [any showEditable], [any isConfigurator], [any objectname], [any renderer], [any bodyRender='false'])
    any serializeObjectParam([any paramValue])
    any setParagraphs([string theString], [any renderer])
    any stripHTML([string str])
     
    Methods inherited from class mura.cfobject
    commitTracePoint, convertTimezone, deleteMethod, get, getAsJSON, getAsStruct, getBean, getConfigBean, getCurrentUser, getEventManager, getFeed, getHTTPAttrs, getHTTPService, getJavaTimezone, getPlugin, getPluginManager, getQueryAttrs, getQueryService, getServiceFactory, getSession, getValue, hasCustomDatasource, initTracePoint, inject, injectMethod, invokeMethod, mixin, parseDateArg, removeValue, set, setValue, valueExists
     
    Methods inherited from class lucee.Component
    None

    Constructor Detail

    init

    public init()


    Method Detail

    addCompletePath

    public any addCompletePath([string str], [string siteID])

    Parameters:
    str
    siteID

    addlink

    public any addlink(any type, any filename, any title, [string target=''], [string targetParams=''], any contentid, any siteid, string querystring='', string context='[runtime expression]', string stub='[runtime expression]', string indexFile='', string showMeta='0', string showCurrent='1', string class='', boolean complete='false', string id='', any aHasKidsClass='[runtime expression]', any aHasKidsAttributes='[runtime expression]', any aCurrentClass='[runtime expression]', any aCurrentAttributes='[runtime expression]', any isParent='false', any aNotCurrentClass='[runtime expression]', [any secure='false'], [any isBreadCrumb='false'], [any renderer])

    Parameters:
    type
    filename
    title
    target
    targetParams
    contentid
    siteid
    querystring
    context
    stub
    indexFile
    showMeta
    showCurrent
    class
    complete
    id
    aHasKidsClass
    aHasKidsAttributes
    aCurrentClass
    aCurrentAttributes
    isParent
    aNotCurrentClass
    secure
    isBreadCrumb
    renderer

    addToHTMLFootQueue

    public any addToHTMLFootQueue([any text], [any action='append'], [any renderer])

    Parameters:
    text
    action
    renderer

    addToHTMLHeadQueue

    public any addToHTMLHeadQueue([any text], [any action='append'], [any renderer])

    Parameters:
    text
    action
    renderer

    allowLink

    public boolean allowLink([numeric restrict='0'], [string restrictgroups=''], [numeric loggedIn='0'], [query rspage], [any renderer])

    Parameters:
    restrict
    restrictgroups
    loggedIn
    rspage
    renderer

    createCSSHook

    public any createCSSHook(string text)

    Parameters:
    text

    createCSSID

    public any createCSSID(string title='', [any renderer])

    Parameters:
    title
    renderer

    createHREF

    public any createHREF(any type='Page', any filename, any siteid='', any contentid='', any target='', any targetParams='', any querystring='', string context='[runtime expression]', string stub='[runtime expression]', string indexFile='', boolean complete='false', string showMeta='0', [any bean], [any secure='false'], [any renderer], [any hashURLS])

    Parameters:
    type
    filename
    siteid
    contentid
    target
    targetParams - deprecated, does not do anything. May come be re-introduced for modal params
    querystring
    context - deprecated
    stub - deprecated
    indexFile - deprecated
    complete
    showMeta
    bean - The contentBean that link is being generated for
    secure
    renderer
    hashURLS

    createHREFForImage

    public any createHREFForImage([any siteID], [any fileID], [any fileExt], any size='undefined', any direct='[runtime expression]', boolean complete='false', [any height=''], [any width=''], [any secure='false'])

    Parameters:
    siteID
    fileID
    fileExt
    size
    direct
    complete
    height
    width
    secure

    createHREFforRSS

    public any createHREFforRSS(any type='Page', any filename, any siteid, any contentid='', any target='', any targetParams='', [string context='[runtime expression]'], [string stub='[runtime expression]'], [string indexFile=''], [string showMeta='0'], string fileExt='', [any secure='false'], [any renderer])

    Parameters:
    type
    filename
    siteid
    contentid
    target
    targetParams - deprecated
    context - deprecated
    stub - deprecated
    indexFile
    showMeta
    fileExt
    secure
    renderer

    dspCrumblistLinks

    public any dspCrumblistLinks([string id='crumblist'], [string separator=''], [string class='[runtime expression]'], [any renderer])

    Parameters:
    id
    separator
    class
    renderer

    dspMultiPageContent

    public any dspMultiPageContent([any body], [any renderer])

    Parameters:
    body
    renderer

    dspObject

    public any dspObject([string object], string objectid='', string siteid='', any params='', string assignmentID='', any regionID='0', any orderno='0', any hasConfigurator='false', any assignmentPerm='none', [boolean allowEditable='false'], [string cacheKey=''], [any renderer], [any showEditableObjects], [any layoutmanager], [any objectname], any bodyRender='false', any include='false', any returnFormat='html')

    Parameters:
    object
    objectid
    siteid
    params
    assignmentID
    regionID
    orderno
    hasConfigurator
    assignmentPerm
    allowEditable
    cacheKey
    renderer
    showEditableObjects
    layoutmanager
    objectname
    bodyRender
    include
    returnFormat

    dspObjects

    public any dspObjects(numeric columnID='1', string ContentHistID='[runtime expression]', [any returnFormat='string'], [any renderer], [any layoutmanager], [any allowInheritance='true'])

    Parameters:
    columnID
    ContentHistID
    returnFormat
    renderer
    layoutmanager
    allowInheritance

    dspSection

    public any dspSection(any level='1', [any renderer])

    Parameters:
    level
    renderer

    dspZoom

    public any dspZoom(array crumbdata, [string fileExt=''], [boolean ajax='false'], [string class='breadcrumb'], [numeric charLimit='0'], [numeric minLevels='0'], [numeric maxLevels='0'], [any renderer])

    Parameters:
    crumbdata
    fileExt - deprecated, this is now in the crumbData
    ajax
    class
    charLimit
    minLevels
    maxLevels
    renderer

    dspZoomNoLinks

    public any dspZoomNoLinks(array crumbdata, [string fileExt=''], [string class='breadcrumb'], [numeric charLimit='0'], [numeric minLevels='0'], [numeric maxLevels='0'], [any renderer])

    Parameters:
    crumbdata
    fileExt - deprecated, this is now in the crumbData
    class
    charLimit
    minLevels
    maxLevels
    renderer

    dspZoomText

    public any dspZoomText(array crumbdata, any separator='>', [any renderer])

    Parameters:
    crumbdata
    separator
    renderer

    generateEditableHook

    public any generateEditableHook([any renderer])

    Parameters:
    renderer

    generateEditableObjectControl

    public any generateEditableObjectControl(any editLink='', [any isConfigurator='false'], [any showEditableObjects='false'], [any enableFrontEndTools='false'], [any renderer])

    Parameters:
    editLink
    isConfigurator
    showEditableObjects
    enableFrontEndTools
    renderer

    generateListImageStyles

    public any generateListImageStyles([any size='small'], [any height='auto'], [any width='auto'], [any padding='[runtime expression]'], [any setHeight='true'], [any setWidth='true'], [any renderer])

    Parameters:
    size
    height
    width
    padding
    setHeight
    setWidth
    renderer

    getContentListAttributes

    public any getContentListAttributes([any property=''], [any class=''], [any contentListPropertyMap], [any renderer])

    Parameters:
    property
    class
    contentListPropertyMap
    renderer

    getContentListLabel

    public any getContentListLabel([any property=''], [any renderer], [any contentListPropertyMap])

    Parameters:
    property
    renderer
    contentListPropertyMap

    getContentListProperty

    public any getContentListProperty([any property=''], [any contentListPropertyMap], [any renderer])

    Parameters:
    property
    contentListPropertyMap
    renderer

    getContentListPropertyValue

    public any getContentListPropertyValue([any property=''], [any value=''], [any renderer], [any contentListPropertyMap])

    Parameters:
    property
    value
    renderer
    contentListPropertyMap

    getCrumbVarByLevel

    public any getCrumbVarByLevel(String theVar='', numeric level='1', [any renderer])

    Parameters:
    theVar
    level
    renderer

    getCurrentURL

    public any getCurrentURL(boolean complete='true', string injectVars='', boolean filterVars='true', [any domain='[runtime expression]'], [any renderer], [any filterVarsList=''])

    Parameters:
    complete
    injectVars
    filterVars
    domain
    renderer
    filterVarsList

    getCurrentURLArray

    public any getCurrentURLArray([any renderer])

    Parameters:
    renderer

    getListFormat

    public any getListFormat([any contentListPropertyMap], [any renderer])

    Parameters:
    contentListPropertyMap
    renderer

    getMetaDesc

    public any getMetaDesc([any renderer])

    Parameters:
    renderer

    getMetaKeyWords

    public any getMetaKeyWords([any renderer])

    Parameters:
    renderer

    getPagesQuery

    public any getPagesQuery([any str])

    Parameters:
    str

    getPersonalizationID

    public any getPersonalizationID([any renderer])

    Parameters:
    renderer

    getTemplate

    public any getTemplate([any renderer])

    Parameters:
    renderer

    getTopId

    public any getTopId(any useNavOffset='false', [any renderer])

    Parameters:
    useNavOffset
    renderer

    getTopVar

    public any getTopVar(String topVar='', boolean useNavOffset='false', [any renderer])

    Parameters:
    topVar
    useNavOffset
    renderer

    iconClassByContentType

    public any iconClassByContentType([any type], [any subtype='Default'], [any siteid=''])

    Parameters:
    type
    subtype
    siteid

    loadShadowboxJS

    public any loadShadowboxJS([any renderer])

    Parameters:
    renderer

    lookupCustomContentTypeBody

    public any lookupCustomContentTypeBody([any $])

    This is for looking up overrides in dspBody

    Parameters:
    $

    renderEditableAttribute

    public any renderEditableAttribute([any attribute], [any type='text'], [any required='false'], [any validation=''], [any message=''], [any label], [any value], [any enableMuraTag='true'], [any renderer])

    Parameters:
    attribute
    type
    required
    validation
    message
    label
    value
    enableMuraTag
    renderer

    renderEditableObjectfooter

    public any renderEditableObjectfooter(any control='', [any showEditableObjects='false'], [any enableFrontEndTools='false'], [any renderer])

    Parameters:
    control
    showEditableObjects
    enableFrontEndTools
    renderer

    renderEditableObjectHeader

    public any renderEditableObjectHeader(any class='', any customWrapperString='', [any showEditableObjects='false'], [any enableFrontEndTools='false'], [any renderer])

    Parameters:
    class
    customWrapperString
    showEditableObjects
    enableFrontEndTools
    renderer

    renderIcon

    public any renderIcon([any data], [any renderer])

    Parameters:
    data
    renderer

    renderIntervalDesc

    public any renderIntervalDesc([any content], [any renderer], [any showTitle='true'])

    Parameters:
    content
    renderer
    showTitle

    renderObjectClassOption

    public any renderObjectClassOption([any object], [any objectid=''], [any objectname=''], [any objectlabel], [any objecticonclass='mi-cog'])

    Parameters:
    object
    objectid
    objectname
    objectlabel
    objecticonclass

    renderObjectInManager

    public any renderObjectInManager([any object], [any objectid], [any content], [any objectParams='[runtime expression]'], [any showEditable], [any isConfigurator], [any objectname], [any renderer], [any bodyRender='false'])

    Parameters:
    object
    objectid
    content
    objectParams
    showEditable
    isConfigurator
    objectname
    renderer
    bodyRender

    serializeObjectParam

    public any serializeObjectParam([any paramValue])

    Parameters:
    paramValue

    setParagraphs

    public any setParagraphs([string theString], [any renderer])

    Parameters:
    theString
    renderer

    stripHTML

    public any stripHTML([string str])

    Parameters:
    str