org.xwiki.rendering.internal.configuration
Class DefaultXWikiRenderingConfiguration

java.lang.Object
  org.xwiki.rendering.internal.configuration.DefaultXWikiRenderingConfiguration

All Implemented Interfaces:

org.xwiki.rendering.configuration.RenderingConfiguration, XWikiRenderingConfiguration

@Component
public class DefaultXWikiRenderingConfiguration
extends java.lang.Object
implements XWikiRenderingConfiguration

All configuration options for the Rendering subsystem.

Since:

2.5M2

Version:

$Id$

Constructor Summary

DefaultXWikiRenderingConfiguration()

Method Summary

int	getImageHeightLimit() One way to improve page load speed is to resize images on the server side just before rendering the page.
int	getImageWidthLimit() One way to improve page load speed is to resize images on the server side just before rendering the page.
java.util.Properties	getInterWikiDefinitions()
java.lang.String	getLinkLabelFormat()
java.util.List<org.xwiki.rendering.transformation.Transformation>	getTransformations()
boolean	isImageDimensionsIncludedInImageURL()

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultXWikiRenderingConfiguration

public DefaultXWikiRenderingConfiguration()

Method Detail

getLinkLabelFormat

public java.lang.String getLinkLabelFormat()

Specified by:

getLinkLabelFormat in interface org.xwiki.rendering.configuration.RenderingConfiguration

See Also:

RenderingConfiguration.getLinkLabelFormat()

getImageWidthLimit

public int getImageWidthLimit()

One way to improve page load speed is to resize images on the server side just before rendering the page. The rendering module can use the image width provided by the user to scale the image. When the user doesn't specify the image width the rendering module can limit the width of the image based on this configuration parameter.

The default value is -1 which means image width is not limited by default. Use a value greater than 0 to limit the image width (pixels). Note that the aspect ratio is kept even when both the width and the height of the image are limited.

Specified by:

getImageWidthLimit in interface XWikiRenderingConfiguration

Returns:

the maximum image width when there's no user supplied width

See Also:

XWikiRenderingConfiguration.getImageWidthLimit()

getImageHeightLimit

public int getImageHeightLimit()

One way to improve page load speed is to resize images on the server side just before rendering the page. The rendering module can use the image height provided by the user to scale the image. When the user doesn't specify the image height the rendering module can limit the height of the image based on this configuration parameter.

The default value is -1 which means image height is not limited by default. Use a value greater than 0 to limit the image height (pixels). Note that the aspect ratio is kept even when both the width and the height of the image are limited.

Specified by:

getImageHeightLimit in interface XWikiRenderingConfiguration

Returns:

the maximum image height when there's no user supplied height

See Also:

XWikiRenderingConfiguration.getImageHeightLimit()

isImageDimensionsIncludedInImageURL

public boolean isImageDimensionsIncludedInImageURL()

Specified by:

isImageDimensionsIncludedInImageURL in interface XWikiRenderingConfiguration

Returns:

true to include the image dimensions extracted from the image parameters in the image URL, false otherwise; when image dimensions are included in the image URL the image can be resized on the server side before being downloaded.

See Also:

XWikiRenderingConfiguration.isImageDimensionsIncludedInImageURL()

getInterWikiDefinitions

public java.util.Properties getInterWikiDefinitions()

Specified by:

getInterWikiDefinitions in interface org.xwiki.rendering.configuration.RenderingConfiguration

See Also:

RenderingConfiguration.getInterWikiDefinitions()

getTransformations

public java.util.List<org.xwiki.rendering.transformation.Transformation> getTransformations()

Specified by:

getTransformations in interface org.xwiki.rendering.configuration.RenderingConfiguration

Since:

2.6RC1

See Also:

RenderingConfiguration.getTransformations()