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

   1 /*
   2  * Copyright 2000-2021 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.escalator.events;
  17
  18 import com.google.gwt.event.shared.GwtEvent;
  19
  20 /**
  21  * Event fired when a spacer element is hidden or shown in Escalator.
  22  *
  23  * @author Vaadin Ltd
  24  * @since 7.7.13
  25  */
  26 public class SpacerVisibilityChangedEvent
  27         extends GwtEvent<SpacerVisibilityChangedHandler> {
  28
  29     /**
  30      * Handler type.
  31      */
  32     public static final Type<SpacerVisibilityChangedHandler> TYPE = new Type<SpacerVisibilityChangedHandler>();
  33
  34     public static final Type<SpacerVisibilityChangedHandler> getType() {
  35         return TYPE;
  36     }
  37
  38     private final int rowIndex;
  39     private final boolean visible;
  40
  41     /**
  42      * Creates a spacer visibility changed event.
  43      *
  44      * @param rowIndex
  45      *         index of row to which the spacer belongs
  46      * @param visible
  47      *         {@code true} if the spacer element is shown, {@code false} if the
  48      *         spacer element is hidden
  49      */
  50     public SpacerVisibilityChangedEvent(int rowIndex, boolean visible) {
  51         this.rowIndex = rowIndex;
  52         this.visible = visible;
  53     }
  54
  55     /**
  56      * Gets the row index to which the spacer element belongs.
  57      *
  58      * @return the row index to which the spacer element belongs
  59      */
  60     public int getRowIndex() {
  61         return rowIndex;
  62     }
  63
  64     /**
  65      * Gets whether the spacer element is displayed.
  66      *
  67      * @return {@code true} if the spacer element is shown, {@code false} if the
  68      * spacer element is hidden
  69      */
  70     public boolean isVisible() {
  71         return visible;
  72     }
  73
  74     @Override
  75     public Type<SpacerVisibilityChangedHandler> getAssociatedType() {
  76         return TYPE;
  77     }
  78
  79     @Override
  80     protected void dispatch(SpacerVisibilityChangedHandler handler) {
  81         handler.onSpacerVisibilityChanged(this);
  82     }
  83
  84 }