DescriptionPaneCalpa.java

/***************************************************
*
* cismet GmbH, Saarbruecken, Germany
*
*              ... and it just works.
*
****************************************************/
package Sirius.navigator.ui;

import Sirius.navigator.ui.status.Status;

import calpa.html.CalCons;
import calpa.html.CalHTMLPane;
import calpa.html.CalHTMLPreferences;
import calpa.html.DefaultCalHTMLObserver;

import java.net.HttpURLConnection;
import java.net.URL;

/**
 * An implementation of DescriptionPane which uses CalpaHTML to render HTML documents.
 *
 * @version  $Revision$, $Date$
 */
public class DescriptionPaneCalpa extends DescriptionPane {

    //~ Static fields/initializers ---------------------------------------------

    private static final org.apache.log4j.Logger LOG = org.apache.log4j.Logger.getLogger(DescriptionPaneCalpa.class);

    //~ Instance fields --------------------------------------------------------

    private final CalHTMLPreferences htmlPrefs = new CalHTMLPreferences();
    private CalHTMLPane htmlPane;
    DefaultCalHTMLObserver htmlObserver = new DefaultCalHTMLObserver() {

            @Override
            public void statusUpdate(final CalHTMLPane calHTMLPane,
                    final int status,
                    final URL uRL,
                    final int i0,
                    final String string) {
                super.statusUpdate(calHTMLPane, status, uRL, i0, string);
                if (status == 1) {
                    htmlPane.showHTMLDocument("");                                                               // NOI18N
                    statusChangeSupport.fireStatusChange(org.openide.util.NbBundle.getMessage(
                            DescriptionPaneCalpa.class,
                            "DescriptionPaneCalpa.statusUpdate(CalHTMLPane,int,URL,int,String).status.error"),   // NOI18N
                        Status.MESSAGE_POSITION_3,
                        Status.ICON_DEACTIVATED,
                        Status.ICON_ACTIVATED);
                } else if ((status == 10) || (status == 11)) {
                    statusChangeSupport.fireStatusChange(org.openide.util.NbBundle.getMessage(
                            DescriptionPaneCalpa.class,
                            "DescriptionPaneCalpa.statusUpdate(CalHTMLPane,int,URL,int,String).status.loading"), // NOI18N
                        Status.MESSAGE_POSITION_3,
                        Status.ICON_BLINKING,
                        Status.ICON_DEACTIVATED);
                } else if (status == 14) {
                    statusChangeSupport.fireStatusChange(org.openide.util.NbBundle.getMessage(
                            DescriptionPaneCalpa.class,
                            "DescriptionPaneCalpa.statusUpdate(CalHTMLPane,int,URL,int,String).status.loaded"),  // NOI18N
                        Status.MESSAGE_POSITION_3,
                        Status.ICON_ACTIVATED,
                        Status.ICON_DEACTIVATED);
                }
            }

            @Override
            public void linkActivatedUpdate(final CalHTMLPane calHTMLPane,
                    final URL uRL,
                    final String string,
                    final String string0) {
                super.linkActivatedUpdate(calHTMLPane, uRL, string, string0);
            }

            @Override
            public void linkFocusedUpdate(final CalHTMLPane calHTMLPane, final URL uRL) {
                super.linkFocusedUpdate(calHTMLPane, uRL);
            }
        };

    //~ Constructors -----------------------------------------------------------

    /**
     * Creates new form DescriptionPane.
     */
    public DescriptionPaneCalpa() {
        super();

        htmlPrefs.setAutomaticallyFollowHyperlinks(true);
        htmlPrefs.setOptimizeDisplay(CalCons.OPTIMIZE_ALL);
        htmlPrefs.setDisplayErrorDialogs(false);
        htmlPrefs.setLoadImages(true);

        initComponents();

        showHTML();
    }

    //~ Methods ----------------------------------------------------------------

    /**
     * Initialisation method of Matisse. Initializes visual components added by this subclass.
     */
    private void initComponents() {
        htmlPane = new CalHTMLPane(htmlPrefs, htmlObserver, "cismap");

        htmlPane.setDoubleBuffered(true);

        add(htmlPane, "html");
    }

    /**
     * Loads the given URI and renders the referenced document. Shows an error page if loading causes an error.
     *
     * @param  page  An URI to an HTML document.
     */
    @Override
    public void setPageFromURI(final String page) {
        if (LOG.isInfoEnabled()) {
            LOG.info(org.openide.util.NbBundle.getMessage(
                    DescriptionPaneCalpa.class,
                    "DescriptionPaneCalpa.setPageFromURI(String).info",
                    page));
        }

        if ((page == null) || (page.trim().length() <= 0)) {
            startNoDescriptionRenderer();
        } else {
            try {
                final URL url = new URL(page);

                final HttpURLConnection httpUrlConnection = (HttpURLConnection)url.openConnection();
                httpUrlConnection.setRequestMethod("HEAD");
                httpUrlConnection.connect();
                final int responseCode = httpUrlConnection.getResponseCode();
                if (responseCode == 200) {
                    htmlPane.stopAll();
                    htmlPane.showHTMLDocument(url);
                } else {
                    setPageFromContent(
                        errorPage,
                        getClass().getClassLoader().getResource("Sirius/navigator/resource/doc/blank.xhtml")
                                    .toString());

                    statusChangeSupport.fireStatusChange(
                        org.openide.util.NbBundle.getMessage(
                            DescriptionPaneCalpa.class,
                            "DescriptionPaneCalpa.setPageFromURI(String).error",
                            page), // NOI18N
                        Status.MESSAGE_POSITION_3,
                        Status.ICON_DEACTIVATED,
                        Status.ICON_ACTIVATED);
                }
            } catch (final Exception e) {
                LOG.error(org.openide.util.NbBundle.getMessage(
                        DescriptionPaneCalpa.class,
                        "DescriptionPaneCalpa.setPageFromURI(String).error",
                        page),
                    e);   // NOI18N

                setPageFromContent(
                    errorPage,
                    getClass().getClassLoader().getResource("Sirius/navigator/resource/doc/blank.xhtml").toString());

                statusChangeSupport.fireStatusChange(
                    org.openide.util.NbBundle.getMessage(
                        DescriptionPaneCalpa.class,
                        "DescriptionPaneCalpa.setPageFromURI(String).error",
                        page), // NOI18N
                    Status.MESSAGE_POSITION_3,
                    Status.ICON_DEACTIVATED,
                    Status.ICON_ACTIVATED);
            }
        }
    }

    /**
     * Renders the given markup.
     *
     * @param  markup  HTML markup to render.
     */

    @Override
    public void setPageFromContent(final String markup) {
        try {
            htmlPane.showHTMLDocument(markup);
        } catch (Exception e) {
            LOG.error(org.openide.util.NbBundle.getMessage(
                    DescriptionPaneCalpa.class,
                    "DescriptionPaneCalpa.setPageFromContent(String).error"),
                e); // NOI18N

            statusChangeSupport.fireStatusChange(
                org.openide.util.NbBundle.getMessage(
                    DescriptionPaneCalpa.class,
                    "DescriptionPaneCalpa.setPageFromContent(String).error"), // NOI18N
                Status.MESSAGE_POSITION_3,
                Status.ICON_DEACTIVATED,
                Status.ICON_ACTIVATED);
        }
    }

    /**
     * Renders the given markup using baseURL as base for relative paths in the markup.
     *
     * @param  markup   HTML markup to render
     * @param  baseURL  Base path for relative paths used in markup
     */

    @Override
    public void setPageFromContent(final String markup, final String baseURL) {
        setPageFromContent(markup);
    }
}