- java.lang.Object
-
- javafx.print.PageLayout
-
public final class PageLayout extends Object
PageLayoutは、コンテンツのレイアウトに必要な情報をカプセル化します。 レポートされる幅と高さは、ウィンドウによって施行されるクリップと同等と見なすことができます。 PageLayoutインスタンスを取得するアプリケーションでは、レイアウトおよびページ区切りを実行するために幅と高さを検査する必要があります。 その他の情報(向きや使用する用紙、この領域の外側のマージンなど)は、ページのレンダリングには必要ありません。通常、プリンタには印刷不可能なハードウェア・マージンがあります。 特定のプリンタに関してプリンタ・ジョブから取得したPageLayoutインスタンスは、その領域全体に印刷できるよう正しく設定されています。 アプリケーションでこの境界の外側の印刷可能領域を調整すると、その領域へのレンダリング内容はデバイスによってクリップされます。
そのようなハードウェア・マージン内で、アプリケーションが必要とする印刷可能領域を定義できます。 その結果の印刷可能領域は、印刷時にアプリケーションで使用可能なページの有効寸法を定義したものとなります。
あるプリンタに基づいて構成されたPageLayoutを別のプリンタ上のジョブに適用しようとしてもうまくいかないことがありますが、これは、2番目のプリンタが同じマージンをサポートしていない、または同じ用紙をサポートしていないためです。 その場合は、PageLayoutを新しいプリンタに対して検証する必要があります。
PageLayoutは不変です。
- 導入されたバージョン:
- JavaFX 8.0
-
-
メソッドのサマリー
すべてのメソッド インスタンス・メソッド 具象メソッド 修飾子と型 メソッド 説明 boolean
equals(Object o)
このオブジェクトと他のオブジェクトが等しいかどうかを示します。double
getBottomMargin()
ページ・レイアウトの下マージン(ポイント単位)を返します。double
getLeftMargin()
ページ・レイアウトの左マージン(ポイント単位)を返します。PageOrientation
getPageOrientation()
Paper
getPaper()
使用される用紙。double
getPrintableHeight()
向きを考慮した、ページの印刷可能領域の高さ寸法(1/72インチ単位)を返します。double
getPrintableWidth()
向きを考慮した、ページの印刷可能領域の幅寸法(1/72インチのポイント単位)を返します。double
getRightMargin()
ページ・レイアウトの右マージン(ポイント単位)を返します。double
getTopMargin()
ページ・レイアウトの上マージン(ポイント単位)を返します。int
hashCode()
オブジェクトのハッシュ・コード値を返します。String
toString()
オブジェクトの文字列表現を返します。
-
-
-
メソッドの詳細
-
getPageOrientation
public PageOrientation getPageOrientation()
-
getPaper
public Paper getPaper()
使用される用紙。- 戻り値:
- この
PageLayout
に使用される用紙。
-
getPrintableWidth
public double getPrintableWidth()
向きを考慮した、ページの印刷可能領域の幅寸法(1/72インチのポイント単位)を返します。印刷可能領域とは、リクエストされた両側のマージンを差し引いた幅または高さです。 リクエストされたマージンがハードウェア・マージンより小さい場合は、レンダリング内容がデバイスによってクリップされる可能性があります。
返される値は向きを考慮したものです。したがって、向きがLANDSCAPEまたはREVERSE_LANDSCAPEの場合は90度回転しているため、基礎となる用紙の高さから左マージンと右マージンが差し引かれます。
- 戻り値:
- 印刷可能な幅(ポイント単位)。
-
getPrintableHeight
public double getPrintableHeight()
向きを考慮した、ページの印刷可能領域の高さ寸法(1/72インチ単位)を返します。印刷可能領域とは、リクエストされた両側のマージンを差し引いた幅または高さです。 リクエストされたマージンがハードウェア・マージンより小さい場合は、レンダリング内容がデバイスによってクリップされる可能性があります。
返される値は向きを考慮したものです。したがって、向きがLANDSCAPEまたはREVERSE_LANDSCAPEの場合は90度回転しているため、基礎となる用紙の高さから上マージンと下マージンが差し引かれます。
- 戻り値:
- 印刷可能な高さ(ポイント単位)。
-
getLeftMargin
public double getLeftMargin()
ページ・レイアウトの左マージン(ポイント単位)を返します。 これはPageLayoutの向きでの値です。- 戻り値:
- 左マージン(ポイント単位)。
-
getRightMargin
public double getRightMargin()
ページ・レイアウトの右マージン(ポイント単位)を返します。 これはPageLayoutの向きでの値です。- 戻り値:
- 右マージン(ポイント単位)。
-
getTopMargin
public double getTopMargin()
ページ・レイアウトの上マージン(ポイント単位)を返します。 これはPageLayoutの向きでの値です。- 戻り値:
- 上マージン(ポイント単位)。
-
getBottomMargin
public double getBottomMargin()
ページ・レイアウトの下マージン(ポイント単位)を返します。 これはPageLayoutの向きでの値です。- 戻り値:
- 下マージン(ポイント単位)。
-
equals
public boolean equals(Object o)
次のクラスからコピーされた説明:Object
このオブジェクトと他のオブジェクトが等しいかどうかを示します。equals
メソッドは、null以外のオブジェクト参照での同値関係を実装します。- 反射性(reflexive): null以外の参照値
x
について、x.equals(x)
はtrue
を返します。 - 対称性(symmetric): null以外の参照値
x
およびy
について、y.equals(x)
がtrue
を返す場合に限り、x.equals(y)
はtrue
を返します。 - 推移性(transitive): null以外の参照値
x
、y
、およびz
について、x.equals(y)
がtrue
を返し、y.equals(z)
がtrue
を返す場合、x.equals(z)
はtrue
を返します。 - 一貫性(consistent): null以外の参照値
x
およびy
について、x.equals(y)
の複数の呼出しは、このオブジェクトに対するequals
による比較で使われた情報が変更されていなければ、一貫してtrue
を返すか、一貫してfalse
を返します。 - null以外の参照値
x
について、x.equals(null)
はfalse
を返します。
Object
クラスのequals
メソッドは、もっとも比較しやすいオブジェクトの同値関係を実装します。つまり、null以外の参照値x
とy
について、このメソッドはx
とy
が同じオブジェクトを参照する(x == y
がtrue
)場合にだけtrue
を返します。通常、このメソッドをオーバーライドする場合は、
hashCode
メソッドを常にオーバーライドして、等価なオブジェクトは等価なハッシュ・コードを保持する必要があるというhashCode
メソッドの汎用規約に従う必要があることに留意してください。- オーバーライド:
equals
、クラス:Object
- パラメータ:
o
- 比較対象の参照オブジェクト。- 戻り値:
- このオブジェクトがobj引数と同じである場合は
true
、それ以外の場合はfalse
。 - 関連項目:
Object.hashCode()
、HashMap
- 反射性(reflexive): null以外の参照値
-
hashCode
public int hashCode()
次のクラスからコピーされた説明:Object
オブジェクトのハッシュ・コード値を返します。 このメソッドは、HashMap
によって提供されるハッシュ表などの、ハッシュ表の利点のためにサポートされています。hashCode
の一般的な規則は次のとおりです。- Javaアプリケーションの実行中に同じオブジェクトに対して複数回呼び出された場合は常に、このオブジェクトに対する
equals
の比較で使用される情報が変更されていなければ、hashCode
メソッドは常に同じ整数を返す必要があります。 ただし、この整数は同じアプリケーションの実行ごとに同じである必要はありません。 equals(Object)
メソッドに従って2つのオブジェクトが等しい場合は、2つの各オブジェクトに対するhashCode
メソッドの呼出しによって同じ整数の結果が生成される必要があります。Object.equals(java.lang.Object)
メソッドに従って2つのオブジェクトが等しくない場合は、2つの各オブジェクトに対するhashCode
メソッドの呼出しによって異なる整数の結果が生成される必要はありません。 ただし、プログラマは、等しくないオブジェクトに対して異なる整数の結果を生成すると、ハッシュ表のパフォーマンスが向上する可能性があることに注意するようにしてください。
クラス
Object
によって定義されたhashCodeメソッドは、可能なかぎり、異なるオブジェクトに対して異なる整数を返します。 (hashCodeは、ある時点におけるオブジェクト・メモリー・アドレスの関数として実装されても実装されなくてもよい。)- オーバーライド:
hashCode
、クラス:Object
- 戻り値:
- このオブジェクトのハッシュ・コード値。
- 関連項目:
Object.equals(java.lang.Object)
,System.identityHashCode(java.lang.Object)
- Javaアプリケーションの実行中に同じオブジェクトに対して複数回呼び出された場合は常に、このオブジェクトに対する
-
toString
public String toString()
次のクラスからコピーされた説明:Object
オブジェクトの文字列表現を返します。 一般に、toString
メソッドは、このオブジェクトをテキストで表す文字列を返します。 この結果は、人間が読める簡潔で有益な情報であるべきです。 すべてのサブクラスで、このメソッドをオーバーライドすることをお勧めします。クラス
Object
のtoString
メソッドは、オブジェクトがインスタンスになっている元のクラスの名前、アットマーク文字@
、およびオブジェクトのハッシュ・コードの符号なし16進数表現から構成される文字列を返します。 つまり、このメソッドは次の値と等しい文字列を返します。getClass().getName() + '@' + Integer.toHexString(hashCode())
-
-