モジュール javafx.graphics

パッケージ javafx.print

クラスPrinter

java.lang.Object

javafx.print.Printer

public final class Printer
extends Object

Printerインスタンスは、印刷ジョブの出力先を表します。

プリンタを列挙して、印刷ジョブで使用するプリンタを選択することができます。

その後、プリンタのデフォルト設定の構成を使用して、ジョブの初期設定を移入できます。

プリンタの可用性はプログラムの実行中、管理アクションによって変化することがあるため、長時間実行プログラムでプリンタをキャッシュしたが、そのプリンタがそれ以来オフラインになっている場合は、そのインスタンスを使用してジョブを作成しても、印刷は失敗します。

導入されたバージョン:

JavaFX 8.0

プロパティのサマリー

プロパティ

型	プロパティ	説明
static ReadOnlyObjectProperty<Printer>	defaultPrinter	現在のデフォルト・プリンタを表す読取り専用のオブジェクト・プロパティ。

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

ネストされたクラス

修飾子と型	クラス	説明
static class	Printer.MarginType	MarginTypeは、PageLayoutの印刷可能領域を決定するために使用されます。

メソッドのサマリー

修飾子と型	メソッド	説明
PageLayout	createPageLayout(Paper paper, PageOrientation orient, double lMargin, double rMargin, double tMargin, double bMargin)	指定されたパラメータを使用して、このプリンタの新しいPageLayoutを取得します。
PageLayout	createPageLayout(Paper paper, PageOrientation orient, Printer.MarginType mType)	指定されたパラメータを使用して、このプリンタの新しいPageLayoutインスタンスを取得します。
static ReadOnlyObjectProperty<Printer>	defaultPrinterProperty()	現在のデフォルト・プリンタを表す読取り専用のオブジェクト・プロパティ。
static ObservableSet<Printer>	getAllPrinters()	インストールされているプリンタを取得します。
PageLayout	getDefaultPageLayout()	このプリンタのデフォルトのページ・レイアウトを返します。
static Printer	getDefaultPrinter()	デフォルト・プリンタを取得します。
String	getName()	基礎となるシステムでプリンタをユーザーまたはアプリケーション(あるいはその両方)に対して識別するために使用される名前を返します。
PrinterAttributes	getPrinterAttributes()	プリンタの属性および機能をカプセル化する委譲オブジェクトを取得します。
String	toString()	オブジェクトの文字列表現を返します。

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

clone、equals、finalize、getClass、hashCode、notify、notifyAll、wait、wait、wait

プロパティの詳細

defaultPrinter

public static ReadOnlyObjectProperty<Printer> defaultPrinterProperty

現在のデフォルト・プリンタを表す読取り専用のオブジェクト・プロパティ。 インストールされているプリンタがない場合、ラップされた値はnullになります。

関連項目:

getDefaultPrinter()

メソッドの詳細

getAllPrinters

public static ObservableSet<Printer> getAllPrinters()

インストールされているプリンタを取得します。 プリンタのセットは動的である場合があります。 そのため、呼出しの結果が毎回同一になる保証はありませんが、結果が変わるのはアプリケーションの環境でデフォルトが変更された場合のみです。

注意: プリンタはインストール済みでもオフラインのことがあるため、アプリケーションでプリンタを使用する前に、プリンタのステータスを問い合せてください。

戻り値:

プリンタがない場合はnullです。

例外:

SecurityException - アプリケーションにプリンタを検索するためのアクセス権がない場合。

defaultPrinterProperty

public static ReadOnlyObjectProperty<Printer> defaultPrinterProperty()

現在のデフォルト・プリンタを表す読取り専用のオブジェクト・プロパティ。 インストールされているプリンタがない場合、ラップされた値はnullになります。

関連項目:

getDefaultPrinter()

getDefaultPrinter

public static Printer getDefaultPrinter()

デフォルト・プリンタを取得します。 プリンタがインストールされていない場合は、nullを返します。

使用可能なプリンタの構成は動的である場合があります。 そのため、呼出しの結果が毎回同一になる保証はありませんが、結果が変わるのはアプリケーションの環境でデフォルトが変更された場合のみです。

戻り値:

デフォルト・プリンタまたはnull。

例外:

SecurityException - アプリケーションにプリンタを検索するためのアクセス権がない場合。

getName

public String getName()

基礎となるシステムでプリンタをユーザーまたはアプリケーション(あるいはその両方)に対して識別するために使用される名前を返します。

戻り値:

プリンタ名。

getPrinterAttributes

public PrinterAttributes getPrinterAttributes()

プリンタの属性および機能をカプセル化する委譲オブジェクトを取得します。

戻り値:

プリンタ属性。

getDefaultPageLayout

public PageLayout getDefaultPageLayout()

このプリンタのデフォルトのページ・レイアウトを返します。

戻り値:

デフォルトのページ・レイアウト。

createPageLayout

public PageLayout createPageLayout(Paper paper,
                                   PageOrientation orient,
                                   Printer.MarginType mType)

指定されたパラメータを使用して、このプリンタの新しいPageLayoutインスタンスを取得します。 用紙はサポートされる用紙のいずれか、向きはサポートされる向きのいずれかとする必要があります。 指定したレイアウトをプリンタがサポートできない場合、返されるレイアウトはサポートされる構成に合せて調整されます

パラメータ:

paper - 使用する用紙

orient - 使用する向き

mType - 使用するマージン・タイプ

戻り値:

指定されたパラメータに基づくPageLayout。

例外:

NullPointerException - いずれかのパラメータがnullの場合。

createPageLayout

public PageLayout createPageLayout(Paper paper,
                                   PageOrientation orient,
                                   double lMargin,
                                   double rMargin,
                                   double tMargin,
                                   double bMargin)

指定されたパラメータを使用して、このプリンタの新しいPageLayoutを取得します。 用紙はサポートされる用紙のいずれか、向きはサポートされる向きのいずれかとする必要があります。

マージンの値は、ポイント(1/72インチ)単位で指定されます。 マージンは、プリンタのサポートするマージンに対して検証され、必要に応じて調整されます。 このメソッドは一般に、デフォルトのマージンと異なる(デフォルトより広いなど)マージン(たとえば、上下は1インチ、左右は0.5インチ)を必要とするクライアントに有効です。

クライアントが有効なマージン値を確認する必要がある場合は、まずHARDWARE_MINIMUMマージンを使用してPageLayoutを取得してください。

指定したレイアウトをプリンタがサポートできない場合、返されるレイアウトはサポートされる構成に合せて調整されます

パラメータ:

paper - 使用する用紙

orient - 使用する向き

lMargin - 使用する左マージン(ポイント単位)。

rMargin - 使用する右マージン(ポイント単位)。

tMargin - 使用する上マージン(ポイント単位)。

bMargin - 使用する下マージン(ポイント単位)。

戻り値:

指定されたパラメータに基づくPageLayout。

例外:

NullPointerException - 用紙または向きがnullの場合。

IllegalArgumentException - いずれかのマージンの値がゼロより小さい場合。

toString

public String toString()

次のクラスからコピーされた説明: Object

オブジェクトの文字列表現を返します。 一般に、toStringメソッドは、このオブジェクトをテキストで表す文字列を返します。 この結果は、人間が読める簡潔で有益な情報であるべきです。 すべてのサブクラスで、このメソッドをオーバーライドすることをお勧めします。

クラスObjectのtoStringメソッドは、オブジェクトがインスタンスになっている元のクラスの名前、アットマーク文字@、およびオブジェクトのハッシュ・コードの符号なし16進数表現から構成される文字列を返します。 つまり、このメソッドは次の値と等しい文字列を返します。

 getClass().getName() + '@' + Integer.toHexString(hashCode())
 

オーバーライド:

toString 、クラス: Object

戻り値:

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