|
JavaTM Platform Standard Ed. 6 |
|||||||||
前のクラス 次のクラス | フレームあり フレームなし | |||||||||
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド |
java.lang.Object java.awt.JobAttributes
public final class JobAttributes
印刷ジョブを制御する属性セットです。
このクラスのインスタンスは、このインスタンスを使用している各印刷ジョブの、コピーの部数、デフォルトの選択、出力先、印刷のダイアログ、ファイル名とプリンタ名、ページ範囲、複数のドキュメント処理 (照合を含む)、デュープレックスのような複数ページの組み付けなどを制御します。属性名は、可能な場合 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 の文字列表現を返します。 |
クラス java.lang.Object から継承されたメソッド |
---|
finalize, getClass, notify, notifyAll, wait, wait, wait |
コンストラクタの詳細 |
---|
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
のコピーを作成して、返します。
Object
内の clone
JobAttributes
にキャストすると安全であるCloneable
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()
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 つの要素を配列する整数配列。1 つの配列は、指定したページを含み、かつ、指定したページの全ページすべてにまたがる範囲として解釈される。範囲は昇順とし、オーバーラップしてはならない。指定されたページ番号は、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()
getPageRanges
の戻り値をこのメソッドの戻り値のあとに受け取ります。
public void setToPage(int toPage)
toPage
- 0 より大きく fromPage 以上、minPage 以上で maxPage 以下の整数値
IllegalArgumentException
- 上記の条件の 1 つ以上に違反した場合public boolean equals(Object obj)
JobAttributes の属性が同じ場合にのみ、2 つの JobAttributes は同一です。フィールドが一意の同じ列挙オブジェクトを参照している場合にだけ、列挙型の属性が等しくなります。ページ範囲のセットは、そのセットが同一の長さで、各範囲が同じページ数を列挙し、その範囲が同一の順になっている場合にのみ、同一になります。
Object
内の equals
obj
- 同じであるかどうかが判定されるオブジェクト
Object.hashCode()
,
Hashtable
public int hashCode()
Object
内の hashCode
Object.equals(java.lang.Object)
,
Hashtable
public String toString()
Object
内の toString
|
JavaTM Platform Standard Ed. 6 |
|||||||||
前のクラス 次のクラス | フレームあり フレームなし | |||||||||
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド |
Copyright 2009 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Documentation Redistribution Policy も参照してください。