- 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
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 forw
- the width to get the baseline forh
- 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.
-
-
Document created the 11/06/2005, last modified the 04/03/2020
Source of the printed document:https://www.gaudry.be/en/java-api-rf-javax/swing/plaf/basic/BasicHTML.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.