JavaTM 2 Platform
Std. Ed. v1.3.1

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 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

propertyKey

public static final String propertyKey
Key to use for the html renderer when stored as a client property of a JComponent.

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

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.

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.


JavaTM 2 Platform
Std. Ed. v1.3.1

Submit a bug or feature
For further API reference and developer documentation, see Java 2 SDK SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.

Java, Java 2D, and JDBC are trademarks or registered trademarks of Sun Microsystems, Inc. in the US and other countries.
Copyright 1993-2001 Sun Microsystems, Inc. 901 San Antonio Road
Palo Alto, California, 94303, U.S.A. All Rights Reserved.



Spec-Zone.ru - all specs in one place



free hit counter