モジュール java.desktop
パッケージ java.awt.print

クラスPageFormat

  • すべての実装されたインタフェース:
    Cloneable
    public class PageFormat
extends Object
implements Cloneable
    PageFormatクラスは、印刷されるページのサイズと印刷方向を記述します。

    • フィールドのサマリー

      フィールド 
      修飾子と型 フィールド 説明
      static int LANDSCAPE
      用紙の左下を原点として、下端から上端をx、左端から右端をyで表します。
      static int PORTRAIT
      用紙の左上を原点として、左端から右端をx、上端から下端をyで表します。
      static int REVERSE_LANDSCAPE
      用紙の右上を原点として、上端から下端をx、右端から左端をyで表します。

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

      コンストラクタ 
      コンストラクタ 説明
      PageFormat()
      縦長のデフォルトPageFormatを作成します。

    • メソッドのサマリー

      すべてのメソッド インスタンス・メソッド 具象メソッド 
      修飾子と型 メソッド 説明
      Object clone()
      このPageFormatのコピーをこのPageFormatと同じ内容で作成します。
      double getHeight()
      ページの縦幅を1/72インチの単位で返します。
      double getImageableHeight()
      ページのイメージング可能領域の高さを1/72インチの単位で返します。
      double getImageableWidth()
      ページのイメージング可能領域の幅を1/72インチの単位で返します。
      double getImageableX()
      このPageFormatに関連したPaperオブジェクトの、イメージング可能領域の左上端のx座標を返します。
      double getImageableY()
      このPageFormatに関連したPaperオブジェクトの、イメージング可能領域の左上端のy座標を返します。
      double[] getMatrix()
      ユーザー空間の描画を、要求されたページの印刷方向に平行移動する変換マトリクスを返します。
      int getOrientation()
      このPageFormatの方向を返します。
      Paper getPaper()
      このPageFormatに関連したPaperオブジェクトのコピーを返します。
      double getWidth()
      ページの横幅を1/72インチの単位で返します。
      void setOrientation​(int orientation)
      ページの印刷方向を設定します。
      void setPaper​(Paper paper)
      このPageFormatのPaperオブジェクトを設定します。

    • フィールドの詳細

      • LANDSCAPE

        @Native
public static final int LANDSCAPE
        用紙の左下を原点として、下端から上端をx、左端から右端をyで表します。 これは、Macintoshで使用される横長ではなく、WindowsおよびPostScriptで使用される横長です。
        関連項目:
        定数フィールド値

      • PORTRAIT

        @Native
public static final int PORTRAIT
        用紙の左上を原点として、左端から右端をx、上端から下端をyで表します。
        関連項目:
        定数フィールド値

      • REVERSE_LANDSCAPE

        @Native
public static final int REVERSE_LANDSCAPE
        用紙の右上を原点として、上端から下端をx、右端から左端をyで表します。 これは、Macintoshで使用される横長です。
        関連項目:
        定数フィールド値

    • コンストラクタの詳細

      • PageFormat

        public PageFormat()
        縦長のデフォルトPageFormatを作成します。

    • メソッドの詳細

      • clone

        public Object clone()
        このPageFormatのコピーをこのPageFormatと同じ内容で作成します。
        オーバーライド:
        clone、クラスObject
        戻り値:
        このPageFormatのコピー。
        関連項目:
        Cloneable

      • getWidth

        public double getWidth()
        ページの横幅を1/72インチの単位で返します。 このメソッドでは、ページの印刷方向を考慮して横幅が決定されます。
        戻り値:
        ページの横幅。

      • getHeight

        public double getHeight()
        ページの縦幅を1/72インチの単位で返します。 このメソッドでは、ページの印刷方向を考慮して縦幅が決定されます。
        戻り値:
        ページの縦幅。

      • getImageableX

        public double getImageableX()
        このPageFormatに関連したPaperオブジェクトの、イメージング可能領域の左上端のx座標を返します。 このメソッドでは、ページの印刷方向が考慮されます。
        戻り値:
        このPageFormatに関連したPaperオブジェクトの、イメージング可能領域の左上端のx座標。

      • getImageableY

        public double getImageableY()
        このPageFormatに関連したPaperオブジェクトの、イメージング可能領域の左上端のy座標を返します。 このメソッドでは、ページの印刷方向が考慮されます。
        戻り値:
        このPageFormatに関連したPaperオブジェクトの、イメージング可能領域の左上端のy座標。

      • getImageableWidth

        public double getImageableWidth()
        ページのイメージング可能領域の幅を1/72インチの単位で返します。 このメソッドでは、ページの印刷方向が考慮されます。
        戻り値:
        ページの横幅。

      • getImageableHeight

        public double getImageableHeight()
        ページのイメージング可能領域の高さを1/72インチの単位で返します。 このメソッドでは、ページの印刷方向が考慮されます。
        戻り値:
        ページの縦幅。

      • getPaper

        public Paper getPaper()
        このPageFormatに関連したPaperオブジェクトのコピーを返します。 このメソッドから返されたPaperオブジェクトに行われた変更は、このPageFormatのPaperオブジェクトには影響しません。 このPageFormatのPaperオブジェクトを更新するには、新しいPaperオブジェクトを生成し、setPaper(Paper)メソッドを使ってそのオブジェクトをこのPageFormatに設定します。
        戻り値:
        このPageFormatに関連したPaperオブジェクトのコピー。
        関連項目:
        setPaper(java.awt.print.Paper)

      • setPaper

        public void setPaper​(Paper paper)
        このPageFormatのPaperオブジェクトを設定します。
        パラメータ:
        paper - このPageFormatに対応するPaperオブジェクトを設定するPaperオブジェクト。
        例外:
        NullPointerException - nullの用紙インスタンスがパラメータとして渡された場合。
        関連項目:
        getPaper()

      • setOrientation

        public void setOrientation​(int orientation)
                    throws IllegalArgumentException
        ページの印刷方向を設定します。orientationは、PORTRAIT、LANDSCAPE、またはREVERSE_LANDSCAPEのいずれか定数である必要があります。
        パラメータ:
        orientation - 新しくページに設定する印刷方向
        例外:
        IllegalArgumentException - 未知の印刷方向が要求された場合
        関連項目:
        getOrientation()

      • getOrientation

        public int getOrientation()
        このPageFormatの方向を返します。
        戻り値:
        このPageFormatオブジェクトの印刷方向。
        関連項目:
        setOrientation(int)

      • getMatrix

        public double[] getMatrix()
        ユーザー空間の描画を、要求されたページの印刷方向に平行移動する変換マトリクスを返します。 値は、AffineTransformのコンストラクタに必要な形式で{ m00, m10, m01, m11, m02, m12}のように配列に配置されます。
        戻り値:
        ユーザー空間の描画をページの印刷方向に平行移動するために使用されるマトリクス
        関連項目:
        AffineTransform