org.apache.wicket.resource.filtering
Class AbstractHeaderResponseFilter

java.lang.Object
  org.apache.wicket.resource.filtering.AbstractHeaderResponseFilter

All Implemented Interfaces:

HeaderResponseContainerFilteringHeaderResponse.IHeaderResponseFilter

Direct Known Subclasses:

CssAcceptingHeaderResponseFilter

public abstract class AbstractHeaderResponseFilter
extends Object
implements HeaderResponseContainerFilteringHeaderResponse.IHeaderResponseFilter

A default implementation of IHeaderResponseFilter that returns true for everything. It is defined as abstract because you are not supposed to use it directly, but use it as a base and override any methods that you need to return something other than true from (whether that's always false or conditional logic).

Author:

Jeremy Thomerson

Constructor Summary

AbstractHeaderResponseFilter(String name)
Create a response filter.

Method Summary

boolean	acceptOtherCss() Whenever a renderCSS* method on IHeaderResponse is called that is not a ResourceReference (i.e.
boolean	acceptOtherJavascript() Whenever a render*Javascript method on IHeaderResponse is called that is not a ResourceReference (i.e.
boolean	acceptReference(ResourceReference object) Determines whether a given ResourceReference should be rendered in the bucket represented by this filter.
String	getName()

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractHeaderResponseFilter

public AbstractHeaderResponseFilter(String name)

Create a response filter.

Parameters:

name -

Method Detail

getName

public String getName()

Specified by:

getName in interface HeaderResponseContainerFilteringHeaderResponse.IHeaderResponseFilter

Returns:

name of the filter (used by the container that renders these resources)

acceptReference

public boolean acceptReference(ResourceReference object)

Description copied from interface: HeaderResponseContainerFilteringHeaderResponse.IHeaderResponseFilter

Determines whether a given ResourceReference should be rendered in the bucket represented by this filter.

Specified by:

acceptReference in interface HeaderResponseContainerFilteringHeaderResponse.IHeaderResponseFilter

Parameters:

object - the reference to be rendered

Returns:

true if it should be bucketed with other things in this filter

acceptOtherJavascript

public boolean acceptOtherJavascript()

Description copied from interface: HeaderResponseContainerFilteringHeaderResponse.IHeaderResponseFilter

Whenever a render*Javascript method on IHeaderResponse is called that is not a ResourceReference (i.e. IHeaderResponse.renderOnDomReadyJavascript(String)), this method determines if the script should be bucketed with other things in this filter. Note that calls to IHeaderResponse.renderJavascriptReference(String url) are also filtered with this method since there is no actual ResourceReference to pass

Specified by:

acceptOtherJavascript in interface HeaderResponseContainerFilteringHeaderResponse.IHeaderResponseFilter

Returns:

true if javascript should be bucketed with other things in this filter

acceptOtherCss

public boolean acceptOtherCss()

Description copied from interface: HeaderResponseContainerFilteringHeaderResponse.IHeaderResponseFilter

Whenever a renderCSS* method on IHeaderResponse is called that is not a ResourceReference (i.e. IHeaderResponse.renderCSSReference(String), or IHeaderResponse.renderCSSReference(String, String)), this method determines if the CSS reference should be bucketed with other things in this filter.

Specified by:

acceptOtherCss in interface HeaderResponseContainerFilteringHeaderResponse.IHeaderResponseFilter

Returns:

true if css should be bucketed with other things in this filter