PrintHelper

Kotlin |Java

class PrintHelper

kotlin.Any
↳	androidx.print.PrintHelper

Helper for printing bitmaps.

Summary

Nested classes
abstract	`OnPrintFinishCallback` Callback for observing when a print operation is completed.

Constants
static Int	`COLOR_MODE_COLOR` this is a color image (default)
static Int	`COLOR_MODE_MONOCHROME` this is a black and white image
static Int	`ORIENTATION_LANDSCAPE` Print the image in landscape orientation (default).
static Int	`ORIENTATION_PORTRAIT` Print the image in portrait orientation.
static Int	`SCALE_MODE_FILL` image will fill the paper and be cropped (default)
static Int	`SCALE_MODE_FIT` image will be scaled but leave white space

Public constructors
`<init>(@NonNull context: Context)` Constructs the PrintHelper that can be used to print images.

Public methods
Int	`getColorMode()` Gets the color mode with which the image will be printed.
Int	`getOrientation()` Gets whether the image will be printed in landscape or portrait.
Int	`getScaleMode()` Returns the scale mode with which the image will fill the paper.
Unit	`printBitmap(@NonNull jobName: String, @NonNull bitmap: Bitmap)` Prints a bitmap.
Unit	`printBitmap(@NonNull jobName: String, @NonNull bitmap: Bitmap, @Nullable callback: PrintHelper.OnPrintFinishCallback?)` Prints a bitmap.
Unit	`printBitmap(@NonNull jobName: String, @NonNull imageFile: Uri)` Prints an image located at the Uri.
Unit	`printBitmap(@NonNull jobName: String, @NonNull imageFile: Uri, @Nullable callback: PrintHelper.OnPrintFinishCallback?)` Prints an image located at the Uri.
Unit	`setColorMode(colorMode: Int)` Sets whether the image will be printed in color (default) `COLOR_MODE_COLOR` or in back and white `COLOR_MODE_MONOCHROME`.
Unit	`setOrientation(orientation: Int)` Sets whether the image will be printed in landscape `ORIENTATION_LANDSCAPE` (default) or portrait `ORIENTATION_PORTRAIT`.
Unit	`setScaleMode(scaleMode: Int)` Selects whether the image will fill the paper and be cropped `SCALE_MODE_FIT` or whether the image will be scaled but leave white space `SCALE_MODE_FILL`.
static Boolean	`systemSupportsPrint()` Gets whether the system supports printing.

static val COLOR_MODE_COLOR: Int

this is a color image (default)

Value: PrintAttributes.COLOR_MODE_COLOR

static val COLOR_MODE_MONOCHROME: Int

this is a black and white image

Value: PrintAttributes.COLOR_MODE_MONOCHROME

static val ORIENTATION_LANDSCAPE: Int

Print the image in landscape orientation (default).

Value: 1

static val ORIENTATION_PORTRAIT: Int

Print the image in portrait orientation.

Value: 2

static val SCALE_MODE_FILL: Int

image will fill the paper and be cropped (default)

Value: 2

static val SCALE_MODE_FIT: Int

image will be scaled but leave white space

Value: 1

PrintHelper(@NonNull context: Context)

Constructs the PrintHelper that can be used to print images.

Parameters
`context`	Context: A context for accessing system resources.

fun getColorMode(): Int

Gets the color mode with which the image will be printed.

Return
`Int`	The color mode which is one of `COLOR_MODE_COLOR` and `COLOR_MODE_MONOCHROME`.

fun getOrientation(): Int

Gets whether the image will be printed in landscape or portrait.

Return
`Int`	The page orientation which is one of `ORIENTATION_LANDSCAPE` or `ORIENTATION_PORTRAIT`.

fun getScaleMode(): Int

Returns the scale mode with which the image will fill the paper.

Return
`Int`	The scale Mode: `SCALE_MODE_FIT` or `SCALE_MODE_FILL`