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.- Since:
- 1.3
-
-
Field Summary
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.
-
Constructor Summary
Constructors Constructor and Description BasicHTML()
-
Method Summary
All Methods Static Methods Concrete 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.
-
-
-
Field Detail
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
-
Method Detail
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.
-
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2022, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.