FileDocCategorySizeDatePackage
BasicHTML.javaAPI DocJava SE 5 API17044Fri Aug 26 14:58:04 BST 2005javax.swing.plaf.basic

BasicHTML

public class BasicHTML extends Object
Support for providing html views for the swing components. This translates a simple html string to a javax.swing.text.View implementation that can render the html and provide the necessary layout semantics.
author
Timothy Prinzing
version
1.22 07/23/04

Fields Summary
private static final String
htmlDisable
If this client property of a JComponent is set to Boolean.TRUE the component's 'text' property is never treated as HTML.
public static final String
propertyKey
Key to use for the html renderer when stored as a client property of a JComponent.
public static final String
documentBaseKey
Key stored as a client property to indicate the base that relative references are resolved against. For example, lets say you keep your images in the directory resources relative to the code path, you would use the following the set the base:
jComponent.putClientProperty(documentBaseKey,
xxx.class.getResource("resources/"));
private static BasicEditorKit
basicHTMLFactory
The source of the html renderers
private static ViewFactory
basicHTMLViewFactory
Creates the Views that visually represent the model.
private static final String
styleChanges
Overrides to the default stylesheet. Should consider just creating a completely fresh stylesheet.
Constructors Summary
Methods Summary
public static javax.swing.text.ViewcreateHTMLView(javax.swing.JComponent c, java.lang.String html)
Create an html renderer for the given component and string of html.

	BasicEditorKit kit = getFactory();
	Document doc = kit.createDefaultDocument(c.getFont(),
                                                 c.getForeground());
	Object base = c.getClientProperty(documentBaseKey);
	if (base instanceof URL) {
	    ((HTMLDocument)doc).setBase((URL)base);
	}
	Reader r = new StringReader(html);
	try {
	    kit.read(r, doc, 0);
	} catch (Throwable e) {
	}
	ViewFactory f = kit.getViewFactory();
	View hview = f.create(doc.getDefaultRootElement());
	View v = new Renderer(c, f, hview);
	return v;
    
static javax.swing.plaf.basic.BasicHTML$BasicEditorKitgetFactory()


       
	if (basicHTMLFactory == null) {
            basicHTMLViewFactory = new BasicHTMLViewFactory();
	    basicHTMLFactory = new BasicEditorKit();
	}
	return basicHTMLFactory;
    
public static booleanisHTMLString(java.lang.String s)
Check the given string to see if it should trigger the html rendering logic in a non-text component that supports html rendering.

	if (s != null) {
	    if ((s.length() >= 6) && (s.charAt(0) == '<") && (s.charAt(5) == '>")) {
		String tag = s.substring(1,5);
		return tag.equalsIgnoreCase(propertyKey);
	    }
	}
	return false;
    
public static voidupdateRenderer(javax.swing.JComponent c, java.lang.String text)
Stash the HTML render for the given text into the client properties of the given JComponent. If the given text is NOT HTML the property will be cleared of any renderer.

This method is useful for ComponentUI implementations that are static (i.e. shared) and get their state entirely from the JComponent.

	View value = null;
        View oldValue = (View)c.getClientProperty(BasicHTML.propertyKey);
        Boolean htmlDisabled = (Boolean) c.getClientProperty(htmlDisable);
	if (htmlDisabled != Boolean.TRUE && BasicHTML.isHTMLString(text)) {
	    value = BasicHTML.createHTMLView(c, text);
	}
        if (value != oldValue && oldValue != null) {
            for (int i = 0; i < oldValue.getViewCount(); i++) {
                oldValue.getView(i).setParent(null);
            }
        }
	c.putClientProperty(BasicHTML.propertyKey, value);