added in version 22.1.0
belongs to Maven artifact com.android.support:print:28.0.0-alpha1

Summary: Nested Classes | Constants | Ctors | Methods | Inherited Methods | [Expand All]

PrintHelper

This package is part of the Android support library which is no longer maintained. The support library has been superseded by AndroidX which is part of Jetpack. We recommend using the AndroidX libraries in all new projects. You should also consider migrating existing projects to AndroidX. To find the AndroidX class that maps to this deprecated class, see the AndroidX support library class mappings.

public final class PrintHelper
extends Object

java.lang.Object
↳	android.support.v4.print.PrintHelper

---

Helper for printing bitmaps.

Summary

Nested classes
interface	PrintHelper.OnPrintFinishCallback Callback for observing when a print operation is completed.

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

Public constructors
PrintHelper(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.
void	printBitmap(String jobName, Bitmap bitmap) Prints a bitmap.
void	printBitmap(String jobName, Bitmap bitmap, PrintHelper.OnPrintFinishCallback callback) Prints a bitmap.
void	printBitmap(String jobName, Uri imageFile) Prints an image located at the Uri.
void	printBitmap(String jobName, Uri imageFile, PrintHelper.OnPrintFinishCallback callback) Prints an image located at the Uri.
void	setColorMode(int colorMode) Sets whether the image will be printed in color (default) COLOR_MODE_COLOR or in back and white COLOR_MODE_MONOCHROME.
void	setOrientation(int orientation) Sets whether the image will be printed in landscape ORIENTATION_LANDSCAPE (default) or portrait ORIENTATION_PORTRAIT.
void	setScaleMode(int scaleMode) 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.

Inherited methods
From class java.lang.Object Object clone() boolean equals(Object arg0) void finalize() final Class<?> getClass() int hashCode() final void notify() final void notifyAll() String toString() final void wait(long arg0, int arg1) final void wait(long arg0) final void wait()

Constants

COLOR_MODE_COLOR

added in version 22.1.0

int COLOR_MODE_COLOR

this is a color image (default)

Constant Value: 2 (0x00000002)

COLOR_MODE_MONOCHROME

added in version 22.1.0

int COLOR_MODE_MONOCHROME

this is a black and white image

Constant Value: 1 (0x00000001)

ORIENTATION_LANDSCAPE

added in version 22.1.0

int ORIENTATION_LANDSCAPE

Print the image in landscape orientation (default).

Constant Value: 1 (0x00000001)

ORIENTATION_PORTRAIT

added in version 22.1.0

int ORIENTATION_PORTRAIT

Print the image in portrait orientation.

Constant Value: 2 (0x00000002)

SCALE_MODE_FILL

added in version 22.1.0

int SCALE_MODE_FILL

image will fill the paper and be cropped (default)

Constant Value: 2 (0x00000002)

SCALE_MODE_FIT

added in version 22.1.0

int SCALE_MODE_FIT

image will be scaled but leave white space

Constant Value: 1 (0x00000001)

Public constructors

PrintHelper

added in version 22.1.0

PrintHelper (Context context)

Constructs the PrintHelper that can be used to print images.

Parameters
context	Context: A context for accessing system resources.

Public methods

getColorMode

added in version 22.1.0

int getColorMode ()

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 version 22.1.0

int getOrientation ()

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 version 22.1.0

int getScaleMode ()

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 version 22.1.0

void printBitmap (String jobName, 
                Bitmap bitmap)

Prints a bitmap.

Parameters
jobName	String: The print job name.
bitmap	Bitmap: The bitmap to print.

printBitmap

added in version 22.1.0

void printBitmap (String jobName, 
                Bitmap bitmap, 
                PrintHelper.OnPrintFinishCallback callback)

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 version 22.1.0

void printBitmap (String jobName, 
                Uri imageFile)

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
FileNotFoundException	if Uri is not pointing to a valid image.

printBitmap

added in version 22.1.0

void printBitmap (String jobName, 
                Uri imageFile, 
                PrintHelper.OnPrintFinishCallback callback)

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
FileNotFoundException	if Uri is not pointing to a valid image.

setColorMode

added in version 22.1.0

void setColorMode (int colorMode)

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 version 22.1.0

void setOrientation (int orientation)

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 version 22.1.0

void setScaleMode (int scaleMode)

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 version 22.1.0

boolean systemSupportsPrint ()

Gets whether the system supports printing.

Returns
boolean	True if printing is supported.

• Interfaces

  • PrintHelper.OnPrintFinishCallback

• Classes

  • PrintHelper