org.eclipse.osbp.vaadin.addons.suggesttext/src/org/eclipse/osbp/vaadin/addons/suggesttext/client/SuggestTextFieldClientRpc.java

/**
 *                                                                            
 * Copyright (c) 2011, 2016 - Loetz GmbH&Co.KG (69115 Heidelberg, Germany)
 *                                                                            
 * All rights reserved. This program and the accompanying materials           
 * are made available under the terms of the Eclipse Public License v1.0       
 * which accompanies this distribution, and is available at                  
 * http://www.eclipse.org/legal/epl-v10.html                                 
 *                                                                            
 * Contributors:   
 * Florian Pirchner <florian.pirchner@gmail.com> - Initial implementation
 */
package org.eclipse.osbp.vaadin.addons.suggesttext.client;

import java.util.List;

import org.eclipse.osbp.vaadin.addons.suggesttext.client.OQueryDelegate.SuggestionResult;

import com.vaadin.shared.communication.ClientRpc;

// TODO: Auto-generated Javadoc
/**
 * The Interface SuggestTextFieldClientRpc.
 */
public interface SuggestTextFieldClientRpc extends ClientRpc {

	/**
	 * Response from the server with suggestions. Request and response are
	 * linked by the handleId.
	 *
	 * @param handleId
	 *            the handle id
	 * @param response
	 *            the response
	 */
	public void respond(String handleId, List<SuggestionResult> response);

	/**
	 * Opens the popup if not already opened and shows the suggested values.
	 */
	public void openPopup();

	/**
	 * Closes the popup if open. Else it has no effect.
	 */
	public void closePopup();

	/**
	 * Navigates the selected suggestion to the next one available.
	 */
	public void navigateToNext();

	/**
	 * Navigates the selected suggestion to the previous one available.
	 */
	public void navigateToPrevious();
	
	/**
	 * Selects the current suggestion.
	 */
	public void selectCurrent();

}