- java.lang.Object
-
- javafx.print.JobSettings
-
public final class JobSettings extends Object
JobSettingsクラスは、印刷ジョブの構成のほとんどをカプセル化します。 アプリケーションでJobSettingsインスタンスのセットを直接作成したり設定したりすることはありません(できません)。 印刷ジョブが作成された時点で、すでにそのジョブに1つインストールされています。PrinterJobの説明にあるように、そのジョブにインストールされたJobSettingsは当初、そのジョブに当初関連付けられているプリンタの現在のデフォルト設定を反映しています。
JobSettingsの委譲はジョブが存在する間変わらず、そのメンバー・プロパティはジョブのPrinterの変更と互換性を持たせるように更新されます。 たとえば、プラットフォームのダイアログを介したユーザー操作の結果として、などです。 設定に互換性がない場合、新しいプリンタの設定は通常、デフォルトに戻ります。
ダイアログでのユーザー操作によって、設定が暗黙的または明示的に更新された場合、ユーザーが「確定」オプションを使用してダイアログを終了することで設定を承認すると、更新内容がアプリケーションに伝播されて参照可能になります。
ほとんどの印刷アプリケーションでは、ユーザーが目的のオプションを設定できて、そのオプションがジョブに伝播されれば十分であると考えられます。 これを必要とするアプリケーション用に、個々のオプションに対してsetterおよびgetterメソッド(プロパティとしても使用可能)が用意されており、設定値の変更はこれらのプロパティを介して監視および更新できます。
すべての設定値がすべてのプリンタで使用できるわけではありません。 たとえば、両面印刷をサポートしていないプリンタもあります。 サポートされる設定の判別方法については、
Printer
クラスを参照してください。- 導入されたバージョン:
- JavaFX 8.0
-
-
プロパティのサマリー
プロパティ 型 プロパティ 説明 ObjectProperty<Collation>
collation
Collation
のインスタンスを表すプロパティ。IntegerProperty
copies
ジョブの印刷部数を表すIntegerProperty
。StringProperty
jobName
ジョブの名前を表すStringProperty
。ObjectProperty<PageLayout>
pageLayout
PageLayout
のインスタンスを表すプロパティ。ObjectProperty
pageRanges
印刷するジョブ・ページをPageRangeの配列として表す値を持つObjectProperty
。ObjectProperty<PaperSource>
paperSource
PaperSource
のインスタンスを表すプロパティ。ObjectProperty<PrintColor>
printColor
PrintColor
のインスタンスを表すプロパティ。ObjectProperty<PrintQuality>
printQuality
PrintQuality
のインスタンスを表すプロパティ。ObjectProperty<PrintResolution>
printResolution
PrintResolution
のインスタンスを表すプロパティ。ObjectProperty<PrintSides>
printSides
PrintSides
のインスタンスを表すプロパティ。
-
メソッドのサマリー
すべてのメソッド インスタンス・メソッド 具象メソッド 修飾子と型 メソッド 説明 ObjectProperty<Collation>
collationProperty()
Collation
のインスタンスを表すプロパティ。IntegerProperty
copiesProperty()
ジョブの印刷部数を表すIntegerProperty
。Collation
getCollation()
Collationは、ドキュメントを複数部印刷する際の用紙のソート方法を決定します。int
getCopies()
印刷する部数を取得します。String
getJobName()
ジョブの名前を取得します。PageLayout
getPageLayout()
このジョブの現在のページ・レイアウトを取得します。PageRange[]
getPageRanges()
印刷するページの範囲。nullは常にすべてのページを意味します。PaperSource
getPaperSource()
プロパティpaperSourceの値を取得します。PrintColor
getPrintColor()
プロパティprintColorの値を取得します。PrintQuality
getPrintQuality()
プロパティprintQualityの値を取得します。PrintResolution
getPrintResolution()
PrintSides
getPrintSides()
プリンタがサポートしている場合は、ジョブをメディア(紙)の両面に印刷できます(両面印刷)。StringProperty
jobNameProperty()
ジョブの名前を表すStringProperty
。ObjectProperty<PageLayout>
pageLayoutProperty()
PageLayout
のインスタンスを表すプロパティ。ObjectProperty
pageRangesProperty()
印刷するジョブ・ページをPageRangeの配列として表す値を持つObjectProperty
。ObjectProperty<PaperSource>
paperSourceProperty()
PaperSource
のインスタンスを表すプロパティ。ObjectProperty<PrintColor>
printColorProperty()
PrintColor
のインスタンスを表すプロパティ。ObjectProperty<PrintQuality>
printQualityProperty()
PrintQuality
のインスタンスを表すプロパティ。ObjectProperty<PrintResolution>
printResolutionProperty()
PrintResolution
のインスタンスを表すプロパティ。ObjectProperty<PrintSides>
printSidesProperty()
PrintSides
のインスタンスを表すプロパティ。void
setCollation(Collation collation)
Collation
プロパティを設定します。void
setCopies(int nCopies)
印刷する部数を設定します。void
setJobName(String name)
ジョブの名前を設定します。void
setPageLayout(PageLayout pageLayout)
使用するPageLayoutを設定します。void
setPageRanges(PageRange... pages)
PageRangeの配列として表した、印刷するページの範囲。void
setPaperSource(PaperSource value)
プロパティpaperSourceの値を設定します。void
setPrintColor(PrintColor color)
PrintColor
プロパティを設定します。void
setPrintQuality(PrintQuality quality)
PrintQuality
プロパティを設定します。void
setPrintResolution(PrintResolution resolution)
PrintResolution
プロパティを設定します。void
setPrintSides(PrintSides sides)
両面印刷を制御するPrintSides
プロパティを設定します。String
toString()
オブジェクトの文字列表現を返します。
-
-
-
プロパティの詳細
-
jobName
public final StringProperty jobNameProperty
ジョブの名前を表すStringProperty
。- 関連項目:
getJobName()
,setJobName(String)
-
copies
public final IntegerProperty copiesProperty
ジョブの印刷部数を表すIntegerProperty
。- 関連項目:
getCopies()
,setCopies(int)
-
pageRanges
public final ObjectProperty pageRangesProperty
印刷するジョブ・ページをPageRangeの配列として表す値を持つObjectProperty
。 null値を指定すると、すべてのページが印刷されます。 それ以外の場合は、ページ番号の昇順に並べられた、PageRangeインスタンスの重複しない配列を指定する必要があります。 ページ番号は1から始まります。 空の配列はnullの配列と同等と見なされます。無効な、または(プリンタで)サポートされないページ範囲のセットは無視されます。
範囲が、印刷時にジョブによってレンダリングされるページ数を超えていても、エラーは発生しません。
-
printSides
public final ObjectProperty<PrintSides> printSidesProperty
PrintSides
のインスタンスを表すプロパティ。
-
collation
public final ObjectProperty<Collation> collationProperty
Collation
のインスタンスを表すプロパティ。
-
printColor
public final ObjectProperty<PrintColor> printColorProperty
PrintColor
のインスタンスを表すプロパティ。
-
printQuality
public final ObjectProperty<PrintQuality> printQualityProperty
PrintQuality
のインスタンスを表すプロパティ。
-
printResolution
public final ObjectProperty<PrintResolution> printResolutionProperty
PrintResolution
のインスタンスを表すプロパティ。
-
paperSource
public final ObjectProperty<PaperSource> paperSourceProperty
PaperSource
のインスタンスを表すプロパティ。
-
pageLayout
public final ObjectProperty<PageLayout> pageLayoutProperty
PageLayout
のインスタンスを表すプロパティ。
-
-
メソッドの詳細
-
jobNameProperty
public final StringProperty jobNameProperty()
ジョブの名前を表すStringProperty
。- 関連項目:
getJobName()
,setJobName(String)
-
getJobName
public String getJobName()
ジョブの名前を取得します。- 戻り値:
- ジョブの名前を表す文字列
-
setJobName
public void setJobName(String name)
ジョブの名前を設定します。- パラメータ:
name
- ジョブの名前を表す文字列
-
copiesProperty
public final IntegerProperty copiesProperty()
ジョブの印刷部数を表すIntegerProperty
。- 関連項目:
getCopies()
,setCopies(int)
-
getCopies
public int getCopies()
印刷する部数を取得します。- 戻り値:
- 印刷部数
-
setCopies
public final void setCopies(int nCopies)
印刷する部数を設定します。- パラメータ:
nCopies
- 印刷部数
-
pageRangesProperty
public final ObjectProperty pageRangesProperty()
印刷するジョブ・ページをPageRangeの配列として表す値を持つObjectProperty
。 null値を指定すると、すべてのページが印刷されます。 それ以外の場合は、ページ番号の昇順に並べられた、PageRangeインスタンスの重複しない配列を指定する必要があります。 ページ番号は1から始まります。 空の配列はnullの配列と同等と見なされます。無効な、または(プリンタで)サポートされないページ範囲のセットは無視されます。
範囲が、印刷時にジョブによってレンダリングされるページ数を超えていても、エラーは発生しません。
-
getPageRanges
public PageRange[] getPageRanges()
印刷するページの範囲。nullは常にすべてのページを意味します。 詳細はpageRangesProperty()
を参照してください。- 戻り値:
- nullまたは上で指定した配列
-
setPageRanges
public void setPageRanges(PageRange... pages)
PageRangeの配列として表した、印刷するページの範囲。 可変引数を使用すると、よくある単一範囲のオートボクシングが可能になります。((PageRange[])null)
は常にすべてのページを意味しますが、これはデフォルトであるため、あまり使用されません。 詳細はpageRangesProperty()
を参照してください。- パラメータ:
pages
- nullまたは上で指定した可変引数配列
-
printSidesProperty
public final ObjectProperty<PrintSides> printSidesProperty()
PrintSides
のインスタンスを表すプロパティ。
-
getPrintSides
public PrintSides getPrintSides()
プリンタがサポートしている場合は、ジョブをメディア(紙)の両面に印刷できます(両面印刷)。 このメソッドは選択された設定を返します。- 戻り値:
- 両面(面)設定。
-
setPrintSides
public void setPrintSides(PrintSides sides)
両面印刷を制御するPrintSides
プロパティを設定します。 null値は無視されます。- パラメータ:
sides
- 面数の新しい設定。
-
collationProperty
public final ObjectProperty<Collation> collationProperty()
Collation
のインスタンスを表すプロパティ。
-
getCollation
public Collation getCollation()
Collationは、ドキュメントを複数部印刷する際の用紙のソート方法を決定します。 そのため、用紙2枚以上のドキュメントを2部以上印刷する場合にのみ意味を持ちます。 用紙は物理メディアであるため、2ページのドキュメントでも、1ページにまとめて印刷したり、両面印刷したりすると、用紙は1枚のみになります。 丁合いありの印刷ジョブでは、用紙を順番にソートした状態のドキュメントが生成されます。 丁合いなしのジョブでは、同じ用紙が複数枚まとめられます。 uncollated (false
)が標準のデフォルト値です。- 戻り値:
- 照合
-
setCollation
public void setCollation(Collation collation)
Collation
プロパティを設定します。 null値は無視されます。- パラメータ:
collation
- 丁合いの新しい設定
-
printColorProperty
public final ObjectProperty<PrintColor> printColorProperty()
PrintColor
のインスタンスを表すプロパティ。
-
getPrintColor
public PrintColor getPrintColor()
プロパティprintColorの値を取得します。- プロパティの説明:
PrintColor
のインスタンスを表すプロパティ。
-
setPrintColor
public void setPrintColor(PrintColor color)
PrintColor
プロパティを設定します。 null値は無視されます。- パラメータ:
color
- 印刷色の新しい設定。
-
printQualityProperty
public final ObjectProperty<PrintQuality> printQualityProperty()
PrintQuality
のインスタンスを表すプロパティ。
-
getPrintQuality
public PrintQuality getPrintQuality()
プロパティprintQualityの値を取得します。- プロパティの説明:
PrintQuality
のインスタンスを表すプロパティ。
-
setPrintQuality
public void setPrintQuality(PrintQuality quality)
PrintQuality
プロパティを設定します。 null値は無視されます。品質と解像度は重複する概念です。 そのため、プリンタによっては、両方ではなくいずれか一方のみをサポートしている場合もあります。 これらをプログラム的に設定するアプリケーションでは、両方のプロパティを問い合せて、サポートされる値から適宜選択してください。 プリンタが非標準の値をサポートしている場合、それらの値のプリンタによる解釈をコードが判別できない可能性があるため、常に要件に合致する標準値から選択するのが最も安全です。
- パラメータ:
quality
- 印刷品質の新しい設定。
-
printResolutionProperty
public final ObjectProperty<PrintResolution> printResolutionProperty()
PrintResolution
のインスタンスを表すプロパティ。
-
getPrintResolution
public PrintResolution getPrintResolution()
- 戻り値:
- 印刷解像度
-
setPrintResolution
public void setPrintResolution(PrintResolution resolution)
PrintResolution
プロパティを設定します。 null値は無視されます。品質と解像度は重複する概念です。 そのため、プリンタによっては、両方ではなくいずれか一方のみをサポートしている場合もあります。 これらをプログラム的に設定するアプリケーションでは、両方のプロパティを問い合せて、サポートされる値から適宜選択してください。 プリンタが非標準の値をサポートしている場合、それらの値のプリンタによる解釈をコードが判別できない可能性があるため、常に要件に合致する標準値から選択するのが最も安全です。
- パラメータ:
resolution
- 印刷解像度の新しい設定。
-
paperSourceProperty
public final ObjectProperty<PaperSource> paperSourceProperty()
PaperSource
のインスタンスを表すプロパティ。
-
getPaperSource
public PaperSource getPaperSource()
プロパティpaperSourceの値を取得します。- プロパティの説明:
PaperSource
のインスタンスを表すプロパティ。
-
setPaperSource
public void setPaperSource(PaperSource value)
プロパティpaperSourceの値を設定します。- プロパティの説明:
PaperSource
のインスタンスを表すプロパティ。
-
pageLayoutProperty
public final ObjectProperty<PageLayout> pageLayoutProperty()
PageLayout
のインスタンスを表すプロパティ。
-
getPageLayout
public PageLayout getPageLayout()
このジョブの現在のページ・レイアウトを取得します。- 戻り値:
- ジョブに使用するページ・レイアウト。
-
setPageLayout
public void setPageLayout(PageLayout pageLayout)
使用するPageLayoutを設定します。- パラメータ:
pageLayout
- 使用するページ・レイアウト。
-
toString
public String toString()
次のクラスからコピーされた説明:Object
オブジェクトの文字列表現を返します。 一般に、toString
メソッドは、このオブジェクトをテキストで表す文字列を返します。 この結果は、人間が読める簡潔で有益な情報であるべきです。 すべてのサブクラスで、このメソッドをオーバーライドすることをお勧めします。クラス
Object
のtoString
メソッドは、オブジェクトがインスタンスになっている元のクラスの名前、アットマーク文字@
、およびオブジェクトのハッシュ・コードの符号なし16進数表現から構成される文字列を返します。 つまり、このメソッドは次の値と等しい文字列を返します。getClass().getName() + '@' + Integer.toHexString(hashCode())
-
-