Files
ofbiz-framework/applications/accounting/widget/CommonScreens.xml
T
Nicolas Malin 7165768251 Implemented: Add a framework method to get main webapp menu with the webapp name
(OFBIZ-10601)

To improve theme management and provide better tools for new themes, we implement a method to obtain the main menu of a webapp.
Instead of just managing a menu, we extend the functionality by offering a method to expose a summary of the webapp, to simplify the navigation.

For this we add a new attribute on webapp definition app-shortcut-screen :

    <webapp name="mywebapp"
            ...
            app-shortcut-screen="component://mycomponent/widget/CommonScreens.xml#ShortcutApp"
            ...
    />

The idea is to define a new purpose screen *Shortcut* that contains what defines a webapp when an action or navigation has been requested. With this screen you can load a menu, a search, a complex description and use all screen powerfulness to resolve what displaying and support by theming

    <screen name="ShortcutApp">
        <section>
            <actions>
                <property-map resource="CommonUiLabels" map-name="uiLabelMap" global="true"/>
            </actions>
            <widgets>
                <decorator-screen name="ShortcutDecorator" location="component://common/widget/CommonScreens.xml">
                    <decorator-section name="body">
                        <include-menu name="MyShortcutAppBar" location="component://mycomponent/widget/CommonMenus.xml"/>
                    </decorator-section>
                </decorator-screen>
            </widgets>
        </section>
    </screen>

Each component are self-sufficient to define what shortcuts to display without framework change or knowledge about other component.
Each theme can implement and customize the display rendering at will.

To illustrate an example of implementation we set sub menu for each webapp defined on applications and exploit it on bluelight theme.

Thanks for Dennis Balkir, Jacques Leroux, Leila Mekika and Julien Nicolas for their involvement
2021-01-15 08:56:23 +01:00

357 lines
19 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
<screens xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://ofbiz.apache.org/Widget-Screen" xsi:schemaLocation="http://ofbiz.apache.org/Widget-Screen http://ofbiz.apache.org/dtds/widget-screen.xsd">
<screen name="main-decorator">
<section>
<actions>
<property-map resource="AccountingUiLabels" map-name="uiLabelMap" global="true"/>
<property-map resource="PartyUiLabels" map-name="uiLabelMap" global="true"/>
<property-map resource="ProductUiLabels" map-name="uiLabelMap" global="true"/>
<property-map resource="OrderUiLabels" map-name="uiLabelMap" global="true"/>
<property-map resource="WorkEffortUiLabels" map-name="uiLabelMap" global="true"/>
<property-map resource="ManufacturingUiLabels" map-name="uiLabelMap" global="true"/>
<property-map resource="CommonUiLabels" map-name="uiLabelMap" global="true"/>
<set field="layoutSettings.companyName" from-field="uiLabelMap.AccountingCompanyName" global="true"/>
<set field="layoutSettings.companySubtitle" from-field="uiLabelMap.AccountingCompanySubtitle" global="true"/>
<!-- layoutSettings.headerImageUrl can be used to specify an application specific logo; if not set,
then the global layoutSettings.commonHeaderImageUrl (specified in GlobalDecorator) will be used. -->
<!--<set field="layoutSettings.headerImageUrl" value="/images/ofbiz_logo.png" global="true"/>-->
<set field="activeApp" value="accounting" global="true"/>
<set field="applicationMenuName" value="AccountingAppBar" global="true"/>
<set field="applicationMenuLocation" value="component://accounting/widget/AccountingMenus.xml" global="true"/>
<set field="applicationTitle" from-field="uiLabelMap.AccountingManagerApplication" global="true"/>
<set field="helpAnchor" from-field="helpAnchor" default-value="_accounting"/>
</actions>
<widgets>
<include-screen name="ApplicationDecorator" location="component://commonext/widget/CommonScreens.xml"/>
</widgets>
</section>
</screen>
<screen name="ShortcutApp">
<section>
<actions>
<property-map resource="AccountingUiLabels" map-name="uiLabelMap" global="true"/>
<property-map resource="PartyUiLabels" map-name="uiLabelMap" global="true"/>
</actions>
<widgets>
<decorator-screen name="ShortcutDecorator" location="component://common/widget/CommonScreens.xml">
<decorator-section name="body">
<include-menu name="AccountingShortcutAppBar" location="component://accounting/widget/AccountingMenus.xml"/>
</decorator-section>
</decorator-screen>
</widgets>
</section>
</screen>
<screen name="CommonFinAccountDecorator">
<section>
<actions>
<set field="headerItem" value="FindFinAccount"/>
<entity-one entity-name="FinAccount" value-field="finAccount"/>
</actions>
<widgets>
<decorator-screen name="main-decorator" location="${parameters.mainDecoratorLocation}">
<decorator-section name="pre-body">
<section>
<condition>
<if-service-permission service-name="acctgFinAcctPermissionCheck" main-action="VIEW"/>
</condition>
<widgets>
<section>
<condition><not><if-empty field="finAccountId"/></not></condition>
<widgets>
<include-menu name="FinAccountTabBar" location="component://accounting/widget/AccountingMenus.xml"/>
</widgets>
<fail-widgets>
<include-menu name="FinAccountMainTabBar" location="component://accounting/widget/AccountingMenus.xml"/>
</fail-widgets>
</section>
</widgets>
</section>
</decorator-section>
<decorator-section name="body">
<section>
<condition>
<not><if-service-permission service-name="acctgFinAcctPermissionCheck" main-action="VIEW"/></not>
</condition>
<widgets>
<label style="h3" text="${uiLabelMap.AccountingViewPermissionError}"/>
</widgets>
</section>
<decorator-section-include name="body"/>
</decorator-section>
</decorator-screen>
</widgets>
</section>
</screen>
<screen name="CommonPaymentDecorator">
<section>
<actions>
<set field="headerItem" value="payments"/>
</actions>
<widgets>
<decorator-screen name="main-decorator" location="${parameters.mainDecoratorLocation}">
<decorator-section name="pre-body">
<section>
<condition>
<if-service-permission service-name="acctgBasePermissionCheck" main-action="VIEW"/>
</condition>
<widgets>
<include-menu name="PaymentTabBar" location="component://accounting/widget/AccountingMenus.xml"/>
</widgets>
</section>
</decorator-section>
<decorator-section name="body">
<section>
<!-- do check for ACCOUNTING, _VIEW permission -->
<condition>
<if-service-permission service-name="acctgBasePermissionCheck" main-action="VIEW"/>
</condition>
<widgets>
<container style="leftclear">
<section>
<condition>
<not><if-empty field="paymentId"/></not>
</condition>
<widgets>
<include-menu name="PaymentSubTabBar" location="component://accounting/widget/AccountingMenus.xml"/>
<label style="h1" text="${uiLabelMap[labelTitleProperty]} ${uiLabelMap.CommonId}:[${paymentId}] ${${extraFunctionName}}"/>
</widgets>
</section>
</container>
<decorator-section-include name="body"/>
</widgets>
<fail-widgets>
<label style="h3" text="${uiLabelMap.AccountingViewPermissionError}"/>
</fail-widgets>
</section>
</decorator-section>
</decorator-screen>
</widgets>
</section>
</screen>
<screen name="CommonPaymentGroupDecorator">
<section>
<actions>
<set field="headerItem" value="PaymentGroup"/>
<set field="paymentGroupId" from-field="parameters.paymentGroupId"/>
<entity-one entity-name="PaymentGroup" value-field="paymentGroup"/>
<entity-and entity-name="PaymentGroupMember" list="paymentGroupMembers" filter-by-date="true">
<field-map field-name="paymentGroupId"/>
</entity-and>
</actions>
<widgets>
<decorator-screen name="main-decorator">
<decorator-section name="pre-body">
<section>
<condition>
<and>
<if-service-permission service-name="acctgBasePermissionCheck" main-action="VIEW"/>
<not><if-empty field="paymentGroup"/></not>
</and>
</condition>
<widgets>
<include-menu name="PaymentGroupTabBar" location="component://accounting/widget/AccountingMenus.xml"/>
</widgets>
</section>
</decorator-section>
<decorator-section name="body">
<section>
<!-- do check for ACCOUNTING, _VIEW permission -->
<condition>
<if-service-permission service-name="acctgBasePermissionCheck" main-action="VIEW"/>
</condition>
<widgets>
<section>
<condition>
<not><if-empty field="paymentGroup"/></not>
</condition>
<widgets>
<include-menu name="PaymentGroupSubTabBar" location="component://accounting/widget/AccountingMenus.xml"/>
<label style="h1">${uiLabelMap[titleProperty]} ${uiLabelMap.CommonFor} ${paymenGroup.paymentGroupName} [${paymentGroupId}]</label>
</widgets>
<fail-widgets>
<label style="h1">${uiLabelMap.AccountingNewPaymentGroup}</label>
</fail-widgets>
</section>
<decorator-section-include name="body"/>
</widgets>
<fail-widgets>
<label style="h3">${uiLabelMap.AccountingViewPermissionError}</label>
</fail-widgets>
</section>
</decorator-section>
</decorator-screen>
</widgets>
</section>
</screen>
<screen name="CommonPartyDecorator">
<section>
<actions>
<set field="headerItem" value="companies"/>
</actions>
<widgets>
<decorator-screen name="main-decorator" location="${parameters.mainDecoratorLocation}">
<decorator-section name="pre-body">
<section>
<condition>
<not><if-empty field="organizationPartyId"/></not>
</condition>
<widgets>
<label style="h1">${uiLabelMap[labelTitleProperty]} ${uiLabelMap.CommonFor}: ${currentOrganization.groupName} [${organizationPartyId}]</label>
<include-menu name="PartyTopTabBar" location="component://accounting/widget/AccountingMenus.xml"/>
</widgets>
</section>
</decorator-section>
<decorator-section name="body">
<section>
<condition>
<not><if-empty field="organizationPartyId"/></not>
</condition>
<widgets>
<decorator-section-include name="body"/>
</widgets>
</section>
</decorator-section>
</decorator-screen>
</widgets>
</section>
</screen>
<screen name="CommonOrganizationAccountingReportsDecorator">
<section>
<actions>
<set field="tabButtonItemTop" value="PartyAccounts"/>
<entity-one entity-name="PartyNameView" value-field="currentOrganization" auto-field-map="false">
<field-map field-name="partyId" value="${groovy:parameters.get('ApplicationDecorator|organizationPartyId')}"/>
</entity-one>
</actions>
<widgets>
<decorator-screen name="CommonPartyDecorator" location="${parameters.partyDecoratorLocation}">
<decorator-section name="body">
<include-menu name="OrganizationAccountingTabBar" location="component://accounting/widget/AccountingMenus.xml"/>
<include-menu name="OrganizationAccountingReportsTabBar" location="component://accounting/widget/AccountingMenus.xml"/>
<decorator-section-include name="body"/>
</decorator-section>
</decorator-screen>
</widgets>
</section>
</screen>
<screen name="CommonAdminChecksDecorator">
<section>
<actions>
<set field="tabButtonItemTop" value="PartyAccounts"/>
<entity-one entity-name="PartyNameView" value-field="currentOrganization" auto-field-map="false">
<field-map field-name="partyId" value="${groovy:parameters.get('ApplicationDecorator|organizationPartyId')}"/>
</entity-one>
</actions>
<widgets>
<decorator-screen name="CommonPartyDecorator" location="${parameters.partyDecoratorLocation}">
<decorator-section name="body">
<include-menu name="OrganizationAccountingTabBar" location="component://accounting/widget/AccountingMenus.xml"/>
<include-menu name="PartyAccountingChecksTabBar" location="component://accounting/widget/AccountingMenus.xml"/>
<label style="h1">${uiLabelMap.CommonFor}: ${currentOrganization.groupName} [${organizationPartyId}]</label>
<decorator-section-include name="checks-body"/>
</decorator-section>
</decorator-screen>
</widgets>
</section>
</screen>
<screen name="main">
<section>
<condition>
<if-service-permission service-name="acctgBasePermissionCheck" main-action="VIEW"/>
</condition>
<actions>
<set field="headerItem" value="main"/>
<set field="helpAnchor" value="_help_for_accounting_main_screen"/>
<entity-condition entity-name="PaymentType" list="paymentTypes">
<order-by field-name="paymentTypeId"/>
</entity-condition>
<entity-condition entity-name="InvoiceType" list="invoiceTypes">
<order-by field-name="invoiceTypeId"/>
</entity-condition>
<entity-condition entity-name="PaymentMethodType" list="paymentMethodTypes">
<order-by field-name="paymentMethodTypeId"/>
</entity-condition>
<entity-condition entity-name="StatusItem" list="invoiceStatus">
<condition-expr field-name="statusTypeId" operator="equals" value="INVOICE_STATUS"/>
<order-by field-name="statusId"/>
</entity-condition>
<entity-condition entity-name="StatusItem" list="paymentStatus">
<condition-expr field-name="statusTypeId" operator="equals" value="PMNT_STATUS"/>
<order-by field-name="statusId"/>
</entity-condition>
</actions>
<widgets>
<decorator-screen name="main-decorator" location="${parameters.mainDecoratorLocation}">
<decorator-section name="body">
<screenlet title="${uiLabelMap.AccountingMainPage}">
<platform-specific><html><html-template location="component://accounting/template/Main.ftl"/></html></platform-specific>
</screenlet>
</decorator-section>
</decorator-screen>
</widgets>
</section>
</screen>
<screen name="creditCardFields">
<section>
<widgets>
<platform-specific><html><html-template location="component://accounting/template/common/CreditCardFields.ftl"/></html></platform-specific>
</widgets>
</section>
</screen>
<screen name="GlobalGLSettingsDecorator">
<section>
<actions>
<set field="headerItem" value="GlobalGLSettings"/>
</actions>
<widgets>
<decorator-screen name="main-decorator" location="${parameters.mainDecoratorLocation}">
<decorator-section name="pre-body">
<include-menu name="GlobalGLSettingMenus" location="component://accounting/widget/AccountingMenus.xml"/>
</decorator-section>
<decorator-section name="body">
<decorator-section-include name="body"/>
</decorator-section>
</decorator-screen>
</widgets>
</section>
</screen>
<screen name="CommonInvoiceDecorator"><!-- used for invoice commission runs -->
<section>
<widgets>
<include-screen name="CommonInvoiceDecorator" location="component://accounting/widget/InvoiceScreens.xml"/>
</widgets>
</section>
</screen>
</screens>