public final class JobAttributes extends Object implements Cloneable
このクラスのインスタンスは、このインスタンスを使用している各印刷ジョブの、コピーの部数、デフォルトの選択、出力先、印刷のダイアログ、ファイル名とプリンタ名、ページ範囲、複数のドキュメント処理(照合を含む)、デュープレックスのような複数ページの組み付けなどを制御します。属性名は、可能な場合Internet Printing Protocol (IPP) 1.1に準拠しています。属性値は可能な場合、部分的にInternet Printing Protocol (IPP) 1.1に準拠しています。
内部クラス型をとるメソッドを使用するには、その内部クラスの定数フィールドに対する参照を渡します。クライアント・コードは、このクラスがpublicコンストラクタを持たないため、内部クラス型の新規インスタンスを作成できません。たとえば、印刷のダイアログ型を共通プラットフォームのPure Java印刷ダイアログに設定するには、次のコードを使用します。
import java.awt.JobAttributes; public class PureJavaPrintDialogExample { public void setPureJavaPrintDialog(JobAttributes jobAttributes) { jobAttributes.setDialog(JobAttributes.DialogType.COMMON); } }
attributeNameのデフォルト値をサポートするどのIPP属性にも、対応するsetattributeNameToDefault
メソッドがあります。デフォルト値のフィールドは提供されていません。
修飾子と型 | クラスと説明 |
---|---|
static class |
JobAttributes.DefaultSelectionType
使用可能なデフォルト選択状態の型保証された列挙です。
|
static class |
JobAttributes.DestinationType
使用可能なジョブ出力先の型保証された列挙です。
|
static class |
JobAttributes.DialogType
ユーザーに表示する使用可能なダイアログの型保証された列挙です。
|
static class |
JobAttributes.MultipleDocumentHandlingType
使用可能な複数のコピー処理の状態の型保証された列挙です。
|
static class |
JobAttributes.SidesType
使用可能な複数ページの組み付けの型保証された列挙です。
|
コンストラクタと説明 |
---|
JobAttributes()
すべての属性にデフォルト値を使用して、
JobAttributes インスタンスを構築します。 |
JobAttributes(int copies, JobAttributes.DefaultSelectionType defaultSelection, JobAttributes.DestinationType destination, JobAttributes.DialogType dialog, String fileName, int maxPage, int minPage, JobAttributes.MultipleDocumentHandlingType multipleDocumentHandling, int[][] pageRanges, String printer, JobAttributes.SidesType sides)
すべての属性に指定された値を使用して、
JobAttributes インスタンスを構築します。 |
JobAttributes(JobAttributes obj)
指定された
JobAttributes のコピーであるJobAttributes インスタンスを構築します。 |
修飾子と型 | メソッドと説明 |
---|---|
Object |
clone()
この
JobAttributes のコピーを作成して返します。 |
boolean |
equals(Object obj)
2つのJobAttributesが同じであるかどうかを判定します。
|
int |
getCopies()
これらの属性を使うジョブに対して、アプリケーションが描画する必要のあるコピーの数を返します。
|
JobAttributes.DefaultSelectionType |
getDefaultSelection()
これらの属性を使用するジョブについて、アプリケーションが、すべてのページ、
getPageRanges の戻り値によって指定された範囲、現在の選択のいずれを出力するかを指定します。 |
JobAttributes.DestinationType |
getDestination()
これらの属性を使用するジョブについて、プリンタまたはファイルのどちらに出力するかを指定します。
|
JobAttributes.DialogType |
getDialog()
これらの属性を使用するジョブについて、ユーザーが印刷の設定を変更する印刷のダイアログを見る必要があるか、そしてどのタイプの印刷のダイアログが表示されるべきかを返します。
|
String |
getFileName()
これらの属性を使うジョブに対して、出力ファイルの名前を指定します。
|
int |
getFromPage()
これらの属性を使用するジョブについてページの範囲を印刷する場合、印刷対象の最初のページを返します。
|
int |
getMaxPage()
これらの属性を使用するジョブについて、ユーザーが指定できる最大値を印刷対象の最終ページとして指定します。
|
int |
getMinPage()
これらの属性を使用するジョブについて、ユーザーが指定できる最小値を印刷対象の開始ページとして指定します。
|
JobAttributes.MultipleDocumentHandlingType |
getMultipleDocumentHandling()
これらの属性を使用するジョブについて、複数のコピーの処理(照合を含む)を指定します。
|
int[][] |
getPageRanges()
これらの属性を使用するジョブについてページの範囲を印刷する場合、印刷対象のページの範囲を指定します。
|
String |
getPrinter()
これらの属性を使用するジョブについて、出力先プリンタを返します。
|
JobAttributes.SidesType |
getSides()
これらの属性を使用するジョブについて、印刷メディアのサイドに連続したページが組み付けられる方法を返します。
|
int |
getToPage()
これらの属性を使用するジョブについてページの範囲を印刷する場合、印刷対象の最終ページ(論理和)を返します。
|
int |
hashCode()
このJobAttributesのハッシュ・コード値を返します。
|
void |
set(JobAttributes obj)
この
JobAttributes のすべての属性をobjの属性と同じ値に設定します。 |
void |
setCopies(int copies)
これらの属性を使うジョブに対して、アプリケーションが描画する必要のあるコピーの数を指定します。
|
void |
setCopiesToDefault()
これらの属性を使うジョブに対して、アプリケーションが描画しなければならないコピーの数をデフォルトに設定します。
|
void |
setDefaultSelection(JobAttributes.DefaultSelectionType defaultSelection)
これらの属性を使用するジョブについて、アプリケーションが、すべてのページ、
getPageRanges の戻り値によって指定された範囲、現在の選択のいずれを出力するかを指定します。 |
void |
setDestination(JobAttributes.DestinationType destination)
これらの属性を使用するジョブについて、プリンタまたはファイルのどちらに出力するかを指定します。
|
void |
setDialog(JobAttributes.DialogType dialog)
これらの属性を使用するジョブについて、ユーザーが印刷の設定を変更する印刷のダイアログを見る必要があるか、そしてどのタイプの印刷のダイアログが表示されるべきかを返します。
|
void |
setFileName(String fileName)
これらの属性を使うジョブに対して、出力ファイルの名前を指定します。
|
void |
setFromPage(int fromPage)
これらの属性を使用するジョブについてページの範囲を印刷する場合、印刷対象の最初のページを指定します。
|
void |
setMaxPage(int maxPage)
これらの属性を使用するジョブについて、ユーザーが指定できる最大値を印刷対象の最終ページとして指定します。
|
void |
setMinPage(int minPage)
これらの属性を使用するジョブについて、ユーザーが指定できる最小値を印刷対象の開始ページとして指定します。
|
void |
setMultipleDocumentHandling(JobAttributes.MultipleDocumentHandlingType multipleDocumentHandling)
これらの属性を使用するジョブについて、複数のコピーの処理(照合を含む)を指定します。
|
void |
setMultipleDocumentHandlingToDefault()
これらの属性を使用するジョブについて、複数のコピーの処理(照合を含む)をデフォルトに設定します。
|
void |
setPageRanges(int[][] pageRanges)
これらの属性を使用するジョブについてページの範囲を印刷する場合、印刷対象のページの範囲を指定します。
|
void |
setPrinter(String printer)
これらの属性を使用するジョブについて、出力先プリンタを指定します。
|
void |
setSides(JobAttributes.SidesType sides)
これらの属性を使用するジョブについて、印刷メディアのサイドに連続したページが組み付けられる方法を指定します。
|
void |
setSidesToDefault()
これらの属性を使用するジョブについて、印刷メディアのサイドに連続したページが組み付ける方法をデフォルトに設定します。
|
void |
setToPage(int toPage)
これらの属性を使用するジョブについてページの範囲を印刷する場合、印刷対象の最終ページ(論理和)を指定します。
|
String |
toString()
このJobAttributesの文字列表現を返します。
|
public JobAttributes()
JobAttributes
インスタンスを構築します。ダイアログは、デフォルトでDialogType.NATIVE
です。最小ページは、デフォルトで1
です。最大ページは、デフォルトでInteger.MAX_VALUE
です。出力先は、デフォルトでDestinationType.PRINTER
です。選択は、デフォルトでDefaultSelectionType.ALL
です。コピーの部数は、デフォルトで1
です。複数のドキュメント処理は、デフォルトでMultipleDocumentHandlingType.SEPARATE_DOCUMENTS_UNCOLLATED_COPIES
です。面の処理は、デフォルトでSidesType.ONE_SIDED
です。ファイル名は、デフォルトでnull
です。public JobAttributes(JobAttributes obj)
JobAttributes
のコピーであるJobAttributes
インスタンスを構築します。obj
- コピーするJobAttributes
public JobAttributes(int copies, JobAttributes.DefaultSelectionType defaultSelection, JobAttributes.DestinationType destination, JobAttributes.DialogType dialog, String fileName, int maxPage, int minPage, JobAttributes.MultipleDocumentHandlingType multipleDocumentHandling, int[][] pageRanges, String printer, JobAttributes.SidesType sides)
JobAttributes
インスタンスを構築します。copies
- 0より大きい整数defaultSelection
- DefaultSelectionType.ALL
、DefaultSelectionType.RANGE
、またはDefaultSelectionType.SELECTION
destination
- DesintationType.FILE
またはDesintationType.PRINTER
dialog
- DialogType.COMMON
、DialogType.NATIVE
、またはDialogType.NONE
fileName
- null
の可能性があるファイル名maxPage
- 0より大きく、minPage以上の整数minPage
- 0より大きくmaxPage以下の整数値multipleDocumentHandling
- MultipleDocumentHandlingType.SEPARATE_DOCUMENTS_COLLATED_COPIES
またはMultipleDocumentHandlingType.SEPARATE_DOCUMENTS_UNCOLLATED_COPIES
pageRanges
- 2要素の整数配列の配列。指定したページを含み、かつ、指定した全ページにまたがる範囲として解釈されます。範囲は昇順とし、オーバーラップしてはなりません。指定されたページ番号はminPage未満にも、maxPageより大きくなることもありません。次に例を示します。
(new int[][] { new int[] { 1, 3 }, new int[] { 5, 5 }, new int[] { 15, 19 } }),ページ1、2、3、5、15、16、17、18、および19を指定することになります。ただし、(
new int[][] { new int[] { 1, 1 }, new int[] { 1, 2 } }
)の場合は2つの範囲がオーバーラップしているため、ページ範囲のセットが無効になりますprinter
- null
の可能性があるプリンタ名sides
- SidesType.ONE_SIDED
、SidesType.TWO_SIDED_LONG_EDGE
、またはSidesType.TWO_SIDED_SHORT_EDGE
IllegalArgumentException
- 上の条件の1つ以上に違反した場合public Object clone()
JobAttributes
のコピーを作成して返します。public void set(JobAttributes obj)
JobAttributes
のすべての属性をobjの属性と同じ値に設定します。obj
- コピーするJobAttributes
public int getCopies()
public void setCopies(int copies)
1
を指定したことになります。copies
- 0より大きい整数IllegalArgumentException
- copies
が0以下の場合public void setCopiesToDefault()
public JobAttributes.DefaultSelectionType getDefaultSelection()
getPageRanges
の戻り値によって指定された範囲、現在の選択のいずれを出力するかを指定します。この属性は、ユーザーが選択した値に更新されます。public void setDefaultSelection(JobAttributes.DefaultSelectionType defaultSelection)
getPageRanges
の戻り値によって指定された範囲、現在の選択のいずれを出力するかを指定します。この属性を指定しないと、DefaultSelectionType.ALLを指定したことになります。defaultSelection
- DefaultSelectionType.ALL、DefaultSelectionType.RANGE、またはDefaultSelectionType.SELECTION。IllegalArgumentException
- defaultSelectionがnull
の場合public JobAttributes.DestinationType getDestination()
public void setDestination(JobAttributes.DestinationType destination)
destination
- DesintationType.FILEまたはDesintationType.PRINTER。IllegalArgumentException
- 出力先がnullの場合。public JobAttributes.DialogType getDialog()
DialogType.COMMON
、DialogType.NATIVE
、またはDialogType.NONE
public void setDialog(JobAttributes.DialogType dialog)
dialog
- DialogType.COMMON、DialogType.NATIVE、またはDialogType.NONE。IllegalArgumentException
- ダイアログがnullの場合。public String getFileName()
null
の可能性があるファイル名public void setFileName(String fileName)
fileName
- nullの可能性があるファイル名。public int getFromPage()
getDefaultSelection
メソッドの戻り値がDefaultSelectionType.RANGEでないかぎり、出力でこの属性を無視するようにしてください。アプリケーションは、可能であれば、このメソッドの戻り値よりgetPageRanges
の戻り値に従うようにしてください。public void setFromPage(int fromPage)
fromPage
- 0より大きくtoPage以下、minPage以上でmaxPage以下の整数値。IllegalArgumentException
- 上の条件の1つ以上に違反した場合。public int getMaxPage()
public void setMaxPage(int maxPage)
Integer.MAX_VALUE
を指定したことになります。maxPage
- 0より大きく、minPage以上の整数IllegalArgumentException
- 上の条件の1つ以上に違反した場合public int getMinPage()
public void setMinPage(int minPage)
1
を指定したことになります。minPage
- 0より大きくmaxPage以下の整数値。IllegalArgumentException
- 上の条件の1つ以上に違反した場合。public JobAttributes.MultipleDocumentHandlingType getMultipleDocumentHandling()
public void setMultipleDocumentHandling(JobAttributes.MultipleDocumentHandlingType multipleDocumentHandling)
multipleDocumentHandling
- MultipleDocumentHandlingType.SEPARATE_DOCUMENTS_COLLATED_COPIESまたはMultipleDocumentHandlingType.SEPARATE_DOCUMENTS_UNCOLLATED_COPIES。IllegalArgumentException
- multipleDocumentHandlingがnullの場合。public void setMultipleDocumentHandlingToDefault()
public int[][] getPageRanges()
getDefaultSelection
メソッドの戻り値がDefaultSelectionType.RANGEでない場合は、アプリケーションは出力に関するこの属性を無視します。public void setPageRanges(int[][] pageRanges)
pageRanges
- 2要素の整数配列の配列。配列は、指定されたページとページの間(両方のページを含む)のすべてのページにまたがる範囲として解釈されます。範囲は昇順である必要があり、オーバーラップしていてはいけません。指定されたページ番号がminPageより小さかったり、maxPageより大きかったりしてはいけません。たとえば、(new int[][] { new int[] { 1, 3 }, new int[] { 5, 5 }, new int[] { 15, 19 } })はページ1、2、3、5、15、16、17、18、および19を指定することになる。ただし、(new int[][] { new int[] { 1, 1 }, new int[] { 1, 2 } })の場合は2つの範囲がオーバーラップしているため、ページ範囲のセットが無効になる。IllegalArgumentException
- 上の条件の1つ以上に違反した場合。public String getPrinter()
public void setPrinter(String printer)
printer
- nullの可能性があるプリンタ名。public JobAttributes.SidesType getSides()
public void setSides(JobAttributes.SidesType sides)
sides
- SidesType.ONE_SIDED、SidesType.TWO_SIDED_LONG_EDGE、またはSidesType.TWO_SIDED_SHORT_EDGE。IllegalArgumentException
- sidesがnullの場合。public void setSidesToDefault()
public int getToPage()
getDefaultSelection
メソッドの戻り値がDefaultSelectionType.RANGEでないかぎり、出力でこの属性を無視するようにしてください。アプリケーションは、可能であれば、このメソッドの戻り値よりgetPageRanges
の戻り値に従うようにしてください。public void setToPage(int toPage)
toPage
- 0より大きくfromPage以上、minPage以上でmaxPage以下の整数値。IllegalArgumentException
- 上の条件の1つ以上に違反した場合。public boolean equals(Object obj)
JobAttributesの属性が同じ場合にのみ、2つのJobAttributesは同一です。フィールドが一意の同じ列挙オブジェクトを参照している場合にだけ、列挙型の属性が等しくなります。ページ範囲のセットは、そのセットが同一の長さで、各範囲が同じページ数を列挙し、その範囲が同一の順になっている場合にのみ、同一になります。
equals
、クラス: Object
obj
- 同じであるかどうかがチェックされるオブジェクト。Object.hashCode()
, HashMap
public int hashCode()
hashCode
、クラス: Object
Object.equals(java.lang.Object)
, System.identityHashCode(java.lang.Object)
バグまたは機能を送信
詳細なAPIリファレンスおよび開発者ドキュメントについては、Java SEのドキュメントを参照してください。そのドキュメントには、概念的な概要、用語の定義、回避方法、有効なコード例などの、開発者を対象にしたより詳細な説明が含まれています。
Copyright© 1993, 2014, Oracle and/or its affiliates. All rights reserved.