org.apache.wicket.behavior
Class HeaderContributor

java.lang.Object
  org.apache.wicket.behavior.AbstractBehavior
      org.apache.wicket.behavior.AbstractHeaderContributor
          org.apache.wicket.behavior.HeaderContributor

All Implemented Interfaces:

java.io.Serializable, IBehavior, IClusterable, IHeaderContributor

public class HeaderContributor
extends AbstractHeaderContributor

A AbstractHeaderContributor behavior that is specialized on package resources. If you use this class, you have to pre-register the resources you want to contribute. A shortcut for common cases is to call forCss(Class, String) to contribute a package css file or forJavaScript(Class, String) to contribute a packaged javascript file. For instance:

 add(HeaderContributor.forCss(MyPanel.class, "mystyle.css"));
 

Author:

Eelco Hillenius, Matej Knopp

See Also:

Serialized Form

Constructor Summary

HeaderContributor(IHeaderContributor headerContributor)
Construct.

Method Summary

static HeaderContributor	forCss(java.lang.Class scope, java.lang.String path) Returns a new instance of HeaderContributor with a header contributor that references a CSS file that lives in a package.
static HeaderContributor	forCss(java.lang.Class scope, java.lang.String path, java.lang.String media) Returns a new instance of HeaderContributor with a header contributor that references a CSS file that lives in a package.
static HeaderContributor	forCss(ResourceReference reference) Returns a new instance of HeaderContributor with a header contributor that references a CSS file that lives in a package.
static HeaderContributor	forCss(ResourceReference reference, java.lang.String media) Returns a new instance of HeaderContributor with a header contributor that references a CSS file that lives in a package.
static HeaderContributor	forCss(java.lang.String location) Returns a new instance of HeaderContributor with a header contributor referencing a CSS file using one of the following schemes: Starts with http:// or https:// for an external reference. Starts with "/" for an absolute reference that Wicket will not rewrite. Starts with anything else, which Wicket will automatically prepend to make relative to the context root of your web-app.
static HeaderContributor	forCss(java.lang.String location, java.lang.String media) Returns a new instance of HeaderContributor with a header contributor referencing a CSS file using one of the following schemes: Starts with http:// or https:// for an external reference. Starts with "/" for an absolute reference that Wicket will not rewrite. Starts with anything else, which Wicket will automatically prepend to make relative to the context root of your web-app.
static HeaderContributor	forJavaScript(java.lang.Class scope, java.lang.String path) Returns a new instance of HeaderContributor with a header contributor that references a java script file that lives in a package.
static HeaderContributor	forJavaScript(ResourceReference reference) Returns a new instance of HeaderContributor with a header contributor that references a java script file that lives in a package.
static HeaderContributor	forJavaScript(java.lang.String location) Returns a new instance of HeaderContributor with a header contributor referencing a java script file using one of the following schemes: Starts with http:// or https:// for an external reference. Starts with "/" for an absolute reference that Wicket will not rewrite. Starts with anything else, which Wicket will automatically prepend to make relative to the context root of your web-app.
IHeaderContributor[]	getHeaderContributors() Gets the header contributors for this behavior.

Methods inherited from class org.apache.wicket.behavior.AbstractHeaderContributor

renderHead

Methods inherited from class org.apache.wicket.behavior.AbstractBehavior

afterRender, beforeRender, bind, cleanup, detach, detachModel, exception, getStatelessHint, isEnabled, isTemporary, onComponentTag, onException, onRendered, rendered

Methods inherited from class java.lang.Object

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

Constructor Detail

HeaderContributor

public HeaderContributor(IHeaderContributor headerContributor)

Construct.

Parameters:

headerContributor - the header contributor

Method Detail

forCss

public static final HeaderContributor forCss(java.lang.Class scope,
                                             java.lang.String path)

Returns a new instance of HeaderContributor with a header contributor that references a CSS file that lives in a package.

Parameters:

scope - The scope of the package resource (typically the class of the caller, or a class that lives in the package where the resource lives).

path - The path

Returns:

the new header contributor instance

forCss

public static final HeaderContributor forCss(java.lang.Class scope,
                                             java.lang.String path,
                                             java.lang.String media)

Returns a new instance of HeaderContributor with a header contributor that references a CSS file that lives in a package.

Parameters:

scope - The scope of the package resource (typically the class of the caller, or a class that lives in the package where the resource lives).

path - The path

media - The media type for this CSS ("print", "screen", etc.)

Returns:

the new header contributor instance

forCss

public static final HeaderContributor forCss(ResourceReference reference)

Returns a new instance of HeaderContributor with a header contributor that references a CSS file that lives in a package.

Parameters:

reference -

Returns:

the new header contributor instance

forCss

public static final HeaderContributor forCss(ResourceReference reference,
                                             java.lang.String media)

Returns a new instance of HeaderContributor with a header contributor that references a CSS file that lives in a package.

Parameters:

reference -

media - The media type for this CSS ("print", "screen", etc.)

Returns:

the new header contributor instance

forCss

public static final HeaderContributor forCss(java.lang.String location)

Returns a new instance of HeaderContributor with a header contributor referencing a CSS file using one of the following schemes:

• Starts with http:// or https:// for an external reference.
• Starts with "/" for an absolute reference that Wicket will not rewrite.
• Starts with anything else, which Wicket will automatically prepend to make relative to the context root of your web-app.

Parameters:

location - The location of the css file.

Returns:

the new header contributor instance

forCss

public static final HeaderContributor forCss(java.lang.String location,
                                             java.lang.String media)

Returns a new instance of HeaderContributor with a header contributor referencing a CSS file using one of the following schemes:

• Starts with http:// or https:// for an external reference.
• Starts with "/" for an absolute reference that Wicket will not rewrite.
• Starts with anything else, which Wicket will automatically prepend to make relative to the context root of your web-app.

Parameters:

location - The location of the css.

media - The media type for this CSS ("print", "screen", etc.)

Returns:

the new header contributor instance

forJavaScript

public static final HeaderContributor forJavaScript(java.lang.Class scope,
                                                    java.lang.String path)

Returns a new instance of HeaderContributor with a header contributor that references a java script file that lives in a package.

Parameters:

scope - The scope of the package resource (typically the class of the caller, or a class that lives in the package where the resource lives).

path - The path

Returns:

the new header contributor instance

forJavaScript

public static final HeaderContributor forJavaScript(ResourceReference reference)

Returns a new instance of HeaderContributor with a header contributor that references a java script file that lives in a package.

Parameters:

reference -

Returns:

the new header contributor instance

forJavaScript

public static final HeaderContributor forJavaScript(java.lang.String location)

Returns a new instance of HeaderContributor with a header contributor referencing a java script file using one of the following schemes:

• Starts with http:// or https:// for an external reference.
• Starts with "/" for an absolute reference that Wicket will not rewrite.
• Starts with anything else, which Wicket will automatically prepend to make relative to the context root of your web-app.

Parameters:

location - The location of the java script file.

Returns:

the new header contributor instance

getHeaderContributors

public final IHeaderContributor[] getHeaderContributors()

Description copied from class: AbstractHeaderContributor

Gets the header contributors for this behavior.

Specified by:

getHeaderContributors in class AbstractHeaderContributor

Returns:

the header contributors; may return null if there are none

See Also:

AbstractHeaderContributor.getHeaderContributors()