You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@ofbiz.apache.org by ad...@apache.org on 2011/06/20 14:00:39 UTC
svn commit: r1137603 -
/ofbiz/trunk/framework/widget/templates/htmlFormMacroLibrary.ftl
Author: adrianc
Date: Mon Jun 20 12:00:39 2011
New Revision: 1137603
URL: http://svn.apache.org/viewvc?rev=1137603&view=rev
Log:
Documentation for the renderLookupField Freemarker macro.
Modified:
ofbiz/trunk/framework/widget/templates/htmlFormMacroLibrary.ftl
Modified: ofbiz/trunk/framework/widget/templates/htmlFormMacroLibrary.ftl
URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/widget/templates/htmlFormMacroLibrary.ftl?rev=1137603&r1=1137602&r2=1137603&view=diff
==============================================================================
--- ofbiz/trunk/framework/widget/templates/htmlFormMacroLibrary.ftl (original)
+++ ofbiz/trunk/framework/widget/templates/htmlFormMacroLibrary.ftl Mon Jun 20 12:00:39 2011
@@ -543,6 +543,39 @@ ${item.description}</span>
</#if>
</#macro>
+<#--
+@renderLookupField
+
+Description: Renders a text input field as a lookup field.
+
+Parameter: className, String, optional - The CSS class name for the lookup field.
+Parameter: alert, String, optional - If "true" then the "alert" CSS class will be added to the lookup field.
+Parameter: name, String, required - The name of the lookup field.
+Parameter: value, String, optional - The value of the lookup field.
+Parameter: size, String, optional - The size of the lookup field.
+Parameter: maxlength, String or Integer, optional - The max length of the lookup field.
+Parameter: id, String or Integer, optional - The ID of the lookup field.
+Parameter: event, String, optional - The lookup field event that invokes "action". If the event parameter is not empty, then the action parameter must be specified as well.
+Parameter: action, String, optional - The action that is invoked on "event". If action parameter is not empty, then the event parameter must be specified as well.
+Parameter: readonly, boolean, optional - If true, the lookup field is made read-only.
+Parameter: autocomplete, String, optional - If not empty, autocomplete is turned off for the lookup field.
+Parameter: descriptionFieldName, String, optional - If not empty and the presentation parameter contains "window", specifies an alternate input field for updating.
+Parameter: formName, String, required - The name of the form that contains the lookup field.
+Parameter: fieldFormName, String, optional - Contains the lookup window form name, used only when the presentation parameter contains "window".
+Parameter: targetParameterIter, List, optional - Contains a list of form field names whose values will be passed to the lookup window.
+Parameter: imgSrc, Not used.
+Parameter: ajaxUrl, String, optional - Contains the Ajax URL, used only when the ajaxEnabled parameter contains true.
+Parameter: ajaxEnabled, boolean, optional - If true, invokes the Ajax auto-completer.
+Parameter: presentation, String, optional - Contains the lookup window type, either "layer" or "window".
+Parameter: width, String or Integer, optional - The width of the lookup field.
+Parameter: height, String or Integer, optional - The height of the lookup field.
+Parameter: position, String, optional - The position style of the lookup field.
+Parameter: fadeBackground, ?
+Parameter: clearText, String, optional - If the readonly parameter is true, clearText contains the text to be displayed in the field.
+Parameter: showDescription, String, optional - ? (contains "true" or "false").
+Parameter: initiallyCollapsed, Not used.
+Parameter: lastViewName, String, optional - If the ajaxEnabled parameter is true, the contents of lastViewName will be appended to the Ajax URL.
+-->
<#macro renderLookupField className alert name value size maxlength id event action readonly autocomplete descriptionFieldName formName fieldFormName targetParameterIter imgSrc ajaxUrl ajaxEnabled presentation width height position fadeBackground clearText showDescription initiallyCollapsed lastViewName="main" >
<#if ajaxEnabled?has_content && ajaxEnabled>
<script type="text/javascript">
Re: svn commit: r1137603 - /ofbiz/trunk/framework/widget/templates/htmlFormMacroLibrary.ftl
Posted by Adrian Crum <ad...@sandglass-software.com>.
I left a few parameters with question marks, because I was unable to
determine what they do. If anyone has any additional information, please
let me know.
-Adrian
On 6/20/2011 1:00 PM, adrianc@apache.org wrote:
> Author: adrianc
> Date: Mon Jun 20 12:00:39 2011
> New Revision: 1137603
>
> URL: http://svn.apache.org/viewvc?rev=1137603&view=rev
> Log:
> Documentation for the renderLookupField Freemarker macro.
>
> Modified:
> ofbiz/trunk/framework/widget/templates/htmlFormMacroLibrary.ftl
>
> Modified: ofbiz/trunk/framework/widget/templates/htmlFormMacroLibrary.ftl
> URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/widget/templates/htmlFormMacroLibrary.ftl?rev=1137603&r1=1137602&r2=1137603&view=diff
> ==============================================================================
> --- ofbiz/trunk/framework/widget/templates/htmlFormMacroLibrary.ftl (original)
> +++ ofbiz/trunk/framework/widget/templates/htmlFormMacroLibrary.ftl Mon Jun 20 12:00:39 2011
> @@ -543,6 +543,39 @@ ${item.description}</span>
> </#if>
> </#macro>
>
> +<#--
> +@renderLookupField
> +
> +Description: Renders a text input field as a lookup field.
> +
> +Parameter: className, String, optional - The CSS class name for the lookup field.
> +Parameter: alert, String, optional - If "true" then the "alert" CSS class will be added to the lookup field.
> +Parameter: name, String, required - The name of the lookup field.
> +Parameter: value, String, optional - The value of the lookup field.
> +Parameter: size, String, optional - The size of the lookup field.
> +Parameter: maxlength, String or Integer, optional - The max length of the lookup field.
> +Parameter: id, String or Integer, optional - The ID of the lookup field.
> +Parameter: event, String, optional - The lookup field event that invokes "action". If the event parameter is not empty, then the action parameter must be specified as well.
> +Parameter: action, String, optional - The action that is invoked on "event". If action parameter is not empty, then the event parameter must be specified as well.
> +Parameter: readonly, boolean, optional - If true, the lookup field is made read-only.
> +Parameter: autocomplete, String, optional - If not empty, autocomplete is turned off for the lookup field.
> +Parameter: descriptionFieldName, String, optional - If not empty and the presentation parameter contains "window", specifies an alternate input field for updating.
> +Parameter: formName, String, required - The name of the form that contains the lookup field.
> +Parameter: fieldFormName, String, optional - Contains the lookup window form name, used only when the presentation parameter contains "window".
> +Parameter: targetParameterIter, List, optional - Contains a list of form field names whose values will be passed to the lookup window.
> +Parameter: imgSrc, Not used.
> +Parameter: ajaxUrl, String, optional - Contains the Ajax URL, used only when the ajaxEnabled parameter contains true.
> +Parameter: ajaxEnabled, boolean, optional - If true, invokes the Ajax auto-completer.
> +Parameter: presentation, String, optional - Contains the lookup window type, either "layer" or "window".
> +Parameter: width, String or Integer, optional - The width of the lookup field.
> +Parameter: height, String or Integer, optional - The height of the lookup field.
> +Parameter: position, String, optional - The position style of the lookup field.
> +Parameter: fadeBackground, ?
> +Parameter: clearText, String, optional - If the readonly parameter is true, clearText contains the text to be displayed in the field.
> +Parameter: showDescription, String, optional - ? (contains "true" or "false").
> +Parameter: initiallyCollapsed, Not used.
> +Parameter: lastViewName, String, optional - If the ajaxEnabled parameter is true, the contents of lastViewName will be appended to the Ajax URL.
> +-->
> <#macro renderLookupField className alert name value size maxlength id event action readonly autocomplete descriptionFieldName formName fieldFormName targetParameterIter imgSrc ajaxUrl ajaxEnabled presentation width height position fadeBackground clearText showDescription initiallyCollapsed lastViewName="main">
> <#if ajaxEnabled?has_content&& ajaxEnabled>
> <script type="text/javascript">
>
>