senselogic.sitevision.api.render

Interface ImageScaler

public interface ImageScaler

The ImageScaler interface describes in which way images should be rescaled by an ImageRenderer.

An immutable instance of the Sitevision class implementing this interface can be obtained via Utils.getImageScaler(int, int). See Utils for how to obtain an instance of the Utils interface.

Since:

Sitevision 2.6.1_08

Author:

Magnus Lövgren

Method Summary

Modifier and Type	Method and Description
int	getMaxHeight() Returns max height in pixels for images scaled with instances of this interface.
int	getMaxWidth() Returns max width in pixels for images scaled with instances of this interface.
Node	getScaledImage(Node aImageNode) Creates a scaled image using the width and height of this scaler.

Method Detail

getMaxWidth

int getMaxWidth()

Returns max width in pixels for images scaled with instances of this interface.

Returns:

max width for scaled images

getMaxHeight

int getMaxHeight()

Returns max height in pixels for images scaled with instances of this interface.

Returns:

max height for scaled images

getScaledImage

Node getScaledImage(Node aImageNode)

Creates a scaled image using the width and height of this scaler.

Note! SVG images can't be scaled, i.e. calling this method with a sv:image of svg type will always return null.

Important Note! The scaled image is a very short-lived and volatile kind of node. Its parent/child relationship can never be relied upon. Hence the JCR Path (and tree-related operations) of the returned scaled image node should never be used (i.e. only use the returned node to get the properties you are interested in).

Parameters:

aImageNode - a image node

Returns:

a scaled variant of aImageNode, or null if aImageNode isn't a sv:image or can't be scaled.

Since:

Sitevision 4.3