javax.help.JHelpContentViewer Maven / Gradle / Ivy
Show all versions of javahelp Show documentation
/*
* @(#)JHelpContentViewer.java 1.34 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.
*/
package javax.help;
import java.net.URL;
import javax.swing.JComponent;
import javax.swing.UIManager;
import javax.swing.LookAndFeel;
import javax.swing.JEditorPane;
import javax.accessibility.*;
import java.util.Hashtable;
import java.beans.PropertyChangeEvent;
import java.beans.PropertyChangeListener;
import javax.help.event.*;
import javax.help.plaf.HelpContentViewerUI;
import javax.swing.text.EditorKit;
import javax.help.Map.ID;
/**
* A component to represent the Help viewer that can be embedded if desired.
*
* @author Eduardo Pelegri-Llopart
* @version 1.34 10/30/06
*/
public class JHelpContentViewer extends JComponent implements Accessible{
protected TextHelpModel model;
/**
* Mark this JHelpContentViewer as synchronized with navigators
* It is false for JHelpContentviewer used inside of glossary
*/
private boolean synch = true;
/**
* Creates a JHelp with an instance of DefaultHelpModel as its data model.
*
* @param hs The HelpSet that provides context information. A null hs is valid
* and creates a TextHelpModel with no HelpSet defined.
*/
public JHelpContentViewer(HelpSet hs) {
super();
setModel(new DefaultHelpModel(hs));
updateUI();
}
/**
* Creates a JHelp with a default TextHelpModel.
*/
public JHelpContentViewer() {
super();
setModel(new DefaultHelpModel(null)); // no HelpSet here!
updateUI();
}
/**
* Creates a JHelp with an specific TextHelpModel as its data model.
*
* @param model The TextHelpModel. A null model is valid.
*/
public JHelpContentViewer(TextHelpModel model) {
super();
setModel(model);
updateUI();
}
/**
* Sets the HelpModel that provides the data.
* Necessary to convert navigation action into visits...
*
* @param newModel The new Model to provide events for this viewer.
*/
public void setModel(TextHelpModel newModel) {
debug("setModel: "+newModel);
TextHelpModel oldModel = model;
if (newModel != oldModel) {
model = newModel;
firePropertyChange("helpModel", oldModel, model);
invalidate();
}
}
/**
* @return The HelpModel that provides the events.
*/
public TextHelpModel getModel() {
return model;
}
/**
* Sets the HelpViewerUI that provides the current look and feel.
*
* @param ui Provides the ComponentUI object. A null ui is valid.
*/
public void setUI(HelpContentViewerUI ui) {
debug("setUI");
if ((HelpContentViewerUI)this.ui != ui) {
super.setUI(ui);
repaint();
}
}
/**
* @return The HelpViewerUI that provides the current look and feel.
*/
public HelpContentViewerUI getUI() {
return (HelpContentViewerUI)ui;
}
/**
* Replaces the UI with the latest version from the default
* UIFactory.
*
* @overrides updateUI in class JComponent
*/
public void updateUI() {
SwingHelpUtilities.installUIDefaults();
setUI((HelpContentViewerUI)UIManager.getUI(this));
invalidate();
}
/**
* @return "HelpViewerUI"
*/
public String getUIClassID()
{
return "HelpContentViewerUI";
}
/*
* Make sure the Look and Feel is set for the Help Component.
*/
static {
SwingHelpUtilities.installLookAndFeelDefaults();
}
/**
* Visits a given ID. Propagates down into the model.
*
* @param id The ID to visit.
* @exception InvalidHelpSetContextException if id.hs is not contained in the
* HelpSet of the current model.
*/
public void setCurrentID(ID id) throws InvalidHelpSetContextException {
model.setCurrentID(id);
}
/**
* Visits a given ID. Propagates down into the model.
*
* @param id The String to visit. Relative to the HS of the current model.
* @exception BadIDException The ID is not valid for the HelpSet for the current model.
*/
public void setCurrentID(String id) throws BadIDException {
try {
model.setCurrentID(ID.create(id, getModel().getHelpSet()));
} catch (InvalidHelpSetContextException ex) {
// cannot happen
}
}
/**
* Visits a given URL. Propagates down into the model.
*
* @param url The URL to visit. Relative to the HS of the current model
*/
public void setCurrentURL(URL url) {
model.setCurrentURL(url);
}
/**
* @return The URL currently being presented in the viewer.
*/
public URL getCurrentURL() {
return model.getCurrentURL();
}
/**
* @return The document title.
*/
public String getDocumentTitle() {
return model.getDocumentTitle();
}
/**
* Hightlights a section of the current document from p0 to p1.
*
* @param p0 Starting position.
* @param p1 Ending position.
*/
public void addHighlight(int p0, int p1) {
model.addHighlight(p0,p1);
}
/**
* Removes any Highlights.
*/
public void removeAllHighlights() {
model.removeAllHighlights();
}
/**
* Sets synchronization of this JHelpContentViewer with navigators.
* If true then JHelpContentViewer will contain homeID page when comes up at first time.
* False value causes blank page in this case.
*/
public void setSynch(boolean value){
synch = value;
}
/**
* Returns synchronization mode
*/
public boolean getSynch(){
return synch;
}
/**
* The local kitRegistry, indexed by mime type.
*/
private Hashtable kitRegistry;
/*
* Creation of EditorKits.
* This is similar to the registry used in JEditorPane, except:
*
* (1) A separate registry is used so as to not interfere with other uses of JEditorPane
*
* (2) The registry is centered around a HelpSet
*/
/**
* Creates a handler for the given type from the registry of editor kits.
* If the registered class has not yet been loaded, an attempt
* is made to dynamically load the prototype of the kit for the
* given type. If the type was registered with a ClassLoader,
* that ClassLoader is used to load the prototype. If there
* was no registered ClassLoader, the ClassLoader for the HelpSet
* is used to load the prototype.
*
* Once a prototype EditorKit instance is successfully located,
* it is cloned and the clone is returned.
*
* @param type the content type
* @return the editor kit, or null if one cannot be created
*/
public EditorKit createEditorKitForContentType(String type) {
EditorKit k = null;
if (kitRegistry == null) {
// nothing has been loaded yet.
kitRegistry = new Hashtable();
} else {
k = (EditorKit) kitRegistry.get(type);
}
if (k == null) {
// try to dynamically load the support
HelpSet hs = model.getHelpSet();
String classname =
(String) hs.getKeyData(HelpSet.kitTypeRegistry,
type);
// I don't know of a class for this type
if (classname == null) {
return null;
}
ClassLoader loader =
(ClassLoader) hs.getKeyData(HelpSet.kitLoaderRegistry,
type);
if (loader == null) {
loader = hs.getLoader();
}
try {
Class c;
if (loader != null) {
c = loader.loadClass(classname);
} else {
c = Class.forName(classname);
}
k = (EditorKit) c.newInstance();
kitRegistry.put(type, k);
} catch (Throwable e) {
e.printStackTrace();
k = null;
}
}
// create a copy of the prototype or null if there
// is no prototype.
if (k != null) {
return (EditorKit) k.clone();
} else {
// null, check the JEditorPane registry
k = JEditorPane.createEditorKitForContentType(type);
}
return k;
}
/**
* Adds a listener for the TExtHelpModelEvent posted after the model has
* changed.
*
* @param l - The listener to add.
* @see javax.help.TextHelpModel#removeHelpModelListener
*/
public void addTextHelpModelListener(TextHelpModelListener l) {
getModel().addTextHelpModelListener(l);
}
/**
* Removes a listener previously added with addTextHelpModelListener
*
* @param l - The listener to remove.
* @see javax.help.TextHelpModel#addTextHelpModelListener
*/
public void removeHelpModelListener(TextHelpModelListener l) {
getModel().removeTextHelpModelListener(l);
}
/**
* Adds a listener for the HelpModelEvent posted after the model has
* changed.
*
* @param l - The listener to add.
* @see javax.help.HelpModel#removeHelpModelListener
*/
public void addHelpModelListener(HelpModelListener l) {
getModel().addHelpModelListener(l);
}
/**
* Removes a listener previously added with addHelpModelListener
*
* @param l - The listener to remove.
* @see javax.help.HelpModel#addHelpModelListener
*/
public void removeHelpModelListener(HelpModelListener l) {
getModel().removeHelpModelListener(l);
}
/**
* Cleans the content
*/
public void clear(){
firePropertyChange("clear", " ","xyz");
}
/**
* Reloads the content
*/
public void reload(){
firePropertyChange("reload", " ","xyz");
}
/**
* Debug code
*/
private boolean debug = false;
private void debug(String msg) {
if (debug) {
System.err.println("JHelpContentViewer: "+msg);
}
}
/////////////////
// Accessibility support
////////////////
/**
* Get the AccessibleContext associated with this JComponent
*
* @return the AccessibleContext of this JComponent
*/
public AccessibleContext getAccessibleContext() {
if (accessibleContext == null) {
accessibleContext = new AccessibleJHelpContentViewer();
}
return accessibleContext;
}
/**
* The class used to obtain the accessible role for this object.
*
* Warning:
* Serialized objects of this class will not be compatible with
* future Swing releases. The current serialization support is appropriate
* for short term storage or RMI between applications running the same
* version of Swing. A future release of Swing will provide support for
* long term persistence.
*/
protected class AccessibleJHelpContentViewer extends AccessibleJComponent {
/**
* Get the role of this object.
*
* @return an instance of AccessibleRole describing the role of the
* object
*/
public AccessibleRole getAccessibleRole() {
return AccessibleRole.PANEL;
}
}
}