KeySignalListener.java

/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package org.waveprotocol.wave.client.common.util;

import com.google.gwt.user.client.ui.Widget;

/**
 * A listener to key signals.
 * Signal equivalent of a keyboard listener.
 *
 * @author danilatos@google.com (Daniel Danilatos)
 */
public interface KeySignalListener {

  /**
   * @param sender
   * @param signal
   * @return true if the event was "handled" for some meaning of handled
   *   Usually this means the caller won't handle it themselves.
   */
  boolean onKeySignal(Widget sender, SignalEvent signal);
}