Android APIs
public final class

PrintAttributes

extends Object
implements Parcelable
java.lang.Object
   ↳ android.print.PrintAttributes

Class Overview

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.
[Expand]
Inherited Constants
From interface android.os.Parcelable
Fields
public static final Creator<PrintAttributes> CREATOR
Public Methods
int describeContents()
Describe the kinds of special objects contained in this Parcelable's marshalled representation.
boolean equals(Object obj)
Compares this instance with the specified object and indicates if they are equal.
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 an integer hash code for this object.
String toString()
Returns a string containing a concise, human-readable description of this object.
void writeToParcel(Parcel parcel, int flags)
Flatten this object in to a Parcel.
[Expand]
Inherited Methods
From class java.lang.Object
From interface android.os.Parcelable

Constants

public static final int COLOR_MODE_COLOR

Added in API level 19

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

Constant Value: 2 (0x00000002)

public static final int COLOR_MODE_MONOCHROME

Added in API level 19

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

Constant Value: 1 (0x00000001)

public static final int DUPLEX_MODE_LONG_EDGE

Added in API level 23

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

Constant Value: 2 (0x00000002)

public static final int DUPLEX_MODE_NONE

Added in API level 23

Duplex mode: No duplexing.

Constant Value: 1 (0x00000001)

public static final int DUPLEX_MODE_SHORT_EDGE

Added in API level 23

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

Constant Value: 4 (0x00000004)

Fields

public static final Creator<PrintAttributes> CREATOR

Added in API level 19

Public Methods

public int describeContents ()

Added in API level 19

Describe the kinds of special objects contained in this Parcelable's marshalled representation.

Returns
int a bitmask indicating the set of special object types marshalled by the Parcelable.

public boolean equals (Object obj)

Added in API level 19

Compares this instance with the specified object and indicates if they are equal. In order to be equal, o must represent the same object as this instance using a class-specific comparison. The general contract is that this comparison should be reflexive, symmetric, and transitive. Also, no object reference other than null is equal to null.

The default implementation returns true only if this == o. See Writing a correct equals method if you intend implementing your own equals method.

The general contract for the equals and hashCode() methods is that if equals returns true for any two objects, then hashCode() must return the same value for these objects. This means that subclasses of Object usually override either both methods or neither of them.

Parameters
obj the object to compare this instance with.
Returns
boolean true if the specified object is equal to this Object; false otherwise.

public int getColorMode ()

Added in API level 19

Gets the color mode.

Returns
int The color mode or zero if not set.

public int getDuplexMode ()

Added in API level 23

Gets the duplex mode.

Returns
int The duplex mode.

public PrintAttributes.MediaSize getMediaSize ()

Added in API level 19

Gets the media size.

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

public PrintAttributes.Margins getMinMargins ()

Added in API level 19

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.

public PrintAttributes.Resolution getResolution ()

Added in API level 19

Gets the resolution.

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

public int hashCode ()

Added in API level 19

Returns an integer hash code for this object. By contract, any two objects for which equals(Object) returns true must return the same hash code value. This means that subclasses of Object usually override both methods or neither method.

Note that hash values must not change over time unless information used in equals comparisons also changes.

See Writing a correct hashCode method if you intend implementing your own hashCode method.

Returns
int this object's hash code.

public String toString ()

Added in API level 19

Returns a string containing a concise, human-readable description of this object. Subclasses are encouraged to override this method and provide an implementation that takes into account the object's type and data. The default implementation is equivalent to the following expression:

   getClass().getName() + '@' + Integer.toHexString(hashCode())

See Writing a useful toString method if you intend implementing your own toString method.

Returns
String a printable representation of this object.

public void writeToParcel (Parcel parcel, int flags)

Added in API level 19

Flatten this object in to a Parcel.

Parameters
parcel The Parcel in which the object should be written.
flags Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE.