WysiwygEditorDebugger.java

/*
 * See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package org.xwiki.gwt.wysiwyg.client;

import org.xwiki.gwt.user.client.Timer;
import org.xwiki.gwt.user.client.TimerListener;
import org.xwiki.gwt.wysiwyg.client.cleaner.HTMLCleaner;
import org.xwiki.gwt.wysiwyg.client.cleaner.HTMLCleanerAsync;
import org.xwiki.gwt.wysiwyg.client.converter.HTMLConverter;
import org.xwiki.gwt.wysiwyg.client.converter.HTMLConverterAsync;

import com.google.gwt.core.client.GWT;
import com.google.gwt.user.client.rpc.AsyncCallback;
import com.google.gwt.user.client.ui.Composite;
import com.google.gwt.user.client.ui.FlowPanel;
import com.google.gwt.user.client.ui.TextArea;

/**
 * Debugger for the {@link WysiwygEditor}. It displays the current HTML content of the debugged rich text area, the
 * cleaned HTML, the corresponding wiki syntax as well as the rendering events triggered during the conversion to wiki
 * syntax.
 * 
 * @version $Id: 1915630260b65fdc3a339d0c40be733640fcd7d3 $
 */
public class WysiwygEditorDebugger extends Composite implements TimerListener
{
    /**
     * The editor being debugged.
     */
    private WysiwygEditor editor;

    /**
     * Displays the corresponding wiki syntax.
     */
    private TextArea wikiTextArea;

    /**
     * Displays the current HTML content.
     */
    private TextArea dirtyHTMLTextArea;

    /**
     * Displays the corresponding XHTML content.
     */
    private TextArea cleanHTMLTextArea;

    /**
     * Displays the rendering events triggered during the conversion to wiki syntax.
     */
    private TextArea eventsTextArea;

    /**
     * Timer used to schedule periodically updates.
     */
    private Timer timer;

    /**
     * The previous HTML content of the rich text area. We store it to detect when the content of the rich text area has
     * change in order to refresh the debug text areas.
     */
    private String previousHTML = "";

    /**
     * The component used to clean the HTML generated by the WYSIWYG editor.
     */
    private final HTMLCleanerAsync cleaner = GWT.create(HTMLCleaner.class);

    /**
     * The component used to convert the HTML generated by the WYSIWYG editor to other syntaxes.
     */
    private final HTMLConverterAsync converter = GWT.create(HTMLConverter.class);

    /**
     * Creates a new debugger for the given editor.
     * 
     * @param editor The WYSIWYG editor being debugged.
     */
    public WysiwygEditorDebugger(WysiwygEditor editor)
    {
        this.editor = editor;

        FlowPanel panel = new FlowPanel();
        panel.setWidth("100%");
        panel.add(editor.getUI());

        String width = "400px";
        String height = "220px";

        dirtyHTMLTextArea = new TextArea();
        dirtyHTMLTextArea.setWidth(width);
        dirtyHTMLTextArea.setHeight(height);
        panel.add(dirtyHTMLTextArea);

        cleanHTMLTextArea = new TextArea();
        cleanHTMLTextArea.setWidth(width);
        cleanHTMLTextArea.setHeight(height);
        panel.add(cleanHTMLTextArea);

        wikiTextArea = new TextArea();
        wikiTextArea.setWidth(width);
        wikiTextArea.setHeight(height);
        panel.add(wikiTextArea);

        eventsTextArea = new TextArea();
        eventsTextArea.setWidth(width);
        eventsTextArea.setHeight(height);
        panel.add(eventsTextArea);

        // get the transformed HTML Content
        dirtyHTMLTextArea.setText(editor.getRichTextEditor().getTextArea().getHTML());

        initWidget(panel);

        timer = new Timer();
        timer.addTimerListener(this);
        timer.scheduleRepeating(4000);
    }

    /**
     * Refreshes the debug text areas if the text in the rich text area has been changed.
     */
    public void refreshData()
    {
        String currentHTML = editor.getRichTextEditor().getTextArea().getHTML();
        if (previousHTML.equals(currentHTML)) {
            return;
        }
        previousHTML = currentHTML;

        dirtyHTMLTextArea.setText(currentHTML);

        cleaner.clean(currentHTML, new AsyncCallback<String>()
        {
            @Override
            public void onFailure(Throwable caught)
            {
                cleanHTMLTextArea.setText(caught.toString());
            }

            @Override
            public void onSuccess(String result)
            {
                cleanHTMLTextArea.setText(result);
            }
        });

        converter.fromHTML(currentHTML, editor.getConfig().getSyntax(), new AsyncCallback<String>()
        {
            @Override
            public void onFailure(Throwable caught)
            {
                wikiTextArea.setText(caught.toString());
            }

            @Override
            public void onSuccess(String result)
            {
                wikiTextArea.setText(result);
            }
        });

        converter.fromHTML(currentHTML, "event/1.0", new AsyncCallback<String>()
        {
            @Override
            public void onFailure(Throwable caught)
            {
                eventsTextArea.setText(caught.toString());
            }

            @Override
            public void onSuccess(String result)
            {
                eventsTextArea.setText(result);
            }
        });
    }

    @Override
    public void onElapsed(Timer sender)
    {
        if (sender == timer) {
            refreshData();
        }
    }
}