javax.print.attribute.standard

クラス MediaSize

java.lang.Object

javax.print.attribute.Size2DSyntax

javax.print.attribute.standard.MediaSize

すべての実装されたインタフェース:

Serializable, Cloneable, Attribute

public class MediaSize
extends Size2DSyntax
implements Attribute

MediaSize は縦長に置いた場合の媒体の寸法を 2 次元のサイズ値として示す印刷属性クラスです。X 次元が底辺の長さ、Y 次元が左辺の長さを表します。Y 次元の値は X 次元の値以上である必要があります。多くの標準的な媒体のサイズ値が宣言され、ネストされた ISO、JIS、北米規格、技術規格、その他媒体などのクラスにそれぞれまとめられています。

MediaSize は、現在はまだ媒体の指定には使用されていません。現在の役割は指定された媒体へのマッピングです (MediaSizeName を参照)。クライアント側でマッピングメソッド MediaSize.getMediaSizeForName(MediaSizeName) を使い、この API で列挙されている MediaSizeName インスタンスの物理的な寸法を検索することができます。このメソッドはこの情報を印刷の書式設定とページ作成に使用するクライアントで有効です。

関連項目:

直列化された形式

ネストされたクラスのサマリー

ネストされたクラス

修飾子と型	クラスと説明
static class	MediaSize.Engineering クラス MediaSize.Engineering には、技術規格媒体の MediaSize 値が含まれています。
static class	MediaSize.ISO クラス MediaSize.ISO には、ISO 媒体の MediaSize 値が含まれています。
static class	MediaSize.JIS クラス MediaSize.JIS には、JIS (日本工業規格) 媒体の MediaSize 値が含まれています。
static class	MediaSize.NA クラス MediaSize.NA には、北米規格媒体の MediaSize 値が含まれています。
static class	MediaSize.Other クラス MediaSize.Other には、その他の媒体の MediaSize 値が含まれています。

フィールドのサマリー

クラス javax.print.attribute.Size2DSyntax から継承されたフィールド

INCH, MM

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
MediaSize(float x, float y, int units) 指定された浮動小数点値を使用して新しい媒体サイズ属性を構築します。
MediaSize(float x, float y, int units, MediaSizeName media) 指定された浮動小数点値を使用して新しい媒体サイズ属性を構築します。
MediaSize(int x, int y, int units) 指定された整数値を使用して新しい媒体サイズ属性を構築します。
MediaSize(int x, int y, int units, MediaSizeName media) 指定された整数値を使用して新しい媒体サイズ属性を構築します。

メソッドのサマリー

メソッド

修飾子と型	メソッドと説明
boolean	equals(Object object) この媒体サイズ属性がオブジェクトで渡されるものと一致するかどうかを返します。
static MediaSizeName	findMedia(float x, float y, int units) 指定された次元を使用して、すべての標準 MediaSize インスタンスから一致する MediaSize インスタンスを検索します。
Class<? extends Attribute>	getCategory() この印刷属性値の「カテゴリ」として使用される印刷属性クラスを返します。
static MediaSize	getMediaSizeForName(MediaSizeName media) 指定された名称を持つ媒体の MediaSize を返します。
MediaSizeName	getMediaSizeName() このサイズに対応する媒体が存在する場合、その名称を返します。
String	getName() 属性値がインスタンスとなるカテゴリの名前を返します。

クラス javax.print.attribute.Size2DSyntax から継承されたメソッド

getSize, getX, getXMicrometers, getY, getYMicrometers, hashCode, toString, toString

クラス java.lang.Object から継承されたメソッド

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

コンストラクタの詳細

MediaSize

public MediaSize(float x,
         float y,
         int units)

指定された浮動小数点値を使用して新しい媒体サイズ属性を構築します。

パラメータ:

x - 寸法 X。

y - 寸法 Y。

units - 単位変換係数。Size2DSyntax.INCH や Size2DSyntax.MM など。

例外:

IllegalArgumentException - 非チェック例外。x < 0 または y < 0 または units < 1 または x > y の場合にスローされる。

MediaSize

public MediaSize(int x,
         int y,
         int units)

指定された整数値を使用して新しい媒体サイズ属性を構築します。

パラメータ:

x - 寸法 X。

y - 寸法 Y。

units - 単位変換係数。Size2DSyntax.INCH や Size2DSyntax.MM など。

例外:

IllegalArgumentException - 非チェック例外。x < 0 または y < 0 または units < 1 または x > y の場合にスローされる。

MediaSize

public MediaSize(float x,
         float y,
         int units,
         MediaSizeName media)

指定された浮動小数点値を使用して新しい媒体サイズ属性を構築します。

パラメータ:

x - 寸法 X。

y - 寸法 Y。

units - 単位変換係数。Size2DSyntax.INCH や Size2DSyntax.MM など。

media - この MediaSize に関連付けられている媒体名

例外:

IllegalArgumentException - 非チェック例外。x < 0 または y < 0 または units < 1 または x > y の場合にスローされる。

MediaSize

public MediaSize(int x,
         int y,
         int units,
         MediaSizeName media)

指定された整数値を使用して新しい媒体サイズ属性を構築します。

パラメータ:

x - 寸法 X。

y - 寸法 Y。

units - 単位変換係数。Size2DSyntax.INCH や Size2DSyntax.MM など。

media - この MediaSize に関連付けられている媒体名

例外:

IllegalArgumentException - 非チェック例外。x < 0 または y < 0 または units < 1 または x > y の場合にスローされる。

メソッドの詳細

getMediaSizeName

public MediaSizeName getMediaSizeName()

このサイズに対応する媒体が存在する場合、その名称を返します。

戻り値:

この媒体サイズに対応する名称。関連付けられている媒体名がない場合は null (匿名サイズ)

getMediaSizeForName

public static MediaSize getMediaSizeForName(MediaSizeName media)

指定された名称を持つ媒体の MediaSize を返します。

パラメータ:

media - - サイズを検索する媒体の名称

戻り値:

媒体のサイズ。この媒体がサイズに関連付けられていない場合は null。

findMedia

public static MediaSizeName findMedia(float x,
                      float y,
                      int units)

指定された次元を使用して、すべての標準 MediaSize インスタンスから一致する MediaSize インスタンスを検索します。一致するものがない場合は一番近いものが使用されます。

検索された MediaSize が MediaSizeName オブジェクトの検索に使用されます。一番近い MediaSize に対応する Media インスタンスがない場合は null が返されます。

クライアントが寸法のみを情報として持ち、その寸法に対応する Media を検索する場合にこのメソッドが有効です。

パラメータ:

x - - 寸法 X

y - - 寸法 Y。

units - 単位変換係数。Size2DSyntax.INCH や Size2DSyntax.MM など

戻り値:

これらの寸法が一致する MediaSizeName、または null

例外:

IllegalArgumentException - x が 0 以下、y が 0 以下、または units が 1 未満の場合

equals

public boolean equals(Object object)

この媒体サイズ属性がオブジェクトで渡されるものと一致するかどうかを返します。次の条件がすべて true の場合に同等とみなされます。

1. object が null ではない。
2. object が MediaSize クラスのインスタンスである。
3. この媒体サイズ属性の X 次元が object の X 次元と一致する。
4. この媒体サイズ属性の Y 次元が object の Y 次元と一致する。

オーバーライド:

equals、クラス: Size2DSyntax

パラメータ:

object - 比較対象のオブジェクト。

戻り値:

object がこの媒体サイズ属性と一致する場合は true、そうでない場合は false。

関連項目:

Object.hashCode()、HashMap

getCategory

public final Class<? extends Attribute> getCategory()

この印刷属性値の「カテゴリ」として使用される印刷属性クラスを返します。

MediaSize クラス、およびベンダー定義の任意のサブクラスでは、カテゴリは MediaSize クラス自身になります。

定義:

getCategory、インタフェース: Attribute

戻り値:

印刷属性クラス (カテゴリ)、java.lang.Class クラスのインスタンス。

getName

public final String getName()

属性値がインスタンスとなるカテゴリの名前を返します。

MediaSize クラスおよびベンダー定義のサブクラスの場合、カテゴリ名は "media-size" です。

定義:

getName、インタフェース: Attribute

戻り値:

属性カテゴリの名前