Most visited

Recently visited

Results for

Summary: Methods | Inherited Methods

PrintJob

public final class PrintJob
extends Object

java.lang.Object
↳	android.printservice.PrintJob

This class represents a print job from the perspective of a print service. It provides APIs for observing the print job state and performing operations on the print job.

Note: All methods of this class must be invoked on the main application thread.

Summary

Public methods
`boolean`	`block(String reason)` Blocks the print job.
`boolean`	`cancel()` Cancels the print job.
`boolean`	`complete()` Completes the print job.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`boolean`	`fail(String error)` Fails the print job.
`int`	`getAdvancedIntOption(String key)` Gets the value of an advanced (printer specific) print option.
`String`	`getAdvancedStringOption(String key)` Gets the value of an advanced (printer specific) print option.
`PrintDocument`	`getDocument()` Gets the printed document.
`PrintJobId`	`getId()` Gets the unique print job id.
`PrintJobInfo`	`getInfo()` Gets the `PrintJobInfo` that describes this job.
`String`	`getTag()` Gets the print job tag.
`boolean`	`hasAdvancedOption(String key)` Gets whether this job has a given advanced (printer specific) print option.
`int`	`hashCode()` Returns a hash code value for the object.
`boolean`	`isBlocked()` Gets whether this print job is blocked.
`boolean`	`isCancelled()` Gets whether this print job is cancelled.
`boolean`	`isCompleted()` Gets whether this print job is completed.
`boolean`	`isFailed()` Gets whether this print job is failed.
`boolean`	`isQueued()` Gets whether this print job is queued.
`boolean`	`isStarted()` Gets whether this print job is started.
`void`	`setProgress(float progress)` Sets the progress of this print job as a fraction of 1.
`void`	`setStatus(CharSequence status)` Sets the status of this print job.
`void`	`setStatus(int statusResId)` Sets the status of this print job as a string resource.
`boolean`	`setTag(String tag)` Sets a tag that is valid in the context of a `PrintService` and is not interpreted by the system.
`boolean`	`start()` Starts the print job.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeout, int nanos)` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
`final void`	`wait(long timeout)` Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.
`final void`	`wait()` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.

Public methods

block

public boolean block (String reason)

Blocks the print job. You should call this method if isStarted() returns true and you need to block the print job. For example, the user has to add some paper to continue printing. To resume the print job call start(). To change the reason call setStatus(java.lang.CharSequence).
This method must be called from the main thread of your app.

Parameters
`reason`	`String`: The human readable, short, and translated reason why the print job is blocked. This value may be `null`.

Returns
`boolean`	Whether the job was blocked.

See also:

isStarted()
isBlocked()

cancel

public boolean cancel ()

Cancels the print job. You should call this method if isQueued() or or #isBlocked() returns true and you canceled the print job as a response to a call to PrintService#onRequestCancelPrintJob(PrintJob).
This method must be called from the main thread of your app.

Returns
`boolean`	Whether the job is canceled.

See also:

complete

public boolean complete ()

Completes the print job. You should call this method if isStarted() returns true and you are done printing.
This method must be called from the main thread of your app.

Returns
`boolean`	Whether the job as completed.

See also:

isStarted()

equals

public boolean equals (Object obj)

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

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.

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).

Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.

Parameters
`obj`	`Object`: This value may be `null`.

Returns
`boolean`	`true` if this object is the same as the obj argument; `false` otherwise.

fail

public boolean fail (String error)

Fails the print job. You should call this method if isQueued() or isStarted() or isBlocked() returns true you failed while printing.
This method must be called from the main thread of your app.

Parameters
`error`	`String`: The human readable, short, and translated reason for the failure. This value may be `null`.

Returns
`boolean`	Whether the job was failed.

See also:

getAdvancedIntOption

public int getAdvancedIntOption (String key)

Gets the value of an advanced (printer specific) print option.
This method must be called from the main thread of your app.

Parameters
`key`	`String`: The option key.

Returns
`int`	The option value.

getAdvancedStringOption

public String getAdvancedStringOption (String key)

Gets the value of an advanced (printer specific) print option.
This method must be called from the main thread of your app.

Parameters
`key`	`String`: The option key.

Returns
`String`	The option value.

getDocument

public PrintDocument getDocument ()

Gets the printed document.
This method must be called from the main thread of your app.

Returns
`PrintDocument`	The document. This value cannot be `null`.

getId

public PrintJobId getId ()

Gets the unique print job id.
This method must be called from the main thread of your app.

Returns
`PrintJobId`	The id.

getInfo

public PrintJobInfo getInfo ()

Gets the PrintJobInfo that describes this job.

Node:The returned info object is a snapshot of the current print job state. Every call to this method returns a fresh info object that reflects the current print job state.

This method must be called from the main thread of your app.

Returns
`PrintJobInfo`	The print job info. This value cannot be `null`.

getTag

public String getTag ()

Gets the print job tag.
This method must be called from the main thread of your app.

Returns
`String`	The tag or null.

See also:

setTag(String)

hasAdvancedOption

public boolean hasAdvancedOption (String key)

Gets whether this job has a given advanced (printer specific) print option.
This method must be called from the main thread of your app.

Parameters
`key`	`String`: The option key.

Returns
`boolean`	Whether the option is present.

hashCode

public int hashCode ()

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

The general contract of hashCode is:

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.

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the Java™ programming language.)

Returns
`int`	a hash code value for this object.

isBlocked

public boolean isBlocked ()

Gets whether this print job is blocked. Such a print job is halted due to an abnormal condition and can be started or canceled or failed.
This method must be called from the main thread of your app.

Returns
`boolean`	Whether the print job is blocked.

See also:

isCancelled

public boolean isCancelled ()

Gets whether this print job is cancelled. Such a print job was cancelled as a result of a user request. This is a final state.
This method must be called from the main thread of your app.

Returns
`boolean`	Whether the print job is cancelled.

See also:

cancel()

isCompleted

public boolean isCompleted ()

Gets whether this print job is completed. Such a print job is successfully printed. This is a final state.
This method must be called from the main thread of your app.

Returns
`boolean`	Whether the print job is completed.

See also:

complete()

isFailed

public boolean isFailed ()

Gets whether this print job is failed. Such a print job is not successfully printed due to an error. This is a final state.
This method must be called from the main thread of your app.

Returns
`boolean`	Whether the print job is failed.

See also:

fail(String)

isQueued

public boolean isQueued ()

Gets whether this print job is queued. Such a print job is ready to be printed and can be started or cancelled.
This method must be called from the main thread of your app.

Returns
`boolean`	Whether the print job is queued.

See also:

start()
cancel()

isStarted

public boolean isStarted ()

Gets whether this print job is started. Such a print job is being printed and can be completed or canceled or failed.
This method must be called from the main thread of your app.

Returns
`boolean`	Whether the print job is started.

See also:

setProgress

public void setProgress (float progress)

Sets the progress of this print job as a fraction of 1.
This method must be called from the main thread of your app.

Parameters
`progress`	`float`: The new progress Value is between 0.0 and 1.0 inclusive

setStatus

public void setStatus (CharSequence status)

Sets the status of this print job. This should be a human readable, short, and translated description of the current state of the print job.

This overrides any previously set status set via setStatus(java.lang.CharSequence), setStatus(int), block(java.lang.String), or fail(java.lang.String),
This method must be called from the main thread of your app.

Parameters
`status`	`CharSequence`: The new status. If null the status will be empty. This value may be `null`.

setStatus

public void setStatus (int statusResId)

Sets the status of this print job as a string resource.

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

setTag

public boolean setTag (String tag)

Sets a tag that is valid in the context of a PrintService and is not interpreted by the system. For example, a print service may set as a tag the key of the print job returned by a remote print server, if the printing is off handed to a cloud based service.
This method must be called from the main thread of your app.

Parameters
`tag`	`String`: The tag. This value cannot be `null`.

Returns
`boolean`	True if the tag was set, false otherwise.

start

public boolean start ()

Starts the print job. You should call this method if isQueued() or isBlocked() returns true and you started resumed printing.

This resets the print status to null. Set the new status by using setStatus(int).

This method must be called from the main thread of your app.

Returns
`boolean`	Whether the job was started.

See also:

isQueued()
isBlocked()