universum.studios.android.intent

Class ImageIntent

java.lang.Object

universum.studios.android.intent.BaseIntent<I>

universum.studios.android.intent.ContentIntent<ImageIntent>

universum.studios.android.intent.ImageIntent

public class ImageIntent
extends ContentIntent<ImageIntent>

A ContentIntent implementation providing API for building and starting of intents to obtain or preview an image content.

Author:

Martin Albedinsky

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ImageIntent.ImageOptions Simple options for processResultIntent(int, int, Intent, Context, ImageOptions).

Nested classes/interfaces inherited from class universum.studios.android.intent.ContentIntent

ContentIntent.ContentHandler

Field Summary

Fields

Modifier and Type	Field and Description
static String	IMAGE_FILE_NAME_FORMAT Default format for image file name.
static int	REQUEST_CODE_CAMERA Flag to identify request code used to obtain image using camera.
static int	REQUEST_CODE_GALLERY Flag to identify request code used to obtain image from gallery.

Fields inherited from class universum.studios.android.intent.ContentIntent

CONTENT_FILE_TIME_STAMP_FORMAT

Constructor Summary

Constructors

Constructor and Description
ImageIntent()

Method Summary

Modifier and Type	Method and Description
static Intent	createCameraIntent() Same as createCameraIntent(File) with null for outputFile parameter.
static Intent	createCameraIntent(File outputFile) Same as createCameraIntent(Uri) with outputUri created from the given outputFile if not nul.
static Intent	createCameraIntent(Uri outputUri) Creates a new instance of Intent with MediaStore.ACTION_IMAGE_CAPTURE that can be used to launch a camera app to capture a single image.
static Intent	createGalleryIntent() Creates a new instance of Intent with Intent.ACTION_GET_CONTENT and MimeType.IMAGE MIME type that can be used to launch a gallery app (depends on user's choice) to pick one of available images.
static File	createImageFile() Same as createImageFile(String) with fileName in IMAGE_FILE_NAME_FORMAT format with a string representation of the current time stamp obtained via ContentIntent.createContentFileTimeStamp().
static File	createImageFile(String fileName) Same as ContentIntent.createContentFile(String, String) with .jpg suffix for the specified fileName (if it does not contain any) and Environment.DIRECTORY_PICTURES as externalDirectoryType.
ImageIntent	input(Uri uri) If the passed uri is not null, the current data (MIME) type will be set by default to MimeType.IMAGE.
protected ContentIntent.ContentHandler	onCreateCameraHandler(Resources resources) Invoked from withDefaultHandlers(Context) to create camera intent handler.
protected ContentIntent.ContentHandler	onCreateGalleryHandler(Resources resources) Invoked from withDefaultHandlers(Context) to create gallery intent handler.
ImageIntent	output(Uri uri) Sets an output uri for an image to be captured by the camera.
ImageIntent	withDefaultHandlers(Context context) Adds two default ContentHandlers.

Methods inherited from class universum.studios.android.intent.ContentIntent

build, createContentFile, createContentFile, createContentFileTimeStamp, dataType, dataType, ensureCanBuildOrThrow, handlers, input, onBuild, onShowChooserDialog, onStartWith, output, startWith, uri, withHandler, withHandlers, withHandlers

Methods inherited from class universum.studios.android.intent.BaseIntent

activityNotFoundMessage, activityNotFoundMessage, cannotBuildIntentException, dialogTitle, dialogTitle, enterTransition, enterTransition, exitTransition, exitTransition, isActivityForIntentAvailable, notifyActivityNotFound, transitions

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

REQUEST_CODE_GALLERY

public static final int REQUEST_CODE_GALLERY

Flag to identify request code used to obtain image from gallery.

See Also:

Constant Field Values

REQUEST_CODE_CAMERA

public static final int REQUEST_CODE_CAMERA

Flag to identify request code used to obtain image using camera.

See Also:

Constant Field Values

IMAGE_FILE_NAME_FORMAT

public static final String IMAGE_FILE_NAME_FORMAT

Default format for image file name.

Constant value: IMAGE_%s

See Also:

Constant Field Values

Constructor Detail

ImageIntent

public ImageIntent()

Method Detail

createGalleryIntent

public static Intent createGalleryIntent()

Creates a new instance of Intent with Intent.ACTION_GET_CONTENT and MimeType.IMAGE MIME type that can be used to launch a gallery app (depends on user's choice) to pick one of available images.

Returns:

New gallery intent instance.

createCameraIntent

public static Intent createCameraIntent()

Same as createCameraIntent(File) with null for outputFile parameter.

createCameraIntent

public static Intent createCameraIntent(File outputFile)

Same as createCameraIntent(Uri) with outputUri created from the given outputFile if not nul.

Parameters:

outputFile - The desired file used to crate the output Uri.

See Also:

createCameraIntent()

createCameraIntent

public static Intent createCameraIntent(Uri outputUri)

Creates a new instance of Intent with MediaStore.ACTION_IMAGE_CAPTURE that can be used to launch a camera app to capture a single image.

Parameters:

outputUri - If not null, it will be attached to intent as MediaStore.EXTRA_OUTPUT, so when the result is received in for example Activity.onActivityResult(int, int, Intent), the outputUri will address to a file which contains the currently captured image.

Returns:

New camera intent instance.

See Also:

createCameraIntent(File)

createImageFile

public static File createImageFile()

Same as createImageFile(String) with fileName in IMAGE_FILE_NAME_FORMAT format with a string representation of the current time stamp obtained via ContentIntent.createContentFileTimeStamp().

createImageFile

public static File createImageFile(String fileName)

Same as ContentIntent.createContentFile(String, String) with .jpg suffix for the specified fileName (if it does not contain any) and Environment.DIRECTORY_PICTURES as externalDirectoryType.

Parameters:

fileName - The desired name for the image file.

See Also:

createImageFile()

withDefaultHandlers

public ImageIntent withDefaultHandlers(Context context)

Adds two default ContentHandlers. One for REQUEST_CODE_GALLERY and second one for REQUEST_CODE_CAMERA.

Specified by:

withDefaultHandlers in class ContentIntent<ImageIntent>

Returns:

This intent builder to allow methods chaining.

onCreateGalleryHandler

protected ContentIntent.ContentHandler onCreateGalleryHandler(Resources resources)

Invoked from withDefaultHandlers(Context) to create gallery intent handler.

This method may be override to create a handler with a localized name.

Parameters:

resources - Application resources.

Returns:

Content handler with gallery intent.

See Also:

onCreateCameraHandler(Resources)

onCreateCameraHandler

protected ContentIntent.ContentHandler onCreateCameraHandler(Resources resources)

Invoked from withDefaultHandlers(Context) to create camera intent handler.

This method may be override to create a handler with a localized name.

Parameters:

resources - Application resources.

Returns:

Content handler with camera intent.

See Also:

onCreateGalleryHandler(Resources)

input

public ImageIntent input(Uri uri)

If the passed uri is not null, the current data (MIME) type will be set by default to MimeType.IMAGE.

Overrides:

input in class ContentIntent<ImageIntent>

Parameters:

uri - The desired uri, which should be delivered to the handling activity. May be null to clear the current one.

Returns:

This intent builder to allow methods chaining.

See Also:

ContentIntent.uri()

output

public ImageIntent output(Uri uri)

Sets an output uri for an image to be captured by the camera.

Overrides:

output in class ContentIntent<ImageIntent>

Parameters:

uri - If not null, it will be attached to ContentHandler holding intent with the REQUEST_CODE_CAMERA request code, so when the camera handler's item is selected within a chooser dialog and user confirms his captured photo, result for this action will be received in for example Activity.onActivityResult(int, int, Intent). The passed uri will then address to a file which contains the currently captured image.

Returns:

This intent builder to allow methods chaining.

See Also:

ContentIntent.uri()