Open Source & Free ❤️

Dynamic AutoComplete

Dynamic AutoComplete

Header Image

With the fix for issue #1694 we can now have
a moderately simple method of creating an
that works with a webservice. This has been requested quite often and was quite frustrating to implement in the past
it is now relatively simple with just a few lines of code.

Check out the live demo using the JavaScript port on the right side here

You can see the full working sample of this project in this
github repository notice that you will need to fill
in a google web API key for the webservice to work as explained

The sample works relatively simply, instead of passing a fixed list of elements we pass a model to the auto
complete and then just modify the model. The auto complete updates itself based on the modification to the
model which is completely asynchronous.

The main thing we need to do is override the filter method and mutate the model there.

Check out the main code of this app below:

Form hi = new Form("AutoComplete", new BoxLayout(BoxLayout.Y_AXIS));
if(apiKey == null) {
    hi.add(new SpanLabel("This demo requires a valid google API key to be set in the constant apiKey, "
            + "you can get this key for the webservice (not the native key) by following the instructions here: "
            + ""));
    hi.getToolbar().addCommandToRightBar("Get Key", null, e -> Display.getInstance().execute(""));;
 final DefaultListModel<String> options = new DefaultListModel<>();
 AutoCompleteTextField ac = new AutoCompleteTextField(options) {
     protected boolean filter(String text) {
         if(text.length() == 0) {
             return false;
         String[] l = searchLocations(text);
         if(l == null || l.length == 0) {
             return false;

         for(String s : l) {
         return true;

Notice that it relies on a call to the Google webservice as such:

String[] searchLocations(String text) {
    try {
        if(text.length() > 0) {
            ConnectionRequest r = new ConnectionRequest();
            r.addArgument("key", apiKey);
            r.addArgument("input", text);
            Map<String,Object> result = new JSONParser().parseJSON(new InputStreamReader(new ByteArrayInputStream(r.getResponseData()), "UTF-8"));
            String[] res = Result.fromContent(result).getAsStringArray("//description");
            return res;
    } catch(Exception err) {
    return null;


  • Carlos says:

    Awesome, thank you, but I would take


    right before:

    if (text.length() == 0)

    So if the user erase to empty the textfield, the combo with the completions disappears.

  • Shai Almog says:

    Makes sense, thanks!

  • Diamond says:

    Hi Shai,

    How do I style the AutoCompleteTextField List selected item? The default color is orange on my theme and I will like to change it to blue. I’ve tried styling “AutoCompleteList”, but it doesn’t help… the whole list got changed to blue and I want only one item to change. I also tried AutoCompleteListRenderer and AutoCompleteListRendererFocus, not helping either.

  • Shai Almog says:

    Hi Diamond,
    you can use setCompletionRenderer() to set a custom renderer. It uses the standard list renderer with ListRendererFocus and ListRenderer UIID’s.

  • Diamond says:

    Hi Shai,

    Is it possible to change the AutoComplete popup to have an icon and text?

    Also, is it possible to clear the text input if user didn’t choose from the popup? This is to force only suggested values in the TextField.

    Lastly, Can I make the popup list break line for long text?

    If any of these are possible, can you please guide on how to achieve this.

    Thank you.

  • Shai Almog says:

    Hi Diamond,
    It’s a renderer so you can do everything a renderer can do with its standard limitations.
    So icon should be easy just use your data model when you fetch the information to render the icon and potentially more than one row.

    However, dynamic line breaking is problematic with renderers so that won’t work.

    I’d love to have a way to use components in box Y instead of list+renderer for this component and the original issue actually suggested going in that direction.

  • Diamond says:

    ac.getHintLabel().setUIID(“CustomHintUIID”); is throwing a nullPointer exception, is there a way to fix this?

  • Shai Almog says:

    That’s standard behavior in a text area/field as well… If you didn’t call setHint(…) first the label wasn’t created so it will be null.

  • emaalam says:

    Hi Shai
    i have two problems first i want to add a map in AutoCompleteTextField exactlly in DefaultListModel and after i want to add the the listmodel in my autocompletetextField second : how can i get the text when i select an element in the AutoCompleteTextField

Leave a Reply