/**
    * This file Copyright (c) 2018 Magnolia International
    * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
    *
    *
    * This file is dual-licensed under both the Magnolia
    * Network Agreement and the GNU General Public License.
    * You may elect to use one or the other of these licenses.
    *
   * This file is distributed in the hope that it will be
   * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
   * implied warranty of MERCHANTABILITY or FITNESS FOR A
   * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
   * Redistribution, except as permitted by whichever of the GPL
   * or MNA you select, is prohibited.
   *
   * 1. For the GPL license (GPL), you can redistribute and/or
   * modify this file under the terms of the GNU General
   * Public License, Version 3, as published by the Free Software
   * Foundation.  You should have received a copy of the GNU
   * General Public License, Version 3 along with this program;
   * if not, write to the Free Software Foundation, Inc., 51
   * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
   *
   * 2. For the Magnolia Network Agreement (MNA), this file
   * and the accompanying materials are made available under the
   * terms of the MNA which accompanies this distribution, and
   * is available at http://www.magnolia-cms.com/mna.html
   *
   * Any modifications to this file must keep this entire header
   * intact.
   *
   */
  package info.magnolia.ui.dialog;
  
  import static java.util.stream.Collectors.toMap;
  
  import info.magnolia.ui.vaadin.extension.ResurfacedWindow;
  
  import java.util.ArrayList;
  import java.util.HashMap;
  import java.util.List;
  import java.util.Map;
  
  import com.vaadin.ui.Component;
  import com.vaadin.ui.UI;
  import com.vaadin.ui.Window;
  
  /**
   * Builder for Magnolia 6.2+ dialogs.
   * They come in two different flavors: <strong>light</strong> and <strong>strong</strong>.
   * Dialogs created with this builder are modal and strong by default.
   * <p>When to use light or strong dialogs:
   * <ul>
   *     <li>light dialogs ask for quick input but do not severely interrupt the user. They have a transparent background. </li>
   *     <li>strong dialogs ask for data collection. They have a partially opaque background</li>
   * </ul>
   *
   * Here is an usage example:
   * <pre>
   * DialogBuilder.dialog()
   *         .withTitle("Edit object")
   *         .withContent(view)
   *         .light(myDialogDefinition.isLight())
   *         .withActions(new Button("Commit"))
   *         .buildAndOpen();
   * </pre>
   *
   * @see info.magnolia.ui.dialog.DialogDefinition
   */
  public class DialogBuilder {
  
      private String title;
      private Component content;
      private List<Component> actions = new ArrayList<>();
      private boolean modal = true;
      private Component footer;
      private Map<Integer, Runnable> shortcuts = new HashMap<>();
      private boolean light = false;
      private List<Window.CloseListener> closeListeners = new ArrayList<>();
  
      public static DialogBuilder dialog() {
          return new DialogBuilder();
      }
  
      public DialogBuilder withTitle(String title) {
          this.title = title;
          return this;
      }
  
      public DialogBuilder withContent(Component content) {
          this.content = content;
          return this;
      }
  
      public DialogBuilder withActions(List<Component> actions) {
          this.actions.addAll(actions);
          return this;
      }
 
     public DialogBuilder modal() {
         this.modal = true;
         return this;
     }
 
     public DialogBuilder light(boolean isLight) {
         this.light = isLight;
         return this;
     }
 
     public DialogBuilder withFooter(Component footer) {
         this.footer = footer;
         return this;
     }
 
     public <T> DialogBuilder withShortcuts(List<ActionExecution<T>> shortcuts) {
         this.shortcuts.putAll(shortcuts.stream().collect(toMap(
                 execution -> execution.getDefinition().getShortcut(),
                 actionExecution -> (Runnable) actionExecution::execute,
                 (initialShortcut, overridingShortcut) -> overridingShortcut)));
         return this;
     }
 
     public DialogBuilder withShortcuts(Map<Integer, Runnable> shortcuts) {
         this.shortcuts.putAll(shortcuts);
         return this;
     }
 
     public DialogBuilder withCloseListener(Window.CloseListener closeListener) {
         this.closeListeners.add(closeListener);
         return this;
     }
 
     public DialogComponent build() {
         DialogComponentnt.html#DialogComponent">DialogComponent dialog = new DialogComponent(this.content, getFooter());
         dialog.setShortcuts(this.shortcuts);
         return dialog;
     }
 
     private Component getFooter() {
         if (this.footer == null) {
             final EditorActionLayoutorActionLayout">EditorActionLayout editorActionLayout = new EditorActionLayout();
             this.actions.forEach(editorActionLayout::addPrimaryAction);
             this.footer = editorActionLayout;
         }
         return this.footer;
     }
 
     public Window buildAndOpen() {
         Window window = new Window();
         window.setCaption(this.title);
         window.setContent(this.build());
         window.center();
         window.setModal(this.modal);
         String modalityStyleName = this.light ? "light" : "";
         window.addStyleNames("dialog", this.content.getStyleName(), modalityStyleName);
         this.content.addStyleName("content");
         window.setDraggable(false);
         window.setResizable(false);
 
         closeListeners.forEach(window::addCloseListener);
         ResurfacedWindow.extend(window);
         UI.getCurrent().addWindow(window);
         return window;
     }
 }