Summary: Constants | Ctors | Methods | Inherited Methods | [Expand All]

public class

BasicHTML

extends Object

java.lang.Object
↳	javax.swing.plaf.basic.BasicHTML

Class Overview

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.

Summary

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

Public Constructors
	BasicHTML()

Public Methods
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.

[Expand]

Inherited Methods

From class java.lang.Object

Object	clone() Creates and returns a copy of this object.
boolean	equals(Object obj) Indicates whether some other object is "equal to" this one.
void	finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
final Class<?>	getClass() Returns the runtime class of this `Object`.
int	hashCode() Returns a hash code value for the object.
final void	notify() Wakes up a single thread that is waiting on this object's monitor.
final void	notifyAll() Wakes up all threads that are waiting on this object's monitor.
String	toString() Returns a string representation of the object.
final void	wait() Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.
final void	wait(long timeout, int nanos) Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
final void	wait(long timeout) Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.

Constants

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

Constant Value: "html.base"

public static final String propertyKey

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

Constant Value: "html"

Public Constructors

public BasicHTML ()

Public Methods

public static View createHTMLView (JComponent c, String html)

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

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

Throws

IllegalArgumentException	if width or height is < 0

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.

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.

Interfaces

Classes