Logo Search packages:      
Sourcecode: javahelp2 version File versions  Download package

BasicContentViewerUI.java

/*
 * @(#)BasicContentViewerUI.java    1.57 06/10/30
 * 
 * Copyright (c) 2006 Sun Microsystems, Inc.  All Rights Reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 * 
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Sun designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Sun in the LICENSE file that accompanied this code.
 * 
 * This code 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
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 * 
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 * 
 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
 * CA 95054 USA or visit www.sun.com if you need additional information or
 * have any questions.
 */
/*
 * @(#) BasicContentViewerUI.java 1.57 - last change made 10/30/06
 */

package javax.help.plaf.basic;

import javax.help.*;
import javax.help.plaf.HelpContentViewerUI;
import javax.help.event.*;
import java.util.Vector;
import java.util.Enumeration;
import java.util.Locale;
import java.util.Hashtable;
import javax.swing.*;
import javax.swing.text.*;
import javax.swing.text.html.HTMLEditorKit;
import javax.swing.text.html.StyleSheet;
import javax.swing.plaf.ComponentUI;
import javax.swing.plaf.TextUI;
import javax.swing.border.*;
import javax.swing.event.*;
import javax.swing.text.html.*;
import javax.swing.text.html.parser.*;
import javax.swing.text.Element;
import java.awt.*;
import java.awt.event.*;
import java.net.URL;
import java.net.MalformedURLException;
import java.net.URLConnection;
import java.beans.PropertyChangeEvent;
import java.beans.PropertyChangeListener;
import java.io.*;
import javax.help.Map.ID;

/**
 * The default UI for JHelpContentViewer.
 *
 * @author Eduardo Pelegri-Llopart
 * @author Richard Gregor
 * @version   1.57     10/30/06
 */

00069 public class BasicContentViewerUI extends HelpContentViewerUI
implements HelpModelListener, TextHelpModelListener, HyperlinkListener, PropertyChangeListener, Serializable {
    // Suggestion: Refactor the class and remove the menu bar and the
    //            HTML viewer into subclasses. This would allow easier
    //            replacement of both components to
    //
    protected JHelpContentViewer theViewer;
    
    private static Dimension PREF_SIZE = new Dimension(200, 300);
    private static Dimension MIN_SIZE = new Dimension(80, 80);
    
    private JEditorPane html;
    private JViewport vp;
    
    private Hashtable registry;
    private boolean loadingURL;
    private TextHelpModelEvent pendingHighlightsEvent;
    
    public static ComponentUI createUI(JComponent x) {
        debug("createUI");
        return new BasicContentViewerUI((JHelpContentViewer) x);
    }
    
    public BasicContentViewerUI(JHelpContentViewer b) {
        debug("createUI - sort of");
    }
    
    public void setEditorKit(String type, EditorKit kit) {
        debug("setEditorKit("+type+", "+kit+")");
        if (registry == null) {
            registry = new Hashtable(3);
        }
        registry.put(type, kit);
        if (html != null) {
            debug("  type: "+type);
            debug("  kit: "+kit);
            html.setEditorKitForContentType(type, kit);
            if (debug)
                debug("  kit got: "+html.getEditorKitForContentType(type));
        }
    }
    
    /**
     * Subclass of JEditorPane that uses the JHelpContentViewer type registry.
     */
    
00115     class JHEditorPane extends JEditorPane {
        private Hashtable typeHandlers;
        
        public EditorKit getEditorKitForContentType(String type) {
            if (typeHandlers == null) {
                typeHandlers = new Hashtable(3);
            }
            EditorKit k = (EditorKit) typeHandlers.get(type);
            if (k == null) {
                k = theViewer.createEditorKitForContentType(type);
                if (k != null) {
                    setEditorKitForContentType(type, k);
                    typeHandlers.put(type, k);
                }
            }
            if (k == null) {
                k = super.getEditorKitForContentType(type);
                if (k != null) {
                    typeHandlers.put(type, k);
                }
            }
            return k;
        }
        
    }
    
       
    public void installUI(JComponent c) {
        debug("installUI");
        theViewer = (JHelpContentViewer)c;
        theViewer.setLayout(new BorderLayout());
        
        // listen to property changes...
        theViewer.addPropertyChangeListener(this);
        
        TextHelpModel model = theViewer.getModel();
        if (model != null) {
            // listen to id changes...
            model.addHelpModelListener(this);
            // listen to highlight changes...
            model.addTextHelpModelListener(this);
        }
        
        html = new JHEditorPane();
        html.addPropertyChangeListener(this);
        html.getAccessibleContext().setAccessibleName(HelpUtilities.getString(HelpUtilities.getLocale(html), "access.contentViewer"));
        html.setEditable(false);
        html.addHyperlinkListener(this);

      // if the model has a current URL then set it
      if (model != null) {
          URL url = model.getCurrentURL();
          if (url != null) {
            try {
                html.setPage(url);
            } catch (IOException ex) {
                // just igonore it
            }
          }
      }

        JScrollPane scroller = new JScrollPane();
        scroller.setBorder(new BevelBorder(BevelBorder.LOWERED, Color.white,
        Color.gray));
        vp = scroller.getViewport();
        vp.add(html);
        vp.setBackingStoreEnabled(true);
        
        theViewer.add("Center", scroller);
        loadingURL = false;
        pendingHighlightsEvent = null;
    }
    
    public void uninstallUI(JComponent c) {
        debug("uninstallUI");
        JHelpContentViewer viewer = (JHelpContentViewer) c;
        viewer.removePropertyChangeListener(this);
        html.removePropertyChangeListener(this);
        TextHelpModel model = viewer.getModel();
        if (model != null) {
            model.removeHelpModelListener(this);
            model.removeTextHelpModelListener(this);
        }
        viewer.setLayout(null);
        viewer.removeAll();
    }
    
    public Dimension getPreferredSize(JComponent c) {
        return PREF_SIZE;
    }
    
    public Dimension getMinimumSize(JComponent c) {
        return MIN_SIZE;
    }
    
    public Dimension getMaximumSize(JComponent c) {
        // This doesn't seem right. But I'm not sure what to do for now
        return new Dimension(Integer.MAX_VALUE, Integer.MAX_VALUE);
    }
    
00215     public void idChanged(HelpModelEvent e) {
        ID id = e.getID();
        URL url = e.getURL();
        TextHelpModel model = theViewer.getModel();
        debug("idChanged("+e+")");
        debug("  = " + id + " " + url);
        debug("  my helpModel: "+model);
        
        model.setDocumentTitle(null);
        
        // HERE - REMIND - event should be generated after visit
        // with the title already in there - epll.
        try {
            Highlighter h = html.getHighlighter();
            debug("removeAllHighlights");
            h.removeAllHighlights();
            try {
                loadingURL = true;
                html.setPage(url);
            } catch (Exception ex) {
                loadingURL = false;
                // IGNORE FOR EA2 --- !! - epll
            }
            debug("html current EditorKit is: "+html.getEditorKit());
            debug("html current ContentType is: "+html.getContentType());
        } catch (Exception e3) {
            // e.g. and incorrect URL will generate a nullexception!!
            // ignore
            debug("Exception geneartated");
        }
        debug("done with idChanged");
    }
    
    private void rebuild() {
        debug("rebuild");
        TextHelpModel model = theViewer.getModel();
        if (model == null) {
            debug("rebuild-end: model is null");
            return;
        }
        // The model has changed. I'll need to clear the HTML viewer and
        // put in the home page
        Highlighter h = html.getHighlighter();
        debug("removeAllHighlights");
        h.removeAllHighlights();
        HelpSet hs = model.getHelpSet();
        // for glossary - not set homeID page - glossary is not synchronized
        if(theViewer.getSynch()){
            try {
                Map.ID homeID = hs.getHomeID();
                Locale locale = hs.getLocale();
                String name = HelpUtilities.getString(locale, "history.homePage");
                model.setCurrentID(homeID, name, (JHelpNavigator)null);
                html.setPage(model.getCurrentURL());
            } catch (Exception e) {
                // ignore
            }
        }
        debug("rebuild-end");
    }
    
    public void propertyChange(PropertyChangeEvent event) {
        debug("propertyChange: " + event.getPropertyName() + "\n\toldValue:" + event.getOldValue() + "\n\tnewValue:" + event.getNewValue());
        
        if (event.getSource() == theViewer) {
            String changeName = event.getPropertyName();
            if (changeName.equals("helpModel")) {
                TextHelpModel oldModel = (TextHelpModel) event.getOldValue();
                TextHelpModel newModel = (TextHelpModel) event.getNewValue();
                if (oldModel != null) {
                    oldModel.removeHelpModelListener(this);
                    oldModel.removeTextHelpModelListener(this);
                }
                if (newModel != null) {
                    newModel.addHelpModelListener(this);
                    newModel.addTextHelpModelListener(this);
                }
                rebuild();
            } else if (changeName.equals("font")) {
                debug("font changed");
                Font newFont = (Font)event.getNewValue();
                EditorKit ek = html.getEditorKit();
                if (ek instanceof HTMLEditorKit) {
                    
                    StringBuffer buf = new StringBuffer(60);
                    buf.append("body { font: ");
                    buf.append(newFont.getSize()).append("pt ");
                    if (newFont.isBold()) {
                        buf.append("bold ");
                    }
                    if (newFont.isItalic()) {
                        buf.append("italic ");
                    }
                    buf.append('"').append(newFont.getFamily()).append('"');
                    buf.append(" }");
                    String cssData = buf.toString();
                        
                    StyleSheet styleSheet;
                    
                    /* Update the default style sheet: */
                    styleSheet = ((HTMLEditorKit) ek).getStyleSheet();
                    styleSheet.addRule(cssData);
                    
                    /*
                     * Update the current document's style sheet, thus forcing
                     * the view to be refreshed:
                     */
                    styleSheet = ((HTMLDocument) html.getDocument()).getStyleSheet();
                    styleSheet.addRule(cssData);
                }
            }else if (changeName.equals("clear")) {
                html.setText("");
            }else if (changeName.equals("reload")) {
            URL url = html.getPage();
            if (url != null) {
                try {
                  html.setPage(url);
                } catch (IOException ex) {
                  // just igonore it
                }
            }
            }
        } else if (event.getSource() == html) {
            String changeName = event.getPropertyName();
            if (changeName.equals("page")) {
                debug("page finished loading");
                loadingURL = false;
                if (pendingHighlightsEvent != null) {
                    debug("Loading the highlights now");
                    highlightsChanged(pendingHighlightsEvent);
                    pendingHighlightsEvent = null;
                }
                Document doc = html.getDocument();
                String title = (String)doc.getProperty(Document.TitleProperty);
                TextHelpModel model = theViewer.getModel();
                model.setDocumentTitle(title);
                
                // Propogate this to property listeners of the ContentViewer.
                // Can't acutally send the real thing because Objects and
                // Strings aren't supported.
                theViewer.firePropertyChange(event.getPropertyName(),
                false, true);
            }
        }
    }
    
    /**
     * Notification of a change relative to a
     * hyperlink.
     */
00365     public void hyperlinkUpdate(HyperlinkEvent e) {
        if (e.getEventType() == HyperlinkEvent.EventType.ACTIVATED) {
            // If in a frame do something different
            if (e instanceof HTMLFrameHyperlinkEvent) {
                ((HTMLDocument)html.getDocument()).processHTMLFrameHyperlinkEvent((HTMLFrameHyperlinkEvent)e);
            } else {
                // Not a frame
                linkActivated(e.getURL());
            }
        }
    }
    
    /**
     * Follows the reference in an
     * link.  The given url is the requested reference.
     * By default this calls <a href="#setPage">setPage</a>,
     * and if an exception is thrown the original previous
     * document is restored and a beep sounded.  If an
     * attempt was made to follow a link, but it represented
     * a malformed url, this method will be called with a
     * null argument.
     *
     * @param u the URL to follow
     */
00389     protected void linkActivated(URL u) {
        debug("linkActivated - URL=" + u );
        Cursor c = html.getCursor();
        Cursor waitCursor = Cursor.getPredefinedCursor(Cursor.WAIT_CURSOR);
        html.setCursor(waitCursor);
        // workaround for bug #418959
        // if there is an anchor make sure the file doesn't end in "/" or "\"
        // if it does then get the current file name and append the ref
        String ref = u.getRef();
        if (ref != null) {
            String file = u.getFile();
            if (file.endsWith("/") || file.endsWith("\\")) {
                u = html.getPage();
                debug("current u=" + u);
                file = u.getFile();
                debug("file=" + file);
                try {
                    u = new URL(u.getProtocol(), u.getHost(),
                    u.getPort(), file + "#" + ref);
                } catch (MalformedURLException e2) {
                    return;
                }
                debug("new u=" + u);
            }
        }
        SwingUtilities.invokeLater(new PageLoader(u, c));
    }
    
    /**
     * Temporary class that loads synchronously (although
     * later than the request so that a cursor change
     * can be done).
     */
00422     class PageLoader implements Runnable {
        String title = null;
        PageLoader(URL u, Cursor c) {
            url = u;
            cursor = c;
        }
        
        public void run() {
            if (url == null) {
                // restore the original cursor
                html.setCursor(cursor);
                
                RepaintManager.currentManager(html).markCompletelyDirty(html);
            } else {
                Document doc= html.getDocument();
                //String title;
                try {
                    html.setPage(url);
                    loadingURL = true;
                    doc = html.getDocument();
                    title = (String)doc.getProperty(Document.TitleProperty);                    
                    String anchor = url.getRef();
                    //if the title is not known (Hyperlink without anchor activated) parse title
                    if(title == null)
                        title = findTitle(url);
                    //in case there is an anchor append it to the title
                    if(anchor != null)
                        title = title + "-" + anchor;
                    TextHelpModel model = theViewer.getModel();
                    model.setDocumentTitle(title);
                    ID id = model.getHelpSet().getCombinedMap().getIDFromURL(url);
                    if (id != null) {
                        try {
                            model.setCurrentID(id,title, (JHelpNavigator)null);
                        } catch (InvalidHelpSetContextException ex) {
                            model.setCurrentURL(url, title,(JHelpNavigator)null);
                        }
                    } else {
                        model.setCurrentURL(url, title, (JHelpNavigator)null);
                    }
                } catch (IOException ioe) {
                    loadingURL = false;
                    html.setDocument(doc);
                    html.getToolkit().beep();
                } finally {
                    // schedule the cursor to revert after
                    // the paint has happended.
                    url = null;
                    SwingUtilities.invokeLater(this);
                }
            }
        }
        
        URL url;
        Cursor cursor;
        
        /**
         * Finds the title of HTML document on given URL
         *
         * @param url The URL of HTML file
         * @return The title of the document
         */
00484         private String findTitle(URL url){
            HTMLEditorKit.ParserCallback callback;
            try{
                URLConnection conn = url.openConnection();
                Reader rd = new InputStreamReader(conn.getInputStream());                
                ParserDelegator parser = new ParserDelegator();
                callback = new Callback();
                parser.parse(rd,callback,true);
            }catch (Exception exp){
                System.err.println(exp);
            }
            return title;
            
        }
        
        /**
         * Class provided the parser callback
         */
00502         class Callback extends HTMLEditorKit.ParserCallback{
            boolean wasTitle = false;
            
            public void handleStartTag(HTML.Tag t, MutableAttributeSet a, int pos){
                if(t.equals(HTML.Tag.TITLE)){
                    wasTitle = true;
                }
            }
            public void handleText(char[] data, int pos){
                if(wasTitle){
                    title = new String(data);
                    wasTitle = false;
                }
            }
            
        }
    }
    
    
    
    /**
     * Determines if highlights have changed.
     * Collects all the highlights and marks the presentation.
     *
     * @param e The TextHelpModelEvent.
     */
00528     public void highlightsChanged(TextHelpModelEvent e) {
        debug("highlightsChanged "+e);
        
        // if we're loading this url this event will need to wait
        // until we're notified that the page has finished loaded.
        // we could wait(), but that would prevent the execution of
        // other events in this thread. Instead preserve the
        // TextHelpModelEvent and recall this method when the notification
        // occurs.
        if (loadingURL) {
            debug("Humm. loadingURL wait a little");
            pendingHighlightsEvent = e;
            return;
        }
        
        Highlighter h = html.getHighlighter();
        debug1("removeAllHighlights");
        h.removeAllHighlights();
        
        TextHelpModel m = (TextHelpModel) e.getSource();
        TextHelpModel.Highlight highlights[] = m.getHighlights();
        
        Highlighter.HighlightPainter p =
        new DefaultHighlighter.DefaultHighlightPainter(html.getSelectionColor());
        for (int i=0; i<highlights.length; i++) {
            int pos0 = highlights[i].getStartOffset();
            int pos1 = highlights[i].getEndOffset();
            debug("  highlight: "+pos0+", "+pos1);
            try {
                h.addHighlight(pos0, pos1, p);
                
                // scroll to the first position
                if (i == 0) {
                    Runnable callScrollToPosition = new ScrollToPosition(html,
                    pos1);
                    SwingUtilities.invokeLater(callScrollToPosition);
                }
            } catch (BadLocationException bl) {
                debug("badLocationExcetpion thrown - " + bl);
            }
        }
        RepaintManager.currentManager(html).markCompletelyDirty(html);
    }
    
    private class ScrollToPosition implements Runnable {
        private int pos;
        private JEditorPane html;
        
        public ScrollToPosition(JEditorPane html, int pos) {
            this.html = html;
            this.pos = pos;
        }
        
        public void run() {
            try {
                Rectangle rec = html.modelToView(pos);
                if (rec != null) {
                    html.scrollRectToVisible(rec);
                }
            } catch (BadLocationException bl) {
            }
        }
    }
    
    /**
     * For printf debugging.
     */
00595     private final static boolean debug = false;
    private static void debug(String str) {
        if (debug) {
            System.out.println("BasicContentViewerUI: " + str);
        }
    }
    private final static boolean debug1 = false;
    private static void debug1(String str) {
        if (debug1) {
            System.out.println("BasicContentViewerUI: " + str);
        }
    }
}

Generated by  Doxygen 1.6.0   Back to index