SearchSelectorWizardStep.java

/*
 * See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 *
 * 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.xwiki.gwt.wysiwyg.client.plugin.link.ui;

import java.util.List;

import org.xwiki.gwt.user.client.StringUtils;
import org.xwiki.gwt.user.client.ui.ListItem;
import org.xwiki.gwt.wysiwyg.client.Strings;
import org.xwiki.gwt.wysiwyg.client.wiki.WikiPage;
import org.xwiki.gwt.wysiwyg.client.wiki.WikiPageReference;
import org.xwiki.gwt.wysiwyg.client.wiki.WikiServiceAsync;

import com.google.gwt.event.dom.client.ClickEvent;
import com.google.gwt.event.dom.client.ClickHandler;
import com.google.gwt.event.dom.client.KeyCodes;
import com.google.gwt.event.dom.client.KeyPressEvent;
import com.google.gwt.event.dom.client.KeyPressHandler;
import com.google.gwt.user.client.rpc.AsyncCallback;
import com.google.gwt.user.client.ui.Button;
import com.google.gwt.user.client.ui.FlowPanel;
import com.google.gwt.user.client.ui.Label;
import com.google.gwt.user.client.ui.TextBox;

/**
 * Wizard step to select the wiki page to link to, from the page search results for a keyword.
 * 
 * @version $Id: ed0af03405063b344107c9902d90844e9b3225d3 $
 */
public class SearchSelectorWizardStep extends AbstractPageListSelectorWizardStep implements ClickHandler,
    KeyPressHandler
{
    /**
     * Loading class for the time to load the step to which it has been toggled.
     */
    private static final String STYLE_LOADING = "loading";

    /**
     * Loading class for the time to load the step to which it has been toggled.
     */
    private static final String STYLE_ERROR = "errormessage";

    /**
     * The search keyword.
     */
    private String keyword;

    /**
     * The search text box.
     */
    private TextBox searchBox;

    /**
     * Creates a new page selector from search results.
     * 
     * @param wikiService the service used to search wiki pages
     */
    public SearchSelectorWizardStep(WikiServiceAsync wikiService)
    {
        super(wikiService);

        display().addStyleName("xPagesSearch");
        // create the search widget
        FlowPanel searchPanel = new FlowPanel();
        searchPanel.addStyleName("xSearchForm");
        searchBox = new TextBox();
        searchBox.setTitle(Strings.INSTANCE.linkWikipageSearchTooltip());
        Button searchButton = new Button(Strings.INSTANCE.linkWikipageSearchButton());
        searchButton.addClickHandler(this);
        searchBox.addKeyPressHandler(this);
        searchPanel.add(searchBox);
        searchPanel.add(searchButton);
        display().insert(searchPanel, 0);
    }

    @Override
    public void onClick(ClickEvent event)
    {
        // set the keyword from the search input
        keyword = searchBox.getText().trim();
        display().addStyleName(STYLE_LOADING);
        // refresh the results list
        refreshList(new AsyncCallback<Object>()
        {
            @Override
            public void onSuccess(Object result)
            {
                display().removeStyleName(STYLE_LOADING);
            }

            @Override
            public void onFailure(Throwable caught)
            {
                display().removeStyleName(STYLE_LOADING);
                Label error = new Label(Strings.INSTANCE.linkErrorLoadingData());
                error.addStyleName(STYLE_ERROR);
                ListItem<WikiPage> errorListItem = new ListItem<WikiPage>();
                errorListItem.add(error);
                getList().insertItem(errorListItem, 0);
            }
        });
    }

    @Override
    protected void fetchData(AsyncCallback<List<WikiPage>> callback)
    {
        String wikiName = new WikiPageReference(getData().getOrigin()).getWikiName();
        getWikiService().getMatchingPages(wikiName, getKeyword(), 0, 20, callback);
    }

    /**
     * @return the keyword
     */
    public String getKeyword()
    {
        return keyword == null ? "" : keyword;
    }

    /**
     * @param keyword the keyword to set
     */
    public void setKeyword(String keyword)
    {
        this.keyword = keyword;
    }

    @Override
    public void onKeyPress(KeyPressEvent event)
    {
        // if the key is enter in the search box, search
        if (event.getSource() == searchBox && event.getNativeEvent().getKeyCode() == KeyCodes.KEY_ENTER
            && !event.isAnyModifierKeyDown()) {
            // should send the correct sender
            onClick(null);
        }
    }

    @Override
    public void setActive()
    {
        // if the search box is empty, set focus there
        if (StringUtils.isEmpty(getKeyword())) {
            searchBox.setFocus(true);
        } else {
            super.setActive();
        }
    }
}