sirius.web.data

Class ExcelExport.ImageCell

java.lang.Object

sirius.web.data.ExcelExport.ImageCell

Enclosing class:

ExcelExport

public static class ExcelExport.ImageCell
extends Object

Represents a cell containing an image which should be inserted.

Constructor Summary

Constructors

Constructor and Description
ImageCell(byte[] fileData, int colWidthInPixel, String fileName) Creates a new cell containing an image which could be inserted into an Excel sheet.

Method Summary

Modifier and Type	Method and Description
protected int	getHeightInPoints() Converted height in pixels of row containing the image as POI uses points as unit for row heights.
protected int	getPOIWidth() Returns width of column containing the image formatted in POI's unit for pixel width.
protected float	getScaleFactor() Calculates the scale factor images should be scaled to so that they fit into the set column width.

Methods inherited from class java.lang.Object

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

Constructor Detail

ImageCell

public ImageCell(byte[] fileData,
                 int colWidthInPixel,
                 String fileName)

Creates a new cell containing an image which could be inserted into an Excel sheet.

The height of the image determines the height of the row containing the image. Currently, only one image is allowed per row as the changes in height for the row might result in distorted images.

Images are scaled to fit in a cell. Their scaling is determined by their width and the parameter colWidthInPixel. Images are only scaled down but never up.

Only the first image cell inserted in a given column is able to set the width of the column as changing a column's width while images being present in the column would result in them beind distorted.

The filename is needed in order to determine the type of image. POI requires an image type for inserting images. Only jpeg, png and bmp are supported.

Parameters:

fileData - the data of the picture

colWidthInPixel - the width of the column containing the image should have

fileName - the filename or path to file containing the filename

Method Detail

getHeightInPoints

protected int getHeightInPoints()

Converted height in pixels of row containing the image as POI uses points as unit for row heights.

Returns:

the height the row should have in points

getPOIWidth

protected int getPOIWidth()

Returns width of column containing the image formatted in POI's unit for pixel width. This is not the exact pixel with but more of an approximation.

Adapted from: https://stackoverflow.com/a/31837639

Returns:

column width formatted for POI

getScaleFactor

protected float getScaleFactor()

Calculates the scale factor images should be scaled to so that they fit into the set column width. Images with a width smaller than the column width are not scaled up but keep their size (scaling of 100%).

Returns:

the scaling factor of images to fit in the column