package fr.ifremer.quadrige2.ui.swing.common.table;
   
   /*
    * #%L
    * Reef DB :: UI
    * $Id:$
    * $HeadURL:$
    * %%
    * Copyright (C) 2014 - 2015 Ifremer
   * %%
   * 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 General Public License for more details.
   * 
   * You should have received a copy of the GNU Affero General Public License
   * along with this program.  If not, see <http://www.gnu.org/licenses/>.
   * #L%
   */
  
  import fr.ifremer.quadrige2.core.config.Quadrige2CoreConfiguration;
  import fr.ifremer.quadrige2.ui.swing.common.table.action.AdditionalTableAction;
  import org.apache.commons.lang3.ObjectUtils;
  import org.jdesktop.swingx.JXTable;
  import org.jdesktop.swingx.action.AbstractActionExt;
  import org.jdesktop.swingx.action.ActionContainerFactory;
  import org.jdesktop.swingx.table.ColumnControlPopup.ActionGrouper;
  import org.jdesktop.swingx.table.TableColumnExt;
  
  import javax.swing.Action;
  import javax.swing.JMenuItem;
  import javax.swing.table.TableColumn;
  import java.awt.Color;
  import java.awt.event.ActionEvent;
  import java.awt.event.MouseAdapter;
  import java.awt.event.MouseEvent;
  import java.util.ArrayList;
  import java.util.List;
  
  import static org.nuiton.i18n.I18n.t;
  
  /**
   * Override version of ColumnControlButton for a JXTable/JXTreeTable. All non hideable columns are not displayed in the popup
   *
   * @author Ludovic Pecquot <ludovic.pecquot@e-is.pro>
   */
  public class ColumnControlButton extends org.jdesktop.swingx.table.ColumnControlButton {
  
      private Quadrige2CoreConfiguration configuration;
  
      /**
       * <p>Constructor for ColumnControlButton.</p>
       *
       * @param table a {@link JXTable} object.
       */
      public ColumnControlButton(JXTable table) {
          super(table);
  
          configuration = Quadrige2CoreConfiguration.getInstance();
  
          AbstractActionExt showAllColumnAction = new AbstractActionExt(t("quadrige2.table.showAllColumn")) {
  
              @Override
              public void actionPerformed(ActionEvent e) {
  
                  for (ColumnVisibilityAction action : getColumnVisibilityActions()) {
                      action.setSelected(true);
                  }
  
              }
          };
  
          showAllColumnAction.putValue(GroupKeyActionGrouper.GROUP_KEY, 0);
          table.getActionMap().put(ColumnControlButton.COLUMN_CONTROL_MARKER + "showAllColumn", showAllColumnAction);
  
          // Add all other AdditionalTableActions
          // For now, use only 1 AdditionalTableAction TODO: be able to add multiple AdditionalTableActions
          Action additionalAction = table.getActionMap().get(AdditionalTableAction.ACTION_NAME);
          if (additionalAction instanceof AdditionalTableAction) {
              additionalAction.putValue(GroupKeyActionGrouper.GROUP_KEY, 1);
              // add the additional action with another key
              table.getActionMap().put(ColumnControlButton.COLUMN_CONTROL_MARKER + "z_additionalAction", additionalAction);
          }
  
          setActionGrouper(new GroupKeyActionGrouper());
      }
  
      /**
       * {@inheritDoc}
       */
      @Override
      protected ColumnVisibilityAction createColumnVisibilityAction(TableColumn column) {
          if (column instanceof TableColumnExt && !((TableColumnExt) column).isHideable()) {
              return null;
         }
         return super.createColumnVisibilityAction(column);
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     protected void addVisibilityActionItems() {
         final List<ColumnVisibilityAction> actions = new ArrayList<>(getColumnVisibilityActions());
 
         // Sort actions by name (= column label)
         actions.sort((o1, o2) -> ObjectUtils.compare(o1.getName(), o2.getName()));
         getColumnControlPopup().addVisibilityActionItems(actions);
     }
 
     @Override
     protected org.jdesktop.swingx.table.ColumnControlPopup createColumnControlPopup() {
         return new ColumnControlPopup();
     }
 
     public static class GroupKeyActionGrouper implements ActionGrouper {
 
         //Marker to support custom grouping of additional actions. (Issue #swingx-968)
         static final String GROUP_KEY = "customActionGroup";
 
         @Override
         public <A extends Action> List<List<A>> group(List<A> actions) {
             List<List<A>> result = new ArrayList<>();
             List<Object> keys = new ArrayList<>();
             List<A> noKey = new ArrayList<>();
             for (A action : actions) {
                 Object groupKey = action.getValue(GROUP_KEY);
                 if (groupKey != null) {
                     int index = keys.indexOf(groupKey);
                     if (index < 0) {
                         keys.add(groupKey);
                         index = keys.size() - 1;
                         result.add(new ArrayList<>());
                     }
                     result.get(index).add(action);
                 } else {
                     noKey.add(action);
                 }
 
             }
             result.add(0, noKey);
             return result;
         }
     }
 
     class ColumnControlPopup extends DefaultColumnControlPopup {
 
         @Override
         protected void addItems(List<? extends Action> actions) {
             ActionContainerFactory factory = new ActionContainerFactory(null);
             for (Action action : actions) {
 
                 JMenuItem menuItem = factory.createMenuItem(action);
 
                 // fix text foreground
                 // TODO use computeForeground with the color of selected element in configuration
                 menuItem.addMouseListener(new MouseAdapter() {
                     @Override
                     public void mouseEntered(MouseEvent e) {
                         if (menuItem.isEnabled()) menuItem.setForeground(Color.WHITE);
                     }
 
                     @Override
                     public void mouseExited(MouseEvent e) {
                         if (menuItem.isEnabled()) menuItem.setForeground(Color.BLACK);
                     }
 
                     @Override
                     public void mouseClicked(MouseEvent e) {
                         menuItem.setForeground(Color.BLACK);
                     }
                 });
                 addItem(menuItem);
             }
         }
     }
 }