PrintAttributes

Kotlin |Java

class PrintAttributes : Parcelable

kotlin.Any
↳	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
	`Builder` Builder for creating `PrintAttributes`.
	`Margins` This class specifies content margins.
	`MediaSize` This class specifies a supported media size.
	`Resolution` This class specifies a supported resolution in DPI (dots per inch).

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

Inherited constants

From class 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: 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)". Some implementations may want to release resources at this point.

Public methods
Int	`describeContents()`
Boolean	`equals(other: Any?)` 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()`
String	`toString()`
Unit	`writeToParcel(parcel: Parcel, flags: Int)`

Properties
static Parcelable.Creator<PrintAttributes!>	`CREATOR`

Constants

COLOR_MODE_COLOR

Added in API level 19

static val COLOR_MODE_COLOR: Int

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

Value: 2

COLOR_MODE_MONOCHROME

Added in API level 19

static val COLOR_MODE_MONOCHROME: Int

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

Value: 1

DUPLEX_MODE_LONG_EDGE

Added in API level 23

static val DUPLEX_MODE_LONG_EDGE: Int

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

Value: 2

DUPLEX_MODE_NONE

Added in API level 23

static val DUPLEX_MODE_NONE: Int

Duplex mode: No duplexing.

Value: 1

DUPLEX_MODE_SHORT_EDGE

Added in API level 23

static val DUPLEX_MODE_SHORT_EDGE: Int

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

Value: 4

Public methods

describeContents

Added in API level 19

fun describeContents(): Int

Return
`Int`	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or `android.os.Parcelable#CONTENTS_FILE_DESCRIPTOR`

equals

Added in API level 19

fun equals(other: Any?): Boolean

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`	This value may be `null`.

Return
`Boolean`	`true` if this object is the same as the obj argument; `false` otherwise.

getColorMode

Added in API level 19

fun getColorMode(): Int

Gets the color mode.

Return
`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

fun getDuplexMode(): Int

Gets the duplex mode.

Return
`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

fun getMediaSize(): PrintAttributes.MediaSize?

Gets the media size.

Return
`PrintAttributes.MediaSize?`	The media size or `null` if not set.

getMinMargins

Added in API level 19

fun getMinMargins(): PrintAttributes.Margins?

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.

Return
`PrintAttributes.Margins?`	The margins or `null` if not set.

getResolution

Added in API level 19

fun getResolution(): PrintAttributes.Resolution?

Gets the resolution.

Return
`PrintAttributes.Resolution?`	The resolution or `null` if not set.

hashCode

Added in API level 19

fun hashCode(): Int

Return
`Int`	a hash code value for this object.

toString

Added in API level 19

fun toString(): String

Return
`String`	a string representation of the object.

writeToParcel

Added in API level 19

fun writeToParcel(
    parcel: Parcel, 
    flags: Int
): Unit

Parameters
`dest`	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_WRITE_RETURN_VALUE`. Value is either `0` or a combination of `android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE`, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

Properties

CREATOR

Added in API level 19

static val CREATOR: Parcelable.Creator<PrintAttributes!>