Module org.apache.wicket.core

Package org.apache.wicket.util.template

Class TextTemplateDecorator

java.lang.Object

org.apache.wicket.util.resource.AbstractResourceStream

org.apache.wicket.util.resource.AbstractStringResourceStream

org.apache.wicket.util.template.TextTemplate

org.apache.wicket.util.template.TextTemplateDecorator

All Implemented Interfaces:

Closeable, Serializable, AutoCloseable, org.apache.wicket.util.io.IClusterable, org.apache.wicket.util.resource.IResourceStream, org.apache.wicket.util.resource.IStringResourceStream, org.apache.wicket.util.watch.IModifiable

Direct Known Subclasses:

CssTemplate, JavaScriptTemplate

public abstract class TextTemplateDecorator
extends TextTemplate

Provides the ability to 'decorate' the actual template contents before it is contributed to the header. For example, to embed it inside a JavaScript tag pair.

Since:

1.2.6

Author:

Eelco Hillenius

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected TextTemplate	decorated	The decorated TextTemplate.

Fields inherited from class org.apache.wicket.util.resource.AbstractStringResourceStream

DEFAULT_CONTENT_TYPE

Constructor Summary

Constructors

Constructor	Description
TextTemplateDecorator(TextTemplate textTemplate)	Constructor.

Method Summary

Modifier and Type	Method	Description
String	asString()	Returns the decorated contents as a String.
String	asString(Map<String,?> variables)	Returns the decorated contents as a String.
void	close()
boolean	equals(Object obj)
abstract String	getAfterTemplateContents()	Retrieves the String to put after the actual template contents, for example:
abstract String	getBeforeTemplateContents()	Retrieves the String to put before the actual template contents, for example:
String	getContentType()
InputStream	getInputStream()
Locale	getLocale()
String	getString()	Retrieves the String resource.
int	hashCode()
Instant	lastModifiedTime()
void	setCharset(Charset charset)
void	setLastModified(Instant lastModified)
void	setLocale(Locale locale)
String	toString()

Methods inherited from class org.apache.wicket.util.template.TextTemplate

interpolate

Methods inherited from class org.apache.wicket.util.resource.AbstractStringResourceStream

getCharset, length

Methods inherited from class org.apache.wicket.util.resource.AbstractResourceStream

getStyle, getVariation, setStyle, setVariation

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.wicket.util.resource.IResourceStream

getStyle, getVariation, setStyle, setVariation

Field Detail

decorated

protected final TextTemplate decorated

The decorated TextTemplate.

Constructor Detail

TextTemplateDecorator

public TextTemplateDecorator(TextTemplate textTemplate)

Constructor.

Parameters:

textTemplate - a TextTemplate to decorate

Method Detail

asString

public String asString()

Returns the decorated contents as a String.

Specified by:

asString in interface org.apache.wicket.util.resource.IStringResourceStream

Overrides:

asString in class TextTemplate

Returns:

the contents decorated with getBeforeTemplateContents() and getAfterTemplateContents()

See Also:

TextTemplate.asString()

asString

public String asString(Map<String,?> variables)

Returns the decorated contents as a String.

Overrides:

asString in class TextTemplate

Parameters:

variables - the variables to interpolate

Returns:

the contents decorated with getBeforeTemplateContents() and getAfterTemplateContents().

See Also:

TextTemplate.asString(java.util.Map)

getBeforeTemplateContents

public abstract String getBeforeTemplateContents()

Retrieves the String to put before the actual template contents, for example:

    <script type="text/javascript">
 

Returns:

the String to put before the actual template contents

getAfterTemplateContents

public abstract String getAfterTemplateContents()

Retrieves the String to put after the actual template contents, for example:

    </script>
 

Returns:

the String to put after the actual template contents

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface org.apache.wicket.util.resource.IResourceStream

Overrides:

close in class org.apache.wicket.util.resource.AbstractStringResourceStream

Throws:

IOException

See Also:

AbstractStringResourceStream.close()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

See Also:

Object.equals(java.lang.Object)

getContentType

public String getContentType()

Specified by:

getContentType in interface org.apache.wicket.util.resource.IResourceStream

Overrides:

getContentType in class org.apache.wicket.util.resource.AbstractStringResourceStream

See Also:

AbstractStringResourceStream.getContentType()

getInputStream

public InputStream getInputStream()
                           throws org.apache.wicket.util.resource.ResourceStreamNotFoundException

Specified by:

getInputStream in interface org.apache.wicket.util.resource.IResourceStream

Overrides:

getInputStream in class org.apache.wicket.util.resource.AbstractStringResourceStream

Throws:

org.apache.wicket.util.resource.ResourceStreamNotFoundException

See Also:

AbstractStringResourceStream.getInputStream()

getLocale

public Locale getLocale()

Specified by:

getLocale in interface org.apache.wicket.util.resource.IResourceStream

Overrides:

getLocale in class org.apache.wicket.util.resource.AbstractResourceStream

See Also:

AbstractResourceStream.getLocale()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

See Also:

Object.hashCode()

lastModifiedTime

public Instant lastModifiedTime()

Specified by:

lastModifiedTime in interface org.apache.wicket.util.watch.IModifiable

Overrides:

lastModifiedTime in class org.apache.wicket.util.resource.AbstractStringResourceStream

See Also:

AbstractStringResourceStream.lastModifiedTime()

setCharset

public void setCharset(Charset charset)

Specified by:

setCharset in interface org.apache.wicket.util.resource.IStringResourceStream

Overrides:

setCharset in class org.apache.wicket.util.resource.AbstractStringResourceStream

See Also:

org.apache.wicket.util.resource.AbstractResourceStream#setCharset(java.nio.charset.Charset)

setLastModified

public void setLastModified(Instant lastModified)

Overrides:

setLastModified in class org.apache.wicket.util.resource.AbstractStringResourceStream

See Also:

org.apache.wicket.util.resource.AbstractStringResourceStream#setLastModified(org.apache.wicket.util.time.Time)

setLocale

public void setLocale(Locale locale)

Specified by:

setLocale in interface org.apache.wicket.util.resource.IResourceStream

Overrides:

setLocale in class org.apache.wicket.util.resource.AbstractResourceStream

See Also:

AbstractResourceStream.setLocale(java.util.Locale)

getString

public String getString()

Description copied from class: TextTemplate

Retrieves the String resource.

Specified by:

getString in class TextTemplate

Returns:

the String resource

See Also:

TextTemplate.getString()

toString

public String toString()

Overrides:

toString in class Object

See Also:

Object.toString()