com.ontimize.gui.field.html

Class HTMLUtils

java.lang.Object

com.ontimize.gui.field.html.HTMLUtils

public class HTMLUtils
extends Object

A collection of static convenience methods for working with HTML, HTMLDocuments, AttributeSets and Elements from HTML documents.

Author:

Imatia S.L.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HTMLUtils.Base64 Deprecated. Use Base64Utils
protected static class	HTMLUtils.CharStyleToken

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.w3c.tidy.Tidy	tidy

Constructor Summary

Constructors

Constructor and Description
HTMLUtils()

Method Summary

Methods

Modifier and Type	Method and Description
static String	colorToHex(Color color) Converts a Color to a hex string in the format "#RRGGBB"
static String	createTag(HTML.Tag enclTag, AttributeSet set, String innerHTML) Incloses a chunk of HTML text in the specified tag with the specified attribs
static String	createTag(HTML.Tag enclTag, String innerHTML) Incloses a chunk of HTML text in the specified tag
protected static int	depthFromRoot(Element curElem)
static AttributeSet	getCharacterAttributes(JEditorPane editor) Gets the character attributes at the JEditorPane's caret position If there is no selection, the character attributes at caretPos - 1 are retuned.
static String	getElementHTML(Element el, boolean includeEnclosingTags) Gets the html of the specified Element
static String	getFontFamily(JEditorPane editor) Gets the font family name at the JEditorPane's current caret position
static Element	getListParent(Element elem) Searches for a list Element that is the parent of the specified Element.
static Element	getNextElement(HTMLDocument doc, Element el) Gets the element one position greater than the end of the specified element
protected static Element	getParaElement(HTMLDocument doc, int pos)
static List	getParagraphElements(JEditorPane editor)
static Element	getParent(Element curElem, HTML.Tag parentTag) Searches upward for the specified parent for the element.
static Element	getPreviousElement(HTMLDocument doc, Element el) Gets the element one position less than the start of the specified element
static HTML.Tag	getStartTag(String text)
static Color	hexToColor(String value) Convert a "#FFFFFF" hex string to a Color.
static void	insertArbitraryHTML(String rawHtml, JEditorPane editor) Inserts an arbitrary chunk of HTML into the JEditorPane at the current caret position.
static void	insertHTML(String html, HTML.Tag tag, JEditorPane editor) Inserts a string of html into the JEditorPane's HTMLDocument at the current caret position.
static boolean	isElementEmpty(Element el) Tests if the element is empty
static boolean	isImplied(Element el) Tests if an element is an implied paragraph (p-implied)
static String	jEditorPaneizeHTML(String html) Removes self-closing tags from xhtml for the benifit of JEditorPane JEditorpane can't handle empty xhtml containers like <br /> or <img />, so this method replaces them without the "/" as in <br>
static void	printAttribs(AttributeSet attr) Helper method that prints out the contents of an AttributeSet to System.err for debugging
static void	removeCharacterAttribute(JEditorPane editor, CSS.Attribute atr, String val) Removes a CSS character attribute that has the specified value from the JEditorPane's current caret position or selection.
static void	removeCharacterAttribute(JEditorPane editor, Object atr) Removes a single character attribute from the editor's current position/selection.
static void	removeElement(Element el) Removes an element from the document that contains it
static String	removeEnclosingTags(Element elem, String txt) Removes the enclosing tags from a chunk of HTML text
static String	removeEnclosingTags(HTML.Tag t, String txt) Removes the enclosing tags from a chunk of HTML text
static void	setCharacterAttributes(JEditorPane editor, AttributeSet attrs) Sets the character attributes for selection of the specified editor
static void	setCharacterAttributes(JEditorPane editor, AttributeSet attr, boolean replace) Sets the character attributes for selection of the specified editor
static void	setFontFamily(JEditorPane editor, String fontName) Set's the font family at the JEditorPane's current caret positon, or for the current selection (if there is one).
static Color	stringToColor(String str) Convert a color string such as "RED" or "#NNNNNN" or "rgb(r, g, b)" to a Color.
static Map	tagAttribsToMap(String atts) Converts an html tag attribute list to a Map.
protected static String	tagClose(HTML.Tag t)
protected static String	tagOpen(HTML.Tag enclTag, AttributeSet set)
protected static List	tokenizeCharAttribs(HTMLDocument doc, int s, int e) Tokenizes character attrbutes.
protected static String	xmlToString(Node node)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

tidy

protected static final org.w3c.tidy.Tidy tidy

Constructor Detail

HTMLUtils

public HTMLUtils()

Method Detail

isImplied

public static boolean isImplied(Element el)

Tests if an element is an implied paragraph (p-implied)

Parameters:

el - The element

Returns:

true if the elements name equals "p-implied", false otherwise

createTag

public static String createTag(HTML.Tag enclTag,
               String innerHTML)

Incloses a chunk of HTML text in the specified tag

Parameters:

enclTag - the tag to enclose the HTML in

innerHTML - the HTML to be inclosed

Returns:

createTag

public static String createTag(HTML.Tag enclTag,
               AttributeSet set,
               String innerHTML)

Incloses a chunk of HTML text in the specified tag with the specified attribs

Parameters:

enclTag -

set -

innerHTML -

Returns:

tagOpen

protected static String tagOpen(HTML.Tag enclTag,
             AttributeSet set)

tagClose

protected static String tagClose(HTML.Tag t)

getParagraphElements

public static List getParagraphElements(JEditorPane editor)

getParaElement

protected static Element getParaElement(HTMLDocument doc,
                     int pos)

getParent

public static Element getParent(Element curElem,
                HTML.Tag parentTag)

Searches upward for the specified parent for the element.

Parameters:

curElem -

parentTag -

Returns:

The parent element, or null if the parent wasnt found

isElementEmpty

public static boolean isElementEmpty(Element el)

Tests if the element is empty

Parameters:

el -

Returns:

getListParent

public static Element getListParent(Element elem)

Searches for a list Element that is the parent of the specified Element.

Parameters:

elem -

Returns:

A list element (UL, OL, DIR, MENU, or DL) if found, null otherwise

getPreviousElement

public static Element getPreviousElement(HTMLDocument doc,
                         Element el)

Gets the element one position less than the start of the specified element

Parameters:

doc -

el -

Returns:

getNextElement

public static Element getNextElement(HTMLDocument doc,
                     Element el)

Gets the element one position greater than the end of the specified element

Parameters:

doc -

el -

Returns:

removeEnclosingTags

public static String removeEnclosingTags(Element elem,
                         String txt)

Removes the enclosing tags from a chunk of HTML text

Parameters:

elem -

txt -

Returns:

removeEnclosingTags

public static String removeEnclosingTags(HTML.Tag t,
                         String txt)

Removes the enclosing tags from a chunk of HTML text

Parameters:

t -

txt -

Returns:

getElementHTML

public static String getElementHTML(Element el,
                    boolean includeEnclosingTags)

Gets the html of the specified Element

Parameters:

el -

includeEnclosingTags - true, if the enclosing tags should be included

Returns:

removeElement

public static void removeElement(Element el)
                          throws BadLocationException

Removes an element from the document that contains it

Parameters:

el -

Throws:

BadLocationException

getStartTag

public static HTML.Tag getStartTag(String text)

depthFromRoot

protected static int depthFromRoot(Element curElem)

insertArbitraryHTML

public static void insertArbitraryHTML(String rawHtml,
                       JEditorPane editor)

Inserts an arbitrary chunk of HTML into the JEditorPane at the current caret position.

Parameters:

rawHtml -

editor -

xmlToString

protected static String xmlToString(Node node)

insertHTML

public static void insertHTML(String html,
              HTML.Tag tag,
              JEditorPane editor)

Inserts a string of html into the JEditorPane's HTMLDocument at the current caret position.

Parameters:

html -

tag -

editor -

getCharacterAttributes

public static AttributeSet getCharacterAttributes(JEditorPane editor)

Gets the character attributes at the JEditorPane's caret position

If there is no selection, the character attributes at caretPos - 1 are retuned. If there is a slection, the attributes at selectionEnd - 1 are returned

Parameters:

editor -

Returns:

An AttributeSet or null, if the editor doesn't have a StyledDocument

getFontFamily

public static String getFontFamily(JEditorPane editor)

Gets the font family name at the JEditorPane's current caret position

Parameters:

editor -

Returns:

The font family name, or null if no font is set

setFontFamily

public static void setFontFamily(JEditorPane editor,
                 String fontName)

Set's the font family at the JEditorPane's current caret positon, or for the current selection (if there is one).

If the fontName parameter is null, any currently set font family is removed.

Parameters:

editor -

fontName -

removeCharacterAttribute

public static void removeCharacterAttribute(JEditorPane editor,
                            CSS.Attribute atr,
                            String val)

Removes a CSS character attribute that has the specified value from the JEditorPane's current caret position or selection.

The val parameter is a String even though the actual attribute value is not. This is because the actual attribute values are not public. Thus, this method checks the value via the toString() method

Parameters:

editor -

atr -

val -

removeCharacterAttribute

public static void removeCharacterAttribute(JEditorPane editor,
                            Object atr)

Removes a single character attribute from the editor's current position/selection.

Removes from the editor kit's input attribtues and/or document at the caret position. If there is a selction the attribute is removed from the selected text

Parameters:

editor -

atr -

tokenizeCharAttribs

protected static List tokenizeCharAttribs(HTMLDocument doc,
                       int s,
                       int e)

Tokenizes character attrbutes.

Parameters:

doc -

s -

e -

Returns:

setCharacterAttributes

public static void setCharacterAttributes(JEditorPane editor,
                          AttributeSet attr,
                          boolean replace)

Sets the character attributes for selection of the specified editor

Parameters:

editor -

attrs -

replace - if true, replaces the attrubutes

setCharacterAttributes

public static void setCharacterAttributes(JEditorPane editor,
                          AttributeSet attrs)

Sets the character attributes for selection of the specified editor

Parameters:

editor -

attrs -

tagAttribsToMap

public static Map tagAttribsToMap(String atts)

Converts an html tag attribute list to a Map. For example, the String 'href="http://blah.com" target="_self"' becomes name-value pairs:
href > http://blah.com
target > _self

Parameters:

atts -

Returns:

colorToHex

public static String colorToHex(Color color)

Converts a Color to a hex string in the format "#RRGGBB"

hexToColor

public static Color hexToColor(String value)

Convert a "#FFFFFF" hex string to a Color. If the color specification is bad, an attempt will be made to fix it up.

stringToColor

public static Color stringToColor(String str)

Convert a color string such as "RED" or "#NNNNNN" or "rgb(r, g, b)" to a Color.

jEditorPaneizeHTML

public static String jEditorPaneizeHTML(String html)

Removes self-closing tags from xhtml for the benifit of JEditorPane

JEditorpane can't handle empty xhtml containers like <br /> or <img />, so this method replaces them without the "/" as in <br>

Parameters:

html -

Returns:

JEditorpane friendly html

printAttribs

public static void printAttribs(AttributeSet attr)

Helper method that prints out the contents of an AttributeSet to System.err for debugging

Parameters:

attr -