BasicHTML (Java Platform SE 6)

This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.

Overview

Package

Class

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.swing.plaf.basic
class BasicHTML

java.lang.Object
  javax.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.

Field Summary
`static String`	`documentBaseKey` Key stored as a client property to indicate the base that relative references are resolved against.
`static String`	`propertyKey` Key to use for the html renderer when stored as a client property of a JComponent.

Constructor Summary
`BasicHTML()`

Method Summary
`static View`	`createHTMLView(JComponent c, String html)` Create an html renderer for the given component and string of html.
`static int`	`getHTMLBaseline(View view, int w, int h)` Returns the baseline for the html renderer.
`static boolean`	`isHTMLString(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.
`static void`	`updateRenderer(JComponent c, String text)` Stash the HTML render for the given text into the client properties of the given JComponent.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

documentBaseKey

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/"));

propertyKey

public static final String propertyKey

Key to use for the html renderer when stored as a client property of a JComponent.

Constructor Detail

BasicHTML

public BasicHTML()

Method Detail

createHTMLView

public static View createHTMLView(JComponent c,
                                  String html)

Create an html renderer for the given component and string of html.

Parameters:: c; html

getHTMLBaseline

public static int getHTMLBaseline(View view,
                                  int w,
                                  int h)

Returns the baseline for the html renderer.

Parameters:: view - the View to get the baseline for; w - the width to get the baseline for; h - the height to get the baseline for
Returns:: baseline or a value < 0 indicating there is no reasonable baseline

isHTMLString

public static boolean isHTMLString(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.

Parameters:: s

updateRenderer

public static void updateRenderer(JComponent c,
                                  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.