org.osivia.portal.api.html

Class DOM4JUtils

java.lang.Object

org.osivia.portal.api.html.DOM4JUtils

public final class DOM4JUtils
extends Object

Utility class with null-safe methods for DOM4J usage.

Author:

Cédric Krommenhoek

See Also:

Element, QName

Method Summary

Modifier and Type	Method and Description
static void	addAriaAttribute(org.dom4j.Element element, String name, String value) Add ARIA attribute to an existing DOM element.
static void	addAttribute(org.dom4j.Element element, String name, String value) Add attribute to an existing DOM element.
static void	addDataAttribute(org.dom4j.Element element, String name, String value) Add data attribute to an existing DOM element.
static void	addGlyphiconText(org.dom4j.Element element, String glyphicon, String text) Add glyphicon and text to an existing DOM element.
static void	addText(org.dom4j.Element element, String text) Add text to an existing DOM element.
static void	addTooltip(org.dom4j.Element element, String title) Add tooltip to DOM element.
static org.dom4j.Element	generateDivElement(String htmlClass) Generate HTML "div" DOM element.
static org.dom4j.Element	generateDivElement(String htmlClass, AccessibilityRoles role) Generate HTML "div" DOM element.
static org.dom4j.Element	generateElement(String name, String htmlClass, String text) Generate DOM element.
static org.dom4j.Element	generateElement(String name, String htmlClass, String text, String glyphicon, AccessibilityRoles role) Generate DOM element.
static org.dom4j.Element	generateLinkElement(String href, String target, String onclick, String htmlClass, String text) Generate HTML "a" link DOM element.
static org.dom4j.Element	generateLinkElement(String href, String target, String onclick, String htmlClass, String text, String glyphicon) Generate HTML "a" link DOM element.
static org.dom4j.Element	generateLinkElement(String href, String target, String onclick, String htmlClass, String text, String glyphicon, AccessibilityRoles role) Generate HTML "a" link DOM element.
static String	write(org.dom4j.Element element) Write HTML content.
static void	write(Writer writer, org.dom4j.Element element) Write HTML content in provided writer.
static String	writeCompact(org.dom4j.Element element) Write compact HTML content.

Methods inherited from class java.lang.Object

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

Method Detail

generateElement

public static org.dom4j.Element generateElement(String name,
                                                String htmlClass,
                                                String text,
                                                String glyphicon,
                                                AccessibilityRoles role)

Generate DOM element.

Parameters:

name - DOM element name

htmlClass - HTML class, may be null

text - DOM element inner text, may be null

glyphicon - glyphicon name, may be null

role - accessibility role, may be null

Returns:

DOM element, or null if DOM element name is blank

generateElement

public static org.dom4j.Element generateElement(String name,
                                                String htmlClass,
                                                String text)

Generate DOM element.

Parameters:

name - DOM element name

htmlClass - HTML class, may be null

text - DOM element inner text, may be null

Returns:

DOM element, or null if element name is blank

generateDivElement

public static org.dom4j.Element generateDivElement(String htmlClass,
                                                   AccessibilityRoles role)

Generate HTML "div" DOM element.

Parameters:

htmlClass - HTML class, may be null

role - accessibility role, may be null

Returns:

HTML "div" DOM element

generateDivElement

public static org.dom4j.Element generateDivElement(String htmlClass)

Generate HTML "div" DOM element.

Parameters:

htmlClass - HTML class, may be null

Returns:

HTML "div" DOM element

generateLinkElement

public static org.dom4j.Element generateLinkElement(String href,
                                                    String target,
                                                    String onclick,
                                                    String htmlClass,
                                                    String text,
                                                    String glyphicon,
                                                    AccessibilityRoles role)

Generate HTML "a" link DOM element.

Parameters:

href - link URL

target - link target, may be null

onclick - link onclick action, may be null

htmlClass - HTML class, may be null

text - link inner text

glyphicon - glyphicon name, may be null

role - accessibility role, may be null

Returns:

HTML "a" link DOM element

generateLinkElement

public static org.dom4j.Element generateLinkElement(String href,
                                                    String target,
                                                    String onclick,
                                                    String htmlClass,
                                                    String text,
                                                    String glyphicon)

Generate HTML "a" link DOM element.

Parameters:

href - link URL

target - link target, may be null

onclick - link onclick action, may be null

htmlClass - HTML class, may be null

text - link inner text

glyphicon - glyphicon name, may be null

Returns:

HTML "a" link DOM element

generateLinkElement

public static org.dom4j.Element generateLinkElement(String href,
                                                    String target,
                                                    String onclick,
                                                    String htmlClass,
                                                    String text)

Generate HTML "a" link DOM element.

Parameters:

href - link URL

target - link target, may be null

onclick - link onclick action, may be null

htmlClass - HTML class, may be null

text - link inner text

Returns:

HTML "a" link DOM element

addAttribute

public static void addAttribute(org.dom4j.Element element,
                                String name,
                                String value)

Add attribute to an existing DOM element.

Parameters:

element - DOM element

name - attribute name

value - attribute value

addDataAttribute

public static void addDataAttribute(org.dom4j.Element element,
                                    String name,
                                    String value)

Add data attribute to an existing DOM element.

Parameters:

element - DOM element

name - data attribute name

value - data attribute value

addAriaAttribute

public static void addAriaAttribute(org.dom4j.Element element,
                                    String name,
                                    String value)

Add ARIA attribute to an existing DOM element.

Parameters:

element - DOM element

name - ARIA attribute name

value - ARIA attribute value

addText

public static void addText(org.dom4j.Element element,
                           String text)

Add text to an existing DOM element.

Parameters:

element - DOM element

text - element inner text

addGlyphiconText

public static void addGlyphiconText(org.dom4j.Element element,
                                    String glyphicon,
                                    String text)

Add glyphicon and text to an existing DOM element.

Parameters:

element - DOM element

glyphicon - glyphicon name, may be null

text - DOM element inner text

addTooltip

public static void addTooltip(org.dom4j.Element element,
                              String title)

Add tooltip to DOM element.

Parameters:

element - DOM element

title - tooltip title

write

public static String write(org.dom4j.Element element)

Write HTML content.

Parameters:

element - DOM element

Returns:

HTML content

writeCompact

public static String writeCompact(org.dom4j.Element element)

Write compact HTML content.

Parameters:

element - DOM element

Returns:

HTML content

write

public static void write(Writer writer,
                         org.dom4j.Element element)

Write HTML content in provided writer.

Parameters:

writer - writer

element - DOM element