org.apache.wicket.settings
Interface IMarkupSettings

All Known Implementing Classes:
MarkupSettings

public interface IMarkupSettings

Interface for markup related settings.

compressWhitespace (defaults to false) - Causes pages to render with redundant whitespace removed. Whitespace stripping is not HTML or JavaScript savvy and can conceivably break pages, but should provide significant performance improvements.

stripComments (defaults to false) - Set to true to strip HTML comments during markup loading

Author:
Igor Vaynberg (ivaynberg)

Method Summary
 boolean getAutomaticLinking()
          If true, automatic link resolution is enabled.
 boolean getCompressWhitespace()
           
 String getDefaultAfterDisabledLink()
           
 String getDefaultBeforeDisabledLink()
           
 String getDefaultMarkupEncoding()
           
 MarkupFactory getMarkupFactory()
          Get the markup factory
 boolean getStripComments()
           
 boolean getStripWicketTags()
          Gets whether to remove wicket tags from the output.
 boolean getThrowExceptionOnMissingXmlDeclaration()
           
 void setAutomaticLinking(boolean automaticLinking)
          Application default for automatic link resolution.
 void setCompressWhitespace(boolean compressWhitespace)
          Turns on whitespace compression.
 void setDefaultAfterDisabledLink(String defaultAfterDisabledLink)
           
 void setDefaultBeforeDisabledLink(String defaultBeforeDisabledLink)
           
 void setDefaultMarkupEncoding(String encoding)
          Set default encoding for markup files.
 void setMarkupFactory(MarkupFactory factory)
          Set a new markup factory
 void setStripComments(boolean stripComments)
          Enables stripping of markup comments denoted in markup by HTML comment tagging.
 void setStripWicketTags(boolean stripWicketTags)
          Sets whether to remove wicket tags from the output.
 void setThrowExceptionOnMissingXmlDeclaration(boolean throwException)
          If true, an exception is thrown if the markup file does not contain a xml declaration
 

Method Detail

getAutomaticLinking

boolean getAutomaticLinking()
If true, automatic link resolution is enabled. Disabled by default.

Returns:
Returns the automaticLinking.
See Also:
AutoLinkResolver, WicketLinkTagHandler

getCompressWhitespace

boolean getCompressWhitespace()
Returns:
Returns the compressWhitespace.
See Also:
setCompressWhitespace(boolean)

getDefaultAfterDisabledLink

String getDefaultAfterDisabledLink()
Returns:
Returns the defaultAfterDisabledLink.

getDefaultBeforeDisabledLink

String getDefaultBeforeDisabledLink()
Returns:
Returns the defaultBeforeDisabledLink.

getDefaultMarkupEncoding

String getDefaultMarkupEncoding()
Returns:
Returns default encoding of markup files. If null, the operating system provided encoding will be used.
Since:
1.1

getStripComments

boolean getStripComments()
Returns:
Returns the stripComments.
See Also:
setStripComments(boolean)

getStripWicketTags

boolean getStripWicketTags()
Gets whether to remove wicket tags from the output.

Returns:
whether to remove wicket tags from the output

getThrowExceptionOnMissingXmlDeclaration

boolean getThrowExceptionOnMissingXmlDeclaration()
Returns:
if true, an exception is thrown if the markup file does not contain a xml declaration
Since:
1.3

setAutomaticLinking

void setAutomaticLinking(boolean automaticLinking)
Application default for automatic link resolution.

Parameters:
automaticLinking - The automaticLinking to set.
See Also:
AutoLinkResolver, WicketLinkTagHandler

setCompressWhitespace

void setCompressWhitespace(boolean compressWhitespace)
Turns on whitespace compression. Multiple occurrences of space/tab characters will be compressed to a single space. Multiple line breaks newline/carriage-return will also be compressed to a single newline.

Compression is currently not HTML aware and so it may be possible for whitespace compression to break pages. For this reason, whitespace compression is off by default and you should test your application thoroughly after turning whitespace compression on.

Spaces are removed from markup at markup load time and there should be no effect on page rendering speed. In fact, your pages should render faster with whitespace compression enabled.

Parameters:
compressWhitespace - The compressWhitespace to set.

setDefaultAfterDisabledLink

void setDefaultAfterDisabledLink(String defaultAfterDisabledLink)
Parameters:
defaultAfterDisabledLink - The defaultAfterDisabledLink to set.

setDefaultBeforeDisabledLink

void setDefaultBeforeDisabledLink(String defaultBeforeDisabledLink)
Parameters:
defaultBeforeDisabledLink - The defaultBeforeDisabledLink to set.

setDefaultMarkupEncoding

void setDefaultMarkupEncoding(String encoding)
Set default encoding for markup files. If null, the encoding provided by the operating system will be used.

Parameters:
encoding -
Since:
1.1

setStripComments

void setStripComments(boolean stripComments)
Enables stripping of markup comments denoted in markup by HTML comment tagging.

Parameters:
stripComments - True to strip markup comments from rendered pages

setStripWicketTags

void setStripWicketTags(boolean stripWicketTags)
Sets whether to remove wicket tags from the output.

Parameters:
stripWicketTags - whether to remove wicket tags from the output

setThrowExceptionOnMissingXmlDeclaration

void setThrowExceptionOnMissingXmlDeclaration(boolean throwException)
If true, an exception is thrown if the markup file does not contain a xml declaration

Parameters:
throwException -
Since:
1.3

getMarkupFactory

MarkupFactory getMarkupFactory()
Get the markup factory

Returns:
A new instance of MarkupFactory.

setMarkupFactory

void setMarkupFactory(MarkupFactory factory)
Set a new markup factory

Parameters:
factory -


Copyright © 2006–2018 Apache Software Foundation. All rights reserved.