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.
- Since:
- 1.3
Fields
Modifier and Type | Field and Description |
---|---|
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. |
Constructors
Constructor and Description |
---|
BasicHTML() |
Methods
Modifier and Type | Method and Description |
---|---|
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
Fields
propertyKey
public static final String propertyKey
Key to use for the html renderer when stored as a client property of a JComponent.
- See Also:
- Constant Field Values
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/"));
- See Also:
- Constant Field Values
Constructors
BasicHTML
public BasicHTML()
Methods
createHTMLView
public static View createHTMLView(JComponent c, String html)
Create an html renderer for the given component and string of 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
- Throws:
-
IllegalArgumentException
- if width or height is < 0 - Since:
- 1.6
- See Also:
-
FontMetrics
,JComponent.getBaseline(int,int)
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.
© 1993, 2020, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/javase/8/docs/api/javax/swing/plaf/basic/BasicHTML.html