ofbiz_screen_widget_cookbook

junmail

浏览: 1762899 次
性别:
来自: 成都

最近访客更多访客>>

devcang

紫水兰

lf78204490

xiaolong0211

博主相关

博客

微博

相册

留言

关于我

文章分类

社区版块

存档分类

博客分类：

OFBIZ

THE SCREEN-WIDGET COOKBOOK

==========================

This document is a series of HOWTOs on using the OFBIZ screen-widget to create screens.

* How to check for a permission FOO_ACTION and render a widget if it passes or a failure widget if it fails

<decorator-section name="foo">

<fail-widgets>

<label style="head3">${uiLabelMap.FooActionPermissionError}</label>

</fail-widgets>

</section>

</decorator-section>

* How to test a value in the context to see if widgets should render or not

<widgets> These will render if condition passes </widgets>

<fail-widgets> Otherwise, these widgets will render </fail-widgets>

</section>

- You can place the <section> block anywhere underneath a <widgets> or <fail-widgets> to acheive nested conditions:

<widgets> ....

<widgets> ...

</section>

</widgets>

<fail-widgets><section>...</section></fail-widgets>

</section>

</widgets>

- You can group conditions by wrapping them with <and>, <or>, <xor> and inverse the sense with <not>:

- There is a <if-empty field="fieldName"> condition for testing if a value is null or not-defined

* Note on using uiLabelMap within screens

Usually the "main-decorator" would define the uiLabelMap, but these cannot be accessed from higher level screens due to the way

<actions> are executed. Avoid using uiLabelMaps within the screens except in the <widgets> section. Instead, define the name of

the map to be called, such as "CommonLogin" in a parameter and then call this uiLabelMap from within the template file. For example,

</actions>

<label style="head3">${uiLabelMap.CommonLogin}</label>

</widgets>

This especially applies to page titles you might want to set for specific screens. That's why you see screen sections define a pageTitleLabel="CommonLogin"

rather than reference uiLabelMap directly.

* How to set data in the <actions> tag for later use

* How to get a single enity in the <actions> section and store in a value

<entity-one entity-name="EntityName" value-name="entityValue"/>

* How to create a two column screen. This comes from a real main-decorator

<platform-specific><html><html-template location="component://crmsfa/webapp/crmsfa/includes/subheader.ftl"/></html></platform-specific>

TODO: insert code to show explicit columns

<include-screen name="${shortcutsScreenName}"/>

<platform-specific><html><html-template location="component://common/webcommon/includes/messages.ftl"/></html></platform-specific>

<decorator-section-include name="section-decorator"/>

</container>

* How to accept a partyId parameter from a link and also have a partyId input parameter in a form without conflict

If you wish to have a form that accepts a partyId but also fills it in from a URL parameter, you may run into an error where the partyId was read as an

array with two values. This is because the screen widget isn't very smart about handling request parameters + forms. It will combine the URL parameter partyId

and the form parameter partyId into an array keyed to parameters.get("partyId"). order to get around this, do the following at the top of your beanshell

script before the form is rendered.

partyId = request.getParameter("partyId"); // check actual URL parameters first

if (partyId == null) parameters.get("partyId"); // if none, it's safe that this is a form parameter and not an array

* Setting properties file values

You can set values from .properties files for use in the screens by doing this:

<property-field field="defaultCurrencyUomId" resource="general" property="currency.uom.id.default" default="USD"/>

where resource denotes which properties file (in this case, "general.properties") and the property is the property to use.

Note that this does not have a global="true" attribute, so it can only be set for the screen that is using it, not globally

in a decorator.

* Paginating your forms

You need to set the VIEW_INDEX and VIEW_SIZE in your form-widget so that your forms will paginate properly. They can be set in the

<actions> section of your screen like this:

In opentaps 0.9 and earlier versions, make sure you set those default-values. Otherwise, your first page might be a negative value,

or your screen might show 100 records at a time.

If you are using an older version of ofbiz and need to pass additional

parameters with the Next and Previous links, put a parameter "queryString"

in the <actions> section as follows,

* Order of Execution of <actions>

TODO: describe the problem with the order of execution of <actions>, the

need to set some global variables, and how to work around it. For instance,

we can't do this,

</actions>

<!-- include the GlobalDecorator's main-decorator here, which

has an <actions> that sets the uiLabelMap. -->

</widgets>

That is because the first actions to be executed are the ones in the screen

that is invoked. This is an event-based parsing system and is quite logical.

* How to set a conditional header item

In the financials application, the same payment screen could belong in either the Receivables or Payables tab, so we had to set it conditionally like this:

in the editPayment.bsh, inside an if block:

parameters.put("headerItem","receivables");

in the PaymentScreens.xml AFTER the .bsh is executed:

* How to access page attributes in screens

The screen widget sets a Map (actually a javolution FastMap) called "page" which can be used in the Freemarker and Beanshell templates to access

the parameters set in the screen. Here is an example of it from the ecommerce application:

page = [leftbarScreenName=leftbar, rightbarScreenName=rightbar, MainColumnStyle=nocolumns, titleProperty=PageTitleCategoryPage, layoutSettings=[extraHead=<link rel="stylesheet" href="/content/images/contentForum.css" type="text/css"/>]]

and here is an example of how to use it in the FTL, from header.ftl of the ecommerce application:

<#if page.title?has_content>${page.title}<#elseif page.titleProperty?has_content>${uiLabelMap.get(page.titleProperty)}</#if>

分享到：

screen widget 框架页面生成原理初探 | Eclipse集成Groovy插件（以eclipse-4.3.0 ...

2014-05-21 18:59
浏览 1591
评论(0)
分类:编程语言
查看更多

发表评论

您还没有登录,请您登录后再发表评论

最近访客更多访客>>

博主相关

文章分类

社区版块

存档分类

最新评论