Added in API level 19

Summary: Nested Classes | Constants | Inherited Constants | Fields | Methods | Inherited Methods

PrintAttributes

---

Kotlin |Java

public final class PrintAttributes
extends Object implements Parcelable

java.lang.Object
↳	android.print.PrintAttributes

---

This class represents the attributes of a print job. These attributes describe how the printed content should be laid out. For example, the print attributes may state that the content should be laid out on a letter size with 300 DPI (dots per inch) resolution, have a margin of 10 mills (thousand of an inch) on all sides, and be black and white.

Summary

Nested classes
class	PrintAttributes.Builder Builder for creating PrintAttributes.
class	PrintAttributes.Margins This class specifies content margins.
class	PrintAttributes.MediaSize This class specifies a supported media size.
class	PrintAttributes.Resolution This class specifies a supported resolution in DPI (dots per inch).

Constants
int	COLOR_MODE_COLOR Color mode: Color color scheme, for example many colors are used.
int	COLOR_MODE_MONOCHROME Color mode: Monochrome color scheme, for example one color is used.
int	DUPLEX_MODE_LONG_EDGE Duplex mode: Pages are turned sideways along the long edge - like a book.
int	DUPLEX_MODE_NONE Duplex mode: No duplexing.
int	DUPLEX_MODE_SHORT_EDGE Duplex mode: Pages are turned upwards along the short edge - like a notpad.

Inherited constants

From interface android.os.Parcelable int CONTENTS_FILE_DESCRIPTOR Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor. int PARCELABLE_WRITE_RETURN_VALUE Flag for use with writeToParcel(Parcel, int): the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)".

Fields
public static final Creator<PrintAttributes>	CREATOR

Public methods
int	describeContents() Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
boolean	equals(Object obj) Indicates whether some other object is "equal to" this one.
int	getColorMode() Gets the color mode.
int	getDuplexMode() Gets the duplex mode.
PrintAttributes.MediaSize	getMediaSize() Gets the media size.
PrintAttributes.Margins	getMinMargins() Gets the minimal margins.
PrintAttributes.Resolution	getResolution() Gets the resolution.
int	hashCode() Returns a hash code value for the object.
String	toString() Returns a string representation of the object.
void	writeToParcel(Parcel parcel, int flags) Flatten this object in to a Parcel.

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 timeoutMillis, int nanos) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait(long timeoutMillis) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait() Causes the current thread to wait until it is awakened, typically by being notified or interrupted.
From interface android.os.Parcelable abstract int describeContents() Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. abstract void writeToParcel(Parcel dest, int flags) Flatten this object in to a Parcel.

Constants

COLOR_MODE_COLOR

Added in API level 19

public static final int COLOR_MODE_COLOR

Color mode: Color color scheme, for example many colors are used.

Constant Value: 2 (0x00000002)

COLOR_MODE_MONOCHROME

Added in API level 19

public static final int COLOR_MODE_MONOCHROME

Color mode: Monochrome color scheme, for example one color is used.

Constant Value: 1 (0x00000001)

DUPLEX_MODE_LONG_EDGE

Added in API level 23

public static final int DUPLEX_MODE_LONG_EDGE

Duplex mode: Pages are turned sideways along the long edge - like a book.

Constant Value: 2 (0x00000002)

DUPLEX_MODE_NONE

Added in API level 23

public static final int DUPLEX_MODE_NONE

Duplex mode: No duplexing.

Constant Value: 1 (0x00000001)

DUPLEX_MODE_SHORT_EDGE

Added in API level 23

public static final int DUPLEX_MODE_SHORT_EDGE

Duplex mode: Pages are turned upwards along the short edge - like a notpad.

Constant Value: 4 (0x00000004)

Fields

CREATOR

Added in API level 19

public static final Creator<PrintAttributes> CREATOR

Public methods

describeContents

Added in API level 19

public int describeContents ()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(android.os.Parcel, int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Returns
int	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or CONTENTS_FILE_DESCRIPTOR

equals

Added in API level 19

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.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
obj	Object: This value may be null.

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

getColorMode

Added in API level 19

public int getColorMode ()

Gets the color mode.

Returns
int	The color mode or zero if not set. Value is 0 or greater

See also:

• COLOR_MODE_COLOR
• COLOR_MODE_MONOCHROME

getDuplexMode

Added in API level 23

public int getDuplexMode ()

Gets the duplex mode.

Returns
int	The duplex mode or zero if not set. Value is 0 or greater

See also:

• DUPLEX_MODE_NONE
• DUPLEX_MODE_LONG_EDGE
• DUPLEX_MODE_SHORT_EDGE

getMediaSize

Added in API level 19

public PrintAttributes.MediaSize getMediaSize ()

Gets the media size.

Returns
PrintAttributes.MediaSize	The media size or null if not set.

getMinMargins

Added in API level 19

public PrintAttributes.Margins getMinMargins ()

Gets the minimal margins. If the content does not fit these margins it will be clipped.

These margins are physically imposed by the printer and they are not rotated, i.e. they are the same for both portrait and landscape. For example, a printer may not be able to print in a stripe on both left and right sides of the page.

Returns
PrintAttributes.Margins	The margins or null if not set.

getResolution

Added in API level 19

public PrintAttributes.Resolution getResolution ()

Gets the resolution.

Returns
PrintAttributes.Resolution	The resolution or null if not set.

hashCode

Added in API level 19

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 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 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.

Returns
int	a hash code value for this object.

toString

Added in API level 19

public String toString ()

Returns a string representation of the object.

Returns
String	a string representation of the object.

writeToParcel

Added in API level 19

public void writeToParcel (Parcel parcel, 
                int flags)

Flatten this object in to a Parcel.

Parameters
parcel	Parcel: The Parcel in which the object should be written. This value cannot be null.
flags	int: Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES