Package org.apache.poi.hslf.model

Class Picture

java.lang.Object

org.apache.poi.hslf.model.Shape

org.apache.poi.hslf.model.SimpleShape

org.apache.poi.hslf.model.Picture

Direct Known Subclasses:

ActiveXShape, MovieShape, OLEShape

public class Picture
extends SimpleShape

Represents a picture in a PowerPoint document.

Author:

Yegor Kozlov

Field Summary

Fields

Modifier and Type	Field	Description
static byte	DIB	Windows DIB (BMP)
static int	EMF	Windows Enhanced Metafile (EMF)
static int	JPEG	JPEG
static int	PICT	Macintosh PICT
static int	PNG	PNG
static int	WMF	Windows Metafile (WMF)

Fields inherited from class org.apache.poi.hslf.model.Shape

_escherContainer, _fill, _parent, _sheet, EMU_PER_CENTIMETER, EMU_PER_INCH, EMU_PER_POINT, logger, MASTER_DPI, PIXEL_DPI, POINT_DPI

Fields inherited from class org.apache.poi.hslf.model.SimpleShape

_clientData, _clientRecords, DEFAULT_LINE_WIDTH

Constructor Summary

Constructors

Modifier	Constructor	Description
	Picture(int idx)	Create a new Picture
	Picture(int idx, Shape parent)	Create a new Picture
protected	Picture(EscherContainerRecord escherRecord, Shape parent)	Create a Picture object

Method Summary

Modifier and Type	Method	Description
protected void	afterInsert(Sheet sh)	By default set the orininal image size
protected EscherContainerRecord	createSpContainer(int idx, boolean isChild)	Create a new Picture and populate the inital structure of the EscherSp record which holds information about this picture.
void	draw(java.awt.Graphics2D graphics)
java.awt.Insets	getBlipClip()	Returns the clipping values as percent ratio relatively to the image size.
protected EscherBSERecord	getEscherBSERecord()
PictureData	getPictureData()	Returns the picture data for this picture.
int	getPictureIndex()	Returns index associated with this picture.
java.lang.String	getPictureName()	Name of this picture.
void	setDefaultSize()	Resize this picture to the default size.
void	setPictureName(java.lang.String name)	Name of this picture.

Methods inherited from class java.lang.Object

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

Methods inherited from class org.apache.poi.hslf.model.Shape

getAnchor, getAnchor2D, getEscherChild, getEscherChild, getEscherOptRecord, getEscherProperty, getEscherProperty, getEscherProperty, getFill, getFlipHorizontal, getFlipVertical, getHyperlink, getOutline, getParent, getRotation, getShapeId, getShapeName, getShapeType, getSheet, getSpContainer, moveTo, setAnchor, setEscherProperty, setEscherProperty, setRotation, setShapeId, setShapeType, setSheet

Methods inherited from class org.apache.poi.hslf.model.SimpleShape

createSpContainer, getClientDataRecord, getClientRecords, getFillColor, getLineColor, getLineDashing, getLineStyle, getLineWidth, getLogicalAnchor2D, setFillColor, setHyperlink, setLineColor, setLineDashing, setLineStyle, setLineWidth, updateClientData

Field Detail

EMF

public static final int EMF

Windows Enhanced Metafile (EMF)

See Also:

Constant Field Values

WMF

public static final int WMF

Windows Metafile (WMF)

See Also:

Constant Field Values

PICT

public static final int PICT

Macintosh PICT

See Also:

Constant Field Values

JPEG

public static final int JPEG

JPEG

See Also:

Constant Field Values

PNG

public static final int PNG

PNG

See Also:

Constant Field Values

DIB

public static final byte DIB

Windows DIB (BMP)

See Also:

Constant Field Values

Constructor Detail

Picture

public Picture(int idx)

Create a new Picture

Parameters:

idx - the index of the picture

Picture

public Picture(int idx,
               Shape parent)

Create a new Picture

Parameters:

idx - the index of the picture

parent - the parent shape

Picture

protected Picture(EscherContainerRecord escherRecord,
                  Shape parent)

Create a Picture object

Parameters:

escherRecord - the EscherSpContainer record which holds information about this picture in the Slide

parent - the parent shape of this picture

Method Detail

getPictureIndex

public int getPictureIndex()

Returns index associated with this picture. Index starts with 1 and points to a EscherBSE record which holds information about this picture.

Returns:

the index to this picture (1 based).

createSpContainer

protected EscherContainerRecord createSpContainer(int idx,
                                                  boolean isChild)

Create a new Picture and populate the inital structure of the EscherSp record which holds information about this picture.

Parameters:

idx - the index of the picture which refers to EscherBSE container.

Returns:

the create Picture object

setDefaultSize

public void setDefaultSize()

Resize this picture to the default size. For PNG and JPEG resizes the image to 100%, for other types sets the default size of 200x200 pixels.

getPictureData

public PictureData getPictureData()

Returns the picture data for this picture.

Returns:

the picture data for this picture.

getEscherBSERecord

protected EscherBSERecord getEscherBSERecord()

getPictureName

public java.lang.String getPictureName()

Name of this picture.

Returns:

name of this picture

setPictureName

public void setPictureName(java.lang.String name)

Name of this picture.

Parameters:

name - of this picture

afterInsert

protected void afterInsert(Sheet sh)

By default set the orininal image size

Overrides:

afterInsert in class Shape

Parameters:

sh - - owning shape

draw

public void draw(java.awt.Graphics2D graphics)

Overrides:

draw in class SimpleShape

getBlipClip

public java.awt.Insets getBlipClip()

Returns the clipping values as percent ratio relatively to the image size. The anchor specified by SimpleShape.getLogicalAnchor2D() is the displayed size, i.e. the size of the already clipped image

Returns:

the clipping as insets converted/scaled to 100000 (=100%)