org.xwiki.rendering.internal.configuration
Interface XWikiRenderingConfiguration

All Superinterfaces:

org.xwiki.rendering.configuration.RenderingConfiguration

All Known Implementing Classes:

DefaultXWikiRenderingConfiguration

@ComponentRole
public interface XWikiRenderingConfiguration
extends org.xwiki.rendering.configuration.RenderingConfiguration

Extends RenderingConfiguration with XWiki specific configuration properties.

Since:

2.0M1

Version:

$Id$

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.
boolean	isImageDimensionsIncludedInImageURL()

Methods inherited from interface org.xwiki.rendering.configuration.RenderingConfiguration

getInterWikiDefinitions, getLinkLabelFormat, getTransformations

Method Detail

isImageDimensionsIncludedInImageURL

boolean isImageDimensionsIncludedInImageURL()

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.

Since:

2.5M2

getImageWidthLimit

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.

Returns:

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

Since:

2.5M2

See Also:

isImageDimensionsIncludedInImageURL()

getImageHeightLimit

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.

Returns:

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

Since:

2.5M2

See Also:

isImageDimensionsIncludedInImageURL()