Most visited

Recently visited

Added in API level 19

PrintJob

public final class PrintJob
extends Object

java.lang.Object
   ↳ android.printservice.PrintJob


这个课程从印刷服务的角度来看印刷工作。 它提供API用于观察打印作业状态并对打印作业执行操作。

注意:必须在主应用程序线程上调用此类的所有方法。

Summary

Public methods

boolean block(String reason)

阻止打印作业。

boolean cancel()

取消打印作业。

boolean complete()

完成打印作业。

boolean equals(Object obj)

指示其他某个对象是否“等于”这一个。

boolean fail(String error)

打印作业失败。

int getAdvancedIntOption(String key)

获取高级(打印机特定)打印选项的值。

String getAdvancedStringOption(String key)

获取高级(打印机特定)打印选项的值。

PrintDocument getDocument()

获取打印文档。

PrintJobId getId()

获取唯一的打印作业ID。

PrintJobInfo getInfo()

获取描述此作业的 PrintJobInfo

String getTag()

获取打印作业标记。

boolean hasAdvancedOption(String key)

获取此作业是否具有给定的高级(打印机特定)打印选项。

int hashCode()

返回对象的哈希码值。

boolean isBlocked()

获取此打印作业是否被阻止。

boolean isCancelled()

获取此打印作业是否被取消。

boolean isCompleted()

获取此打印作业是否完成。

boolean isFailed()

获取此打印作业是否失败。

boolean isQueued()

获取此打印作业是否排队。

boolean isStarted()

获取此打印作业是否已启动。

void setProgress(float progress)

将此打印作业的进度设置为1的一部分。

void setStatus(CharSequence status)

设置此打印作业的状态。

void setStatus(int statusResId)

将此打印作业的状态设置为字符串资源。

boolean setTag(String tag)

设置一个在 PrintService的上下文中有效且不被系统解释的标签。

boolean start()

开始打印作业。

Inherited methods

From class java.lang.Object

Public methods

block

Added in API level 19
boolean block (String reason)

阻止打印作业。 如果isStarted()返回true,并且您需要阻止打印作业,则应该调用此方法。 例如,用户必须添加一些纸张才能继续打印。 要恢复打印作业,请致电start() 要更改原因,请致电setStatus(CharSequence)

Parameters
reason String: The human readable, short, and translated reason why the print job is blocked.
Returns
boolean Whether the job was blocked.

也可以看看:

cancel

Added in API level 19
boolean cancel ()

取消打印作业。 如果isQueued()or #isBlocked()返回true,并且您取消了打印作业作为对onRequestCancelPrintJob(PrintJob)的呼叫的响应,则应该调用此方法。

Returns
boolean Whether the job is canceled.

也可以看看:

complete

Added in API level 19
boolean complete ()

完成打印作业。 如果isStarted()返回true并且您已完成打印,则应该调用此方法。

Returns
boolean Whether the job as completed.

也可以看看:

equals

Added in API level 19
boolean equals (Object obj)

指示其他某个对象是否“等于”这一个。

equals方法在非空对象引用上实现等价关系:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

Objectequals方法实现了对象上最可能的等价关系; 也就是说,对于任何非空参考值xy ,当且仅当xy引用同一对象( x == y的值为true )时,此方法返回true

请注意,无论何时覆盖此方法,通常都必须覆盖 hashCode方法,以便维护 hashCode方法的一般合约,该方法声明相等对象必须具有相同的散列代码。

Parameters
obj Object: the reference object with which to compare.
Returns
boolean true if this object is the same as the obj argument; false otherwise.

fail

Added in API level 19
boolean fail (String error)

打印作业失败。 如果在打印时isQueued()isStarted()isBlocked()返回true,则应该调用此方法。

Parameters
error String: The human readable, short, and translated reason for the failure.
Returns
boolean Whether the job was failed.

也可以看看:

getAdvancedIntOption

Added in API level 19
int getAdvancedIntOption (String key)

获取高级(打印机特定)打印选项的值。

Parameters
key String: The option key.
Returns
int The option value.

getAdvancedStringOption

Added in API level 19
String getAdvancedStringOption (String key)

获取高级(打印机特定)打印选项的值。

Parameters
key String: The option key.
Returns
String The option value.

getDocument

Added in API level 19
PrintDocument getDocument ()

获取打印文档。

Returns
PrintDocument The document.

getId

Added in API level 19
PrintJobId getId ()

获取唯一的打印作业ID。

Returns
PrintJobId The id.

getInfo

Added in API level 19
PrintJobInfo getInfo ()

获取描述此作业的 PrintJobInfo

节点:返回的信息对象是当前打印作业状态的快照。 每次调用此方法都会返回一个反映当前打印作业状态的新信息对象。

Returns
PrintJobInfo The print job info.

getTag

Added in API level 19
String getTag ()

获取打印作业标记。

Returns
String The tag or null.

也可以看看:

hasAdvancedOption

Added in API level 19
boolean hasAdvancedOption (String key)

获取此作业是否具有给定的高级(打印机特定)打印选项。

Parameters
key String: The option key.
Returns
boolean Whether the option is present.

hashCode

Added in API level 19
int hashCode ()

返回对象的哈希码值。 为了散列表的好处而支持此方法,例如HashMap提供的HashMap

hashCode的总合同是:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals(java.lang.Object) method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

尽可能合理实用,类Object定义的hashCode方法确实为不同的对象返回不同的整数。 (这通常通过将对象的内部地址转换为整数来实现,但Java TM编程语言不需要此实现技术。)

Returns
int a hash code value for this object.

isBlocked

Added in API level 19
boolean isBlocked ()

获取此打印作业是否被阻止。 这样的打印作业因异常情况而停止,可以启动,取消或失败。

Returns
boolean Whether the print job is blocked.

也可以看看:

isCancelled

Added in API level 19
boolean isCancelled ()

获取此打印作业是否被取消。 这样的打印作业由于用户请求而被取消。 这是最后的状态。

Returns
boolean Whether the print job is cancelled.

也可以看看:

isCompleted

Added in API level 19
boolean isCompleted ()

获取此打印作业是否完成。 这样的打印作业已成功打印。 这是最后的状态。

Returns
boolean Whether the print job is completed.

也可以看看:

isFailed

Added in API level 19
boolean isFailed ()

获取此打印作业是否失败。 由于错误,这样的打印作业没有成功打印。 这是最后的状态。

Returns
boolean Whether the print job is failed.

也可以看看:

isQueued

Added in API level 19
boolean isQueued ()

获取此打印作业是否排队。 这样的打印作业已准备好打印并可以启动或取消。

Returns
boolean Whether the print job is queued.

也可以看看:

isStarted

Added in API level 19
boolean isStarted ()

获取此打印作业是否已启动。 这样的打印作业正在打印并且可以完成,取消或失败。

Returns
boolean Whether the print job is started.

也可以看看:

setProgress

Added in API level 24
void setProgress (float progress)

将此打印作业的进度设置为1的一部分。

Parameters
progress float: The new progress

setStatus

Added in API level 24
void setStatus (CharSequence status)

设置此打印作业的状态。 这应该是对打印作业当前状态的可读,简短和翻译的描述。

This overrides any previously set status set via setStatus(CharSequence), setStatus(int), block(String), or fail(String),

Parameters
status CharSequence: The new status. If null the status will be empty.

setStatus

Added in API level 24
void setStatus (int statusResId)

将此打印作业的状态设置为字符串资源。

This overrides any previously set status set via setStatus(CharSequence), setStatus(int), block(String), or fail(String),

Parameters
statusResId int: The new status as a String resource. If 0 the status will be empty.

setTag

Added in API level 19
boolean setTag (String tag)

设置在PrintService的上下文中有效且不被系统解释的标签。 例如,打印服务可以将远程打印服务器返回的打印作业的关键字设置为标签,如果打印不在基于云的服务中的话。

Parameters
tag String: The tag.
Returns
boolean True if the tag was set, false otherwise.

start

Added in API level 19
boolean start ()

开始打印作业。 如果isQueued()isBlocked()返回true,并且您开始恢复打印,则应该调用此方法。

这会将打印状态重置为空。 使用setStatus(int)设置新状态。

Returns
boolean Whether the job was started.

也可以看看:

Hooray!