PrintHelper

class PrintHelper

Helper for printing bitmaps.

Summary

Nested types

Callback for observing when a print operation is completed.

Constants
const Int

this is a color image (default)
const Int

this is a black and white image
const Int

Print the image in landscape orientation (default).
const Int

Print the image in portrait orientation.
const Int

image will fill the paper and be cropped (default)
const Int

image will be scaled but leave white space

Public constructors
PrintHelper(context: Context)

Constructs the PrintHelper that can be used to print images.

Public functions
Int

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

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

Returns the scale mode with which the image will fill the paper.
Unit
printBitmap(jobName: String, bitmap: Bitmap)

Prints a bitmap.
Unit
printBitmap(jobName: String, imageFile: Uri)

Prints an image located at the Uri.
Unit
printBitmap(
    jobName: String,
    bitmap: Bitmap,
    callback: PrintHelper.OnPrintFinishCallback?
)

Prints a bitmap.
Unit
printBitmap(
    jobName: String,
    imageFile: Uri,
    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.
java-static Boolean

Gets whether the system supports printing.

Constants

COLOR_MODE_COLOR

Added in 1.0.0
const val COLOR_MODE_COLOR = 2: Int

this is a color image (default)

COLOR_MODE_MONOCHROME

Added in 1.0.0
const val COLOR_MODE_MONOCHROME = 1: Int

this is a black and white image

ORIENTATION_LANDSCAPE

Added in 1.0.0
const val ORIENTATION_LANDSCAPE = 1: Int

Print the image in landscape orientation (default).

ORIENTATION_PORTRAIT

Added in 1.0.0
const val ORIENTATION_PORTRAIT = 2: Int

Print the image in portrait orientation.

SCALE_MODE_FILL

Added in 1.0.0
const val SCALE_MODE_FILL = 2: Int

image will fill the paper and be cropped (default)

SCALE_MODE_FIT

Added in 1.0.0
const val SCALE_MODE_FIT = 1: Int

image will be scaled but leave white space

Public constructors

PrintHelper

Added in 1.0.0
PrintHelper(context: Context)

Constructs the PrintHelper that can be used to print images.

Parameters
context: Context

A context for accessing system resources.

Public functions

getColorMode

Added in 1.0.0
fun getColorMode(): Int

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

Returns
Int

The color mode which is one of COLOR_MODE_COLOR and COLOR_MODE_MONOCHROME.

getOrientation

Added in 1.0.0
fun getOrientation(): Int

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

Returns
Int

The page orientation which is one of ORIENTATION_LANDSCAPE or ORIENTATION_PORTRAIT.

getScaleMode

Added in 1.0.0
fun getScaleMode(): Int

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

Returns
Int

The scale Mode: SCALE_MODE_FIT or SCALE_MODE_FILL

printBitmap

Added in 1.0.0
fun printBitmap(jobName: String, bitmap: Bitmap): Unit

Prints a bitmap.

Parameters
jobName: String

The print job name.
bitmap: Bitmap

The bitmap to print.

printBitmap

Added in 1.0.0
fun printBitmap(jobName: String, imageFile: Uri): Unit

Prints an image located at the Uri. Image types supported are those of android.graphics.BitmapFactory.decodeStream(java.io.InputStream)

Parameters
jobName: String

The print job name.
imageFile: Uri

The Uri pointing to an image to print.
Throws
java.io.FileNotFoundException

if Uri is not pointing to a valid image.

printBitmap

Added in 1.0.0
fun printBitmap(
    jobName: String,
    bitmap: Bitmap,
    callback: PrintHelper.OnPrintFinishCallback?
): Unit

Prints a bitmap.

Parameters
jobName: String

The print job name.
bitmap: Bitmap

The bitmap to print.
callback: PrintHelper.OnPrintFinishCallback?

Optional callback to observe when printing is finished.

printBitmap

Added in 1.0.0
fun printBitmap(
    jobName: String,
    imageFile: Uri,
    callback: PrintHelper.OnPrintFinishCallback?
): Unit

Prints an image located at the Uri. Image types supported are those of android.graphics.BitmapFactory.decodeStream(java.io.InputStream)

Parameters
jobName: String

The print job name.
imageFile: Uri

The Uri pointing to an image to print.
callback: PrintHelper.OnPrintFinishCallback?

Optional callback to observe when printing is finished.
Throws
java.io.FileNotFoundException

if Uri is not pointing to a valid image.

setColorMode

Added in 1.0.0
fun setColorMode(colorMode: Int): Unit

Sets whether the image will be printed in color (default) COLOR_MODE_COLOR or in back and white COLOR_MODE_MONOCHROME.

Parameters
colorMode: Int

The color mode which is one of COLOR_MODE_COLOR and COLOR_MODE_MONOCHROME.

setOrientation

Added in 1.0.0
fun setOrientation(orientation: Int): Unit

Sets whether the image will be printed in landscape ORIENTATION_LANDSCAPE (default) or portrait ORIENTATION_PORTRAIT.

Parameters
orientation: Int

The page orientation which is one of ORIENTATION_LANDSCAPE or ORIENTATION_PORTRAIT.

setScaleMode

Added in 1.0.0
fun setScaleMode(scaleMode: Int): Unit

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.

Parameters
scaleMode: Int

SCALE_MODE_FIT or SCALE_MODE_FILL

systemSupportsPrint

Added in 1.0.0
java-static fun systemSupportsPrint(): Boolean

Gets whether the system supports printing.

Returns
Boolean

True if printing is supported.