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.client.widget.grid.events;
  17
  18 import com.google.gwt.event.shared.EventHandler;
  19 import com.google.gwt.event.shared.GwtEvent;
  20
  21 /**
  22  * FOR INTERNAL USE ONLY, MAY GET REMOVED OR MODIFIED AT ANY TIME!
  23  * <p>
  24  * Event handler that gets notified when the visibility of the vertical
  25  * scrollbar of the Escalator changes.
  26  *
  27  * @author Vaadin Ltd
  28  */
  29 public interface VerticalScrollbarVisibilityChangeHandler
  30         extends EventHandler {
  31
  32     /**
  33      * FOR INTERNAL USE ONLY, MAY GET REMOVED OR MODIFIED AT ANY TIME!
  34      * <p>
  35      * Called when the visibility of the vertical scrollbar of the Escalator
  36      * changes.
  37      *
  38      * @param event
  39      *            the row visibility change event describing the change
  40      */
  41     void onVisibilityChange(
  42             VerticalScrollbarVisibilityChangeEvent event);
  43
  44     /**
  45      * FOR INTERNAL USE ONLY, MAY GET REMOVED OR MODIFIED AT ANY TIME!
  46      * <p>
  47      * Event fired when the visibility of the vertical scrollbar of the
  48      * Escalator changes.
  49      *
  50      * @author Vaadin Ltd
  51      */
  52     public class VerticalScrollbarVisibilityChangeEvent extends
  53             GwtEvent<VerticalScrollbarVisibilityChangeHandler> {
  54         /**
  55          * FOR INTERNAL USE ONLY, MAY GET REMOVED OR MODIFIED AT ANY TIME!
  56          * <p>
  57          * The type of this event.
  58          */
  59         public static final Type<VerticalScrollbarVisibilityChangeHandler> TYPE = new Type<>();
  60
  61         /**
  62          * FOR INTERNAL USE ONLY, MAY GET REMOVED OR MODIFIED AT ANY TIME!
  63          * <p>
  64          * Creates a new Escalator vertical scrollbar visibility change event.
  65          *
  66          */
  67         public VerticalScrollbarVisibilityChangeEvent() {
  68             // NOP
  69         }
  70
  71         /*
  72          * (non-Javadoc)
  73          *
  74          * @see com.google.gwt.event.shared.GwtEvent#getAssociatedType()
  75          */
  76         @Override
  77         public Type<VerticalScrollbarVisibilityChangeHandler> getAssociatedType() {
  78             return TYPE;
  79         }
  80
  81         /*
  82          * (non-Javadoc)
  83          *
  84          * @see
  85          * com.google.gwt.event.shared.GwtEvent#dispatch(com.google.gwt.event.
  86          * shared .EventHandler)
  87          */
  88         @Override
  89         protected void dispatch(
  90                 VerticalScrollbarVisibilityChangeHandler handler) {
  91             handler.onVisibilityChange(this);
  92         }
  93     }
  94 }