org.eclipse.scout.rt.client/src/org/eclipse/scout/rt/client/ui/desktop/UnsavedFormChangesForm.java

/*******************************************************************************
 * Copyright (c) 2010 BSI Business Systems Integration AG.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     BSI Business Systems Integration AG - initial API and implementation
 ******************************************************************************/
package org.eclipse.scout.rt.client.ui.desktop;

import java.util.ArrayList;
import java.util.LinkedList;
import java.util.List;

import org.eclipse.scout.commons.CollectionUtility;
import org.eclipse.scout.commons.StringUtility;
import org.eclipse.scout.commons.annotations.ClassId;
import org.eclipse.scout.commons.annotations.Order;
import org.eclipse.scout.commons.exception.ProcessingException;
import org.eclipse.scout.rt.client.ui.desktop.UnsavedFormChangesForm.MainBox.CancelButton;
import org.eclipse.scout.rt.client.ui.desktop.UnsavedFormChangesForm.MainBox.OkButton;
import org.eclipse.scout.rt.client.ui.desktop.UnsavedFormChangesForm.MainBox.UnsavedChangesBox;
import org.eclipse.scout.rt.client.ui.desktop.UnsavedFormChangesForm.MainBox.UnsavedChangesBox.OpenFormsField;
import org.eclipse.scout.rt.client.ui.form.AbstractForm;
import org.eclipse.scout.rt.client.ui.form.AbstractFormHandler;
import org.eclipse.scout.rt.client.ui.form.IForm;
import org.eclipse.scout.rt.client.ui.form.fields.button.AbstractButton;
import org.eclipse.scout.rt.client.ui.form.fields.button.AbstractCancelButton;
import org.eclipse.scout.rt.client.ui.form.fields.button.AbstractOkButton;
import org.eclipse.scout.rt.client.ui.form.fields.groupbox.AbstractGroupBox;
import org.eclipse.scout.rt.client.ui.form.fields.listbox.AbstractListBox;
import org.eclipse.scout.rt.client.ui.messagebox.MessageBox;
import org.eclipse.scout.rt.shared.TEXTS;
import org.eclipse.scout.rt.shared.services.lookup.ILookupCall;
import org.eclipse.scout.rt.shared.services.lookup.ILookupRow;
import org.eclipse.scout.rt.shared.services.lookup.LocalLookupCall;
import org.eclipse.scout.rt.shared.services.lookup.LookupRow;

@ClassId("b5783a42-9fd8-4043-afc1-6e744dad9c8f")
public class UnsavedFormChangesForm extends AbstractForm {
  private final List<IForm> m_forms;

  public UnsavedFormChangesForm(List<IForm> forms) throws ProcessingException {
    m_forms = forms;
  }

  @Override
  protected String getConfiguredTitle() {
    return TEXTS.get("UnsavedChangesTitle");
  }

  @Override
  protected boolean getConfiguredAskIfNeedSave() {
    return false;
  }

  public void startNew() throws ProcessingException {
    startInternal(new NewHandler());
  }

  public CancelButton getCancelButton() {
    return getFieldByClass(CancelButton.class);
  }

  public MainBox getMainBox() {
    return getFieldByClass(MainBox.class);
  }

  public UnsavedChangesBox getUnsavedChangesBox() {
    return getFieldByClass(UnsavedChangesBox.class);
  }

  public OkButton getOkButton() {
    return getFieldByClass(OkButton.class);
  }

  public OpenFormsField getOpenFormsField() {
    return getFieldByClass(OpenFormsField.class);
  }

  public List<IForm> getUnsavedForms() {
    return CollectionUtility.arrayList(m_forms);
  }

  @Order(10.0)
  @ClassId("7c89cc91-2c09-472b-af3b-ee93b50caaad")
  public class MainBox extends AbstractGroupBox {

    @Override
    protected int getConfiguredGridColumnCount() {
      return 1;
    }

    @Order(10.0)
    @ClassId("51908aa1-6409-44fd-9aeb-a92cec73baaa")
    public class UnsavedChangesBox extends AbstractGroupBox {

      @Override
      protected String getConfiguredLabel() {
        return TEXTS.get("SaveChangesOfSelectedItems");
      }

      @Override
      protected String getConfiguredBorderDecoration() {
        return BORDER_DECORATION_LINE;
      }

      @Override
      protected int getConfiguredGridColumnCount() {
        return 1;
      }

      @Order(20.0)
      @ClassId("84f2a9cf-bce5-4379-aede-11d07b21d3fb")
      public class OpenFormsField extends AbstractListBox<IForm> {

        @Override
        protected void execInitField() throws ProcessingException {
          checkAllKeys();
        }

        public List<IForm> getInvalidForms() {
          LinkedList<IForm> invalidForms = new LinkedList<IForm>();
          for (IForm f : getValue()) {
            try {
              f.validateForm();
            }
            catch (ProcessingException e) {
              invalidForms.add(f);
            }
          }
          return invalidForms;
        }

        @Override
        protected Class<? extends ILookupCall<IForm>> getConfiguredLookupCall() {
          return UnsavedFormsLookupCall.class;
        }

        @Override
        protected void execPrepareLookup(ILookupCall<IForm> call) throws ProcessingException {
          UnsavedFormsLookupCall unsavedFormsLookupCall = (UnsavedFormsLookupCall) call;
          unsavedFormsLookupCall.setUnsavedForms(getUnsavedForms());
        }

        @Override
        protected int getConfiguredGridH() {
          return 5;
        }

        @Override
        protected boolean getConfiguredLabelVisible() {
          return false;
        }
      }

      @Order(30.0)
      @ClassId("215a6594-5fb2-435e-85ec-f612afb36a05")
      public class CheckAllButton extends AbstractButton {
        @Override
        protected String getConfiguredLabel() {
          return TEXTS.get("CheckAllWithMnemonic");
        }

        @Override
        protected void execClickAction() throws ProcessingException {
          getOpenFormsField().checkAllKeys();
        }
      }

      @Order(30.0)
      @ClassId("b7f69fff-f7ff-4474-8a27-be9083ff731d")
      public class UnCheckAllButton extends AbstractButton {
        @Override
        protected String getConfiguredLabel() {
          return TEXTS.get("UncheckAllWithMnemonic");
        }

        @Override
        protected void execClickAction() throws ProcessingException {
          getOpenFormsField().uncheckAllKeys();
        }
      }
    }

    @Order(20.0)
    @ClassId("caca3d68-b8cc-4cb0-a35c-5b8ccbcc3745")
    public class OkButton extends AbstractOkButton {
      @Override
      protected String getConfiguredTooltipText() {
        return TEXTS.get("SaveCheckedFormsAndShutdown");
      }
    }

    @Order(30.0)
    @ClassId("50c8526a-333f-4878-9876-b48f2b583d88")
    public class CancelButton extends AbstractCancelButton {
      @Override
      protected String getConfiguredTooltipText() {
        return TEXTS.get("CancelShutdownAndReturnToTheApplication");
      }
    }
  }

  public class NewHandler extends AbstractFormHandler {
    @Override
    protected void execPostLoad() throws ProcessingException {
      touch();
    }

    @Override
    protected boolean execValidate() throws ProcessingException {
      List<IForm> invalidForms = getOpenFormsField().getInvalidForms();
      if (invalidForms.size() > 0) {
        StringBuilder msg = new StringBuilder(TEXTS.get("FormsCannotBeSaved"));
        msg.append("\n\n");
        for (IForm f : invalidForms) {
          msg.append("- ").append(getFormDisplayName(f)).append("\n");
        }
        MessageBox.showOkMessage(TEXTS.get("NotAllCheckedFormsCanBeSaved"), TEXTS.get("NotAllCheckedFormsCanBeSaved"), msg.toString());
        return false;
      }
      return true;
    }

    @Override
    protected void execStore() throws ProcessingException {
      for (IForm f : getOpenFormsField().getValue()) {
        f.doOk();
      }
    }
  }

  private static String getFormDisplayName(IForm f) {
    return StringUtility.nvl(f.getTitle(), f.getClass().getName());
  }

  @ClassId("70052229-e6e5-43f3-bac5-cabe6e4525d3")
  public static class UnsavedFormsLookupCall extends LocalLookupCall<IForm> {
    private static final long serialVersionUID = 1L;
    private List<IForm> m_unsavedForms;

    public void setUnsavedForms(List<IForm> unsavedForms) {
      m_unsavedForms = unsavedForms;
    }

    @Override
    protected List<? extends ILookupRow<IForm>> execCreateLookupRows() throws ProcessingException {
      List<ILookupRow<IForm>> formRows = new ArrayList<ILookupRow<IForm>>();
      for (IForm f : m_unsavedForms) {
        String text = getFormDisplayName(f);
        formRows.add(new LookupRow<IForm>(f, text, null, text));
      }
      return formRows;
    }
  }
}