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

Methods

Modifier and Type	Method and Description
static void	addAttribute(org.dom4j.Element element, String name, String value) Add attribute to an existing DOM4J element.
static void	addGlyphiconText(org.dom4j.Element element, String glyphicon, String text) Add glyphicon and text to an existing DOM4J element.
static void	addText(org.dom4j.Element element, String text) Add text to an existing DOM4J element.
static void	addTooltip(org.dom4j.Element element, String title) Add tooltip to element.
static org.dom4j.Element	generateDivElement(String htmlClass) Generate HTML "div" DOM4J element.
static org.dom4j.Element	generateDivElement(String htmlClass, AccessibilityRoles role) Generate HTML "div" DOM4J element.
static org.dom4j.Element	generateElement(String name, String htmlClass, String text) Generate DOM4J element.
static org.dom4j.Element	generateElement(String name, String htmlClass, String text, String glyphicon, AccessibilityRoles role) Generate DOM4J element.
static org.dom4j.Element	generateLinkElement(String href, String target, String onclick, String htmlClass, String text) Generate HTML "a" link DOM4J element.
static org.dom4j.Element	generateLinkElement(String href, String target, String onclick, String htmlClass, String text, String glyphicon) Generate HTML "a" link DOM4J element.
static org.dom4j.Element	generateLinkElement(String href, String target, String onclick, String htmlClass, String text, String glyphicon, AccessibilityRoles role) Generate HTML "a" link DOM4J element.
static String	write(org.dom4j.Element element) Write 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 DOM4J element.

Parameters:

name - element name

htmlClass - HTML class, may be null

text - element inner text, may be null

glyphicon - glyphicon name, may be null

role - accessibility role, may be null

Returns:

DOM4J element, or null if element name is blank

generateElement

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

Generate DOM4J element.

Parameters:

name - element name

htmlClass - HTML class, may be null

text - element inner text, may be null

Returns:

DOM4J element, or null if element name is blank

generateDivElement

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

Generate HTML "div" DOM4J element.

Parameters:

htmlClass - HTML class, may be null

role - accessibility role, may be null

Returns:

HTML "div" DOM4J element

generateDivElement

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

Generate HTML "div" DOM4J element.

Parameters:

htmlClass - HTML class, may be null

Returns:

HTML "div" DOM4J 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 DOM4J 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 DOM4J element

generateLinkElement

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

Generate HTML "a" link DOM4J 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 DOM4J element

generateLinkElement

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

Generate HTML "a" link DOM4J 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 DOM4J element

addAttribute

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

Add attribute to an existing DOM4J element.

Parameters:

element - DOM4J element

name - attribute name

value - attribute value

addText

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

Add text to an existing DOM4J element.

Parameters:

element - DOM4J 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 DOM4J element.

Parameters:

element - DOM4J element

glyphicon - glyphicon name, may be null

text - element inner text

textHTMLClass - text HTML class, may be null

addTooltip

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

Add tooltip to element.

Parameters:

element - element

title - tooltip title

write

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

Write HTML content.

Parameters:

element - element

Returns:

HTML content