teichmann@5861: /* Copyright (C) 2011, 2012, 2013 by Bundesanstalt für Gewässerkunde
teichmann@5861:  * Software engineering by Intevation GmbH
teichmann@5861:  *
teichmann@5993:  * This file is Free Software under the GNU AGPL (>=v3)
teichmann@5861:  * and comes with ABSOLUTELY NO WARRANTY! Check out the
teichmann@5993:  * documentation coming with Dive4Elements River for details.
teichmann@5861:  */
teichmann@5861: 
teichmann@5835: package org.dive4elements.river.client.client.ui.chart;
ingo@523: 
teichmann@5835: import org.dive4elements.river.client.client.Config;
teichmann@5835: import org.dive4elements.river.client.client.services.FeedServiceAsync;
teichmann@5835: import org.dive4elements.river.client.client.services.LoadArtifactService;
teichmann@5835: import org.dive4elements.river.client.client.services.LoadArtifactServiceAsync;
teichmann@5835: import org.dive4elements.river.client.client.ui.CollectionView;
gernotbelger@9416: import org.dive4elements.river.client.client.ui.IThemeRecordHandler;
teichmann@5835: import org.dive4elements.river.client.client.ui.ThemePanel;
teichmann@5835: import org.dive4elements.river.client.shared.model.Artifact;
teichmann@5835: import org.dive4elements.river.client.shared.model.Data;
teichmann@5835: import org.dive4elements.river.client.shared.model.DefaultArtifact;
teichmann@5835: import org.dive4elements.river.client.shared.model.DefaultData;
teichmann@5835: import org.dive4elements.river.client.shared.model.FacetRecord;
teichmann@5835: import org.dive4elements.river.client.shared.model.OutputMode;
teichmann@5835: import org.dive4elements.river.client.shared.model.Recommendation;
teichmann@5835: import org.dive4elements.river.client.shared.model.Theme;
teichmann@5835: import org.dive4elements.river.client.shared.model.ThemeList;
ingo@523: 
gernotbelger@9416: import com.google.gwt.core.client.GWT;
gernotbelger@9416: import com.google.gwt.user.client.rpc.AsyncCallback;
gernotbelger@9416: import com.smartgwt.client.types.ListGridFieldType;
gernotbelger@9416: import com.smartgwt.client.util.SC;
gernotbelger@9416: import com.smartgwt.client.widgets.grid.CellFormatter;
gernotbelger@9416: import com.smartgwt.client.widgets.grid.ListGridField;
gernotbelger@9416: import com.smartgwt.client.widgets.grid.ListGridRecord;
gernotbelger@9416: import com.smartgwt.client.widgets.layout.VLayout;
gernotbelger@9416: import com.smartgwt.client.widgets.menu.Menu;
gernotbelger@9416: import com.smartgwt.client.widgets.menu.MenuItem;
gernotbelger@9416: import com.smartgwt.client.widgets.menu.events.ClickHandler;
gernotbelger@9416: import com.smartgwt.client.widgets.menu.events.MenuItemClickEvent;
felix@1456: 
ingo@523: /**
felix@1430:  * ThemePanel on the left in CollectionView.
tom@8856:  * Contains control widgets for "themes", which are plotted
tom@8856:  * in a diagram (chart).
felix@1430:  *
ingo@523:  * @author <a href="mailto:ingo.weinzierl@intevation.de">Ingo Weinzierl</a>
ingo@523:  */
ingo@805: public class ChartThemePanel extends ThemePanel {
felix@1456:     /** Artifact Clone/Creation service. */
gernotbelger@9416:     private final LoadArtifactServiceAsync loadService = GWT.create(LoadArtifactService.class);
ingo@523: 
gernotbelger@9416:     protected static final String GRID_FIELD_ACTIVE = "active";
gernotbelger@9416:     protected static final String GRID_FIELD_NAME = "name";
gernotbelger@9416:     protected static final String GRID_FIELD_ACTIONS = "actions";
felix@1456: 
gernotbelger@9416:     protected final FeedServiceAsync feedService = GWT.create(org.dive4elements.river.client.client.services.FeedService.class);
ingo@523: 
gernotbelger@9416:     /** Constructor for a ChartThemePanel.
gernotbelger@9416:      * @param recordHandler */
gernotbelger@9416:     public ChartThemePanel(final OutputMode mode, final CollectionView view, final IThemeRecordHandler recordHandler) {
gernotbelger@9416:         super(mode, view, recordHandler);
gernotbelger@9416: 
gernotbelger@9416:         initGrid(recordHandler);
ingo@523:         initLayout();
ingo@523: 
ingo@523:         updateGrid();
ingo@523:     }
ingo@523: 
felix@1514:     /** Creates Layout with theme list and navigation bar inside. */
felix@1430:     protected VLayout createLayout() {
gernotbelger@9416:         final VLayout layout = new VLayout();
felix@1430:         layout.setWidth100();
felix@1430:         layout.setHeight100();
felix@1430: 
gernotbelger@9416:         layout.addMember(this.list);
gernotbelger@9416:         layout.addMember(this.navigation);
felix@1430: 
felix@1430:         return layout;
felix@1430:     }
felix@1430: 
ingo@523:     /**
ingo@523:      * Initializes the layout of this panel.
ingo@523:      */
gernotbelger@9416:     private void initLayout() {
ingo@523:         setWidth100();
ingo@523:         setHeight100();
ingo@523: 
felix@1430:         addChild(createLayout());
ingo@523:     }
ingo@523: 
ingo@523:     /**
ingo@523:      * Initializes the components (columns) of the theme grid.
gernotbelger@9416:      * @param recordHandler
ingo@523:      */
gernotbelger@9416:     protected void initGrid( final IThemeRecordHandler recordHandler ) {
gernotbelger@9416:         this.list.setCanEdit(true);
gernotbelger@9416:         this.list.setCanSort(false);
gernotbelger@9416:         this.list.setShowRecordComponents(false);
gernotbelger@9416:         this.list.setShowRecordComponentsByCell(true);
gernotbelger@9416:         this.list.setShowHeader(true);
gernotbelger@9416:         this.list.setShowHeaderContextMenu(false);
gernotbelger@9416:         this.list.setWidth100();
gernotbelger@9416:         this.list.setHeight100();
ingo@523: 
gernotbelger@9416:         this.list.addEditCompleteHandler(this);
ingo@523: 
gernotbelger@9416:         final ListGridField active = new ListGridField(GRID_FIELD_ACTIVE, " ", 20);
ingo@523:         active.setType(ListGridFieldType.BOOLEAN);
ingo@523: 
gernotbelger@9416:         final ListGridField name = new ListGridField(GRID_FIELD_NAME, this.MSG.chart_themepanel_header_themes());
ingo@523:         name.setType(ListGridFieldType.TEXT);
ingo@523: 
gernotbelger@9416:         if( recordHandler instanceof CellFormatter)
gernotbelger@9416:             name.setCellFormatter((CellFormatter) recordHandler);
gernotbelger@9416: 
gernotbelger@9416:         this.list.setFields(active, name);
ingo@523:     }
ingo@523: 
felix@1460:     /** Set theme active/inactive. */
ingo@805:     @Override
gernotbelger@9416:     public void activateTheme(final Theme theme, final boolean active) {
ingo@805:         theme.setActive(active ? 1 : 0);
ingo@527:     }
felix@1456: 
felix@1457:     /** Returns name of longitudinal section area facets. */
felix@1457:     protected String getAreaFacetName() {
felix@1457:         return "longitudinal_section.area";
felix@1457:     }
felix@1457: 
felix@1517:     /** Create the DataProvider ('Blackboard') key for a theme. */
gernotbelger@9416:     public static String areaKey(final Theme theme) {
gernotbelger@9416:         return theme.getArtifact() + ":" + theme.getFacet() + ":" + theme.getIndex();
felix@1514:     }
felix@1514: 
felix@1456:     /**
felix@1456:      * Tell an area artifact where to get the upper and lower curve from.
gernotbelger@9416:      *
gernotbelger@9416:      * @param artifact
gernotbelger@9416:      *            UUID of area-artifact.
felix@1456:      */
gernotbelger@9416:     public void feedTellArea(final String artifact, final Theme under, final Theme over, final boolean between) {
felix@1456:         Data[] feedData;
felix@1456: 
felix@1456:         if (over != null && under != null) {
gernotbelger@9416:             feedData = new Data[] { DefaultData.createSimpleStringData("area.curve_under", areaKey(under)),
gernotbelger@9416:                     DefaultData.createSimpleStringData("area.curve_over", areaKey(over)),
gernotbelger@9416:                     DefaultData.createSimpleStringData("area.name", over.getDescription() + " / " + under.getDescription()),
gernotbelger@9416:                     DefaultData.createSimpleStringData("area.facet", getAreaFacetName()),
gernotbelger@9416:                     DefaultData.createSimpleStringData("area.between", (between) ? "true" : "false") };
felix@1517:             GWT.log("Have 'over' and 'under' curve");
gernotbelger@9416:         } else if (over == null && under != null) {
gernotbelger@9416:             feedData = new Data[] { DefaultData.createSimpleStringData("area.curve_under", areaKey(under)),
gernotbelger@9416:                     DefaultData.createSimpleStringData("area.name", under.getDescription() + " / " + this.MSG.getString("x_axis")),
gernotbelger@9416:                     DefaultData.createSimpleStringData("area.facet", getAreaFacetName()),
gernotbelger@9416:                     DefaultData.createSimpleStringData("area.between", (between) ? "true" : "false") };
felix@1517:             GWT.log("Have 'under' curve only");
gernotbelger@9416:         } else if (over != null && under == null) {
gernotbelger@9416:             feedData = new Data[] { DefaultData.createSimpleStringData("area.curve_over", areaKey(over)),
gernotbelger@9416:                     DefaultData.createSimpleStringData("area.name", this.MSG.getString("x_axis") + " / " + over.getDescription()),
gernotbelger@9416:                     DefaultData.createSimpleStringData("area.facet", getAreaFacetName()),
gernotbelger@9416:                     DefaultData.createSimpleStringData("area.between", (between) ? "true" : "false") };
felix@1517:             GWT.log("Have 'over' curve only");
gernotbelger@9416:         } else {
felix@1456:             GWT.log("Missing Data for area painting.");
felix@1456:             return;
felix@1456:         }
felix@1456: 
gernotbelger@9416:         this.feedService.feed(Config.getInstance().getLocale(), new DefaultArtifact(artifact, "TODO:hash"), feedData, new AsyncCallback<Artifact>() {
gernotbelger@9416:             @Override
gernotbelger@9416:             public void onFailure(final Throwable caught) {
gernotbelger@9416:                 GWT.log("Could not feed artifact (" + artifact + ") with area info: " + caught.getMessage());
gernotbelger@9416:                 SC.warn(ChartThemePanel.this.MSG.getString(caught.getMessage()));
gernotbelger@9416:                 enable();
gernotbelger@9416:             }
gernotbelger@9416: 
gernotbelger@9416:             @Override
gernotbelger@9416:             public void onSuccess(final Artifact fartifact) {
gernotbelger@9416:                 GWT.log("Successfully set area params to " + artifact);
gernotbelger@9416:                 requestRedraw();
gernotbelger@9416:                 updateCollection();
gernotbelger@9416:                 updateGrid();
gernotbelger@9416:                 enable();
gernotbelger@9416:             }
gernotbelger@9416:         });
felix@1456:     }
felix@1456: 
felix@1456:     /**
felix@1456:      * Create and parameterize a new area artifact.
gernotbelger@9416:      *
felix@1456:      * @param under
gernotbelger@9416:      * @param over
gernotbelger@9416:      *            if null, against axis.
gernotbelger@9416:      * @param between
gernotbelger@9416:      *            if true, ignore under/over order.
felix@1456:      */
gernotbelger@9416:     public void createAreaArtifact(final Theme over, final Theme under, final boolean between) {
gernotbelger@9416:         final Config config = Config.getInstance();
gernotbelger@9416:         final String locale = config.getLocale();
felix@1456: 
gernotbelger@9416:         final Recommendation area = new Recommendation("area", "", "", null);
felix@7679: 
felix@7679:         // Set target out dynamically.
felix@7679:         area.setTargetOut(getMode().getName());
felix@7679: 
gernotbelger@9416:         final Recommendation[] recommendations = new Recommendation[] { area };
felix@1456: 
gernotbelger@9416:         this.loadService.loadMany(this.getCollection(), recommendations, null, // use individual factories.
gernotbelger@9416:                 locale, new AsyncCallback<Artifact[]>() {
gernotbelger@9416:                     @Override
gernotbelger@9416:                     public void onFailure(final Throwable caught) {
gernotbelger@9416:                         GWT.log("Failed, no area artifact: " + caught.getMessage());
gernotbelger@9416:                         enable();
gernotbelger@9416:                         // TODO i18n
gernotbelger@9416:                         SC.warn("Failed, no area artifact: " + caught.getMessage());
gernotbelger@9416:                     }
gernotbelger@9416: 
gernotbelger@9416:                     @Override
gernotbelger@9416:                     public void onSuccess(final Artifact[] artifacts) {
gernotbelger@9416:                         GWT.log("Success, created area artifact: " + artifacts[0].getUuid());
gernotbelger@9416:                         // Now, feed the artifact with the relevant data.
gernotbelger@9416:                         feedTellArea(artifacts[0].getUuid(), under, over, between);
gernotbelger@9416:                     }
gernotbelger@9416:                 });
felix@1456:     }
felix@1456: 
felix@1456:     /**
felix@1456:      * Return true if two themes are canditates for an area being
felix@1456:      * rendered between them.
felix@1456:      * TODO join with canArea, generalize to allow easier modification
gernotbelger@9416:      * in subclasses.
felix@1456:      */
gernotbelger@9416:     protected boolean areAreaCompatible(final Theme a, final Theme b) {
felix@1456:         if (a.equals(b)) {
felix@1456:             return false;
felix@1456:         }
gernotbelger@9416:         if (a.getFacet().equals("w_differences") && b.getFacet().equals("w_differences")) {
aheinecke@7712:             return true;
aheinecke@7712:         }
gernotbelger@9416:         if (a.getFacet().equals("longitudinal_section.w") || a.getFacet().equals("other.wqkms.w") || a.getFacet().equals("other.wqkms")
gernotbelger@9416:                 || a.getFacet().equals("discharge_longitudinal_section.w") || a.getFacet().equals("discharge_longitudinal_section.c")
gernotbelger@9416:                 || a.getFacet().equals("other.wkms")) {
gernotbelger@9416:             return b.getFacet().equals("longitudinal_section.w") || b.getFacet().equals("other.wqkms") || b.getFacet().equals("other.wqkms.w")
gernotbelger@9416:                     || b.getFacet().equals("discharge_longitudinal_section.w") || b.getFacet().equals("discharge_longitudinal_section.c")
gernotbelger@9416:                     || b.getFacet().equals("other.wkms");
gernotbelger@9416:         } else if (a.getFacet().equals("longitudinal_section.q") || a.getFacet().equals("discharge_longitudinal_section.q")
gernotbelger@9416:                 || a.getFacet().equals("other.wqkms.q")) {
gernotbelger@9416:             return b.getFacet().equals("longitudinal_section.q") || b.getFacet().equals("discharge_longitudinal_section.q")
felix@7680:                     || b.getFacet().equals("other.wqkms.q");
felix@1456:         }
felix@1456:         return false;
felix@1456:     }
felix@1456: 
felix@1456:     /**
felix@1456:      * True if context menu should contain 'create area' submenu on
felix@1456:      * this theme.
felix@1456:      */
gernotbelger@9416:     protected boolean canArea(final Theme a) {
gernotbelger@9416:         return a.getFacet().equals("longitudinal_section.q") || a.getFacet().equals("longitudinal_section.w")
gernotbelger@9416:                 || a.getFacet().equals("discharge_longitudinal_section.w") || a.getFacet().equals("discharge_longitudinal_section.q")
gernotbelger@9416:                 || a.getFacet().equals("discharge_longitudinal_section.c") || a.getFacet().startsWith("other.wqkms") || a.getFacet().equals("other.wkms")
gernotbelger@9416:                 || a.getFacet().equals("w_differences");
felix@1456:     }
felix@1456: 
felix@1559:     /** Attach menu/item to open editor for Manual Points. */
gernotbelger@9416:     protected void attachManualPointsMenu(final Menu menu) {
felix@1559:         menu.addItem(createSeparator());
gernotbelger@9416:         final MenuItem editManualPoints = new MenuItem(this.MSG.editpoints());
sascha@2905: 
felix@1559:         editManualPoints.addClickHandler(new ClickHandler() {
gernotbelger@9416:             @Override
gernotbelger@9416:             public void onClick(final MenuItemClickEvent evt) {
gernotbelger@9416:                 if (ChartThemePanel.this.mode.getName().equals("historical_discharge")) {
gernotbelger@9416:                     new ManualDatePointsEditor(ChartThemePanel.this.view.getCollection(), ChartThemePanel.this.redrawRequestHandlers.get(0),
gernotbelger@9416:                             ChartThemePanel.this.mode.getName()).show();
gernotbelger@9416:                 } else {
gernotbelger@9416:                     new ManualPointsEditor(ChartThemePanel.this.view.getCollection(), ChartThemePanel.this.redrawRequestHandlers.get(0),
gernotbelger@9416:                             ChartThemePanel.this.mode.getName()).show();
felix@1559:                 }
gernotbelger@9416:             }
gernotbelger@9416:         });
felix@1559:         menu.addItem(editManualPoints);
felix@1559:     }
felix@1559: 
felix@1456:     /**
felix@1559:      * Include area specific menu items and manual point editor, depending
felix@1559:      * on facet.
felix@1456:      */
christian@4568:     @Override
felix@1456:     protected Menu getSingleContextMenu(final ListGridRecord[] records) {
gernotbelger@9416:         final Menu menu = super.getSingleContextMenu(records);
felix@1456: 
gernotbelger@9416:         final Theme facetTheme = ((FacetRecord) records[0]).getTheme();
christian@4568: 
felix@1456:         if (!canArea(facetTheme)) {
felix@1607:             if (facetTheme.getFacet().endsWith("manualpoints")) {
felix@1559:                 attachManualPointsMenu(menu);
felix@1559:                 return menu;
gernotbelger@9416:             } else {
felix@1559:                 return menu;
felix@1559:             }
felix@1456:         }
sascha@2905: 
felix@1456:         menu.addItem(createSeparator());
felix@1456: 
gernotbelger@9416:         final MenuItem areaMenuItem = new MenuItem(this.MSG.chart_themepanel_new_area());
gernotbelger@9416:         final Menu areaMenu = new Menu();
felix@1456: 
gernotbelger@9416:         final ThemeList themes = getThemeList();
gernotbelger@9416:         final int nThemes = themes.getThemeCount();
felix@1456: 
felix@1517:         // Create the "under..." submenu.
gernotbelger@9416:         final MenuItem underMenuItem = new MenuItem(this.MSG.chart_themepanel_area_under());
gernotbelger@9416:         final Menu underMenu = new Menu();
gernotbelger@9416:         for (int i = 0; i < nThemes; i++) {
gernotbelger@9416:             final Theme theme = themes.getThemeAt(i + 1);
felix@2442: 
felix@2442:             if (theme.getVisible() == 0) {
felix@2442:                 continue;
felix@2442:             }
felix@2442: 
felix@1456:             if (!areAreaCompatible(facetTheme, theme)) {
felix@1456:                 continue;
felix@1456:             }
felix@2442: 
gernotbelger@9416:             final MenuItem againster = new MenuItem(theme.getDescription());
felix@1456:             underMenu.addItem(againster);
felix@1456: 
felix@1456:             againster.addClickHandler(new ClickHandler() {
christian@4568:                 @Override
gernotbelger@9416:                 public void onClick(final MenuItemClickEvent evt) {
felix@1456:                     disable();
felix@1456:                     createAreaArtifact(theme, facetTheme, false);
felix@1456:                 }
felix@1456:             });
felix@1456:         }
felix@1456: 
felix@1517:         // Create the "over..." submenu.
gernotbelger@9416:         final MenuItem overMenuItem = new MenuItem(this.MSG.chart_themepanel_area_over());
gernotbelger@9416:         final Menu overMenu = new Menu();
gernotbelger@9416:         for (int i = 0; i < nThemes; i++) {
gernotbelger@9416:             final Theme theme = themes.getThemeAt(i + 1);
felix@2442:             if (theme.getVisible() == 0) {
felix@2442:                 continue;
felix@2442:             }
felix@1456:             if (!areAreaCompatible(facetTheme, theme)) {
felix@1456:                 continue;
felix@1456:             }
gernotbelger@9416:             final MenuItem againster = new MenuItem(theme.getDescription());
felix@1456:             overMenu.addItem(againster);
felix@1456: 
felix@1456:             againster.addClickHandler(new ClickHandler() {
christian@4568:                 @Override
gernotbelger@9416:                 public void onClick(final MenuItemClickEvent evt) {
felix@1456:                     disable();
felix@1456:                     createAreaArtifact(facetTheme, theme, false);
felix@1456:                 }
felix@1456:             });
felix@1456:         }
felix@1456:         overMenu.addItem(createSeparator());
gernotbelger@9416:         final MenuItem againstAxis = new MenuItem(this.MSG.getString("x_axis"));
felix@1456:         againstAxis.addClickHandler(new ClickHandler() {
christian@4568:             @Override
gernotbelger@9416:             public void onClick(final MenuItemClickEvent evt) {
felix@1456:                 disable();
felix@1469:                 createAreaArtifact(null, facetTheme, false);
felix@1456:             }
felix@1456:         });
felix@1456:         overMenu.addItem(againstAxis);
felix@1456: 
felix@1517:         // Create the "between..." submenu.
gernotbelger@9416:         final MenuItem betweenMenuItem = new MenuItem(this.MSG.chart_themepanel_area_between());
gernotbelger@9416:         final Menu betweenMenu = new Menu();
gernotbelger@9416:         for (int i = 0; i < nThemes; i++) {
gernotbelger@9416:             final Theme theme = themes.getThemeAt(i + 1);
felix@2442:             if (theme.getVisible() == 0) {
felix@2442:                 continue;
felix@2442:             }
felix@1456:             if (!areAreaCompatible(facetTheme, theme)) {
felix@1456:                 continue;
felix@1456:             }
gernotbelger@9416:             final MenuItem againster = new MenuItem(theme.getDescription());
felix@1456:             betweenMenu.addItem(againster);
felix@1456: 
felix@1456:             againster.addClickHandler(new ClickHandler() {
christian@4568:                 @Override
gernotbelger@9416:                 public void onClick(final MenuItemClickEvent evt) {
felix@1456:                     disable();
felix@1456:                     createAreaArtifact(facetTheme, theme, true);
felix@1456:                 }
felix@1456:             });
felix@1456:         }
felix@1456:         betweenMenu.addItem(createSeparator());
felix@1456:         betweenMenu.addItem(againstAxis);
felix@1456: 
felix@1456:         overMenuItem.setSubmenu(overMenu);
felix@1456:         underMenuItem.setSubmenu(underMenu);
felix@1456:         betweenMenuItem.setSubmenu(betweenMenu);
felix@1456: 
felix@1469:         areaMenu.addItem(betweenMenuItem);
felix@1456:         areaMenu.addItem(overMenuItem);
felix@1456:         areaMenu.addItem(underMenuItem);
felix@1469:         areaMenu.addItem(createSeparator());
gernotbelger@9416:         final MenuItem standAloneAgainstAxis = new MenuItem(this.MSG.getString("against_x_axis"));
felix@1469:         standAloneAgainstAxis.addClickHandler(new ClickHandler() {
christian@4568:             @Override
gernotbelger@9416:             public void onClick(final MenuItemClickEvent evt) {
felix@1469:                 disable();
felix@1469:                 createAreaArtifact(null, facetTheme, false);
felix@1469:             }
felix@1469:         });
felix@1469:         areaMenu.addItem(standAloneAgainstAxis);
felix@1456: 
felix@1456:         areaMenuItem.setSubmenu(areaMenu);
felix@1456:         menu.addItem(areaMenuItem);
felix@1456: 
felix@1456:         return menu;
felix@1456:     }
gernotbelger@9416: }