GeoPlatformSearchWindow.java

/**
 *
 *    geo-platform
 *    Rich webgis framework
 *    http://geo-platform.org
 *   ====================================================================
 *
 *   Copyright (C) 2008-2017 geoSDI Group (CNR IMAA - Potenza - ITALY).
 *
 *   This program is free software: you can redistribute it and/or modify it
 *   under the terms of the GNU General Public License as published by
 *   the Free Software Foundation, either version 3 of the License, or
 *   (at your option) any later version. This program 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 General Public License
 *   for more details. You should have received a copy of the GNU General
 *   Public License along with this program. If not, see http://www.gnu.org/licenses/
 *
 *   ====================================================================
 *
 *   Linking this library statically or dynamically with other modules is
 *   making a combined work based on this library. Thus, the terms and
 *   conditions of the GNU General Public License cover the whole combination.
 *
 *   As a special exception, the copyright holders of this library give you permission
 *   to link this library with independent modules to produce an executable, regardless
 *   of the license terms of these independent modules, and to copy and distribute
 *   the resulting executable under terms of your choice, provided that you also meet,
 *   for each linked independent module, the terms and conditions of the license of
 *   that module. An independent module is a module which is not derived from or
 *   based on this library. If you modify this library, you may extend this exception
 *   to your version of the library, but you are not obligated to do so. If you do not
 *   wish to do so, delete this exception statement from your version.
 */
package org.geosdi.geoplatform.gui.client.widget.grid.pagination;

import com.extjs.gxt.ui.client.Style.HorizontalAlignment;
import com.extjs.gxt.ui.client.data.*;
import com.extjs.gxt.ui.client.event.*;
import com.extjs.gxt.ui.client.store.ListStore;
import com.extjs.gxt.ui.client.widget.VerticalPanel;
import com.extjs.gxt.ui.client.widget.Window;
import com.extjs.gxt.ui.client.widget.button.Button;
import com.extjs.gxt.ui.client.widget.form.FieldSet;
import com.extjs.gxt.ui.client.widget.form.FormPanel;
import com.extjs.gxt.ui.client.widget.layout.FlowLayout;
import com.extjs.gxt.ui.client.widget.layout.FormData;
import com.extjs.gxt.ui.client.widget.layout.FormLayout;
import com.extjs.gxt.ui.client.widget.toolbar.LabelToolItem;
import com.extjs.gxt.ui.client.widget.toolbar.PagingToolBar;
import com.google.gwt.event.dom.client.KeyCodes;
import com.google.gwt.user.client.ui.AbstractImagePrototype;
import com.google.gwt.user.client.ui.Widget;
import java.util.logging.Logger;
import org.geosdi.geoplatform.gui.client.BasicWidgetResources;
import org.geosdi.geoplatform.gui.client.i18n.BasicWidgetConstants;
import org.geosdi.geoplatform.gui.client.i18n.buttons.ButtonsConstants;
import org.geosdi.geoplatform.gui.client.i18n.status.SearchStatusConstants;
import org.geosdi.geoplatform.gui.client.widget.SearchStatus;
import org.geosdi.geoplatform.gui.client.widget.SearchStatus.EnumSearchStatus;
import org.geosdi.geoplatform.gui.configuration.GPSecureStringTextField;
import org.geosdi.geoplatform.gui.global.GeoPlatformException;
import org.geosdi.geoplatform.gui.model.GeoPlatformBeanModel;

/**
 * @author Nazzareno Sileno - CNR IMAA geoSDI Group
 * @email nazzareno.sileno@geosdi.org
 */
public abstract class GeoPlatformSearchWindow<C extends Widget, T extends GeoPlatformBeanModel>
        extends Window {

    protected final static Logger logger = Logger.getLogger("");
    //
    private VerticalPanel vp;
    protected FieldSet searchFieldSet;
    protected FormPanel formPanel;
    protected ListStore<T> store;
    protected C widget;
    protected GPSecureStringTextField search;
    protected RpcProxy<PagingLoadResult<T>> proxy;
    protected PagingLoader<PagingLoadResult<ModelData>> loader;
    protected PagingToolBar toolBar;
    protected Button selectButton;
    protected Button closeButton;
    protected SearchStatus searchStatus;
    protected String searchText;
    private boolean initialized;
    private int pageSize = 25;

    /**
     *
     * @param lazy
     */
    public GeoPlatformSearchWindow(boolean lazy) {
        if (!lazy) {
            init();
        }
    }

    public GeoPlatformSearchWindow(boolean lazy, int pageSize) {
        this.pageSize = pageSize;
        if (!lazy) {
            init();
        }
    }

    protected final void init() {
        if (!isInitialized()) {
            initWindow();
            initVerticalPanel();
            initFormPanel();
            this.finalizeInitOperations();
            this.initialized = true;
        }
    }

    @Override
    protected void beforeRender() {
        super.beforeRender();
        init();
    }

    /**
     * Remember to call super.finalizeInitOperations when override this method
     */
    public void finalizeInitOperations() {
        add(vp);
    }

    private void initWindow() {
        setModal(true);
        setResizable(false);
        setLayout(new FlowLayout());
        setPlain(true);
        setMaximizable(false);

        addWindowListener(new WindowListener() {

            @Override
            public void windowHide(WindowEvent we) {
                executeClose();
            }

        });

        setWindowProperties();
    }

    private void initVerticalPanel() {
        vp = new VerticalPanel();
        vp.setSpacing(10);
        createStore();
        setUpLoadListener();
        initWidget();
    }

    private void initFormPanel() {
        formPanel = new FormPanel();
        formPanel.setHeaderVisible(false);
        formPanel.setFrame(true);
        formPanel.setLayout(new FlowLayout());

        this.searchFieldSet = new FieldSet();
        searchFieldSet.setHeadingHtml(
                BasicWidgetConstants.INSTANCE.GeoPlatformSearchWindow_headingText());

        FormLayout layout = new FormLayout();
        layout.setLabelWidth(80);
        searchFieldSet.setLayout(layout);

        search = new GPSecureStringTextField();
        search.setFieldLabel(
                BasicWidgetConstants.INSTANCE.GeoPlatformSearchWindow_searchFieldLabelText());

        search.addKeyListener(new KeyListener() {

            @Override
            public void componentKeyUp(ComponentEvent event) {
                if (((event.getKeyCode() == KeyCodes.KEY_BACKSPACE)
                        || (event.getKeyCode() == KeyCodes.KEY_DELETE))
                        && (search.getValue() == null)) {
                    reset();
                }
            }

            @Override
            public void componentKeyPress(ComponentEvent event) {
                if ((event.getKeyCode() == KeyCodes.KEY_ENTER)) {
                    searchText = search.getValue() == null ? ""
                            : search.getValue();
                    loader.load(0, 25);
                }
            }

        });

        searchFieldSet.add(search, new FormData("98%"));

        formPanel.add(searchFieldSet);

        initWidget();
        if (widget == null) {
            throw new NullPointerException(
                    "Widget must be not null (create widget into initWidget method).");
        }
        formPanel.add(widget);

        this.searchStatus = new SearchStatus();
        searchStatus.setAutoWidth(true);

        formPanel.getButtonBar().add(this.searchStatus);

        formPanel.getButtonBar().add(new LabelToolItem("    "));

        formPanel.setButtonAlign(HorizontalAlignment.RIGHT);

        selectButton = new Button(ButtonsConstants.INSTANCE.selectText(),
                new SelectionListener<ButtonEvent>() {

                    @Override
                    public void componentSelected(ButtonEvent ce) {
                        executeSelect();
                    }

                });

        selectButton.setIcon(AbstractImagePrototype.create(
                BasicWidgetResources.ICONS.select()));
        selectButton.disable();

        formPanel.addButton(this.selectButton);

        closeButton = new Button(ButtonsConstants.INSTANCE.closeText(),
                new SelectionListener<ButtonEvent>() {

                    @Override
                    public void componentSelected(ButtonEvent ce) {
                        executeClose();
                    }

                });

        closeButton.setIcon(AbstractImagePrototype.create(
                BasicWidgetResources.ICONS.cancel()));

        formPanel.addButton(closeButton);

        formPanel.setBottomComponent(this.toolBar);

        vp.add(formPanel);
    }

    /**
     * Remove all beans from the Store and after Hide the window
     */
    public void executeClose() {
        super.hide();
        reset();
    }

    public void reset() {
        this.search.reset();
        this.store.removeAll();
        this.toolBar.clear();
        this.selectButton.disable();
        this.searchStatus.clearStatus("");
    }

    public void clearWidgetElements() {
        this.store.removeAll();
        this.toolBar.clear();
    }

    /**
     *
     * @param position
     * @param button
     */
    public void addButton(int position, Button button) {
        this.formPanel.getButtonBar().getItems().add(position, button);
    }

    /**
     * Set the correct Status Icon Style
     */
    public void setSearchStatus(Enum status, Enum message) {
        this.searchStatus.setIconStyle(status.toString());
        this.searchStatus.setText(message.toString());
    }

    public void setSearchStatus(Enum status, String message) {
        this.searchStatus.setIconStyle(status.toString());
        this.searchStatus.setText(message);
    }

    public abstract void setWindowProperties();

    public abstract void createStore();

    public abstract void initWidget();

    public abstract void executeSelect();

    private void setUpLoadListener() {
        loader.addLoadListener(new LoadListener() {

            @Override
            public void loaderBeforeLoad(LoadEvent le) {
                searchStatus.setBusy(
                        BasicWidgetConstants.INSTANCE.GeoPlatformSearchWindow_connectionBusyStatusText());
                if (selectButton.isEnabled()) {
                    selectButton.disable();
                }
            }

            @Override
            public void loaderLoad(LoadEvent le) {
                setSearchStatus(EnumSearchStatus.STATUS_SEARCH,
                        SearchStatusConstants.INSTANCE.STATUS_MESSAGE_SEARCH());
            }

            @Override
            public void loaderLoadException(LoadEvent le) {
                clearWidgetElements();
                try {
                    throw le.exception;
                } catch (GeoPlatformException e) {
                    setSearchStatus(EnumSearchStatus.STATUS_NO_SEARCH,
                            SearchStatusConstants.INSTANCE.STATUS_MESSAGE_NOT_SEARCH());
                } catch (Throwable e) {
                    setSearchStatus(EnumSearchStatus.STATUS_SEARCH_ERROR,
                            SearchStatusConstants.INSTANCE.STATUS_MESSAGE_SEARCH_ERROR());
                }
            }

        });
    }

    /**
     * @return the initialized
     */
    public boolean isInitialized() {
        return initialized;
    }

    /**
     * @return the pageSize
     */
    public int getPageSize() {
        return pageSize;
    }

}