/*
 * Copyright 2017 Antti Nieminen
 *
 * Licensed 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 com.haulmont.cuba.web.widgets.client.addons.aceeditor.gwt;

import com.google.gwt.core.client.JavaScriptObject;

/**
 * Handles key presses.
 * 
 */
public interface GwtAceKeyboardHandler {
	/**
	 * A command returned by
	 * GwtAceKeyboardHandler#handleKeyboard(JavaScriptObject, int, String, int, JavaScriptObject)
	 * .
	 * 
	 */
	public enum Command {
		/**
		 * Let the editor handle the key press like it normally would.
		 */
		DEFAULT,
		/**
		 * Prevent the editor from handling the key press.
		 */
		NULL
	}

	/**
	 * Called on key press.
	 * 
	 * @param data
	 * @param hashId
	 * @param keyString
	 * @param keyCode
	 * @param e
	 * @return command
	 */
	public Command handleKeyboard(JavaScriptObject data, int hashId,
                                  String keyString, int keyCode, GwtAceKeyboardEvent e);
}
