* spring.ftl * * This file consists of a collection of FreeMarker macros aimed at easing * some of the common requirements of web applications - in particular * handling of forms. * * Spring's FreeMarker support will automatically make this file and therefore * all macros within it available to any application using Spring's * FreeMarkerConfigurer. * * To take advantage of these macros, the "exposeSpringMacroHelpers" property * of the FreeMarker class needs to be set to "true". This will expose a * RequestContext under the name "springMacroRequestContext", as needed by * the macros in this library. * * @author Darren Davison * @author Juergen Hoeller * @since 1.1 --> * message * * Macro to translate a message code into a message. --> ${springMacroRequestContext.getMessage(code)} * messageText * * Macro to translate a message code into a message, * using the given default text if no message found. --> ${springMacroRequestContext.getMessage(code, text)} * url * * Takes a relative URL and makes it absolute from the server root by * adding the context root for the web application. --> ${springMacroRequestContext.getContextPath()}${relativeUrl} * bind * * Exposes a BindStatus object for the given bind path, which can be * a bean (e.g. "person") to get global errors, or a bean property * (e.g. "person.name") to get field errors. Can be called multiple times * within a form to bind to multiple command objects and/or field names. * * This macro will participate in the default HTML escape setting for the given * RequestContext. This can be customized by calling "setDefaultHtmlEscape" * on the "springMacroRequestContext" context variable, or via the * "defaultHtmlEscape" context-param in web.xml (same as for the JSP bind tag). * Also regards a "htmlEscape" variable in the namespace of this library. * * Producing no output, the following context variable will be available * each time this macro is referenced (assuming you import this library in * your templates with the namespace 'spring'): * * spring.status : a BindStatus instance holding the command object name, * expression, value, and error messages and codes for the path supplied * * @param path : the path (string value) of the value required to bind to. * Spring defaults to a command name of "command" but this can be overridden * by user config. --> kind of variable. This temp value is only used in this macro lib --> * bindEscaped * * Similar to spring:bind, but takes an explicit HTML escape flag rather * than relying on the default HTML escape setting. --> kind of variable. This temp value is only used in this macro lib --> * formInput * * Display a form input field of type 'text' and bind it to an attribute * of a command or bean. * * @param path the name of the field to bind to * @param attributes any additional attributes for the element (such as class * or CSS styles or size --> * formPasswordInput * * Display a form input field of type 'password' and bind it to an attribute * of a command or bean. No value will ever be displayed. This functionality * can also be obtained by calling the formInput macro with a 'type' parameter * of 'password'. * * @param path the name of the field to bind to * @param attributes any additional attributes for the element (such as class * or CSS styles or size --> * formHiddenInput * * Generate a form input field of type 'hidden' and bind it to an attribute * of a command or bean. This functionality can also be obtained by calling * the formInput macro with a 'type' parameter of 'hidden'. * * @param path the name of the field to bind to * @param attributes any additional attributes for the element (such as class * or CSS styles or size --> * formTextarea * * Display a text area and bind it to an attribute of a command or bean. * * @param path the name of the field to bind to * @param attributes any additional attributes for the element (such as class * or CSS styles or size --> ${stringStatusValue} * formSingleSelect * * Show a selectbox (dropdown) input element allowing a single value to be chosen * from a list of options. * * @param path the name of the field to bind to * @param options a map (value=label) of all the available options * @param attributes any additional attributes for the element (such as class * or CSS styles or size --> ${options[value]} * formMultiSelect * * Show a listbox of options allowing the user to make 0 or more choices from * the list of options. * * @param path the name of the field to bind to * @param options a map (value=label) of all the available options * @param attributes any additional attributes for the element (such as class * or CSS styles or size --> ${options[value]} * formRadioButtons * * Show radio buttons. * * @param path the name of the field to bind to * @param options a map (value=label) of all the available options * @param separator the html tag or other character list that should be used to * separate each option. Typically ' ' or '' * @param attributes any additional attributes for the element (such as class * or CSS styles or size --> checked="checked" ${attributes} ${options[value]}${separator} * formCheckboxes * * Show checkboxes. * * @param path the name of the field to bind to * @param options a map (value=label) of all the available options * @param separator the html tag or other character list that should be used to * separate each option. Typically ' ' or '' * @param attributes any additional attributes for the element (such as class * or CSS styles or size --> checked="checked" ${attributes} ${options[value]}${separator} * showErrors * * Show validation errors for the currently bound field, with * optional style attributes. * * @param separator the html tag or other character list that should be used to * separate each option. Typically ''. * @param classOrStyle either the name of a CSS class element (which is defined in * the template or an external CSS file) or an inline style. If the value passed in here * contains a colon (:) then a 'style=' attribute will be used, else a 'class=' attribute * will be used. --> ${error} ${error} ${separator} * checkSelected * * Check a value in a list to see if it is the currently selected value. * If so, add the 'selected="selected"' text to the output. * Handles values of numeric and string types. * This function is used internally but can be accessed by user code if required. * * @param value the current value in a list iteration --> selected="selected" selected="selected" * contains * * Macro to return true if the list contains the scalar, false if not. * Surprisingly not a FreeMarker builtin. * This function is used internally but can be accessed by user code if required. * * @param list the list to search for the item * @param item the item to search for in the list * @return true if item is found in the list, false otherwise --> * closeTag * * Simple macro to close an HTML tag that has no body with '>' or '/>', * depending on the value of a 'xhtmlCompliant' variable in the namespace * of this library. --> />>
