ly.img.android.sdk.models.state

Class EditorSaveSettings

java.lang.Object

ly.img.android.sdk.models.state.manager.StateObservable<EventEnum>

ly.img.android.sdk.models.state.manager.Settings<EditorSaveSettings.Event>

ly.img.android.sdk.models.state.EditorSaveSettings

All Implemented Interfaces:

android.os.Parcelable, java.lang.Cloneable

public class EditorSaveSettings
extends Settings<EditorSaveSettings.Event>

Created by svennahler on 02.09.16.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EditorSaveSettings.Event
static interface	EditorSaveSettings.FORMAT
static class	EditorSaveSettings.SavePolicy

Nested classes/interfaces inherited from class ly.img.android.sdk.models.state.manager.Settings

Settings.RevertibleField, Settings.SaveState

Nested classes/interfaces inherited from class ly.img.android.sdk.models.state.manager.StateObservable

StateObservable.StateUnbindedException

Nested classes/interfaces inherited from interface android.os.Parcelable

android.os.Parcelable.ClassLoaderCreator<T>, android.os.Parcelable.Creator<T>

Field Summary

Fields

Modifier and Type	Field and Description
static android.os.Parcelable.Creator<EditorSaveSettings>	CREATOR

Fields inherited from class ly.img.android.sdk.models.state.manager.Settings

isRevertible, revertibleFields, STATE_REVERTED

Fields inherited from class ly.img.android.sdk.models.state.manager.StateObservable

isConfigObject

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Modifier	Constructor and Description
	EditorSaveSettings()
protected	EditorSaveSettings(android.os.Parcel in)

Method Summary

Modifier and Type	Method and Description
int	describeContents()
int	determinedExportFormat() Get the Export Format with determined AUTO value.
java.lang.String	generateOutputFilePath()
ExifMode	getExifMode()
int	getExportFormat() Get the Export Format without determined AUTO value.
int	getJpegQuality()
EditorSaveSettings.SavePolicy	getSavePolicy()
boolean	hasNonDefaults()
boolean	isAlwaysUseImgLyEncoder()
boolean	isExportNecessary()
void	saveImage(Operator.Callback callback)
EditorSaveSettings	setExifMode(ExifMode exifMode)
EditorSaveSettings	setExportDir(Directory.EnvironmentDirApi19 directory, java.lang.String folderName) !!!
EditorSaveSettings	setExportDir(Directory.EnvironmentDir directory, java.lang.String folderName) Set the Export directory save path of the captured image.
EditorSaveSettings	setExportDir(java.lang.String path) Set the Export directory save path of the captured image.
EditorSaveSettings	setExportFormat(int exportFormat)
EditorSaveSettings	setExportPrefix(java.lang.String prefix) Set the image save name prefix.
EditorSaveSettings	setJpegQuality(int jpegQuality)
EditorSaveSettings	setJpegQuality(int jpegQuality, boolean alwaysUseImgLyEncoder)
EditorSaveSettings	setOutputFilePath(java.lang.String outputPath) Set Output path without File Extension
EditorSaveSettings	setSavePolicy(EditorSaveSettings.SavePolicy savePolicy)
void	writeToParcel(android.os.Parcel dest, int flags)

Methods inherited from class ly.img.android.sdk.models.state.manager.Settings

createSaveState, getFrozenSettings, getSettingsModel, hasChanges, hasRevertableState, isFrozen, isRevertible, revertState, revertState, saveInitState, saveState

Methods inherited from class ly.img.android.sdk.models.state.manager.StateObservable

addCallback, addCallback, getSettingsHandler, getStateModel, hasModelNonDefaultValue, notifyPropertyChanged, onBind, onBind, removeCallback, removeCallback

Methods inherited from class java.lang.Object

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

Field Detail

CREATOR

public static final android.os.Parcelable.Creator<EditorSaveSettings> CREATOR

Constructor Detail

EditorSaveSettings

public EditorSaveSettings()

EditorSaveSettings

protected EditorSaveSettings(android.os.Parcel in)

Method Detail

describeContents

public int describeContents()

Specified by:

describeContents in interface android.os.Parcelable

Overrides:

describeContents in class Settings<EditorSaveSettings.Event>

determinedExportFormat

@WorkerThread
public int determinedExportFormat()

Get the Export Format with determined AUTO value. @see #getExportFormat() This has to be executed in a background thread.

Returns:

the @EditorSaveSettings.FORMAT format int excluding AUTO

generateOutputFilePath

public java.lang.String generateOutputFilePath()

getExifMode

public ExifMode getExifMode()

getExportFormat

public int getExportFormat()

Get the Export Format without determined AUTO value. @see #determinedExportFormat()

Returns:

the @EditorSaveSettings.FORMAT format int including AUTO

getJpegQuality

public int getJpegQuality()

getSavePolicy

public EditorSaveSettings.SavePolicy getSavePolicy()

hasNonDefaults

public boolean hasNonDefaults()

Specified by:

hasNonDefaults in class Settings<EditorSaveSettings.Event>

isAlwaysUseImgLyEncoder

public boolean isAlwaysUseImgLyEncoder()

isExportNecessary

public boolean isExportNecessary()

saveImage

public void saveImage(Operator.Callback callback)

setExifMode

public EditorSaveSettings setExifMode(@NonNull
                                      ExifMode exifMode)

setExportDir

@NonNull
public EditorSaveSettings setExportDir(@NonNull
                                                Directory.EnvironmentDirApi19 directory,
                                                @NonNull
                                                java.lang.String folderName)

!!!Do not use Directory.DOCUMENTS until API 19.!!! Set the Export directory save path of the captured image.

Parameters:

directory - A specific system directory

folderName - A folder name will saved in the system directory.

Returns:

this intent.

setExportDir

@NonNull
public EditorSaveSettings setExportDir(@NonNull
                                                Directory.EnvironmentDir directory,
                                                @NonNull
                                                java.lang.String folderName)

Set the Export directory save path of the captured image.

Parameters:

directory - A specific system directory

folderName - A folder name will saved in the system directory.

Returns:

this intent.

setExportDir

@NonNull
public EditorSaveSettings setExportDir(java.lang.String path)

Set the Export directory save path of the captured image.

Parameters:

path - the absolutely save directory

Returns:

this intent.

setExportFormat

public EditorSaveSettings setExportFormat(int exportFormat)

setExportPrefix

public EditorSaveSettings setExportPrefix(java.lang.String prefix)

Set the image save name prefix.

Parameters:

prefix -

Returns:

this intent.

setJpegQuality

public EditorSaveSettings setJpegQuality(int jpegQuality)

setJpegQuality

public EditorSaveSettings setJpegQuality(int jpegQuality,
                                         boolean alwaysUseImgLyEncoder)

setOutputFilePath

public EditorSaveSettings setOutputFilePath(@NonNull
                                            java.lang.String outputPath)

Set Output path without File Extension

Parameters:

outputPath - file path without extension

Returns:

EditorSaveSettings to allow sequence

setSavePolicy

public EditorSaveSettings setSavePolicy(EditorSaveSettings.SavePolicy savePolicy)

writeToParcel

public void writeToParcel(android.os.Parcel dest,
                          int flags)

Specified by:

writeToParcel in interface android.os.Parcelable

Overrides:

writeToParcel in class Settings<EditorSaveSettings.Event>