- java.lang.Object
-
- javax.print.attribute.standard.MediaPrintableArea
-
- すべての実装されたインタフェース:
Serializable
,Attribute
,DocAttribute
,PrintJobAttribute
,PrintRequestAttribute
public final class MediaPrintableArea extends Object implements DocAttribute, PrintRequestAttribute, PrintJobAttribute
MediaPrintableAreaは媒体の印刷可能領域と印刷不可能領域を区別する印刷属性です。印刷可能領域は媒体の寸法内に収まる矩形として指定します。
ほとんどのプリンタにはハードウェア上の制限があり、媒体の表面全体に印刷することはできません。 このクラスは印刷ジョブの許容値照会、印刷ジョブで使用できる印刷可能領域の制限内での領域要求に使用できます。
印刷可能領域を照会する場合、クライアント側で適切なコンテキストを提供する必要があります。 少なくとも使用する媒体のサイズが指定されていなければ、印刷可能領域として有効な値を取得することはできません。
この属性は用紙の端からの距離としては記述されません。この理由の1つとしてあげられるのは、この属性は特定の媒体と関連したものであることを強調するためです。この属性は他の属性選択のコンテキスト内で記述する必要があります。 またクライアント側の処理も印刷可能領域を指定するほうが通常は容易になります。
ハードウェアの最小マージンはプリンタのプロパティだけでなく、媒体のサイズ、方向、タイプ、および指定された仕上げなどの影響を受けます。
PrintService
が提供するメソッドで、適切なコンテキストで属性のサポートされる値を照会できます。PrintService.getSupportedAttributeValues()
を参照してください矩形の印刷可能領域を決定する場合、要求しているコンテキスト内で指定されている方向に関わらず、ポートレート・モードで印刷する場合の用紙の左上位置が原点となり、その座標(x,y)が設定されます。 たとえばA4サイズ用紙の印刷可能領域は、ポートレート・モードおよびランドスケープ・モードのどちらの場合でも、高さが幅より大きくなります。
印刷可能領域属性の値は、整数型としてミクロン(µm)単位で内部に格納されます。ここで、1ミクロン= 10-6メートル= 1/1000ミリメートル= 1/25400インチです。 これにより、寸法を1/1000 mm (= 1µm)または1/100インチ(= 254µm)の精度で正確に表すことができます。 小数点以下のインチを2の負のべき乗で表す場合、寸法を1/8インチ(= 3175µm)精度で表すことはできますが、1/16インチ精度で表すことはできません(1/16インチがµmの積分値と一致しないため)。
IPP互換性: MediaPrintableAreaはIPP属性ではありません。
- 関連項目:
- 直列化された形式
-
-
コンストラクタのサマリー
コンストラクタ コンストラクタ 説明 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<? extends Attribute>
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)
この矩形サイズ属性を指定された単位で、文字列形式で返します。
-
-
-
コンストラクタの詳細
-
MediaPrintableArea
public MediaPrintableArea(float x, float y, float w, float h, int units)
浮動小数点値からMediaPrintableAreaオブジェクトを構築します。- パラメータ:
x
- 印刷可能領域の原点のx座標y
- 印刷可能領域の原点のy座標w
- 印刷可能領域の幅h
- 印刷可能領域の高さunits
- 値の単位。- 例外:
IllegalArgumentException
-x < 0
またはy < 0
またはw <= 0
またはh <= 0
または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 < 0
またはy < 0
またはw <= 0
またはh <= 0
または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の場合に同等とみなされます。-
object
がnullではない。 -
object
がMediaPrintableAreaクラスのインスタンスである。 - 原点と寸法が同じである
- オーバーライド:
equals
、クラス:Object
- パラメータ:
object
- 比較対象のオブジェクト。- 戻り値:
object
がこの媒体マージン属性と一致する場合はtrue、そうでない場合はfalse。- 関連項目:
Object.hashCode()
、HashMap
-
-
getCategory
public final Class<? extends Attribute> getCategory()
この印刷属性値の「カテゴリ」として使用される印刷属性クラスを返します。MediaPrintableAreaクラスの場合、カテゴリはMediaPrintableAreaクラス自身です。
- 定義:
getCategory
、インタフェース:Attribute
- 戻り値:
- 印刷属性クラス(カテゴリ)、
java.lang.Class
クラスのインスタンス。
-
getName
public final String getName()
属性値がインスタンスとなるカテゴリの名前を返します。MediaPrintableAreaクラスの場合、カテゴリ名は
"media-printable-area"
です。これはIPP V1.1属性ではありません。
-
toString
public String toString(int units, String unitsName)
この矩形サイズ属性を指定された単位で、文字列形式で返します。- パラメータ:
units
- 単位変換係数。INCH
やMM
など。unitsName
- 単位名の文字列。"in"
または"mm"
など。 nullの場合、結果に単位名は付けられない。- 戻り値:
- この2次元のサイズの属性の文字列バージョン
- 例外:
IllegalArgumentException
- 非チェック例外。units < 1
の場合にスローされる。
-
toString
public String toString()
この矩形サイズ属性をmm単位で、文字列形式で返します。
-
hashCode
public int hashCode()
この属性のハッシュ・コード値を返します。- オーバーライド:
hashCode
、クラス:Object
- 戻り値:
- このオブジェクトのハッシュ・コード値。
- 関連項目:
Object.equals(java.lang.Object)
,System.identityHashCode(java.lang.Object)
-
-