Picture (Keikai Spreadsheet Build 5.0.0 API)

java.lang.Object
- org.zkoss.poi.hwpf.usermodel.Picture

```
public final class Picture
extends Object
```
Represents embedded picture extracted from Word Document

Field Summary

Fields
Modifier and Type	Field and Description
`static byte[]`	`BMP` Deprecated.
`static byte[]`	`COMPRESSED1`
`static byte[]`	`COMPRESSED2`
`static byte[]`	`EMF` Deprecated.
`static byte[]`	`GIF` Deprecated.
`static byte[]`	`IHDR`
`static byte[]`	`JPG` Deprecated.
`static byte[]`	`PNG` Deprecated.
`static byte[]`	`TIFF` Deprecated.
`static byte[]`	`TIFF1` Deprecated.
`static byte[]`	`WMF1` Deprecated.
`static byte[]`	`WMF2` Deprecated.

Constructor Summary

Constructors
Constructor and Description
`Picture(EscherBlipRecord blipRecord)` Builds a Picture object for a Picture stored as Escher.
`Picture(int dataBlockStartOfsset, byte[] _dataStream, boolean fillBytes)` Builds a Picture object for a Picture stored in the DataStream

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`int`	`getAspectRatioX()` Deprecated. use more precise `getHorizontalScalingFactor()`
`int`	`getAspectRatioY()` Deprecated. use more precise `getVerticalScalingFactor()`
`byte[]`	`getContent()`
`String`	`getDescription()` returns the description stored in the alternative text
`int`	`getDxaCropLeft()` Deprecated.
`int`	`getDxaCropRight()` Deprecated.
`int`	`getDxaGoal()` Gets the initial width of the picture, in twips, prior to cropping or scaling.
`int`	`getDyaCropBottom()` Deprecated.
`int`	`getDyaCropTop()` Deprecated.
`int`	`getDyaGoal()` Gets the initial height of the picture, in twips, prior to cropping or scaling.
`int`	`getHeight()` returns pixel height of the picture or -1 if dimensions determining was failed
`int`	`getHorizontalScalingFactor()`
`String`	`getMimeType()` Returns the MIME type for the image
`byte[]`	`getRawContent()` Returns picture's content as it stored in Word file, i.e.
`int`	`getSize()`
`int`	`getStartOffset()`
`int`	`getVerticalScalingFactor()`
`int`	`getWidth()` returns pixel width of the picture or -1 if dimensions determining was failed
`String`	`suggestFileExtension()` tries to suggest extension for picture's file by matching signatures of popular image formats to first bytes of picture's contents
`String`	`suggestFullFileName()` Tries to suggest a filename: hex representation of picture structure offset in "Data" stream plus extension that is tried to determine from first byte of picture's content.
`PictureType`	`suggestPictureType()`
`void`	`writeImageContent(OutputStream out)` Writes Picture's content bytes to specified OutputStream.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - BMP
```
@Deprecated
public static final byte[] BMP
```
    Deprecated.
  - COMPRESSED1
```
public static final byte[] COMPRESSED1
```
  - COMPRESSED2
```
public static final byte[] COMPRESSED2
```
  - EMF
```
@Deprecated
public static final byte[] EMF
```
    Deprecated.
  - GIF
```
@Deprecated
public static final byte[] GIF
```
    Deprecated.
  - IHDR
```
public static final byte[] IHDR
```
  - JPG
```
@Deprecated
public static final byte[] JPG
```
    Deprecated.
  - PNG
```
@Deprecated
public static final byte[] PNG
```
    Deprecated.
  - TIFF
```
@Deprecated
public static final byte[] TIFF
```
    Deprecated.
  - TIFF1
```
@Deprecated
public static final byte[] TIFF1
```
    Deprecated.
  - WMF1
```
@Deprecated
public static final byte[] WMF1
```
    Deprecated.
  - WMF2
```
@Deprecated
public static final byte[] WMF2
```
    Deprecated.
- Constructor Detail
  - Picture
```
public Picture(EscherBlipRecord blipRecord)
```
    Builds a Picture object for a Picture stored as Escher. TODO We need to pass in the PICF data too somehow!
  - Picture
```
public Picture(int dataBlockStartOfsset,
               byte[] _dataStream,
               boolean fillBytes)
```
    Builds a Picture object for a Picture stored in the DataStream
- Method Detail
  - getAspectRatioX
```
@Deprecated
public int getAspectRatioX()
```
    Deprecated. use more precise getHorizontalScalingFactor()
    
    Returns:
    
    the horizontal aspect ratio for picture provided by user
  - getAspectRatioY
```
@Deprecated
public int getAspectRatioY()
```
    Deprecated. use more precise getVerticalScalingFactor()
    
    Returns:
    
    the vertical aspect ratio for picture provided by user
  - getContent
```
public byte[] getContent()
```
    Returns:
    
    picture's content as byte array
  - getDxaCropLeft
```
@Deprecated
public int getDxaCropLeft()
```
    Deprecated.
    
    Returns:
    
    The amount the picture has been cropped on the left in twips
  - getDxaCropRight
```
@Deprecated
public int getDxaCropRight()
```
    Deprecated.
    
    Returns:
    
    The amount the picture has been cropped on the right in twips
  - getDxaGoal
```
public int getDxaGoal()
```
    Gets the initial width of the picture, in twips, prior to cropping or scaling.
    
    Returns:
    
    the initial width of the picture in twips
  - getDyaCropBottom
```
@Deprecated
public int getDyaCropBottom()
```
    Deprecated.
    
    Returns:
    
    The amount the picture has been cropped on the bottom in twips
  - getDyaCropTop
```
@Deprecated
public int getDyaCropTop()
```
    Deprecated.
    
    Returns:
    
    The amount the picture has been cropped on the top in twips
  - getDyaGoal
```
public int getDyaGoal()
```
    Gets the initial height of the picture, in twips, prior to cropping or scaling.
    
    Returns:
    
    the initial width of the picture in twips
  - getHeight
```
public int getHeight()
```
    returns pixel height of the picture or -1 if dimensions determining was failed
  - getHorizontalScalingFactor
```
public int getHorizontalScalingFactor()
```
    Returns:
    
    Horizontal scaling factor supplied by user expressed in .001% units
  - getMimeType
```
public String getMimeType()
```
    Returns the MIME type for the image
    
    Returns:
    
    MIME-type for known types of image or "image/unknown" if unknown
  - getRawContent
```
public byte[] getRawContent()
```
    Returns picture's content as it stored in Word file, i.e. possibly in compressed form.
    
    Returns:
    
    picture's content as it stored in Word file
  - getSize
```
public int getSize()
```
    Returns:
    
    size in bytes of the picture
  - getStartOffset
```
public int getStartOffset()
```
    Returns:
    
    The offset of this picture in the picture bytes, used when matching up with CharacterRun.getPicOffset()
  - getVerticalScalingFactor
```
public int getVerticalScalingFactor()
```
    Returns:
    
    Vertical scaling factor supplied by user expressed in .001% units
  - getWidth
```
public int getWidth()
```
    returns pixel width of the picture or -1 if dimensions determining was failed
  - getDescription
```
public String getDescription()
```
    returns the description stored in the alternative text
    
    Returns:
    
    pictue description
  - suggestFileExtension
```
public String suggestFileExtension()
```
    tries to suggest extension for picture's file by matching signatures of popular image formats to first bytes of picture's contents
    
    Returns:
    
    suggested file extension
  - suggestFullFileName
```
public String suggestFullFileName()
```
    Tries to suggest a filename: hex representation of picture structure offset in "Data" stream plus extension that is tried to determine from first byte of picture's content.
    
    Returns:
    
    suggested file name
  - suggestPictureType
```
public PictureType suggestPictureType()
```
  - writeImageContent
```
public void writeImageContent(OutputStream out)
                       throws IOException
```
    Writes Picture's content bytes to specified OutputStream. Is useful when there is need to write picture bytes directly to stream, omitting its representation in memory as distinct byte array.
    
    Parameters:
    
    out - a stream to write to
    
    Throws:
    
    IOException - if some exception is occured while writing to specified out

Class Picture

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

BMP

COMPRESSED1

COMPRESSED2

EMF

GIF

IHDR

JPG

PNG

TIFF

TIFF1

WMF1

WMF2

Constructor Detail

Picture

Picture

Method Detail

getAspectRatioX

getAspectRatioY

getContent

getDxaCropLeft

getDxaCropRight

getDxaGoal

getDyaCropBottom

getDyaCropTop

getDyaGoal

getHeight

getHorizontalScalingFactor

getMimeType

getRawContent

getSize

getStartOffset

getVerticalScalingFactor

getWidth

getDescription

suggestFileExtension

suggestFullFileName

suggestPictureType

writeImageContent