org.dawnsci.webintro.views.WelcomePart.java Source code

Introduction

Here is the source code for org.dawnsci.webintro.views.WelcomePart.java

Source

/*
 * Copyright (c) 2016 Diamond Light Source Ltd.
 *
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 */
package org.dawnsci.webintro.views;

import org.dawnsci.webintro.Activator;
import org.dawnsci.webintro.FeedbackUtil;
import org.eclipse.jface.action.Action;
import org.eclipse.jface.action.IToolBarManager;
import org.eclipse.swt.SWT;
import org.eclipse.swt.program.Program;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.ui.IActionBars;
import org.eclipse.ui.part.IntroPart;

import javafx.application.Platform;
import javafx.beans.value.ChangeListener;
import javafx.beans.value.ObservableValue;
import javafx.concurrent.Worker.State;
import javafx.embed.swt.FXCanvas;
import javafx.scene.Scene;
import javafx.scene.layout.BorderPane;
import javafx.scene.web.WebEngine;
import javafx.scene.web.WebView;
import netscape.javascript.JSObject;

import org.dawnsci.webintro.JSBridge;

/**
 * Class to replace the welcome screen with a web browser 
 * 
 * @author David Taylor
 * 
 */
public class WelcomePart extends IntroPart {

    /**
     * The location which is opened when the part is opened
     */
    private static String homeLocation = "platform:/plugin/org.dawnsci.webintro/web/index.html";

    /**
     * Any page urls loaded that do not start with this will be opened in the system browser
     * (Note that this does not apply to JS, CSS, images etc.)
     */
    private static String locationLock = "platform:/plugin/org.dawnsci.webintro/web";

    private WebEngine webEngine;

    @Override
    public void createPartControl(Composite container) {

        Platform.setImplicitExit(false); // Keep the JavaFX thread running

        //Creating a JavaFX Browser, so create an FXCanvas to contain it
        FXCanvas canvas = new FXCanvas(container, SWT.NONE);
        BorderPane borderPane = new BorderPane();
        Scene scene = new Scene(borderPane);

        WebView browser = new WebView();
        webEngine = browser.getEngine();
        webEngine.load(homeLocation);

        borderPane.setCenter(browser);

        canvas.setScene(scene);

        IActionBars actionBars = getIntroSite().getActionBars();
        IToolBarManager toolBar = actionBars.getToolBarManager();

        setupToolbarButtons(toolBar);
        lockUrl();
        addJSBridges();
    }

    /**
     * Adds a home button to the toolbar
     * @param toolBar
     */
    private void setupToolbarButtons(IToolBarManager toolBar) {
        Action homeButton = new Action() {
            @Override
            public void run() {
                webEngine.load(homeLocation);
            }
        };
        homeButton.setText("Home");
        homeButton.setImageDescriptor(Activator.getImageDescriptor("icons/home.png"));
        toolBar.add(homeButton);
    }

    /**
     * Adds a listener for any change of URL. 
     * If the page changes outside of the locationLock, the user will be sent back to the old page, 
     * and the page they were trying to access will be opened in their system browser.
     */
    private void lockUrl() {
        webEngine.locationProperty().addListener(new ChangeListener<String>() {
            @Override
            public void changed(ObservableValue<? extends String> ov, final String oldLoc, final String loc) {
                if (!loc.startsWith(locationLock)) {
                    Platform.runLater(new Runnable() { //Workaround for bug with calling engine.load within a ChangeListener event
                        @Override
                        public void run() {
                            webEngine.load(oldLoc);
                            Program.launch(loc);
                        }
                    });
                }
            }
        });
    }

    /**
     * Register instances of the bridge classes as javascript objects
     */
    private void addJSBridges() {
        // create the Java object in a scope where they won't be collected by the GC
        JSBridge jsobjBridge = new JSBridge();
        FeedbackUtil jsobjFeedbackUtil = new FeedbackUtil();
        webEngine.getLoadWorker().stateProperty().addListener((ov, oldState, newState) -> {
            if (newState == State.SUCCEEDED) {
                JSObject jsobj = (JSObject) webEngine.executeScript("window");
                jsobj.setMember("java", jsobjBridge);
                jsobj.setMember("feedbackUtil", jsobjFeedbackUtil);
                webEngine.executeScript("javaReady();");
            }
        });
    }

    @Override
    public String getTitle() {
        return "Welcome";
    }

    @Override
    public void standbyStateChanged(boolean standby) {
        // TODO Auto-generated method stub   
    }

    @Override
    public void setFocus() {
        // TODO Auto-generated method stub
    }
}