to.etc.domui.dom.header

Class HeaderContributor

java.lang.Object

to.etc.domui.dom.header.HeaderContributor

Direct Known Subclasses:

FaviconContributor, GoogleChartsContributor, JavascriptContributor, JavaScriptletContributor, ThemedJavascriptContributor

public abstract class HeaderContributor
extends Object

A header contributor can be registered by nodes to cause something to be generated at the time that the page HEAD is rendered. A header contributor typically contains things like Javascript modules to load or stylesheets to use. The actual contribution to the header is done at rendering time, so the content can be dynamically determined. Each header contributor must implement full equality comparison semantics in such a way that when a header contributor for the same contribution is added it can be dropped. This is needed for instance when adding Javascript modules; if 15 components all need the same .js file it needs to be added only once, not 15 times...

Author:

Frits Jalvingh Created on Aug 17, 2007

Field Summary

Fields

Modifier and Type	Field and Description
static Comparator<HeaderContributorEntry>	C_ENTRY

Constructor Summary

Constructors

Constructor and Description
HeaderContributor()

Method Summary

Modifier and Type	Method and Description
abstract void	contribute(HtmlFullRenderer r)
abstract void	contribute(OptimalDeltaRenderer r)
abstract boolean	equals(Object obj)
abstract int	hashCode()
static HeaderContributor	loadGoogleAnalytics(String uacode) Add a header contributor to add the Google Analytics blurb to every page.
static HeaderContributor	loadGoogleCharts()
static HeaderContributor	loadJavascript(String name)
static HeaderContributor	loadJavaScriptlet(String name)
static HeaderContributor	loadStylesheet(String name)
static HeaderContributor	loadThemedJavasciptContributor(String name)

Methods inherited from class java.lang.Object

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

Field Detail

C_ENTRY

public static final Comparator<HeaderContributorEntry> C_ENTRY

Constructor Detail

HeaderContributor

public HeaderContributor()

Method Detail

contribute

public abstract void contribute(HtmlFullRenderer r)
                         throws Exception

Throws:

Exception

contribute

public abstract void contribute(OptimalDeltaRenderer r)
                         throws Exception

Throws:

Exception

hashCode

public abstract int hashCode()

Overrides:

hashCode in class Object

equals

public abstract boolean equals(Object obj)

Overrides:

equals in class Object

loadJavascript

@Nonnull
public static HeaderContributor loadJavascript(String name)

loadJavaScriptlet

@Nonnull
public static HeaderContributor loadJavaScriptlet(String name)

loadStylesheet

public static HeaderContributor loadStylesheet(String name)

loadThemedJavasciptContributor

public static HeaderContributor loadThemedJavasciptContributor(String name)

loadGoogleAnalytics

public static HeaderContributor loadGoogleAnalytics(String uacode)

Add a header contributor to add the Google Analytics blurb to every page.

Parameters:

uacode -

Returns:

loadGoogleCharts

public static HeaderContributor loadGoogleCharts()