Appendix E. Template Root Object Reference

This document displays list of available Template root objects that can be used in view templates. Root objects are listed in alphabetic order according to their names.

Each template root object in the following list is backed by a server-side java class respectively. Public methods of the server-side java class are exposed as APIs for corresponding Template root object.

For example

{
   "data":
   {
    "ticket":"${jsonUtils.encodeJSONString(ticket)}"
   }
}

This project has total 9 Template root objects.

E.1. argreplace

  • Java Class : org.springframework.extensions.webscripts.ArgReplaceMethod

  • Module Artifact Id : spring-webscripts

  • Module Group Id : Users.mindthegab.Dev.alfresco.workspace.spring-surf-parent.target.checkout.spring-webscripts

  • Module Version : target

  • Java Doc : link

  • Help :

    Given a URL string and N named/value pairs, replace each URL argument with 
    respective name/value pair (if name matches existing URL argument), or add 
    name/value pair to URL (if name does not match existing URL argument).

    Usage: argreplace(url.args, "skipCount", cursor.nextPage, ...)

  • Sample Code :

    [#if cursor.hasFirstPage]
    <link rel="first" href="${absurl(encodeuri(scripturl(argreplace(url.args, pageNo,
    cursor.firstPage, pageSize, cursor.pageSize))))?xml}" type="${format.type}"/>
    [/#if]

  • Methods

E.2. atom

  • Java Class : org.springframework.extensions.webscripts.atom.AtomService

  • Module Artifact Id : spring-webscripts

  • Module Group Id : Users.mindthegab.Dev.alfresco.workspace.spring-surf-parent.target.checkout.spring-webscripts

  • Module Version : target

  • Java Doc : link

  • Help :

    Collection of Atom related methods.

  • Sample Code :

    //JavaScript Sample Code
     var object = entry.getExtension(atom.names.cmis_object);
    //Freemarker Sample Code
    <#assign cmis_object=entry.getExtension(atom.names.cmis_object)>

  • Methods

    • Method : createEntry

      • Help :

        Constructs an empty entry

      • Return : Empty entry

    • Method : getNames

      • Help :

        Gets pre-configured Atom Extensions (QNames)

      • Return : map of QNames by alias

    • Method : createFeed

      • Help :

        Constructs an empty feed

      • Return : Empty feed

    • Method : createQName

      • Help :

        Creates a QName

      • Return : QName

      • Parameters

        • Parameter : var0

          • Java Class : java.lang.String

          • Help :

            Uri string

        • Parameter : var1

          • Java Class : java.lang.String

          • Help :

            Local name

    • Method : toMimeType

      • Help :

        Establishs mimetype of atom content

      • Return : mimetype (or null, if it could not be established)

      • Parameters

        • Parameter : var0

          • Java Class : org.apache.abdera.model.Entry

          • Help :

            Entry

    • Method : toAtom

      • Help :

        Parses an Atom element

      • Return : Element

      • Parameters

        • Parameter : var0

          • Java Class : org.springframework.extensions.surf.util.Content

          • Help :

            Atom element

    • Method : toAtom

      • Help :

        Parses an Atom element

      • Return : Element

      • Parameters

        • Parameter : var0

          • Java Class : java.lang.String

          • Help :

            Atom element string

    • Method : toService

      • Help :

        Parses an Atom service

      • Return : Atom servce

      • Parameters

        • Parameter : var0

          • Java Class : org.springframework.extensions.surf.util.Content

          • Help :

            Atom entry

    • Method : toService

      • Help :

        Parses an Atom service

      • Return : Atom service

      • Parameters

        • Parameter : var0

          • Java Class : java.lang.String

          • Help :

            Atom entry string

    • Method : toEntry

      • Help :

        Parses an Atom Entry

      • Return : Entry

      • Parameters

        • Parameter : var0

          • Java Class : org.springframework.extensions.surf.util.Content

          • Help :

            Atom entry

    • Method : toEntry

      • Help :

        Parses an Atom entry

      • Return : Entry

      • Parameters

        • Parameter : var0

          • Java Class : java.lang.String

          • Help :

            Atom entry string

    • Method : toFeed

      • Help :

        Parses an Atom feed

      • Return : Feed

      • Parameters

        • Parameter : var0

          • Java Class : org.springframework.extensions.surf.util.Content

          • Help :

            Atom feed

    • Method : toFeed

      • Help :

        Parses an Atom feed

      • Return : Feed

      • Parameters

        • Parameter : var0

          • Java Class : java.lang.String

          • Help :

            Atom feed string

E.3. date

  • Java Class : java.util.Date

E.4. dateCompare

  • Java Class : org.springframework.extensions.webscripts.DateCompareMethod

  • Module Artifact Id : spring-webscripts

  • Module Group Id : Users.mindthegab.Dev.alfresco.workspace.spring-surf-parent.target.checkout.spring-webscripts

  • Module Version : target

  • Java Doc : link

  • Help :

    Perform a test to see how two dates compare, optionally offset by a specified number of
    milliseconds.

    Usage: 
      dateCompare(dateA, dateB) - 1 if dateA if greater than dateB
      dateCompare(dateA, dateB, millis) - 1 if dateA is greater than dateB by at least millis, else 0
      dateCompare(dateA, dateB, millis, test) - same as above, but the 'test' variable is one of the
      following strings ">", "<", "==" - greater than, less than or equal - as the test to perform.

  • Sample Code :

    <#if (dateCompare(child.properties["cm:modified"], date, 1000*60*60*24*7) == 1)>
    </#if>

  • Methods

E.5. encodeuri

  • Java Class : org.springframework.extensions.webscripts.UrlEncodeMethod

  • Module Artifact Id : spring-webscripts

  • Module Group Id : Users.mindthegab.Dev.alfresco.workspace.spring-surf-parent.target.checkout.spring-webscripts

  • Module Version : target

  • Java Doc : link

  • Help :

    Encode a URL Path.

    Usage: pathencode(String url)

  • Sample Code :

    <link rel="self" href="${absurl(encodeuri(url.full))?xml}"/>

  • Methods

E.6. jsonUtils

  • Java Class : org.springframework.extensions.webscripts.json.JSONUtils

  • Module Artifact Id : spring-webscripts

  • Module Group Id : Users.mindthegab.Dev.alfresco.workspace.spring-surf-parent.target.checkout.spring-webscripts

  • Module Version : target

  • Java Doc : link

  • Help :

    Collection of JSON Utility methods.

  • Sample Code :

    //JavaScript Sample Code
    var myObj = {'name':'Test Object','size':100};
    var myObjAsString = jsonUtils.toJSONString(myObj);
    
    //Freemarker Template Sample Code
    [
        <#list tags as tag>
            ${jsonUtils.encodeJSONString(tag)}<#if tag_has_next>,</#if>
        </#list>
    ]

  • Methods

    • Method : toObject

      • Help :

        Takes a JSON string and converts it to a native java script object

      • Sample Code :

        //JavaScript Sample Code
        model.postCode = jsonUtils.toObject(json).postCode;

      • Return : the created native JS object that represents the JSON object

      • Parameters

        • Parameter : var0

          • Java Class : java.lang.String

          • Help :

            A valid json string

    • Method : toObject

      • Help :

        Takes a JSON object and converts it to a native java script object

      • Sample Code :

        //JavaScript Sample Code
        model.postCode = jsonUtils.toObject(json).postCode;

      • Return : the created native object

      • Parameters

        • Parameter : var0

          • Java Class : org.json.JSONObject

          • Help :

            The json object

    • Method : toJSONString

      • Help :

        Converts a given JavaScript native object and converts it to the relevant JSON string.

      • Sample Code :

        //JavaScript Sample Code
        var myObj = {'name':'Test Object','size':100};
        var myObjAsString = jsonUtils.toJSONString(myObj);

      • Return : JSON string

      • Parameters

        • Parameter : var0

          • Java Class : java.lang.Object

          • Help :

            JavaScript object

    • Method : encodeJSONString

      • Help :

        Encodes a JSON string value

      • Return : Encoded value

      • Parameters

        • Parameter : var0

          • Java Class : java.lang.Object

          • Help :

            Value to encode

E.7. server

  • Java Class : org.springframework.extensions.webscripts.PresentationContainer$PresentationServerModel

  • Module Artifact Id : spring-webscripts

  • Module Group Id : Users.mindthegab.Dev.alfresco.workspace.spring-surf-parent.target.checkout.spring-webscripts

  • Module Version : target

  • Java Doc : link

E.8. stringUtils

  • Java Class : org.springframework.extensions.webscripts.ScriptableUtils

  • Module Artifact Id : spring-webscripts

  • Module Group Id : Users.mindthegab.Dev.alfresco.workspace.spring-surf-parent.target.checkout.spring-webscripts

  • Module Version : target

  • Java Doc : link

  • Help :

    Collection of script utility methods for working with strings etc.

  • Sample Code :

    //JavaScript Sample Code
    model.biohtml = stringUtils.replaceLineBreaks(bio);
    
    //Freemarker Template Sample Code
    ${stringUtils.stripUnsafeHTML(item.node.content)?substring(0, contentLength)}

  • Methods

    • Method : urlDecode

      • Help :

        Decodes input URL string

      • Return : Processed string

      • Parameters

        • Parameter : var0

          • Java Class : java.lang.String

          • Help :

            Input string

    • Method : stripEncodeUnsafeHTML

      • Help :

        Strips encode unsafe HTML tags from the input string

      • Return : Processed string

      • Parameters

        • Parameter : var0

          • Java Class : java.lang.String

          • Help :

            Input string

    • Method : stripUnsafeHTML

      • Help :

        Strips unsafe HTML tags from the input string

      • Return : Processed string

      • Parameters

        • Parameter : var0

          • Java Class : java.lang.String

          • Help :

            Input string

    • Method : replaceLineBreaks

      • Help :

        Replaces line breaks in the input string

      • Return : Processed string

      • Parameters

        • Parameter : var0

          • Java Class : java.lang.String

          • Help :

            Input string

    • Method : encodeHTML

      • Help :

        Encodes input HTML string

      • Return : Processed string

      • Parameters

        • Parameter : var0

          • Java Class : java.lang.String

          • Help :

            Input string

    • Method : encodeJavaScript

      • Help :

        Encodes input JavaScript string

      • Return : Processed string

      • Parameters

        • Parameter : var0

          • Java Class : java.lang.String

          • Help :

            Input string

    • Method : urlEncode

      • Help :

        Encodes input string using URLEncoder

      • Return : Processed string

      • Parameters

        • Parameter : var0

          • Java Class : java.lang.String

          • Help :

            Input string

    • Method : urlEncodeComponent

      • Help :

        Encode input URL string

      • Return : Processed string

      • Parameters

        • Parameter : var0

          • Java Class : java.lang.String

          • Help :

            Input string

    • Method : parseXMLNodeModel

      • Help :

        Converts an xml string to a freemarker node model

      • Return : Freemarker node model

      • Parameters

        • Parameter : var0

          • Java Class : java.lang.String

          • Help :

            Input XML string

E.9. xmldate

  • Java Class : org.springframework.extensions.webscripts.ISO8601DateFormatMethod

  • Module Artifact Id : spring-webscripts

  • Module Group Id : Users.mindthegab.Dev.alfresco.workspace.spring-surf-parent.target.checkout.spring-webscripts

  • Module Version : target

  • Java Doc : link

  • Help :

    Render Date to ISO8601 format. Or parse ISO6801 format string date to a Date object.

    Usage: xmldate(Date date)
            xmldate(String date)

  • Sample Code :

    <updated>${xmldate(date)}</updated>

  • Methods