GovernmentBodyOverviewPageModContentFactoryImpl.java

  1. /*
  2.  * Copyright 2010-2025 James Pether Sörling
  3.  *
  4.  * Licensed under the Apache License, Version 2.0 (the "License");
  5.  * you may not use this file except in compliance with the License.
  6.  * You may obtain a copy of the License at
  7.  *
  8.  *   http://www.apache.org/licenses/LICENSE-2.0
  9.  *
  10.  * Unless required by applicable law or agreed to in writing, software
  11.  * distributed under the License is distributed on an "AS IS" BASIS,
  12.  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13.  * See the License for the specific language governing permissions and
  14.  * limitations under the License.
  15.  *
  16.  *  $Id$
  17.  *  $HeadURL$
  18. */
  19. package com.hack23.cia.web.impl.ui.application.views.user.govermentbody.pagemode;

  21. import java.util.List;

  23. import org.springframework.security.access.annotation.Secured;
  24. import org.springframework.stereotype.Component;

  26. import com.hack23.cia.model.internal.application.system.impl.ApplicationEventGroup;
  27. import com.hack23.cia.service.external.esv.api.GovernmentBodyAnnualSummary;
  28. import com.hack23.cia.web.impl.ui.application.action.ViewAction;
  29. import com.hack23.cia.web.impl.ui.application.views.common.menufactory.api.pagecommands.PageCommandGovernmentBodyConstants;
  30. import com.hack23.cia.web.impl.ui.application.views.common.pagemode.CardInfoRowUtil;
  31. import com.hack23.cia.web.impl.ui.application.views.common.sizing.ContentRatio;
  32. import com.vaadin.icons.VaadinIcons;
  33. import com.vaadin.server.Responsive;
  34. import com.vaadin.ui.HorizontalLayout;
  35. import com.vaadin.ui.Layout;
  36. import com.vaadin.ui.MenuBar;
  37. import com.vaadin.ui.Panel;
  38. import com.vaadin.ui.VerticalLayout;

  40. /**
  41.  * The Class GovernmentBodyOverviewPageModContentFactoryImpl.
  42.  */
  43. @Component
  44. public final class GovernmentBodyOverviewPageModContentFactoryImpl
  45.         extends AbstractGovernmentBodyPageModContentFactoryImpl {

  47.     /**
  48.      * Instantiates a new government body overview page mod content factory impl.
  49.      */
  50.     public GovernmentBodyOverviewPageModContentFactoryImpl() {
  51.         super();
  52.     }

  54.     @Secured({ "ROLE_ANONYMOUS", "ROLE_USER", "ROLE_ADMIN" })
  55.     @Override
  56.     public Layout createContent(final String parameters, final MenuBar menuBar, final Panel panel) {
  57.         final VerticalLayout panelContent = createPanelContent();
  58.         panel.setContent(panelContent);

  60.         final String pageId = getPageId(parameters);
  61.         final List<GovernmentBodyAnnualSummary> item = getItem(parameters);

  63.         if (item != null && !item.isEmpty()) {
  64.             final GovernmentBodyAnnualSummary governmentBodyAnnualSummary = item.get(0);

  66.             getGovernmentBodyMenuItemFactory().createGovernmentBodyMenuBar(menuBar, pageId, governmentBodyAnnualSummary.getName());

  68.             createPageHeader(panel, panelContent, governmentBodyAnnualSummary);
  69.             createMainCard(panelContent, governmentBodyAnnualSummary, pageId);

  71.             getPageActionEventHelper().createPageEvent(ViewAction.VISIT_GOVERNMENT_BODY_VIEW,
  72.                     ApplicationEventGroup.USER, NAME, parameters, pageId);
  73.         }

  75.         return panelContent;
  76.     }

  78.     /**
  79.      * Creates the page header.
  80.      *
  81.      * @param panel the panel
  82.      * @param panelContent the panel content
  83.      * @param govBody the gov body
  84.      */
  85.     private void createPageHeader(final Panel panel, final VerticalLayout panelContent, final GovernmentBodyAnnualSummary govBody) {
  86.         CardInfoRowUtil.createPageHeader(panel, panelContent,
  87.             formatTitle(govBody, GovernmentBodyDescriptionConstants.OVERVIEW_HEADER),
  88.             GovernmentBodyDescriptionConstants.OVERVIEW_SUBTITLE,
  89.             GovernmentBodyDescriptionConstants.OVERVIEW_DESC);
  90.     }

  92.     /**
  93.      * Creates the main card.
  94.      *
  95.      * @param panelContent the panel content
  96.      * @param govBody the gov body
  97.      * @param pageId the page id
  98.      */
  99.     private void createMainCard(final VerticalLayout panelContent, final GovernmentBodyAnnualSummary govBody, final String pageId) {
  100.         final Panel cardPanel = createCardPanel();
  101.         final VerticalLayout cardContent = createCardContent(cardPanel);
  102.         panelContent.addComponent(cardPanel);
  103.         panelContent.setExpandRatio(cardPanel, ContentRatio.SMALL_GRID);

  105.         CardInfoRowUtil.createCardHeader(cardContent, GovernmentBodyViewConstants.BODY_INFO);

  107.         final HorizontalLayout attributesLayout = createAttributesLayout();
  108.         cardContent.addComponent(attributesLayout);

  110.         addProfileAndStatsColumns(attributesLayout, govBody);
  111.         addOverviewLayout(panelContent, pageId);
  112.     }

  114.     /**
  115.      * Creates the card panel.
  116.      *
  117.      * @return the panel
  118.      */
  119.     private Panel createCardPanel() {
  120.         final Panel cardPanel = new Panel();
  121.         cardPanel.addStyleName(GovernmentBodyViewConstants.STYLE_GOVERNMENT_BODY_CARD);
  122.         cardPanel.setWidth(GovernmentBodyViewConstants.WIDTH_100_PERCENT);
  123.         cardPanel.setHeightUndefined();
  124.         Responsive.makeResponsive(cardPanel);
  125.         return cardPanel;
  126.     }

  128.     /**
  129.      * Creates the card content.
  130.      *
  131.      * @param cardPanel the card panel
  132.      * @return the vertical layout
  133.      */
  134.     private VerticalLayout createCardContent(final Panel cardPanel) {
  135.         final VerticalLayout cardContent = new VerticalLayout();
  136.         cardContent.setMargin(GovernmentBodyLayoutConstants.USE_MARGIN);
  137.         cardContent.setSpacing(GovernmentBodyLayoutConstants.USE_SPACING);
  138.         cardContent.setWidth(GovernmentBodyLayoutConstants.WIDTH_100_PERCENT);
  139.         cardPanel.setContent(cardContent);
  140.         return cardContent;
  141.     }

  143.     /**
  144.      * Creates the attributes layout.
  145.      *
  146.      * @return the horizontal layout
  147.      */
  148.     private HorizontalLayout createAttributesLayout() {
  149.         final HorizontalLayout attributesLayout = new HorizontalLayout();
  150.         attributesLayout.setSpacing(GovernmentBodyLayoutConstants.USE_SPACING);
  151.         attributesLayout.setWidth(GovernmentBodyLayoutConstants.WIDTH_100_PERCENT);
  152.         return attributesLayout;
  153.     }

  155.     /**
  156.      * Adds the profile and stats columns.
  157.      *
  158.      * @param attributesLayout the attributes layout
  159.      * @param govBody the gov body
  160.      */
  161.     private void addProfileAndStatsColumns(final HorizontalLayout attributesLayout, final GovernmentBodyAnnualSummary govBody) {
  162.         final VerticalLayout profileLayout = createProfileColumn(govBody);
  163.         final VerticalLayout statsLayout = createStatsColumn(govBody);

  165.         attributesLayout.addComponents(profileLayout, statsLayout);
  166.     }

  168.     /**
  169.      * Creates the profile column.
  170.      *
  171.      * @param govBody the gov body
  172.      * @return the vertical layout
  173.      */
  174.     private VerticalLayout createProfileColumn(final GovernmentBodyAnnualSummary govBody) {
  175.         final VerticalLayout profileLayout = CardInfoRowUtil.createSectionLayout(
  176.             GovernmentBodyViewConstants.ORG_PROFILE);

  178.         addProfileDetails(profileLayout, govBody);
  179.         return profileLayout;
  180.     }

  182.     /**
  183.      * Adds the profile details.
  184.      *
  185.      * @param profileLayout the profile layout
  186.      * @param govBody the gov body
  187.      */
  188.     private void addProfileDetails(final VerticalLayout profileLayout, final GovernmentBodyAnnualSummary govBody) {
  189.         profileLayout.addComponents(
  190.             createProfileInfoRow(GovernmentBodyHeaderConstants.NAME_FIELD,
  191.                 govBody.getName(),
  192.                 GovernmentBodyIconConstants.INFO_ICON,
  193.                 GovernmentBodyHeaderConstants.NAME_DESC),
  194.             createProfileInfoRow(GovernmentBodyHeaderConstants.ID_FIELD,
  195.                 govBody.getGovermentBodyId(),
  196.                 GovernmentBodyIconConstants.USER_ICON,
  197.                 GovernmentBodyHeaderConstants.ID_DESC),
  198.             // ...add other profile fields...
  199.             createProfileInfoRow(GovernmentBodyHeaderConstants.VAT_FIELD,
  200.                 govBody.getVat(),
  201.                 GovernmentBodyIconConstants.MONEY_ICON,
  202.                 GovernmentBodyHeaderConstants.VAT_DESC)
  203.         );
  204.     }

  206.     /**
  207.      * Creates the profile info row.
  208.      *
  209.      * @param label the label
  210.      * @param value the value
  211.      * @param icon the icon
  212.      * @param description the description
  213.      * @return the com.vaadin.ui. component
  214.      */
  215.     private com.vaadin.ui.Component createProfileInfoRow(final String label, final String value, final VaadinIcons icon, final String description) {
  216.         return CardInfoRowUtil.createInfoRow(label, value, icon, description);
  217.     }

  219.     /**
  220.      * Creates the stats column.
  221.      *
  222.      * @param govBody the gov body
  223.      * @return the vertical layout
  224.      */
  225.     private VerticalLayout createStatsColumn(final GovernmentBodyAnnualSummary govBody) {
  226.         final VerticalLayout statsLayout = CardInfoRowUtil.createSectionLayout(
  227.             GovernmentBodyViewConstants.ANNUAL_STATS);

  229.         addStatsDetails(statsLayout, govBody);
  230.         return statsLayout;
  231.     }

  233.     /**
  234.      * Adds the stats details.
  235.      *
  236.      * @param statsLayout the stats layout
  237.      * @param govBody the gov body
  238.      */
  239.     private void addStatsDetails(final VerticalLayout statsLayout, final GovernmentBodyAnnualSummary govBody) {
  240.         statsLayout.addComponents(
  241.             createStatsInfoRow(GovernmentBodyHeaderConstants.YEAR_FIELD,
  242.                 formatYear(govBody.getYear()),
  243.                 GovernmentBodyIconConstants.CALENDAR_ICON,
  244.                 GovernmentBodyHeaderConstants.YEAR_DESC),
  245.             createStatsInfoRow(GovernmentBodyHeaderConstants.HEAD_COUNT_FIELD,
  246.                 formatCount(govBody.getHeadCount()),
  247.                 GovernmentBodyIconConstants.GROUP_ICON,
  248.                 GovernmentBodyHeaderConstants.HEAD_COUNT_DESC),
  249.             createStatsInfoRow(GovernmentBodyHeaderConstants.ANNUAL_HEADCOUNT_FIELD,
  250.                 formatCount(govBody.getAnnualWorkHeadCount()),
  251.                 GovernmentBodyIconConstants.USER_CHECK_ICON,
  252.                 GovernmentBodyHeaderConstants.ANNUAL_HEAD_DESC)
  253.         );

  255.         if (govBody.getComment() != null && !govBody.getComment().isEmpty()) {
  256.             statsLayout.addComponent(createStatsInfoRow(
  257.                 GovernmentBodyHeaderConstants.COMMENT_FIELD,
  258.                 govBody.getComment(),
  259.                 GovernmentBodyIconConstants.COMMENT_ICON,
  260.                 GovernmentBodyHeaderConstants.COMMENT_DESC));
  261.         }
  262.     }

  264.     /**
  265.      * Creates the stats info row.
  266.      *
  267.      * @param label the label
  268.      * @param value the value
  269.      * @param icon the icon
  270.      * @param description the description
  271.      * @return the com.vaadin.ui. component
  272.      */
  273.     private com.vaadin.ui.Component createStatsInfoRow(final String label, final String value, final VaadinIcons icon, final String description) {
  274.         return CardInfoRowUtil.createInfoRow(label, value, icon, description);
  275.     }

  277.     /**
  278.      * Adds the overview layout.
  279.      *
  280.      * @param panelContent the panel content
  281.      * @param pageId the page id
  282.      */
  283.     private void addOverviewLayout(final VerticalLayout panelContent, final String pageId) {
  284.         final VerticalLayout overviewLayout = new VerticalLayout();
  285.         overviewLayout.setSizeFull();
  286.         panelContent.addComponent(overviewLayout);
  287.         panelContent.setExpandRatio(overviewLayout, ContentRatio.LARGE_FORM);
  288.         getGovernmentBodyMenuItemFactory().createOverviewPage(overviewLayout, pageId);
  289.     }

  291.     @Override
  292.     public boolean matches(final String page, final String parameters) {
  293.         return  PageCommandGovernmentBodyConstants.COMMAND_GOVERNMENT_BODY_OVERVIEW.matches(page, parameters);
  294.     }

  296. }
Created with JaCoCo 0.8.12.202403310830