DeletingGroupsAlert.java

/*
** Module   : DeletingGroupsAlert.java
** Abstract : DeletingGroupsAlert represents a Deleting Groups Alert dialog.
**
** Copyright (c) 2017, Golden Code Development Corporation.
**
** -#- -I- --Date-- ----------------Description----------------------
** 001 SBI 20170601 Created initial version.
*/
/*
** This program is free software: you can redistribute it and/or modify
** it under the terms of the GNU Affero General Public License as
** published by the Free Software Foundation, either version 3 of the
** License, or (at your option) any later version.
**
** This program is distributed in the hope that it will be useful,
** but WITHOUT ANY WARRANTY; without even the implied warranty of
** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
** GNU Affero General Public License for more details.
**
** You may find a copy of the GNU Affero GPL version 3 at the following
** location: https://www.gnu.org/licenses/agpl-3.0.en.html
** 
** Additional terms under GNU Affero GPL version 3 section 7:
** 
**   Under Section 7 of the GNU Affero GPL version 3, the following additional
**   terms apply to the works covered under the License.  These additional terms
**   are non-permissive additional terms allowed under Section 7 of the GNU
**   Affero GPL version 3 and may not be removed by you.
** 
**   0. Attribution Requirement.
** 
**     You must preserve all legal notices or author attributions in the covered
**     work or Appropriate Legal Notices displayed by works containing the covered
**     work.  You may not remove from the covered work any author or developer
**     credit already included within the covered work.
** 
**   1. No License To Use Trademarks.
** 
**     This license does not grant any license or rights to use the trademarks
**     Golden Code, FWD, any Golden Code or FWD logo, or any other trademarks
**     of Golden Code Development Corporation. You are not authorized to use the
**     name Golden Code, FWD, or the names of any author or contributor, for
**     publicity purposes without written authorization.
** 
**   2. No Misrepresentation of Affiliation.
** 
**     You may not represent yourself as Golden Code Development Corporation or FWD.
** 
**     You may not represent yourself for publicity purposes as associated with
**     Golden Code Development Corporation, FWD, or any author or contributor to
**     the covered work, without written authorization.
** 
**   3. No Misrepresentation of Source or Origin.
** 
**     You may not represent the covered work as solely your work.  All modified
**     versions of the covered work must be marked in a reasonable way to make it
**     clear that the modified work is not originating from Golden Code Development
**     Corporation or FWD.  All modified versions must contain the notices of
**     attribution required in this license.
*/

package com.goldencode.p2j.admin.client.application.home.accounts.groups;

import java.util.logging.Level;

import org.gwtbootstrap3.client.ui.Button;
import org.gwtbootstrap3.client.ui.Modal;
import org.gwtbootstrap3.client.ui.html.Text;

import com.goldencode.p2j.admin.TaggedName;
import com.goldencode.p2j.admin.client.widget.dialog.ModalViewWithUiHandlers;
import com.google.gwt.event.dom.client.ClickEvent;
import com.google.gwt.i18n.client.Messages;
import com.google.gwt.uibinder.client.UiBinder;
import com.google.gwt.uibinder.client.UiField;
import com.google.gwt.uibinder.client.UiHandler;
import com.google.gwt.user.client.ui.Widget;
import com.google.inject.Inject;

/**
 * DeletingGroupsAlert is a dialog to display an alert message that these groups accounts are
 * about to be deleted.
 *
 */
public class DeletingGroupsAlert
extends ModalViewWithUiHandlers<GroupsUIHandlers>
{
   /**
    * GWT UI creator
    */
   interface Binder
   extends UiBinder<Widget, DeletingGroupsAlert>
   {}
   
   /**
    * Alert message templates.
    */
   interface AlertMessages
   extends Messages
   {
      /**
       * Builds the being deleted message.
       * 
       * @param    groupAccountsMsg
       *           The message parameter
       * 
       * @return   The being deleted message
       */
      @DefaultMessage("{0} being deleted. Continue?")
      String deleteSelectedAlert(String groupAccountsMsg);
      
      /**
       * Builds the being deleted message.
       * 
       * @param    group
       *           The message parameter
       * 
       * @return   The group account message
       */
      @DefaultMessage("{0} group account")
      String groupAccount(String group);
      
      /**
       * Builds the groups to delete message.
       * 
       * @param    numberOfAccounts
       *           The number of accounts
       * 
       * @return   The groups to delete message
       */
      @DefaultMessage("{0} group accounts")
      @AlternateMessage({"=1", "1 group account"})
      String groupsToDelete(@PluralCount int numberOfAccounts);
   }
   
   /** The underlined modal dialog */
   @UiField
   Modal modal;
   
   /** The message text field*/
   @UiField
   Text deleteSelectedAlert;

   /** The approval button */
   @UiField
   Button yesAction;
   
   /** The cancel button */
   @UiField
   Button noAction;
   
   /** The alerts builder */
   private final AlertMessages messages;
   
   /** The selected groups requesting an approval to delete*/
   private TaggedName[] selectedGroupAccounts;
   
   /**
    * Constructs this dialog used by by MPV gwtplatform of ArcBees Inc.
    * 
    * @param    binder
    *           The injected GWT UI creator
    * @param    messages
    *           The injected alerts builder
    */
   @Inject
   public DeletingGroupsAlert(DeletingGroupsAlert.Binder binder,
                              DeletingGroupsAlert.AlertMessages messages)
   {
      initWidget(binder.createAndBindUi(this));
      this.messages = messages;
   }

   /**
    * The yes approval button click handler.
    * 
    * @param    e
    *           Click event
    */
   @UiHandler("yesAction")
   void onYesAction(ClickEvent e)
   {
      logger.log(Level.INFO, "onYesAction");
      getUiHandlers().deleteSelectedGroups(this.selectedGroupAccounts);
   }
   
   /**
    * The no cancel button click handler.
    * 
    * @param    e
    *           Click event
    */
   @UiHandler("noAction")
   void onNoAction(ClickEvent e)
   {
      logger.log(Level.INFO, "onNoAction");
      getUiHandlers().cancelDeletingGroupsAlert();
   }
   
   /**
    * Provides group accounts to be shown by this dialog in its alert message.
    * 
    * @param    selectedGroupAccounts
    *           The selected group accounts to be deleted.
    */
   public void setAlert(TaggedName[] selectedGroupAccounts)
   {
      if (selectedGroupAccounts != null && selectedGroupAccounts.length > 0)
      {
         this.selectedGroupAccounts = selectedGroupAccounts;
         deleteSelectedAlert.setText(this.messages.deleteSelectedAlert(
                  this.messages.groupsToDelete(selectedGroupAccounts.length)));
      }
   }

   /**
    * Provides an access to the target modal dialog.
    * 
    * @return   The underlined modal dialog
    */
   @Override
   protected Modal getModal()
   {
      return modal;
   }

}