Skip to content

Most visited

Recently visited

navigation
Added in API level 19

PrintAttributes

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

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
From interface android.os.Parcelable

Constants

COLOR_MODE_COLOR

Added in API level 19
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
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
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
int DUPLEX_MODE_NONE

Duplex mode: No duplexing.

Constant Value: 1 (0x00000001)

DUPLEX_MODE_SHORT_EDGE

Added in API level 23
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
Creator<PrintAttributes> CREATOR

Public methods

describeContents

Added in API level 19
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(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.

equals

Added in API level 19
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: the reference object with which to compare.
Returns
boolean true if this object is the same as the obj argument; false otherwise.

getColorMode

Added in API level 19
int getColorMode ()

Gets the color mode.

Returns
int The color mode or zero if not set.

See also:

getDuplexMode

Added in API level 23
int getDuplexMode ()

Gets the duplex mode.

Returns
int The duplex mode or zero if not set.

See also:

getMediaSize

Added in API level 19
PrintAttributes.MediaSize getMediaSize ()

Gets the media size.

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

getMinMargins

Added in API level 19
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
PrintAttributes.Resolution getResolution ()

Gets the resolution.

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

hashCode

Added in API level 19
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 JavaTM programming language.)

Returns
int a hash code value for this object.

toString

Added in API level 19
String toString ()

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

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

Returns
String a string representation of the object.

writeToParcel

Added in API level 19
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.
flags int: Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE.
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.