org.vaadin.tori.ToriNavigator.java Source code

Introduction

Here is the source code for org.vaadin.tori.ToriNavigator.java

Source

/*
 * Copyright 2012 Vaadin Ltd.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 * 
 * http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */

package org.vaadin.tori;

import org.vaadin.tori.indexing.IndexableCategoryView;
import org.vaadin.tori.indexing.IndexableDashboardView;
import org.vaadin.tori.indexing.IndexableThreadView;
import org.vaadin.tori.indexing.IndexableView;
import org.vaadin.tori.mvp.AbstractView;
import org.vaadin.tori.view.listing.ListingViewImpl;
import org.vaadin.tori.view.thread.ThreadViewImpl;
import org.vaadin.tori.view.thread.newthread.NewThreadViewImpl;

import com.vaadin.navigator.Navigator;
import com.vaadin.navigator.View;
import com.vaadin.navigator.ViewChangeListener;
import com.vaadin.server.Page;
import com.vaadin.ui.ComponentContainer;
import com.vaadin.ui.JavaScript;
import com.vaadin.ui.UI;

@SuppressWarnings("serial")
public class ToriNavigator extends Navigator {
    private final Configuration configuration = ToriApiLoader.getCurrent().getDataSource().getConfiguration();

    public ToriNavigator(final ComponentContainer container) {
        super(UI.getCurrent(), container);
        for (ApplicationView view : ApplicationView.values()) {
            addView(view.getNavigatorUrl(), view.getViewClass());
        }
        setErrorView(ApplicationView.getDefault().getViewClass());

        addViewChangeListener(new ViewChangeListener() {
            @Override
            public boolean beforeViewChange(final ViewChangeEvent event) {
                ((AbstractView<?, ?>) event.getNewView()).init();
                return true;
            }

            @Override
            public void afterViewChange(final ViewChangeEvent event) {
                final View newView = event.getNewView();
                if (newView instanceof AbstractView<?, ?>) {
                    String title = ((AbstractView) newView).getTitle();
                    if (configuration.isUpdatePageTitle()) {
                        updatePageTitle(title);
                    }
                }

                final View oldView = event.getOldView();
                if (oldView instanceof AbstractView<?, ?>) {
                    ((AbstractView<?, ?>) oldView).exit();
                }

                ToriUI.getCurrent().trackAction(null);
            }

        });

    }

    private void updatePageTitle(final String title) {
        String prefix = configuration.getPageTitlePrefix();

        StringBuilder sb = new StringBuilder();
        if (prefix != null) {
            sb.append(prefix);
        }
        if (title != null && !title.isEmpty()) {
            if (!sb.toString().isEmpty()) {
                sb.append(" > ");
            }
            sb.append(title);
        }

        String pageTitle = sb.toString();
        Page.getCurrent().setTitle(pageTitle);

        // Liferay session.js resets the document.title after every request
        // (when logged in).
        // This hack is a workaround for the issue.
        JavaScript.eval(
                // @formatter:off
                //Liferay 6.0
                "try {" + "Liferay.Session._originalTitle = '" + pageTitle + "';" + "} catch(err){}" +
                //Liferay 6.2
                        "try {" + "Liferay.Session.display._state.data.pageTitle.initValue = '" + pageTitle + "';"
                        + "Liferay.Session.display._state.data.pageTitle.lazy.value = '" + pageTitle + "';"
                        + "} catch(err){}");
        // @formatter:on
    }

    public void navigateToDashboard() {
        navigateTo(ApplicationView.DASHBOARD.getNavigatorUrl());
    }

    public void navigateToCategory(final Long categoryId) {
        if (categoryId == null) {
            navigateToDashboard();
        } else {
            navigateTo(ApplicationView.CATEGORIES.getNavigatorUrl() + "/" + categoryId);
        }
    }

    public void navigateToThread(final long threadId) {
        navigateTo(ApplicationView.THREADS.getNavigatorUrl() + "/" + threadId);
    }

    public void navigateToNewThread(final Long categoryId) {
        String suffix = "";
        if (categoryId != null) {
            suffix = String.valueOf(categoryId);
        }
        navigateTo(String.format("%s/%s", ToriNavigator.ApplicationView.NEWTHREAD.getNavigatorUrl(), suffix));
    }

    /**
     * All the views of Tori application that can be navigated to.
     */
    public enum ApplicationView {
        // @formatter:off
        DASHBOARD("dashboard", ListingViewImpl.class, IndexableDashboardView.class), CATEGORIES("category",
                ListingViewImpl.class, IndexableCategoryView.class), THREADS("thread", ThreadViewImpl.class,
                        IndexableThreadView.class), NEWTHREAD("thread/new", NewThreadViewImpl.class, null);
        // @formatter:on

        private String viewName;
        private Class<? extends View> viewClass;
        private final Class<? extends IndexableView> indexView;

        private static final String NAVIGATOR_URL_PREFIX = "/";
        private static final String URL_PREFIX = "!" + NAVIGATOR_URL_PREFIX;

        private ApplicationView(final String url, final Class<? extends View> viewClass,
                final Class<? extends IndexableView> indexView) {
            this.viewName = url;
            this.viewClass = viewClass;
            this.indexView = indexView;
        }

        public String getViewName() {
            return viewName;
        }

        public String getUrl() {
            return URL_PREFIX + viewName;
        }

        public String getNavigatorUrl() {
            return NAVIGATOR_URL_PREFIX + viewName;
        }

        public static ApplicationView getDefault() {
            return DASHBOARD;
        }

        public Class<? extends IndexableView> getIndexableView() {
            return indexView;
        }

        public Class<? extends View> getViewClass() {
            return viewClass;
        }
    }

    public static ToriNavigator getCurrent() {
        return (ToriNavigator) UI.getCurrent().getNavigator();
    }

}