AbstractMainUIHandler

package fr.ifremer.quadrige2.ui.swing.common.content;

/*
 * #%L
 * Reef DB :: UI
 * $Id:$
 * $HeadURL:$
 * %%
 * Copyright (C) 2014 - 2015 Ifremer
 * %%
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero 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 Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 * #L%
 */

import com.google.common.base.Preconditions;
import fr.ifremer.quadrige2.core.security.AuthenticationInfo;
import fr.ifremer.quadrige2.ui.swing.common.*;
import fr.ifremer.quadrige2.ui.swing.common.content.db.DbManagerUIHandler;
import fr.ifremer.quadrige2.ui.swing.common.content.login.LoginUI;
import jaxx.runtime.SwingUtil;
import jaxx.runtime.validator.swing.SwingValidator;
import org.apache.commons.lang3.StringUtils;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.nuiton.jaxx.application.bean.RemoveablePropertyChangeListener;
import org.nuiton.jaxx.application.swing.util.CloseableUI;

import javax.swing.*;
import java.awt.Cursor;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.beans.PropertyChangeEvent;
import java.util.Locale;

import static org.nuiton.i18n.I18n.t;

/**
 * <p>AbstractMainUIHandler class.</p>
 *
 * @since 0.1
 */
public abstract class AbstractMainUIHandler<M extends ApplicationUIContext, UI extends MainUI<? extends AbstractMainUIHandler>> extends AbstractUIHandler<ApplicationUIContext, UI> {

    /**
     * Logger.
     */
    private static final Log LOG = LogFactory.getLog(AbstractMainUIHandler.class);

    private JComponent currentBody;

    private Timer messageTimer;

    /**
     * <p>reloadDbManagerText.</p>
     */
    public void reloadDbManagerText() {

        ApplicationUI<?, ?> body = (ApplicationUI<?, ?>) currentBody;

        if (body != null && body.getHandler() instanceof DbManagerUIHandler) {
            DbManagerUIHandler dbManagerUIHandler = (DbManagerUIHandler) body.getHandler();
            dbManagerUIHandler.updateMessage();
        }
    }

    //------------------------------------------------------------------------//
    //-- AbstractApplicationUIHandler methods                                     --//
    //------------------------------------------------------------------------//

    /**
     * {@inheritDoc}
     */
    @Override
    public void beforeInit(UI ui) {
        super.beforeInit(ui);
        ApplicationUIContext context = ApplicationUIContext.getInstance();
        ui.setContextValue(context);

        context.installActionUI(ui);
        context.addPropertyChangeListener(new RemoveablePropertyChangeListener() {
            @Override
            public void propertyChange(final PropertyChangeEvent evt) {
                String propertyName = evt.getPropertyName();
                if (ApplicationUIContext.PROPERTIES_TO_SAVE.contains(propertyName)) {

                    // change the ui title
                    changeTitle();

                } else if (propertyName.equals(ApplicationUIContext.PROPERTY_SCREEN)) {

                    // change the current screen
                    setScreen((Screen) evt.getNewValue());
                }
            }
        });
        ui.setContextValue(ui, MainUI.class.getName());

        // ecoute des changements de l'état busy
        context.addPropertyChangeListener(ApplicationUIContext.PROPERTY_BUSY, new RemoveablePropertyChangeListener() {

            @Override
            public void propertyChange(PropertyChangeEvent evt) {
                Boolean newvalue = (Boolean) evt.getNewValue();
                updateBusyState(newvalue != null && newvalue);
            }
        });

        // ecoute des changements de l'état busy
        context.addPropertyChangeListener(ApplicationUIContext.PROPERTY_HIDE_BODY, new RemoveablePropertyChangeListener() {

            @Override
            public void propertyChange(PropertyChangeEvent evt) {
                Boolean newvalue = (Boolean) evt.getNewValue();
                if (getUI() != null && getUI().getBody() != null) {
                    getUI().getBody().setVisible(newvalue != null && newvalue);
                }
            }
        });

    }

    /**
     * <p>updateBusyState.</p>
     *
     * @param busy a boolean.
     */
    protected void updateBusyState(boolean busy) {

        if (LOG.isDebugEnabled()) {
            LOG.debug(busy ? "block ui in busy mode" : "unblock ui in none busy mode");
        }

        // update cursor
        getUI().setCursor(busy ? Cursor.getPredefinedCursor(Cursor.WAIT_CURSOR) : Cursor.getDefaultCursor());

        if (getUI().getMenu() != null) {
            if (busy) getUI().getMenu().removeNotify();
            else getUI().getMenu().addNotify();
        }
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void afterInit(UI ui) {

        initUI(ui);

        // allow MainUI frame to move even when UIAction performing or modal dialog (DOCUMENT_MODAL or APPLICATION_MODAL) opened
        // only dialog with TOOLKIT_MODAL mode will block MainUI
        // TODO : à laisser en commentaire tant ques les ActionUI de JAXX sont TOOLKIT_MODAL (ou superieure à APPLICATION_MODAL)
        // spécialement dans FileChooserUtil qui n'ouvre pas en modal
        // sinon lors des actions longues, le menu est toujours dispo
        // par contre on perd la possibilté de bouger la fenetre lors de ces actions
//        ui.setModalExclusionType(Dialog.ModalExclusionType.APPLICATION_EXCLUDE);

        // installation layer de blocage en mode busy
        SwingUtil.setLayerUI(getUI().getBody(), getUI().getBusyBlockLayerUI());

        //FIXME-TC See why this binding is not setted ?
//        ui.applyDataBinding(MainUI.BINDING_MENU_CHANGE_LOCALE_FR_ENABLED);
//        ui.applyDataBinding(MainUI.BINDING_MENU_CHANGE_LOCALE_UK_ENABLED);

        // Init SwingSession
        getContext().initSwingSession(getUI());

        changeTitle();

        JToolBar bar = getUI().getBottomBar();
        getUI().getStatus().addWidget(bar, 0);

        messageTimer = new Timer(3000, new ActionListener() {

            @Override
            public void actionPerformed(ActionEvent e) {
                getUI().getStatus().clearStatus();
            }
        });
        messageTimer.setRepeats(false);

    }

    /**
     * {@inheritDoc}
     */
    @Override
    protected JComponent getComponentToFocus() {
        return currentBody;
    }

    /**
     * <p>Getter for the field <code>currentBody</code>.</p>
     *
     * @return a {@link JComponent} object.
     */
    public JComponent getCurrentBody() {
        return currentBody;
    }

    /**
     * <p>closeUI.</p>
     */
    public void closeUI() {

        // close ui
        onCloseUI();

        getContext().saveSwingSession(null);

        // close context
        getContext().close();

    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void onCloseUI() {

        if (getUI() != null) {

            // clean ui
            ApplicationUIUtil.removeBindings(getUI());
            getUI().setVisible(false);
        }
    }

    //------------------------------------------------------------------------//
    //-- Public methods                                                     --//
    //------------------------------------------------------------------------//

    /**
     * <p>reloadUI.</p>
     */
    public void reloadUI() {

        //close ui
        onCloseUI();

        // restart ui TODO trouver comment faire
//        RunUI.reloadUI(getContext());
        showNotImplementedFunctionnality();

    }

    /**
     * <p>changeLocale.</p>
     *
     * @param locale a {@link Locale} object.
     */
    public void changeLocale(Locale locale) {

        // change locale (and save configuration)
        getModel().setLocale(locale);

        // close reload
        reloadUI();
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public final void showInformationMessage(String message) {
        getUI().getStatus().setStatus(ApplicationUIUtil.getHtmlString(message));

        messageTimer.restart();
    }

    /**
     * <p>registerValidator.</p>
     *
     * @param validator a {@link SwingValidator} object.
     */
    public void registerValidator(SwingValidator<?> validator) {
        getUI().getValidatorMessageWidget().registerValidator(validator);
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void clearValidators() {
        getUI().getValidatorMessageWidget().clearValidators();
    }

    /**
     * <p>quitCurrentScreen.</p>
     *
     * @return a boolean.
     */
    public boolean quitCurrentScreen() {

        boolean canClose;
        if (getContext().getScreen() == null || currentBody == null) {

            // no screen, surely can quit
            canClose = true;
            if (LOG.isWarnEnabled()) {
                LOG.warn("==================================================");
                LOG.warn("No screen, Should then skipCheckCurrent in action.");
                LOG.warn("==================================================");
            }
        } else {
            ApplicationUI<?, ?> body = (ApplicationUI<?, ?>) currentBody;
            Preconditions.checkNotNull(currentBody);
            AbstractUIHandler<?, ?> handler = body.getHandler();
            if (handler instanceof CloseableUI) {

                // try to quit UI
                canClose = ((CloseableUI) handler).quitUI();
            } else {

                // can always close ui
                canClose = true;
            }
        }
        return canClose;
    }

    //------------------------------------------------------------------------//
    //-- Internal methods                                                   --//
    //------------------------------------------------------------------------//

    /**
     * <p>setScreen.</p>
     *
     * @param screen a {@link Screen} object.
     *               <p>
     *               TODO ???? à mettre dans un listener quand un nouvel écran est demandé
     */
    protected void setScreen(Screen screen) {

        ApplicationUIContext context = getContext();

        // close current body (if any)
        if (currentBody != null) {
            ApplicationUI<?, ?> body = (ApplicationUI<?, ?>) currentBody;
            body.getHandler().onCloseUI();

            getContext().saveSwingSession(currentBody);

            getUI().getBody().remove(currentBody);

            currentBody = null;
        }

        if (screen != null) {

            // load new body
            ApplicationUI<?, ?> screenUI = context.getApplicationUI(screen);

            if (screenUI != null) {

                // TODO créer l'icône dans chaque écran (dans le beforeInit comme le model)
                Icon icon = screenUI.getContextValue(Icon.class);

                final JButton showHelp = getUI().getShowHelp();
                final JToolBar rightDecoration = new JToolBar();
                rightDecoration.setFloatable(false);
                rightDecoration.setOpaque(false);
                rightDecoration.setBorderPainted(false);
                rightDecoration.add(showHelp, 0);
                this.currentBody = (JComponent) screenUI;
                context.getSwingSession().add(currentBody, true);
                getUI().getBody().setTitle(screenUI.getHandler().getTitle());
                getUI().getBody().setContentContainer(currentBody);
                getUI().getBody().setLeftDecoration(new JLabel(icon));
                getUI().getBody().setRightDecoration(rightDecoration);
                getUI().getBody().getRightDecoration().setVisible(true);

            } else {

                // if no screen, set fallback screen
                context.getDialogHelper().showErrorDialog(t("quadrige2.main.screen.error", screen.getName()));
                context.setFallBackScreen();
            }
        }
    }

    /**
     * <p>changeTitle.</p>
     */
    public void changeTitle() {

        String title = getContext().getSelectedScreenTitle();

        getUI().setTitle(t("quadrige2.main.title.application",
                getConfig().getApplicationName(),
                getConfig().getVersion(),
                title));

    }

    /**
     * <p>askAuthenticationInfo.</p>
     *
     * @param url a {@link String} object.
     * @return a {@link fr.ifremer.quadrige2.core.security.AuthenticationInfo} object.
     */
    public AuthenticationInfo askAuthenticationInfo(String url) {

        AuthenticationInfo authentication;

        // Auto-login, if config as login/pwd (only the first time)
        if (getContext().getAuthenticationInfo() == null
                && StringUtils.isNotBlank(getConfig().getAuthenticationDefaultUsername())
                && StringUtils.isNotBlank(getConfig().getAuthenticationDefaultPassword())) {
            authentication = new AuthenticationInfo(
                    getConfig().getAuthenticationDefaultUsername(),
                    getConfig().getAuthenticationDefaultPassword()
            );
        }

        // Open the login dialog
        else {
            LoginUI loginUI = new LoginUI((ApplicationUI) getUI());
            loginUI.getModel().setUrl(url);
            loginUI.getModel().setAuthenticationInfo(getContext().getAuthenticationInfo());
            openDialogForceOnTop(loginUI);
            authentication = loginUI.getModel().getAuthenticationInfo();
        }

        if (authentication != null) {

            // store it back in authentication store
            getContext().setAuthenticationInfo(authentication);
        }

        return authentication;
    }

}