Module java.desktop

软件包 javax.imageio

Class IIOImage

java.lang.Object

javax.imageio.IIOImage

public class IIOImage
extends Object

用于聚合图像的简单容器类，一组缩略图（预览）图像，以及表示与该图像相关联的元数据的对象。

图像数据可以采用RenderedImage或Raster 。 阅读器方法返回IIOImage将始终返回BufferedImage使用RenderedImage参考。 接受IIOImage作者方法将始终接受一个RenderedImage ，并且可以选择接受一个Raster 。

getRenderedImage和getRaster将返回非null值。 子类负责确保此行为。

另请参见：

ImageReader.readAll(int, ImageReadParam) ， ImageReader.readAll(java.util.Iterator) ， ImageWriter.write(javax.imageio.metadata.IIOMetadata, IIOImage, ImageWriteParam) ， ImageWriter.write(IIOImage) ， ImageWriter.writeToSequence(IIOImage, ImageWriteParam) ， ImageWriter.writeInsert(int, IIOImage, ImageWriteParam)

Field Summary

Fields

Modifier and Type	Field	描述
protected RenderedImage	image	参考 RenderedImage 。
protected IIOMetadata	metadata	包含与图像相关联的元数据的 IIOMetadata对象。
protected Raster	raster	Raster被引用。
protected List<? extends BufferedImage>	thumbnails	A List的 BufferedImage缩略图，或 null 。

构造方法摘要

构造方法

Constructor	描述
IIOImage(Raster raster, List<? extends BufferedImage> thumbnails, IIOMetadata metadata)	构造一个 IIOImage含有 Raster ，和缩略图和元数据与之相关联。
IIOImage(RenderedImage image, List<? extends BufferedImage> thumbnails, IIOMetadata metadata)	构造一个 IIOImage含有 RenderedImage ，和缩略图和元数据与之相关联。

方法摘要

Modifier and Type	方法	描述
IIOMetadata	getMetadata()	返回对当前 IIOMetadata对象的引用，或者是 null没有设置。
int	getNumThumbnails()	返回此 IIOImage存储的缩略图数。
Raster	getRaster()	如果只有 RenderedImage可用，则返回当前设置的 Raster或 null 。
RenderedImage	getRenderedImage()	如果只有一个 Raster可用，则返回当前设置的 RenderedImage ，或 null 。
BufferedImage	getThumbnail(int index)	返回与主图像相关联的缩略图。
List<? extends BufferedImage>	getThumbnails()	返回当前 List缩略图 BufferedImage S，或 null ，如果没有设置。
boolean	hasRaster()	如果这 IIOImage存储 Raster而不是 true则返回 RenderedImage 。
void	setMetadata(IIOMetadata metadata)	将 IIOMetadata设置为新对象，或 null 。
void	setRaster(Raster raster)	设置当前的 Raster 。
void	setRenderedImage(RenderedImage image)	设置当前的 RenderedImage 。
void	setThumbnails(List<? extends BufferedImage> thumbnails)	将缩略图到一个新的列表 List的 BufferedImage S，或 null 。

Methods inherited from class java.lang.Object

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

字段详细信息

image

protected RenderedImage image

参考的 RenderedImage 。

raster

protected Raster raster

参考 Raster 。

thumbnails

protected List<? extends BufferedImage> thumbnails

A List的BufferedImage缩略图，或null 。 非BufferedImage对象不能存储在此List 。

metadata

protected IIOMetadata metadata

包含与图像相关联的元数据的 IIOMetadata对象。

构造方法详细信息

IIOImage

public IIOImage(RenderedImage image,
                List<? extends BufferedImage> thumbnails,
                IIOMetadata metadata)

构造一个IIOImage含有RenderedImage ，和缩略图和元数据与之相关联。

所有参数通过参考存储。

thumbnails参数必须为null或仅包含BufferedImage对象。

参数

image - a RenderedImage 。

thumbnails - a List （ BufferedImage ）或 null 。

metadata - 一个 IIOMetadata对象，或 null 。

异常

IllegalArgumentException - 如果 image为 null 。

IIOImage

public IIOImage(Raster raster,
                List<? extends BufferedImage> thumbnails,
                IIOMetadata metadata)

构造一个IIOImage含有Raster ，和缩略图和元数据与之相关联。

所有参数通过参考存储。

参数

raster - a Raster 。

thumbnails - a List的 BufferedImage s或 null 。

metadata - 一个 IIOMetadata对象，或 null 。

异常

IllegalArgumentException - 如果 raster是 null 。

方法详细信息

getRenderedImage

public RenderedImage getRenderedImage()

如果只有 Raster可用，则返回当前设置的 RenderedImage或 null 。

结果

一个 RenderedImage或 null 。

另请参见：

setRenderedImage(java.awt.image.RenderedImage)

setRenderedImage

public void setRenderedImage(RenderedImage image)

设置当前的RenderedImage 。 该值通过引用存储。 任何现有的Raster被丢弃。

参数

image - a RenderedImage 。

异常

IllegalArgumentException - 如果 image是 null 。

另请参见：

getRenderedImage()

hasRaster

public boolean hasRaster()

如果这个 IIOImage存储 Raster而不是 true则返回 RenderedImage 。

结果

true如果有一个 Raster可用。

getRaster

public Raster getRaster()

如果只有一个 RenderedImage可用，则返回当前设置的 Raster或 null 。

结果

一个 Raster ，或 null 。

另请参见：

setRaster(java.awt.image.Raster)

setRaster

public void setRaster(Raster raster)

设置当前的Raster 。 该值通过引用存储。 任何现有的RenderedImage被丢弃。

参数

raster - a Raster 。

异常

IllegalArgumentException - 如果 raster是 null 。

另请参见：

getRaster()

getNumThumbnails

public int getNumThumbnails()

返回此 IIOImage存储的缩略图数。

结果

缩略图的数量，作为一个 int 。

getThumbnail

public BufferedImage getThumbnail(int index)

返回与主图像相关联的缩略图。

参数

index - 所需缩略图的索引。

结果

缩略图，作为 BufferedImage 。

异常

IndexOutOfBoundsException - 如果提供的索引为负或大于最大有效索引。

ClassCastException - 如果在给定索引的缩略图列表中遇到非 BufferedImage对象。

另请参见：

getThumbnails() ， setThumbnails(java.util.List<? extends java.awt.image.BufferedImage>)

getThumbnails

public List<? extends BufferedImage> getThumbnails()

返回当前List缩略图BufferedImage S，或null ，如果没有设置。 返回实时参考。

结果

目前 List的 BufferedImage缩略图，或 null 。

另请参见：

getThumbnail(int) ， setThumbnails(java.util.List<? extends java.awt.image.BufferedImage>)

setThumbnails

public void setThumbnails(List<? extends BufferedImage> thumbnails)

将缩略图到一个新的列表List的BufferedImage S，或null 。 对以前的List的引用被丢弃。

thumbnails参数必须为null或仅包含BufferedImage对象。

参数

thumbnails - a List的 BufferedImage缩略图，或 null 。

另请参见：

getThumbnail(int) ， getThumbnails()

getMetadata

public IIOMetadata getMetadata()

返回对当前 IIOMetadata对象的引用，或者是 null没有设置。

结果

一个 IIOMetadata对象，或 null 。

另请参见：

setMetadata(javax.imageio.metadata.IIOMetadata)

setMetadata

public void setMetadata(IIOMetadata metadata)

将 IIOMetadata设置为新对象，或 null 。

参数

metadata - 一个 IIOMetadata对象，或 null 。

另请参见：

getMetadata()