org.richfaces.fragment.autocomplete.SelectOrConfirm Maven / Gradle / Ivy
/*
* JBoss, Home of Professional Open Source
* Copyright 2013, Red Hat, Inc. and individual contributors
* by the @authors tag. See the copyright.txt in the distribution for a
* full listing of individual contributors.
*
* This is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This software is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package org.richfaces.fragment.autocomplete;
import org.richfaces.fragment.common.picker.ChoicePicker;
/**
* @author Juraj Huska
* @author Jiri Stefek
*/
public interface SelectOrConfirm {
/**
* Confirms previously typed value.
*
* In other words it puts the already typed text into the associated autocomplete input.
*
* @return back the Autocomplete component.
*/
Autocomplete confirm();
/**
* Selects the first suggestion.
*
* @return back the Autocomplete component.
* @throws RuntimeException when no option found
*/
Autocomplete select();
/**
* Selects the suggestion from the list of the suggestions at index.
*
* @param index index of suggestion
* @return back the Autocomplete component.
* @throws RuntimeException when no option found
*/
Autocomplete select(int index);
/**
* Selects the first suggestion, which matches the given text.
*
* @param match string to match the suggestion
* @return returns back the Autocomplete component.
* @throws RuntimeException when no option found
*/
Autocomplete select(String match);
/**
* Selects the first suggestion according to the given rules in picker param.
*
* In other words, it selects the first suggestion which satisfies the choice picking rules defined in picker
*
* @param picker for defining the rules by which the suggestion will be selected
* @return returns back the Autocomplete component.
* @throws RuntimeException when no such option found
* @see org.richfaces.fragment.common.picker.ChoicePickerHelper.ByIndexChoicePicker
* @see org.richfaces.fragment.common.picker.ChoicePickerHelper.ByVisibleTextChoicePicker
*/
Autocomplete select(ChoicePicker picker);
}