javax.imageio
类 ImageWriteParam

java.lang.Object
  javax.imageio.IIOParam
      javax.imageio.ImageWriteParam

直接已知子类：

BMPImageWriteParam, JPEGImageWriteParam

public class ImageWriteParam
     

      extends 
      IIOParam
     

描述如何对流进行编码的类。此类的实例或其子类用于提供 ImageWriter 实例的规定“入门”信息。

用于特定图像格式的插件可以定义此类的一个子类，并从其 ImageWriter 实现的 getDefaultWriteParam 方法返回该类的对象。例如，内置 JPEG writer 插件将返回 javax.imageio.plugins.jpeg.JPEGImageWriteParam 的实例。

要写入的图像区域通过第一次将图像的实际边界与 IIOParam.setSourceRegion 指定的矩形（如果有）的相交来确定。如果所得矩形的宽度或高度为零，则该 writer 将抛出 IIOException。如果相交区域为非空，则写入操作将从第一个二次取样的像素开始，并根据 IIOParam.setSourceSubsampling 指定的水平和垂直二次取样因子包含相交边界内额外的像素。

个别特征（比如 tiling、逐步编码和压缩）可以用以下四种模式之一设置。MODE_DISABLED 禁用这些特征；MODE_DEFAULT 使用带有受控于 writer 的参数值启用这些特征；MODE_EXPLICIT 启用这些特定并允许使用 set 方法提供额外的参数；MODE_COPY_FROM_METADATA 则从流以及传递给 writer 的图像元数据对象中复制相关的参数值。所有特征的默认模式是 MODE_COPY_FROM_METADATA。鼓励使用子类中提供的非标准特征，但不要求使用类似的方案。

插件 writer 可以通过提供实现额外的、特定于插件的接口来扩展 ImageWriteParam 的功能。由插件负责记录哪些接口可用以及如何使用。writer 将安静地忽略所有其未知的 ImageWriteParam 子类扩展功能。此外，将忽略通常在通过 getDefaultWriteParam 创建自己的 ImageWriteParam 实例时禁用的所有可选功能。

注意，如果不存在针对某一功能的查询方法，所有 ImageWriter 实现就必须都支持该功能（例如，逐步编码是可选的，但二次取样必须受支持）。

另请参见：

ImageReadParam

MODE_DISABLED

public static final int MODE_DISABLED

一个常量值，可以传入诸如 setTilingMode、 setProgressiveMode 和 setCompressionMode 之类的方法中，以禁用用于以后的写入操作的某个特征。也就是说，在设置此模式时，该流将 不被平铺、逐步编码或压缩，相关的访问器方法将抛出 IllegalStateException。

另请参见：

MODE_EXPLICIT, MODE_COPY_FROM_METADATA, MODE_DEFAULT, setProgressiveMode(int), getProgressiveMode(), setTilingMode(int), getTilingMode(), setCompressionMode(int), getCompressionMode(), 常量字段值

MODE_DEFAULT

public static final int MODE_DEFAULT

一个常量值，可以传入诸如 setTilingMode、 setProgressiveMode 和 setCompressionMode 之类的方法中，以启用用于以后的写入操作的特征。也就是说，在启用此模式时，将根据 writer 以与插件有关的方式内部选择的明智默认值来平铺、逐步编码和压缩该流，相关的访问器方法将抛出 IllegalStateException。

另请参见：

MODE_DISABLED, MODE_EXPLICIT, MODE_COPY_FROM_METADATA, setProgressiveMode(int), getProgressiveMode(), setTilingMode(int), getTilingMode(), setCompressionMode(int), getCompressionMode(), 常量字段值

MODE_EXPLICIT

public static final int MODE_EXPLICIT

一个常量值，可以传入诸如 setTilingMode 或 setCompressionMode 之类的方法中，以启用用于以后的写入操作的特征。也就是说，在设置此模式时，将根据为此类中的相应 set 方法提供的额外信息和可以从相应 get 方法中获取到的信息来平铺或压缩该流。注意，此模式不支持逐步输出。

另请参见：

MODE_DISABLED, MODE_COPY_FROM_METADATA, MODE_DEFAULT, setProgressiveMode(int), getProgressiveMode(), setTilingMode(int), getTilingMode(), setCompressionMode(int), getCompressionMode(), 常量字段值

MODE_COPY_FROM_METADATA

public static final int MODE_COPY_FROM_METADATA

一个常量值，可以传入诸如 setTilingMode、 setProgressiveMode 或 setCompressionMode 之类的方法中，以启用用于以后的写入操作的特征。也就是说，在启用此模式时，将根据传入写入操作的流内容和/或图像元数据来平铺、逐步编码和压缩该流，所有相关访问器方法都将抛出 IllegalStateException。

这是所有特征的默认模式，因此，如果一个包括元数据的读取操作之后将进行包括元数据的写入操作，则读取操作将保留尽可能多的信息。

另请参见：

MODE_DISABLED, MODE_EXPLICIT, MODE_DEFAULT, setProgressiveMode(int), getProgressiveMode(), setTilingMode(int), getTilingMode(), setCompressionMode(int), getCompressionMode(), 常量字段值

canWriteTiles

protected boolean canWriteTiles

如果此 ImageWriteParam 允许设置 tile 的宽度和高度参数，则返回为 true 的 boolean 值。默认情况下，该值为 false。子类必须手工设置该值。

不支持写入 tile 的子类应该确保此值被设置为 false。

tilingMode

protected int tilingMode

控制 tiling 设置的模式，必须将它设置为以下四个 MODE_* 值之一。默认值为 MODE_COPY_FROM_METADATA。

不支持写入 tile 的子类可以忽略此值。

另请参见：

MODE_DISABLED, MODE_EXPLICIT, MODE_COPY_FROM_METADATA, MODE_DEFAULT, setTilingMode(int), getTilingMode()

preferredTileSizes

protected Dimension[] preferredTileSizes

首选 tile 大小范围对组成的数组。默认值为 null，指示没有首选大小。如果该值为非 null 值，则首选大小的平均长度必须至少为 2。

不支持写入 tile 的子类可以忽略此值。

另请参见：

getPreferredTileSizes()

tilingSet

protected boolean tilingSet

如果已经指定 tiling 参数，则返回一个为 true 的 boolean 值。

不支持写入 tile 的子类可以忽略此值。

tileWidth

protected int tileWidth

如果已经设置 tiling，则返回每个 tile 的宽度，否则返回 0。

不支持 tiling 的子类可以忽略此值。

tileHeight

protected int tileHeight

如果已经设置 tiling，则返回每个 tile 的高度，否则返回 0。初始值为 0。

不支持 tiling 的子类可以忽略此值。

canOffsetTiles

protected boolean canOffsetTiles

如果此 ImageWriteParam 允许使用 tiling 网格偏移量参数，则返回为 true 的 boolean 值。默认情况下，该值为 false。子类必须手工设置该值。

不支持写入 tile 的子类或支持写入 tile 但不支持将 tile 偏移的子类必须确保此值被设置为 false。

tileGridXOffset

protected int tileGridXOffset

如果已经设置 tiling，则返回 tile 网格原点应该从图像原点水平偏移的量。否则返回 0。初始值为 0。

不支持将 tile 偏移的子类可以忽略此值。

tileGridYOffset

protected int tileGridYOffset

如果已经设置 tiling，则返回 tile 网格原点应该从图像原点垂直偏移的量。否则返回 0。初始值为 0。

不支持将 tile 偏移的子类可以忽略此值。

canWriteProgressive

protected boolean canWriteProgressive

如果此 ImageWriteParam 允许以一个质量递增传递的逐步序列的方式写入图像，则返回为 true 的 boolean 值。默认情况下，该值为 false。子类必须手工设置该值。

不支持逐步编码的子类必须确保此值被设置为 false。

progressiveMode

protected int progressiveMode

控制逐步编码的模式，必须将它设置为除 MODE_EXPLICIT 以外的四个 MODE_* 值之一。默认值为 MODE_COPY_FROM_METADATA。

不支持逐步编码的子类可以忽略此值。

另请参见：

MODE_DISABLED, MODE_EXPLICIT, MODE_COPY_FROM_METADATA, MODE_DEFAULT, setProgressiveMode(int), getProgressiveMode()

canWriteCompressed

protected boolean canWriteCompressed

如果此 writer 可以使用压缩写入图像，则返回为 true 的 boolean 值。默认情况下，该值为 false。子类必须手工设置该值。

不支持压缩的子类必须确保此值被设置为 false。

compressionMode

protected int compressionMode

控制压缩设置的模式，必须将它设置为四个 MODE_* 值之一。默认值为 MODE_COPY_FROM_METADATA。

不支持压缩的子类可以忽略此值。

另请参见：

MODE_DISABLED, MODE_EXPLICIT, MODE_COPY_FROM_METADATA, MODE_DEFAULT, setCompressionMode(int), getCompressionMode()

compressionTypes

protected String[] compressionTypes

包含可用压缩类型名称的 String 数组。子类必须手工设置该值。

不支持压缩的子类可以忽略此值。

compressionType

protected String compressionType

包含当前压缩类型名称的 String，如果没有设置压缩类型，则返回 null。

不支持压缩的子类可以忽略此值。

compressionQuality

protected float compressionQuality

包含当前压缩质量设置的 float 值。初始值为 1.0F。

不支持压缩的子类可以忽略此值。

locale

protected Locale locale

用于本地化压缩类型名称和质量描述的 Locale， null 表示使用默认 Locale。子类必须手工设置该值。

ImageWriteParam

protected ImageWriteParam()

构造一个空的 ImageWriteParam。由子类负责恰当地设置实例变量。

ImageWriteParam

public ImageWriteParam(Locale locale)

构造一个 ImageWriteParam 集，以使用给定 Locale。

参数：

locale - 将用于本地化压缩类型名称和质量描述的 Locale，或者为 null。

getLocale

public Locale getLocale()

返回当前设置的 Locale，如果仅支持默认 Locale，则返回 null。

返回：

当前 Locale 或 null。

canWriteTiles

public boolean canWriteTiles()

如果 writer 在执行写入操作的同时可以进行平铺，则返回 true。如果此方法返回 false，则 setTiling 将抛出 UnsupportedOperationException。

返回：

如果 writer 支持平铺，则返回 true。

另请参见：

canOffsetTiles(), setTiling(int, int, int, int)

canOffsetTiles

public boolean canOffsetTiles()

如果 writer 在执行写入操作的同时可以使用非零网格偏移量进行平铺，则返回 true。如果此方法返回 false，则 setTiling 将抛出 UnsupportedOperationException，如果网格偏移量参数不同时为零的话。如果 canWriteTiles 返回 false，则此方法也将返回 false。

返回：

如果 writer 支持非零 tile 偏移量，则返回 true。

另请参见：

canWriteTiles(), setTiling(int, int, int, int)

setTilingMode

public void setTilingMode(int mode)

确定图像在输出流中是否将被平铺，如果将被平铺，将如何确定 tiling 参数。对这些模式的解释如下：

• MODE_DISABLED - 图像不会被平铺，setTiling 将抛出 IllegalStateException。
• MODE_DEFAULT - 将使用默认参数平铺图像。setTiling 将抛出 IllegalStateException。
• MODE_EXPLICIT - 将根据 setTiling 方法中给定的参数平铺图像。任何以前设置的 tiling 参数都将被丢弃。
• MODE_COPY_FROM_METADATA - 图像将与传入某一写入操作中的元数据对象一致。setTiling 将抛出 IllegalStateException。

参数：

mode - 用于 tiling 的模式。

抛出：

UnsupportedOperationException - 如果 canWriteTiles 返回 false。

IllegalArgumentException - 如果 mode 不是上面列出的模式之一。

另请参见：

setTiling(int, int, int, int), getTilingMode()

getTilingMode

public int getTilingMode()

如果支持平铺，则返回当前平铺模式。否则抛出 UnsupportedOperationException。

返回：

当前平铺模式。

抛出：

UnsupportedOperationException - 如果 canWriteTiles 返回 false。

另请参见：

setTilingMode(int)

getPreferredTileSizes

public Dimension[] getPreferredTileSizes()

返回一个 Dimension 数组，指示在输出文件或流中进行编码时 tile 的合法大小范围。返回的数组是一个副本。

信息以对集合的形式返回；对的第一个元素包含最小宽度和高度（包括在内），第二个元素包含最大宽度和高度（包括在内）。将其放到一起，每个对便定义了一个有效大小范围。要定义固定大小，则对两个元素使用相同的宽度和高度。要定义任意范围，则使用 null 值替代实际 Dimension 数组。

如果构造方法上没有指定数组，但允许进行平铺，则此方法返回 null。

返回：

一个 Dimension 数组，其平均长度至少为 2；或者 null。

抛出：

UnsupportedOperationException - 如果插件不支持平铺。

setTiling

public void setTiling(int tileWidth,
                      int tileHeight,
                      int tileGridXOffset,
                      int tileGridYOffset)

指定应该在输出流中平铺图像。 tileWidth 和 tileHeight 参数指定文件中 tile 的宽度和高度。如果 tile 的宽度或高度大于图像的宽度或高度，则图像无法使用该维数平铺。

如果 canOffsetTiles 返回 false，则 tileGridXOffset 和 tileGridYOffset 参数必须为零。

参数：

tileWidth - 每个 tile 的宽度。

tileHeight - 每个 tile 的高度。

tileGridXOffset - tile 网格的水平偏移量。

tileGridYOffset - tile 网格的垂直偏移量。

抛出：

UnsupportedOperationException - 如果插件不支持平铺。

IllegalStateException - 如果平铺模式不为 MODE_EXPLICIT。

UnsupportedOperationException - 如果插件不支持网格偏移量，且网格偏移量并不都为零。

IllegalArgumentException - 如果 tile 大小不在 getPreferredTileSizes 返回的某个所允许范围内。

IllegalArgumentException - 如果 tileWidth 或 tileHeight 小于等于 0。

另请参见：

canWriteTiles, canOffsetTiles, getTileWidth(), getTileHeight(), getTileGridXOffset(), getTileGridYOffset()

unsetTiling

public void unsetTiling()

移除通过调用 setTiling 指定的所有以前的 tile 网格参数。

默认实现将实例变量 tileWidth、tileHeight、tileGridXOffset 和 tileGridYOffset 都设置为 0。

抛出：

UnsupportedOperationException - 如果插件不支持平铺。