AutoCompleteControl.java

package com.mattc.autotyper.gui.fx;

import javafx.scene.control.ListView;
import com.mattc.autotyper.meta.FXCompatible;
import com.mattc.autotyper.meta.SwingCompatible;

import java.util.List;

/**
 * A JavaFX Control that can handle AutoCompletion input. Typically a Text Control.
 *
 * @param <T>
 * @author Matthew
 */
@FXCompatible
@SwingCompatible
public interface AutoCompleteControl<T> {

    /**
     * Set the Auto Completion data for this Auto Complete Control.
     */
    void setData(List<T> data);

    /**
     * Get the Auto Completion data for this Auto Complete Control.
     */
    List<T> getData();

    /**
     * Get the List View associated with the Auto Completion data and this Auto
     * Complete Control.
     */
    ListView<T> getListView();

    /**
     * Set the Max Size of the List of Auto Complete Data
     */
    void setMaxResults(int max);

    /**
     * Get Max Auto Complete Data Count
     */
    int getMaxResults();

}