JavaTM 2 Platform
Standard Ed. 6

java.awt
類別 JobAttributes

java.lang.Object
  繼承者 java.awt.JobAttributes
所有已實作的介面:
Cloneable

public final class JobAttributes
extends Object
implements Cloneable

控制列印作業的屬性集合。

此類別的實例控制份數、預設選擇、目標、列印對話框、檔案和印表機名稱、頁面範圍、多文檔處理(包括整理)和使用此實例的每個列印作業的多頁整版(如雙面)。在可能的地方屬性名遵守 Internet Printing Protocol (IPP) 1.1。在可能的地方屬性值部分地遵守 Internet Printing Protocol (IPP) 1.1。

要使用採用內部類別型別的方法,需要將參考傳遞給內部類別的常數欄位之一。客戶端程式碼無法創建內部類別型別的新實例,因為這些類別都不具有公共建構子。例如,將列印對話框型別設置為跨平臺的純 Java 列印對話框,使用以下程式碼:

 import java.awt.JobAttributes;

 public class PureJavaPrintDialogExample {
     public void setPureJavaPrintDialog(JobAttributes jobAttributes) {
         jobAttributes.setDialog(JobAttributes.DialogType.COMMON);
     }
 }
 

每個支持 attributeName(預設值)的 IPP 屬性都具有相應的 setattributeNameToDefault 方法。未提供預設值欄位。

從以下版本開始:
1.3

巢狀類別摘要
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)
          確定兩個 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
 

建構子詳細資訊

JobAttributes

public JobAttributes()
建構一個具有每個屬性的預設值的 JobAttributes 實例。對話框預設為 DialogType.NATIVE。最小頁預設為 1。最大頁預設為 Integer.MAX_VALUE。目標預設為 DestinationType.PRINTER。選擇預設為 DefaultSelectionType.ALL。份數預設為 1。多文檔處理預設為 MultipleDocumentHandlingType.SEPARATE_DOCUMENTS_UNCOLLATED_COPIES。面預設為 SidesType.ONE_SIDED。檔案名預設為 null


JobAttributes

public JobAttributes(JobAttributes obj)
建構一個 JobAttributes 實例,作為所提供的 JobAttributes 的副本。

參數:
obj - 要複製的 JobAttributes

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.ALLDefaultSelectionType.RANGEDefaultSelectionType.SELECTION
destination - DesintationType.FILEDesintationType.PRINTER
dialog - DialogType.COMMONDialogType.NATIVEDialogType.NONE
fileName - 可能為 null 檔案名
maxPage - 大於零且大於或等於 minPage 的整數
minPage - 大於零且小於或等於 maxPage 的整數
multipleDocumentHandling - MultipleDocumentHandlingType.SEPARATE_DOCUMENTS_COLLATED_COPIESMultipleDocumentHandlingType.SEPARATE_DOCUMENTS_UNCOLLATED_COPIES
pageRanges - 兩個元素的整數陣列的陣列;陣列的範圍被解釋為包括兩個指定頁面以及它們之間的所有頁面;範圍必須為升序並且一定不能重疊;指定的頁碼既不能小於 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 } }) 是一種無效的頁面範圍設置,因為兩個範圍重疊
printer - 可能為 null 印表機名稱
sides - SidesType.ONE_SIDEDSidesType.TWO_SIDED_LONG_EDGESidesType.TWO_SIDED_SHORT_EDGE
拋出:
IllegalArgumentException - 如果違反了一個或多個上述條件
方法詳細資訊

clone

public Object clone()
創建並返回此 JobAttributes 的一個副本。

覆寫:
類別 Object 中的 clone
返回:
新創建的副本;可以安全地將此 Object 強制轉換為 JobAttributes
另請參見:
Cloneable

set

public void set(JobAttributes obj)
將此 JobAttributes 的所有屬性設置為與 obj 的屬性相同的值。

參數:
obj - 要複製的 JobAttributes

getCopies

public int getCopies()
返回應用程序應該使用這些屬性呈現作業的份數。將此屬性更新為使用者選擇的值。

返回:
大於 0 的整數。

setCopies

public void setCopies(int copies)
指定應用程序應該使用這些屬性呈現作業的份數。不指定此屬性等效於指定 1

參數:
copies - 複製一個大於 0 的整數
拋出:
IllegalArgumentException - 如果 copies 小於或等於 0

setCopiesToDefault

public void setCopiesToDefault()
將應用程序應該使用這些屬性呈現作業的份數設置為預設值。預設份數為 1。


getDefaultSelection

public JobAttributes.DefaultSelectionType getDefaultSelection()
指定應用程序應該為使用這些屬性的作業列印所有頁面,即 getPageRanges 的返回值所指定範圍的頁面,還是列印當前選擇的頁面。將此屬性更新為使用者選擇的值。

返回:
DefaultSelectionType.ALL、DefaultSelectionType.RANGE 或 DefaultSelectionType.SELECTION

setDefaultSelection

public void setDefaultSelection(JobAttributes.DefaultSelectionType defaultSelection)
指定應用程序應該為使用這些屬性的作業列印所有頁面,即 getPageRanges 的返回值所指定範圍的頁面,還是列印當前選擇的頁面。不指定此屬性等效於指定 DefaultSelectionType.ALL。

參數:
defaultSelection - DefaultSelectionType.ALL、DefaultSelectionType.RANGE 或 DefaultSelectionType.SELECTION。
拋出:
IllegalArgumentException - 如果 defaultSelection 為 null

getDestination

public JobAttributes.DestinationType getDestination()
指定將輸出到印表機還是使用這些屬性的作業檔案。將此屬性更新為使用者選擇的值。

返回:
DesintationType.FILE 或 DesintationType.PRINTER

setDestination

public void setDestination(JobAttributes.DestinationType destination)
指定將輸出到印表機還是使用這些屬性的作業檔案。不指定此屬性等效於指定 DesintationType.PRINTER。

參數:
destination - DesintationType.FILE 或 DesintationType.PRINTER。
拋出:
IllegalArgumentException - 如果目標為 null。

getDialog

public JobAttributes.DialogType getDialog()
返回對於使用這些屬性的作業,使用者是否應該看到用於修改列印設置的列印對話框,以及顯示哪種型別的列印對話框。DialogType.COMMON 表示跨平臺的純 Java 列印對話框。DialogType.NATIVE 表示平臺的本機列印對話框。如果平臺不支持本機列印對話框,則顯示純 Java 列印對話框。DialogType.NONE 指定無列印對話框(即後台列印)。任何實作或目標印表機都不能修改此屬性,也不能對其加以限制。

返回:
DialogType.COMMONDialogType.NATIVEDialogType.NONE

setDialog

public void setDialog(JobAttributes.DialogType dialog)
指定對於使用這些屬性的作業,使用者是否應該看到用於修改列印設置的列印對話框,以及顯示哪種型別的列印對話框。DialogType.COMMON 表示跨平臺的純 Java 列印對話框。DialogType.NATIVE 表示平臺的本機列印對話框。如果平臺不支持本機列印對話框,則顯示純 Java 列印對話框。DialogType.NONE 指定無列印對話框(即後台列印)。不指定此屬性等效於指定 DialogType.NATIVE。

參數:
dialog - DialogType.COMMON、DialogType.NATIVE 或 DialogType.NONE。
拋出:
IllegalArgumentException - 如果對話框為 null。

getFileName

public String getFileName()
指定使用這些屬性的作業的輸出檔案的檔案名。將此屬性更新為使用者選擇的值。

返回:
可能為 null 檔案名

setFileName

public void setFileName(String fileName)
指定使用這些屬性的作業的輸出檔案的檔案名。預設為依賴於平臺並且隨實作而定。

參數:
fileName - 可能為 null 檔案名。

getFromPage

public int getFromPage()
對於使用這些屬性的作業,如果要列印某個範圍的頁面,則返回要列印的第一頁。將此屬性更新為使用者選擇的值。應用程序應該忽略此輸出屬性,除非 getDefaultSelection 方法的返回值為 DefaultSelectionType.RANGE。如有可能,應用程序應該優先使用 getPageRanges 的返回值而不是此方法的返回值。

返回:
大於零且小於或等於 toPage 並且大於或等於 minPage 且小於或等於 maxPage 的整數。

setFromPage

public void setFromPage(int fromPage)
對於使用這些屬性的作業,如果要列印某個範圍的頁面,則指定要列印的第一頁。如果未指定此屬性,則使用 pageRanges 屬性的值。如果指定 pageRanges,同時指定 fromPage 和 toPage 的其中之一或兩者,則優先使用 pageRanges。如果不指定 pageRanges、fromPage 或 toPage 中的任何一個,則等效於調用 setPageRanges(new int[][] { new int[] { minPage } });

參數:
fromPage - 大於零且小於或等於 toPage 並且大於或等於 minPage 且小於或等於 maxPage 的整數。
拋出:
IllegalArgumentException - 如果違反了一個或多個上述條件。

getMaxPage

public int getMaxPage()
指定對於使用這些屬性的作業,使用者可以指定為要列印的最後一頁的最大值。任何實作或目標印表機都不能修改此屬性,也不能對其加以限制。

返回:
大於零且大於或等於 minPage 的整數。

setMaxPage

public void setMaxPage(int maxPage)
指定對於使用這些屬性的作業,使用者可以指定為要列印的最後一頁的最大值。不指定此屬性等效於指定 Integer.MAX_VALUE

參數:
maxPage - 大於零且大於或等於 minPage 的整數
拋出:
IllegalArgumentException - 如果違反了一個或多個上述條件

getMinPage

public int getMinPage()
指定對於使用這些屬性的作業,使用者可以指定為要列印的第一頁的最小值。任何實作或目標印表機都不能修改此屬性,也不能對其加以限制。

返回:
大於零且小於或等於 maxPage 的整數。

setMinPage

public void setMinPage(int minPage)
指定對於使用這些屬性的作業,使用者可以指定為要列印的第一頁的最小值。不指定此屬性等效於指定 1

參數:
minPage - 大於零且小於或等於 maxPage 的整數。
拋出:
IllegalArgumentException - 如果違反了一個或多個上述條件。

getMultipleDocumentHandling

public JobAttributes.MultipleDocumentHandlingType getMultipleDocumentHandling()
為使用這些屬性的作業指定多份處理,包括整理。將此屬性更新為使用者選擇的值。

返回:
MultipleDocumentHandlingType.SEPARATE_DOCUMENTS_COLLATED_COPIES 或 MultipleDocumentHandlingType.SEPARATE_DOCUMENTS_UNCOLLATED_COPIES。

setMultipleDocumentHandling

public void setMultipleDocumentHandling(JobAttributes.MultipleDocumentHandlingType multipleDocumentHandling)
為使用這些屬性的作業指定多份處理,包括整理。不指定此屬性等效於指定 MultipleDocumentHandlingType.SEPARATE_DOCUMENTS_UNCOLLATED_COPIES。

參數:
multipleDocumentHandling - MultipleDocumentHandlingType.SEPARATE_DOCUMENTS_COLLATED_COPIES 或 MultipleDocumentHandlingType.SEPARATE_DOCUMENTS_UNCOLLATED_COPIES。
拋出:
IllegalArgumentException - 如果 multipleDocumentHandling 為 null。

setMultipleDocumentHandlingToDefault

public void setMultipleDocumentHandlingToDefault()
對於使用這些屬性的作業,將多份處理(包括整理)設置為預設值。預設處理為 MultipleDocumentHandlingType.SEPARATE_DOCUMENTS_UNCOLLATED_COPIES。


getPageRanges

public int[][] getPageRanges()
對於使用這些屬性的作業,如果要列印某個範圍的頁面,則指定要列印的頁面範圍。範圍中的所有數字都包括在內。將此屬性更新為使用者選擇的值。應用程序應該忽略此輸出屬性,除非 getDefaultSelection 方法的返回值為 DefaultSelectionType.RANGE。

返回:
兩個元素的整數陣列的陣列。陣列的範圍被解釋為包括兩個指定頁面以及它們之間的所有頁面。範圍必須為升序並且一定不能重疊。指定的頁碼不能小於 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。

setPageRanges

public void setPageRanges(int[][] pageRanges)
對於使用這些屬性的作業,如果要列印某個範圍的頁面,則指定要列印的頁面範圍。範圍中的所有數字都包括在內。如果未指定此屬性,則使用 fromPage 和 toPages 屬性的值。如果指定 pageRanges,同時指定 fromPage 和 toPage 的其中之一或兩者,則優先使用 pageRanges。如果不指定 pageRanges、fromPage 和 toPage 中的任何一個,則等效於調用 setPageRanges(new int[][] { new int[] { minPage, minPage } });

參數:
pageRanges - 兩個元素的整數陣列的陣列。陣列的範圍被解釋為包括兩個指定頁面以及它們之間的所有頁面。範圍必須為升序並且一定不能重疊。指定的頁碼不能小於 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 } }) 是一種頁面範圍的無效設置,因為兩個範圍重疊。
拋出:
IllegalArgumentException - 如果違反了一個或多個上述條件。

getPrinter

public String getPrinter()
為使用這些屬性的作業返回目標印表機。將此屬性更新為使用者選擇的值。

返回:
可能為 null 印表機名稱。

setPrinter

public void setPrinter(String printer)
為使用這些屬性的作業指定目標印表機。預設為依賴於平臺並且隨實作而定。

參數:
printer - 可能為 null 印表機名稱。

getSides

public JobAttributes.SidesType getSides()
返回對於使用這些屬性的作業,如何在列印介質的面上強制應用連續頁。SidesType.ONE_SIDED 將每個連續頁強制應用於連續介質紙張的同一面。這種整版有時稱為 simplex。SidesType.TWO_SIDED_LONG_EDGE 將每個連續頁對應用於連續介質紙張的前後兩面,以便介質上的每個頁對方向正對著讀者,就好像綁定在長邊上一樣。這種整版有時稱為 duplex。SidesType.TWO_SIDED_SHORT_EDGE 將每個連續頁對應用於連續介質紙張的前後兩面,以便介質上的每個頁對方向正對著讀者,就好像綁定在短邊上一樣。這種整版有時稱為 tumble。將此屬性更新為使用者選擇的值。

返回:
SidesType.ONE_SIDED、SidesType.TWO_SIDED_LONG_EDGE 或 SidesType.TWO_SIDED_SHORT_EDGE。

setSides

public void setSides(JobAttributes.SidesType sides)
指定對於使用這些屬性的作業,如何在列印介質的面上強制應用連續頁。SidesType.ONE_SIDED 將每個連續頁強制應用於連續介質表的同一面。這種整版有時稱為 simplex。SidesType.TWO_SIDED_LONG_EDGE 將每個連續頁對應用於連續介質紙張的前後兩面,以便介質上的每個頁對方向正對著讀者,就好像綁定在長邊上一樣。這種整版有時稱為 duplex。SidesType.TWO_SIDED_SHORT_EDGE 將每個連續頁對應用於連續介質紙張的前後兩面,以便介質上的每個頁對方向正對著讀者,就好像綁定在短邊上一樣。這種整版有時稱為 tumble。不指定此屬性等效於指定 SidesType.ONE_SIDED。

參數:
sides - SidesType.ONE_SIDED、SidesType.TWO_SIDED_LONG_EDGE 或 SidesType.TWO_SIDED_SHORT_EDGE。
拋出:
IllegalArgumentException - 如果面為 null。

setSidesToDefault

public void setSidesToDefault()
對於使用這些屬性的作業,將如何在列印介質的面上強制應用連續頁設置為預設值。預設的整版為 SidesType.ONE_SIDED。


getToPage

public int getToPage()
對於使用這些屬性的作業,如果要列印某個範圍的頁面,則返回要列印的最後一頁(包括該頁)。將此屬性更新為使用者選擇的值。應用程序應該忽略此輸出屬性,除非 getDefaultSelection 方法的返回值是 DefaultSelectionType.RANGE。如果可能,應用程序應該優先使用 getPageRanges 的返回值而不用此方法的返回值。

返回:
大於零且大於或等於 toPage 並且大於或等於 minPage 且小於或等於 maxPage 的整數。

setToPage

public void setToPage(int toPage)
對於使用這些屬性的作業,如果要列印某個範圍的頁面,則指定要列印的最後一頁(包括該頁)。如果未指定此屬性,則使用 pageRanges 屬性的值。如果指定 pageRanges,同時指定 fromPage 和 toPage 的其中之一或兩者,則優先使用 pageRanges。如果不指定 pageRanges、fromPage 和 toPage 中的任何一個,則等效於調用 setPageRanges(new int[][] { new int[] { minPage } });

參數:
toPage - 大於零且大於或等於 fromPage 並且大於或等於 minPage 且小於或等於 maxPage 的整數。
拋出:
IllegalArgumentException - 如果違反了一個或多個上述條件。

equals

public boolean equals(Object obj)
確定兩個 JobAttributes 是否相等。

當且僅當兩個 JobAttributes 的每個屬性都相等時,這兩個 JobAttributes 才相等。當且僅當欄位都參考同一個惟一列舉物件時,列舉型別的屬性才相等。當且僅當範圍集合長度相等,每個範圍列舉相同的頁面並且這些範圍順序都相同時,頁面範圍的集合才相等。

覆寫:
類別 Object 中的 equals
參數:
obj - 將檢查其相等性的物件。
返回:
obj 是否等於此 JobAttribute,遵循上述標準。
另請參見:
Object.hashCode(), Hashtable

hashCode

public int hashCode()
返回此 JobAttributes 的雜湊碼值。

覆寫:
類別 Object 中的 hashCode
返回:
雜湊碼。
另請參見:
Object.equals(java.lang.Object), Hashtable

toString

public String toString()
返回此 JobAttributes 的字元串表示形式。

覆寫:
類別 Object 中的 toString
返回:
字元串表示形式。

JavaTM 2 Platform
Standard Ed. 6

提交錯誤或意見

版權所有 2008 Sun Microsystems, Inc. 保留所有權利。請遵守GNU General Public License, version 2 only