javax.print.attribute.standard
クラス MediaPrintableArea

java.lang.Object
  |
  +--javax.print.attribute.standard.MediaPrintableArea

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

Attribute, DocAttribute, PrintJobAttribute, PrintRequestAttribute, Serializable

public final class MediaPrintableArea

extends Object

implements DocAttribute, PrintRequestAttribute, PrintJobAttribute

MediaPrintableArea は媒体の印刷可能領域と印刷不可能領域を区別する印刷属性です。

印刷可能領域は媒体の寸法内に収まる矩形として指定します。

ほとんどのプリンタにはハードウェア上の制限があり、媒体の表面全体に印刷することはできません。このクラスは印刷ジョブの許容値照会、印刷ジョブで使用できる印刷可能領域の制限内での領域要求に使用できます。

印刷可能領域を照会する場合、クライアント側で適切なコンテキストを提供する必要があります。少なくとも使用する媒体のサイズが指定されていなければ、印刷可能領域として有効な値を取得することはできません。

この属性は用紙の端からの距離としては記述されません。この理由の 1 つとして挙げられるのは、この属性は特定の媒体と関連したものであることを強調するためです。この属性は他の属性選択のコンテキスト内で記述する必要があります。またクライアント側の処理も印刷可能領域を指定するほうが通常は容易になります。

ハードウェアの最小マージンはプリンタのプロパティだけでなく、媒体のサイズ、方向、タイプ、指定された仕上げなどの影響を受けます。適切なコンテキストで属性がサポートする値を PrintService が提供するメソッドで照会することができます。PrintService.getSupportedAttributeValues() を参照してください。

矩形の印刷可能領域を決定する場合、要求しているコンテキスト内で指定されている方向に関わらず、ポートレートモードで印刷する場合の用紙の左上位置が原点となり、その座標 (x,y) が設定されます。たとえば A4 サイズ用紙の印刷可能領域は、ポートレートモードおよびランドスケープモードのどちらの場合でも、高さが幅より大きくなります。

印刷可能領域属性の値は、内部的には micrometer (µm) 単位の整数として格納されます。1 micrometer = 10^-6 meter = 1/1000 millimeter = 1/25400 inch です。つまり寸法を 1/1000 mm (= 1 µm) または 1/100 inch (= 254 µm) の精度で表すことができます。小数点以下の inch を 2 の負のべき乗で表す場合、寸法を 1/8 inch (= 3175 µm) 精度で表すことができますが、1/16 inch 精度で表すことはできません。これは 1/16 inch が µm の積分値と一致しないためです。

IPP 互換性: MediaPrintableArea は IPP 属性ではありません。

関連項目:

直列化された形式

フィールドの概要

static int	INCH inch (in) の単位を表す値です。
static int	MM millimeter (mm) の単位を表す値です。

コンストラクタの概要

MediaPrintableArea(float x, float y, float w, float h, int units)
浮動小数点値から MediaPrintableArea オブジェクトを構築します。

MediaPrintableArea(int x, int y, int w, int h, int units)
整数値から MediaPrintableArea オブジェクトを構築します。

メソッドの概要

boolean	equals(Object object) この媒体マージン属性がオブジェクトで渡されるものと一致するかどうかを返します。
Class	getCategory() この印刷属性値の「カテゴリ」として使用される印刷属性クラスを返します。
float	getHeight(int units) 印刷可能領域の高さを指定された単位で返します。
String	getName() この属性値がインスタンスであるカテゴリの名称を返します。
float[]	getPrintableArea(int units) x, y, w, h の 4 つの値のこの順序の配列として印刷可能領域を返します。
float	getWidth(int units) 印刷可能領域の幅を指定された単位で返します。
float	getX(int units) 印刷可能領域の原点の x 座標を指定された単位で返します。
float	getY(int units) 印刷可能領域の原点の y 座標を指定された単位で返します。
int	hashCode() この属性のハッシュコード値を返します。
String	toString() この矩形サイズ属性を mm 単位で、文字列形式で返します。
String	toString(int units, String unitsName) この矩形サイズ属性を指定された単位で、文字列形式で返します。

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

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

フィールドの詳細

INCH

public static final int INCH

inch (in) の単位を表す値です。実際は inch を µm に変換するための変換係数 (25400) です。

関連項目:

定数フィールド値

MM

public static final int MM

millimeter (mm) の単位を表す値です。実際は mm を µm に変換するための変換係数 (1000) です。

関連項目:

定数フィールド値

コンストラクタの詳細

MediaPrintableArea

public MediaPrintableArea(float x,
                          float y,
                          float w,
                          float h,
                          int units)

浮動小数点値から MediaPrintableArea オブジェクトを構築します。

パラメータ:

x - 印刷可能領域の原点の x 座標

y - 印刷可能領域の原点の y 座標

w - 印刷可能領域の幅

h - 印刷可能領域の高さ

units - 値の単位

例外:

IllegalArgumentException - x または y がゼロより小さい場合、w または h がゼロ以下の場合、または units が 1 より小さい場合

MediaPrintableArea

public MediaPrintableArea(int x,
                          int y,
                          int w,
                          int h,
                          int units)

整数値から MediaPrintableArea オブジェクトを構築します。

パラメータ:

x - 印刷可能領域の原点の x 座標

y - 印刷可能領域の原点の y 座標

w - 印刷可能領域の幅

h - 印刷可能領域の高さ

units - 値の単位

例外:

IllegalArgumentException - x または y がゼロより小さい場合、w または h がゼロ以下の場合、または units が 1 より小さい場合

メソッドの詳細

getPrintableArea

public float[] getPrintableArea(int units)

x, y, w, h の 4 つの値のこの順序の配列として印刷可能領域を返します。指定された単位での値が返されます。

パラメータ:

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

戻り値:

指定された単位の x、y、w、h の配列として表される印刷可能領域

例外:

IllegalArgumentException - 未確認の例外。units が 1 より小さい場合

getX

public float getX(int units)

印刷可能領域の原点の x 座標を指定された単位で返します。

パラメータ:

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

戻り値:

指定された単位で表される印刷可能領域の原点の x 座標

例外:

IllegalArgumentException - 未確認の例外。units が 1 より小さい場合

getY

public float getY(int units)

印刷可能領域の原点の y 座標を指定された単位で返します。

パラメータ:

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

戻り値:

指定された単位で表される印刷可能領域の原点の y 座標

例外:

IllegalArgumentException - 未確認の例外。units が 1 より小さい場合

getWidth

public float getWidth(int units)

印刷可能領域の幅を指定された単位で返します。

パラメータ:

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

戻り値:

指定された単位で表される印刷可能領域の幅

例外:

IllegalArgumentException - 未確認の例外。units が 1 より小さい場合

getHeight

public float getHeight(int units)

印刷可能領域の高さを指定された単位で返します。

パラメータ:

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

戻り値:

指定された単位で表される印刷可能領域の高さ

例外:

IllegalArgumentException - 未確認の例外。units が 1 より小さい場合

equals

public boolean equals(Object object)

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

1. object が null でない
2. object が MediaPrintableArea クラスのインスタンスである
3. 原点と寸法が同じである

オーバーライド:

クラス Object 内の equals

パラメータ:

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

戻り値:

object がこの媒体マージン属性と一致する場合は true、そうでない場合は false

関連項目:

Object.hashCode(), Hashtable

getCategory

public final Class getCategory()

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

MediaPrintableArea クラスの場合、カテゴリは MediaPrintableArea クラス自身です。

定義:

インタフェース Attribute 内の getCategory

戻り値:

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

getName

public final String getName()

この属性値がインスタンスであるカテゴリの名称を返します。

MediaPrintableArea クラスの場合、カテゴリ名は media-printable-area になります。

これは IPP V1.1 属性ではありません。

定義:

インタフェース Attribute 内の getName

戻り値:

属性カテゴリ名

toString

public String toString(int units,
                       String unitsName)

この矩形サイズ属性を指定された単位で、文字列形式で返します。

パラメータ:

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

unitsName - 単位名を表す文字列。in や mm など。null の場合、結果には単位名は含まれない

戻り値:

この 2 次元サイズ属性の文字列バージョン

例外:

IllegalArgumentException - 未確認の例外。units が 1 より小さい場合

toString

public String toString()

この矩形サイズ属性を mm 単位で、文字列形式で返します。

オーバーライド:

クラス Object 内の toString

戻り値:

このオブジェクトの文字列表現

hashCode

public int hashCode()

この属性のハッシュコード値を返します。

オーバーライド:

クラス Object 内の hashCode

戻り値:

このオブジェクトのハッシュコード値

関連項目:

Object.equals(java.lang.Object), Hashtable