Java Doc for BMPImageWriteParam.java in  » 6.0-JDK-Modules » Java-Advanced-Imaging » com » sun » media » imageio » plugins » bmp » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » 6.0 JDK Modules » Java Advanced Imaging » com.sun.media.imageio.plugins.bmp 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


javax.imageio.ImageWriteParam
   com.sun.media.imageio.plugins.bmp.BMPImageWriteParam

BMPImageWriteParam
public class BMPImageWriteParam extends ImageWriteParam (Code)
A subclass of ImageWriteParam for encoding images in the BMP format.

This class allows for the specification of various parameters while writing a BMP format image file. By default, the data layout is bottom-up, such that the pixels are stored in bottom-up order, the first scanline being stored last.

The particular compression scheme to be used can be specified by using the setCompressionType() method with the appropriate type string. The compression scheme specified will be honored if and only if it is compatible with the type of image being written. If the specified compression scheme is not compatible with the type of image being written then the IOException will be thrown by the BMP image writer. If the compression type is not set explicitly then getCompressionType() will return null. In this case the BMP image writer will select a compression type that supports encoding of the given image without loss of the color resolution.

The compression type strings and the image type(s) each supports are listed in the following table:

Compression Types
Type String Description Image Types
BI_RGB Uncompressed RLE <= 8-bits/sample
BI_RLE8 8-bit Run Length Encoding <= 8-bits/sample
BI_RLE4 4-bit Run Length Encoding <= 4-bits/sample
BI_BITFIELDS Packed data 16 or 32 bits/sample
BI_JPEG JPEG encoded grayscale or RGB image

When BI_BITFIELDS is used, if the image encoded has a DirectColorModel, the bit mask in the color model will be written into the stream. Otherwise, only 5-5-5 16-bit image or 8-8-8 32-bit images are supported.



Field Summary
final public static  intVERSION_2
     Constant for BMP version 2.
final public static  intVERSION_3
     Constant for BMP version 3.
final public static  intVERSION_4
     Constant for BMP version 4.
final public static  intVERSION_5
     Constant for BMP version 5.

Constructor Summary
public  BMPImageWriteParam(Locale locale)
     Constructs a BMPImageWriteParam set to use a given Locale and with default values for all parameters.
public  BMPImageWriteParam()
     Constructs an BMPImageWriteParam object with default values for all parameters and a null Locale.

Method Summary
public  intgetVersion()
     Returns the BMP version to be used.
public  booleanisTopDown()
     Returns the value of the topDown parameter.
public  voidsetCompressionType(String compressionType)
     Sets the compression type to one of the values indicated by getCompressionTypes.
public  voidsetTopDown(boolean topDown)
     If set, the data will be written out in a top-down manner, the first scanline being written first. Any compression other than BI_RGB or BI_BITFIELDS is incompatible with the data being written in top-down order.

Field Detail
VERSION_2
final public static int VERSION_2(Code)
Constant for BMP version 2.



VERSION_3
final public static int VERSION_3(Code)
Constant for BMP version 3.



VERSION_4
final public static int VERSION_4(Code)
Constant for BMP version 4.



VERSION_5
final public static int VERSION_5(Code)
Constant for BMP version 5.




Constructor Detail
BMPImageWriteParam
public BMPImageWriteParam(Locale locale)(Code)
Constructs a BMPImageWriteParam set to use a given Locale and with default values for all parameters.
Parameters:
  locale - a Locale to be used to localizecompression type names and quality descriptions, ornull.



BMPImageWriteParam
public BMPImageWriteParam()(Code)
Constructs an BMPImageWriteParam object with default values for all parameters and a null Locale.




Method Detail
getVersion
public int getVersion()(Code)
Returns the BMP version to be used. The default is VERSION_3. the BMP version number.



isTopDown
public boolean isTopDown()(Code)
Returns the value of the topDown parameter. The default is false. whether the data are written in top-down order.



setCompressionType
public void setCompressionType(String compressionType)(Code)
Sets the compression type to one of the values indicated by getCompressionTypes. If a value of null is passed in, any previous setting is removed.

The method first invokes javax.imageio.ImageWriteParam.#setCompressionType(String) setCompressionType() with the supplied value of compressionType. Next, if BMPImageWriteParam.isTopDown() returns true and the value of compressionType is incompatible with top-down order, BMPImageWriteParam.setTopDown(boolean) is invoked with parameter topDown set to false. The image will then be written in bottom-up order with the specified compressionType.


Parameters:
  compressionType - one of the Strings returnedby getCompressionTypes, or null toremove any previous setting.
exception:
  UnsupportedOperationException - if the writer does notsupport compression.
exception:
  IllegalStateException - if the compression mode is notMODE_EXPLICIT.
exception:
  UnsupportedOperationException - if there are nosettable compression types.
exception:
  IllegalArgumentException - ifcompressionType is non-null but is notone of the values returned by getCompressionTypes.
See Also:   BMPImageWriteParam.isTopDown
See Also:   BMPImageWriteParam.setTopDown
See Also:   BMPImageWriteParam.getCompressionTypes
See Also:   BMPImageWriteParam.getCompressionType
See Also:   BMPImageWriteParam.unsetCompression



setTopDown
public void setTopDown(boolean topDown)(Code)
If set, the data will be written out in a top-down manner, the first scanline being written first. Any compression other than BI_RGB or BI_BITFIELDS is incompatible with the data being written in top-down order. Setting the topDown argument to true will be honored only when the compression type at the time of writing the image is one of the two mentioned above. Otherwise, the topDown setting will be ignored.
Parameters:
  topDown - whether the data are written in top-down order.



Fields inherited from javax.imageio.ImageWriteParam
final public static int MODE_COPY_FROM_METADATA(Code)(Java Doc)
final public static int MODE_DEFAULT(Code)(Java Doc)
final public static int MODE_DISABLED(Code)(Java Doc)
final public static int MODE_EXPLICIT(Code)(Java Doc)
protected boolean canOffsetTiles(Code)(Java Doc)
protected boolean canWriteCompressed(Code)(Java Doc)
protected boolean canWriteProgressive(Code)(Java Doc)
protected boolean canWriteTiles(Code)(Java Doc)
protected int compressionMode(Code)(Java Doc)
protected float compressionQuality(Code)(Java Doc)
protected String compressionType(Code)(Java Doc)
protected String[] compressionTypes(Code)(Java Doc)
protected Locale locale(Code)(Java Doc)
protected Dimension[] preferredTileSizes(Code)(Java Doc)
protected int progressiveMode(Code)(Java Doc)
protected int tileGridXOffset(Code)(Java Doc)
protected int tileGridYOffset(Code)(Java Doc)
protected int tileHeight(Code)(Java Doc)
protected int tileWidth(Code)(Java Doc)
protected int tilingMode(Code)(Java Doc)
protected boolean tilingSet(Code)(Java Doc)

Methods inherited from javax.imageio.ImageWriteParam
public boolean canOffsetTiles()(Code)(Java Doc)
public boolean canWriteCompressed()(Code)(Java Doc)
public boolean canWriteProgressive()(Code)(Java Doc)
public boolean canWriteTiles()(Code)(Java Doc)
public float getBitRate(float quality)(Code)(Java Doc)
public int getCompressionMode()(Code)(Java Doc)
public float getCompressionQuality()(Code)(Java Doc)
public String[] getCompressionQualityDescriptions()(Code)(Java Doc)
public float[] getCompressionQualityValues()(Code)(Java Doc)
public String getCompressionType()(Code)(Java Doc)
public String[] getCompressionTypes()(Code)(Java Doc)
public Locale getLocale()(Code)(Java Doc)
public String getLocalizedCompressionTypeName()(Code)(Java Doc)
public Dimension[] getPreferredTileSizes()(Code)(Java Doc)
public int getProgressiveMode()(Code)(Java Doc)
public int getTileGridXOffset()(Code)(Java Doc)
public int getTileGridYOffset()(Code)(Java Doc)
public int getTileHeight()(Code)(Java Doc)
public int getTileWidth()(Code)(Java Doc)
public int getTilingMode()(Code)(Java Doc)
public boolean isCompressionLossless()(Code)(Java Doc)
public void setCompressionMode(int mode)(Code)(Java Doc)
public void setCompressionQuality(float quality)(Code)(Java Doc)
public void setCompressionType(String compressionType)(Code)(Java Doc)
public void setProgressiveMode(int mode)(Code)(Java Doc)
public void setTiling(int tileWidth, int tileHeight, int tileGridXOffset, int tileGridYOffset)(Code)(Java Doc)
public void setTilingMode(int mode)(Code)(Java Doc)
public void unsetCompression()(Code)(Java Doc)
public void unsetTiling()(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.