Apache POI - Common 5.3.0 · org.apache.poi.hssf.usermodel.HSSFPicture

Access	Constructor and Description
public	HSSFPicture(EscherContainerRecord spContainer, ObjRecord objRecord)
public	HSSFPicture(HSSFShape parent, HSSFAnchor anchor) Constructs a picture object.

Method Summary

Modifier and Type	Method and Description
pack-priv void	afterInsert(HSSFPatriarch patriarch) Overrides org.apache.poi.hssf.usermodel.HSSFSimpleShape.afterInsert.
protected HSSFShape	cloneShape() Overrides org.apache.poi.hssf.usermodel.HSSFSimpleShape.cloneShape.
protected EscherContainerRecord	createSpContainer() Overrides org.apache.poi.hssf.usermodel.HSSFSimpleShape.createSpContainer.
public HSSFClientAnchor	Returns: the anchor that is used by this picture. getClientAnchor() Implements org.apache.poi.ss.usermodel.Picture.getClientAnchor.
public String	getFileName() The filename of the embedded image
public Dimension	Returns: image dimension in pixels getImageDimension() Implements org.apache.poi.ss.usermodel.Picture.getImageDimension. Return the dimension of the embedded image in pixel
public HSSFPictureData	Returns: picture data for this shape or `null` if picture wasn't embedded, i.e. external linked getPictureData() Implements org.apache.poi.ss.usermodel.Picture.getPictureData. Return picture data for this shape
public int	getPictureIndex()
public HSSFClientAnchor	Returns: HSSFClientAnchor with the preferred size for this image getPreferredSize() Implements org.apache.poi.ss.usermodel.Picture.getPreferredSize. Calculate the preferred size for this picture.
public HSSFClientAnchor	Returns: HSSFClientAnchor with the preferred size for this image getPreferredSize(double the amount by which image dimensions are multiplied relative to the original size. scale) Calculate the preferred size for this picture.
public HSSFClientAnchor	Returns: HSSFClientAnchor with the preferred size for this image getPreferredSize(double the amount by which image width is multiplied relative to the original width. scaleX, double the amount by which image height is multiplied relative to the original height. scaleY) Implements org.apache.poi.ss.usermodel.Picture.getPreferredSize. Calculate the preferred size for this picture.
public HSSFSheet	Returns: the sheet which contains the picture shape getSheet() Implements org.apache.poi.ss.usermodel.Picture.getSheet.
public void	resize() Implements org.apache.poi.ss.usermodel.Picture.resize. Reset the image to the dimension of the embedded image Please note, that this method works correctly only for workbooks with default font size (Arial 10pt for .xls).
public void	resize(double scale) Implements org.apache.poi.ss.usermodel.Picture.resize. Resize the image proportionally.
public void	resize(double the amount by which the image width is multiplied relative to the original width. scaleX, double the amount by which the image height is multiplied relative to the original height. scaleY) Implements org.apache.poi.ss.usermodel.Picture.resize. Resize the image Please note, that this method works correctly only for workbooks with default font size (Arial 10pt for .xls).
public void	setFileName(String data)
public void	setPictureIndex(int pictureIndex)
public void	setShapeType(int - shapeType shapeType) Overrides org.apache.poi.hssf.usermodel.HSSFSimpleShape.setShapeType.

Inherited from org.apache.poi.hssf.usermodel.HSSFSimpleShape:: afterRemove createObjRecord createTextObjRecord getShapeId getShapeType getString getTextObjectRecord getWrapText setString setWrapText

HSSFPicture	back to summary
public HSSFPicture(EscherContainerRecord spContainer, ObjRecord objRecord)

HSSFPicture	back to summary
public HSSFPicture(HSSFShape parent, HSSFAnchor anchor) Constructs a picture object.

Method Detail

afterInsert	back to summary
pack-priv void afterInsert(HSSFPatriarch patriarch) Overrides org.apache.poi.hssf.usermodel.HSSFSimpleShape.afterInsert. Annotations @Override

afterInsert

back to summary

pack-priv void afterInsert(HSSFPatriarch patriarch)

Overrides org.apache.poi.hssf.usermodel.HSSFSimpleShape.afterInsert.

Annotations

@Override

cloneShape	back to summary
protected HSSFShape cloneShape() Overrides org.apache.poi.hssf.usermodel.HSSFSimpleShape.cloneShape. Annotations @Override

cloneShape

back to summary

protected HSSFShape cloneShape()

Overrides org.apache.poi.hssf.usermodel.HSSFSimpleShape.cloneShape.

Annotations

@Override

createSpContainer	back to summary
protected EscherContainerRecord createSpContainer() Overrides org.apache.poi.hssf.usermodel.HSSFSimpleShape.createSpContainer. Annotations @Override

createSpContainer

back to summary

protected EscherContainerRecord createSpContainer()

Overrides org.apache.poi.hssf.usermodel.HSSFSimpleShape.createSpContainer.

Annotations

@Override

getClientAnchor	back to summary
public HSSFClientAnchor getClientAnchor() Implements org.apache.poi.ss.usermodel.Picture.getClientAnchor. Returns:HSSFClientAnchor the anchor that is used by this picture. Annotations @Override

getClientAnchor

back to summary

public HSSFClientAnchor getClientAnchor()

Implements org.apache.poi.ss.usermodel.Picture.getClientAnchor.

Returns:HSSFClientAnchor

the anchor that is used by this picture.

Annotations

@Override

getFileName	back to summary
public String getFileName() The filename of the embedded image

getImageDimension	back to summary
public Dimension getImageDimension() Implements org.apache.poi.ss.usermodel.Picture.getImageDimension. Return the dimension of the embedded image in pixel Returns:Dimension image dimension in pixels Annotations @Override

getImageDimension

back to summary

public Dimension getImageDimension()

Implements org.apache.poi.ss.usermodel.Picture.getImageDimension.

Return the dimension of the embedded image in pixel

Returns:Dimension

image dimension in pixels

Annotations

@Override

getPictureData back to summary

getPictureData	back to summary
public HSSFPictureData getPictureData() Implements org.apache.poi.ss.usermodel.Picture.getPictureData. Return picture data for this shape Returns:HSSFPictureData picture data for this shape or `null` if picture wasn't embedded, i.e. external linked Annotations @Override

public HSSFPictureData getPictureData()

Implements org.apache.poi.ss.usermodel.Picture.getPictureData.

Return picture data for this shape

Returns:HSSFPictureData

picture data for this shape or null if picture wasn't embedded, i.e. external linked

Annotations

@Override

getPictureIndex	back to summary
public int getPictureIndex()

getPreferredSize	back to summary
public HSSFClientAnchor getPreferredSize() Implements org.apache.poi.ss.usermodel.Picture.getPreferredSize. Calculate the preferred size for this picture. Returns:HSSFClientAnchor HSSFClientAnchor with the preferred size for this image Annotations @Override Since POI 3.0.2

getPreferredSize

back to summary

public HSSFClientAnchor getPreferredSize()

Implements org.apache.poi.ss.usermodel.Picture.getPreferredSize.

Calculate the preferred size for this picture.

Returns:HSSFClientAnchor

HSSFClientAnchor with the preferred size for this image

Annotations

@Override

Since

POI 3.0.2

getPreferredSize	back to summary
public HSSFClientAnchor getPreferredSize(double scale) Calculate the preferred size for this picture. Parameters scale:double the amount by which image dimensions are multiplied relative to the original size. Returns:HSSFClientAnchor HSSFClientAnchor with the preferred size for this image Since POI 3.0.2

getPreferredSize

back to summary

public HSSFClientAnchor getPreferredSize(double scale)

Calculate the preferred size for this picture.

Parameters

scale:double: the amount by which image dimensions are multiplied relative to the original size.

Returns:HSSFClientAnchor

HSSFClientAnchor with the preferred size for this image

Since

POI 3.0.2

getPreferredSize	back to summary
public HSSFClientAnchor getPreferredSize(double scaleX, double scaleY) Implements org.apache.poi.ss.usermodel.Picture.getPreferredSize. Calculate the preferred size for this picture. Parameters scaleX:double the amount by which image width is multiplied relative to the original width. scaleY:double the amount by which image height is multiplied relative to the original height. Returns:HSSFClientAnchor HSSFClientAnchor with the preferred size for this image Annotations @Override Since POI 3.11

getPreferredSize

back to summary

public HSSFClientAnchor getPreferredSize(double scaleX, double scaleY)

Implements org.apache.poi.ss.usermodel.Picture.getPreferredSize.

Calculate the preferred size for this picture.

Parameters

scaleX:double: the amount by which image width is multiplied relative to the original width.
scaleY:double: the amount by which image height is multiplied relative to the original height.

Returns:HSSFClientAnchor

HSSFClientAnchor with the preferred size for this image

Annotations

@Override

Since

POI 3.11

getSheet	back to summary
public HSSFSheet getSheet() Implements org.apache.poi.ss.usermodel.Picture.getSheet. Returns:HSSFSheet the sheet which contains the picture shape Annotations @Override

getSheet

back to summary

public HSSFSheet getSheet()

Implements org.apache.poi.ss.usermodel.Picture.getSheet.

Returns:HSSFSheet

the sheet which contains the picture shape

Annotations

@Override

resize	back to summary
public void resize() Implements org.apache.poi.ss.usermodel.Picture.resize. Reset the image to the dimension of the embedded image Please note, that this method works correctly only for workbooks with default font size (Arial 10pt for .xls). If the default font is changed the resized image can be stretched vertically or horizontally. Annotations @Override

resize

back to summary

public void resize()

Implements org.apache.poi.ss.usermodel.Picture.resize.

Reset the image to the dimension of the embedded image

Please note, that this method works correctly only for workbooks with default font size (Arial 10pt for .xls). If the default font is changed the resized image can be stretched vertically or horizontally.

Annotations

@Override

resize back to summary

resize	back to summary
public void resize(double scale) Implements org.apache.poi.ss.usermodel.Picture.resize. Resize the image proportionally. Annotations @Override See Also `resize(double, double)`

public void resize(double scale)

Implements org.apache.poi.ss.usermodel.Picture.resize.

Resize the image proportionally.

Annotations

@Override

See Also

resize(double, double)

resize back to summary

resize	back to summary
public void resize(double scaleX, double scaleY) Implements org.apache.poi.ss.usermodel.Picture.resize. Resize the image Please note, that this method works correctly only for workbooks with default font size (Arial 10pt for .xls). If the default font is changed the resized image can be stretched vertically or horizontally. `resize(1.0,1.0)` keeps the original size, `resize(0.5,0.5)` resize to 50% of the original, `resize(2.0,2.0)` resizes to 200% of the original. `resize(Double#MAX_VALUE,Double#MAX_VALUE)` resizes to the dimension of the embedded image. Parameters scaleX:double the amount by which the image width is multiplied relative to the original width. scaleY:double the amount by which the image height is multiplied relative to the original height. Annotations @Override

public void resize(double scaleX, double scaleY)

Implements org.apache.poi.ss.usermodel.Picture.resize.

Resize the image

resize(1.0,1.0) keeps the original size,
resize(0.5,0.5) resize to 50% of the original,
resize(2.0,2.0) resizes to 200% of the original.
resize(Double#MAX_VALUE,Double#MAX_VALUE) resizes to the dimension of the embedded image.

Parameters

scaleX:double: the amount by which the image width is multiplied relative to the original width.
scaleY:double: the amount by which the image height is multiplied relative to the original height.

Annotations

@Override

setFileName	back to summary
public void setFileName(String data)

setPictureIndex	back to summary
public void setPictureIndex(int pictureIndex)

setShapeType	back to summary
public void setShapeType(int shapeType) Overrides org.apache.poi.hssf.usermodel.HSSFSimpleShape.setShapeType. Parameters shapeType:int Doc from org.apache.poi.hssf.usermodel.HSSFSimpleShape.setShapeType. - shapeType Annotations @Override

setShapeType

back to summary

public void setShapeType(int shapeType)

Overrides org.apache.poi.hssf.usermodel.HSSFSimpleShape.setShapeType.

Parameters

shapeType:int

Doc from org.apache.poi.hssf.usermodel.HSSFSimpleShape.setShapeType.

- shapeType

Annotations

@Override

public Class HSSFPicture

Field Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail