source.dussan.org Git - vaadin-framework.git/blob

   1 /*
   2  * Copyright 2000-2018 Vaadin Ltd.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License"); you may not
   5  * use this file except in compliance with the License. You may obtain a copy of
   6  * the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
  12  * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
  13  * License for the specific language governing permissions and limitations under
  14  * the License.
  15  */
  16 package com.vaadin.v7.client.widget.grid.selection;
  17
  18 import com.google.gwt.event.shared.HandlerRegistration;
  19 import com.vaadin.v7.client.widget.grid.events.BodyClickHandler;
  20 import com.vaadin.v7.client.widget.grid.events.GridClickEvent;
  21 import com.vaadin.v7.client.widgets.Grid;
  22
  23 /**
  24  * Generic class to perform selections when clicking on cells in body of Grid.
  25  *
  26  * @since 7.4
  27  * @author Vaadin Ltd
  28  */
  29 public class ClickSelectHandler<T> {
  30
  31     private Grid<T> grid;
  32     private HandlerRegistration clickHandler;
  33     private boolean deselectAllowed = true;
  34
  35     private class RowClickHandler implements BodyClickHandler {
  36
  37         @Override
  38         public void onClick(GridClickEvent event) {
  39             if (!grid.isUserSelectionAllowed()) {
  40                 return;
  41             }
  42
  43             T row = (T) event.getTargetCell().getRow();
  44             if (!grid.isSelected(row)) {
  45                 grid.select(row);
  46             } else if (deselectAllowed) {
  47                 grid.deselect(row);
  48             }
  49         }
  50     }
  51
  52     /**
  53      * Constructor for ClickSelectHandler. This constructor will add all
  54      * necessary handlers for selecting rows by clicking cells.
  55      *
  56      * @param grid
  57      *            grid to attach to
  58      */
  59     public ClickSelectHandler(Grid<T> grid) {
  60         this.grid = grid;
  61         clickHandler = grid.addBodyClickHandler(new RowClickHandler());
  62     }
  63
  64     /**
  65      * Clean up function for removing all now obsolete handlers.
  66      */
  67     public void removeHandler() {
  68         clickHandler.removeHandler();
  69     }
  70
  71     /**
  72      * Sets whether clicking the currently selected row should deselect the row.
  73      *
  74      * @param deselectAllowed
  75      *            <code>true</code> to allow deselecting the selected row;
  76      *            otherwise <code>false</code>
  77      */
  78     public void setDeselectAllowed(boolean deselectAllowed) {
  79         this.deselectAllowed = deselectAllowed;
  80     }
  81 }