ja.burhanrashid52.photoeditor

Class PhotoEditor

java.lang.Object

ja.burhanrashid52.photoeditor.PhotoEditor

public class PhotoEditor
extends java.lang.Object

This class in initialize by PhotoEditor.Builder using a builder pattern with multiple editing attributes

Since:

18/01/2017

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PhotoEditor.Builder Builder pattern to define PhotoEditor Instance
static interface	PhotoEditor.OnSaveListener A callback to save the edited image asynchronously

Method Summary

Modifier and Type	Method and Description
void	addEmoji(java.lang.String emojiName) Adds emoji to the PhotoEditorView which you drag,rotate and scale using pinch if PhotoEditor.Builder.setPinchTextScalable(boolean) enabled
void	addEmoji(android.graphics.Typeface emojiTypeface, java.lang.String emojiName) Adds emoji to the PhotoEditorView which you drag,rotate and scale using pinch if PhotoEditor.Builder.setPinchTextScalable(boolean) enabled
void	addImage(android.graphics.Bitmap desiredImage) This will add image on PhotoEditorView which you drag,rotate and scale using pinch if PhotoEditor.Builder.setPinchTextScalable(boolean) enabled
void	addText(java.lang.String text, int colorCodeTextView) This add the text on the PhotoEditorView with provided parameters by default TextView.setText(int) will be 18sp
void	addText(java.lang.String text, TextStyleBuilder styleBuilder) This add the text on the PhotoEditorView with provided parameters by default TextView.setText(int) will be 18sp
void	addText(android.graphics.Typeface textTypeface, java.lang.String text, int colorCodeTextView) This add the text on the PhotoEditorView with provided parameters by default TextView.setText(int) will be 18sp
void	brushEraser() Its enables eraser mode after that whenever user drags on screen this will erase the existing paint Note : This eraser will work on paint views only
void	clearAllViews() Removes all the edited operations performed PhotoEditorView This will also clear the undo and redo stack
void	clearHelperBox() Remove all helper boxes from views
void	editText(android.view.View view, java.lang.String inputText, int colorCode) This will update text and color on provided view
void	editText(android.view.View view, java.lang.String inputText, TextStyleBuilder styleBuilder) This will update the text and color on provided view
void	editText(android.view.View view, android.graphics.Typeface textTypeface, java.lang.String inputText, int colorCode) This will update the text and color on provided view
int	getBrushColor()
java.lang.Boolean	getBrushDrawableMode()
float	getBrushSize()
static java.util.ArrayList<java.lang.String>	getEmojis(android.content.Context context) Provide the list of emoji in form of unicode string
float	getEraserSize()
boolean	isCacheEmpty() Check if any changes made need to save
void	onStartDrawing()
void	onStopDrawing()
void	onViewAdd(BrushDrawingView brushDrawingView)
void	onViewRemoved(BrushDrawingView brushDrawingView)
boolean	redo() Redo the last operation perform on the PhotoEditor
void	saveAsBitmap(OnSaveBitmap onSaveBitmap) Save the edited image as bitmap
void	saveAsBitmap(SaveSettings saveSettings, OnSaveBitmap onSaveBitmap) Save the edited image as bitmap
void	saveAsFile(java.lang.String imagePath, PhotoEditor.OnSaveListener onSaveListener) Save the edited image on given path
void	saveAsFile(java.lang.String imagePath, SaveSettings saveSettings, PhotoEditor.OnSaveListener onSaveListener) Save the edited image on given path
void	setBrushColor(int color) set brush color which user want to paint
void	setBrushDrawingMode(boolean brushDrawingMode) Enable/Disable drawing mode to draw on PhotoEditorView
void	setBrushEraserSize(float brushEraserSize) set the eraser size Note : Eraser size is different from the normal brush size
void	setBrushSize(float size) set the size of bursh user want to paint on canvas i.e BrushDrawingView
void	setFilterEffect(CustomEffect customEffect) Setup of custom effect using effect type and set parameters values
void	setFilterEffect(PhotoFilter filterType) Set pre-define filter available
void	setOnPhotoEditorListener(OnPhotoEditorListener onPhotoEditorListener) Callback on editing operation perform on PhotoEditorView
void	setOpacity(int opacity) set opacity/transparency of brush while painting on BrushDrawingView
boolean	undo() Undo the last operation perform on the PhotoEditor

Methods inherited from class java.lang.Object

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

Method Detail

addImage

public void addImage(android.graphics.Bitmap desiredImage)

This will add image on PhotoEditorView which you drag,rotate and scale using pinch if PhotoEditor.Builder.setPinchTextScalable(boolean) enabled

Parameters:

desiredImage - bitmap image you want to add

addText

public void addText(java.lang.String text,
                    int colorCodeTextView)

This add the text on the PhotoEditorView with provided parameters by default TextView.setText(int) will be 18sp

Parameters:

text - text to display

colorCodeTextView - text color to be displayed

addText

public void addText(android.graphics.Typeface textTypeface,
                    java.lang.String text,
                    int colorCodeTextView)

This add the text on the PhotoEditorView with provided parameters by default TextView.setText(int) will be 18sp

Parameters:

textTypeface - typeface for custom font in the text

text - text to display

colorCodeTextView - text color to be displayed

addText

public void addText(java.lang.String text,
                    TextStyleBuilder styleBuilder)

This add the text on the PhotoEditorView with provided parameters by default TextView.setText(int) will be 18sp

Parameters:

text - text to display

styleBuilder - text style builder with your style

editText

public void editText(android.view.View view,
                     java.lang.String inputText,
                     int colorCode)

This will update text and color on provided view

Parameters:

view - view on which you want update

inputText - text to update TextView

colorCode - color to update on TextView

editText

public void editText(android.view.View view,
                     android.graphics.Typeface textTypeface,
                     java.lang.String inputText,
                     int colorCode)

This will update the text and color on provided view

Parameters:

view - root view where text view is a child

textTypeface - update typeface for custom font in the text

inputText - text to update TextView

colorCode - color to update on TextView

editText

public void editText(android.view.View view,
                     java.lang.String inputText,
                     TextStyleBuilder styleBuilder)

This will update the text and color on provided view

Parameters:

view - root view where text view is a child

inputText - text to update TextView

styleBuilder - style to apply on TextView

addEmoji

public void addEmoji(java.lang.String emojiName)

Adds emoji to the PhotoEditorView which you drag,rotate and scale using pinch if PhotoEditor.Builder.setPinchTextScalable(boolean) enabled

Parameters:

emojiName - unicode in form of string to display emoji

addEmoji

public void addEmoji(android.graphics.Typeface emojiTypeface,
                     java.lang.String emojiName)

Adds emoji to the PhotoEditorView which you drag,rotate and scale using pinch if PhotoEditor.Builder.setPinchTextScalable(boolean) enabled

Parameters:

emojiTypeface - typeface for custom font to show emoji unicode in specific font

emojiName - unicode in form of string to display emoji

setBrushDrawingMode

public void setBrushDrawingMode(boolean brushDrawingMode)

Enable/Disable drawing mode to draw on PhotoEditorView

Parameters:

brushDrawingMode - true if mode is enabled

getBrushDrawableMode

public java.lang.Boolean getBrushDrawableMode()

Returns:

true is brush mode is enabled

setBrushSize

public void setBrushSize(float size)

set the size of bursh user want to paint on canvas i.e BrushDrawingView

Parameters:

size - size of brush

setOpacity

public void setOpacity(int opacity)

set opacity/transparency of brush while painting on BrushDrawingView

Parameters:

opacity - opacity is in form of percentage

setBrushColor

public void setBrushColor(int color)

set brush color which user want to paint

Parameters:

color - color value for paint

setBrushEraserSize

public void setBrushEraserSize(float brushEraserSize)

set the eraser size

Note : Eraser size is different from the normal brush size

Parameters:

brushEraserSize - size of eraser

getEraserSize

public float getEraserSize()

Returns:

provide the size of eraser

See Also:

setBrushEraserSize(float)

getBrushSize

public float getBrushSize()

Returns:

provide the size of eraser

See Also:

setBrushSize(float)

getBrushColor

public int getBrushColor()

Returns:

provide the size of eraser

See Also:

setBrushColor(int)

brushEraser

public void brushEraser()

Its enables eraser mode after that whenever user drags on screen this will erase the existing paint
Note : This eraser will work on paint views only

undo

public boolean undo()

Undo the last operation perform on the PhotoEditor

Returns:

true if there nothing more to undo

redo

public boolean redo()

Redo the last operation perform on the PhotoEditor

Returns:

true if there nothing more to redo

clearAllViews

public void clearAllViews()

Removes all the edited operations performed PhotoEditorView This will also clear the undo and redo stack

clearHelperBox

public void clearHelperBox()

Remove all helper boxes from views

setFilterEffect

public void setFilterEffect(CustomEffect customEffect)

Setup of custom effect using effect type and set parameters values

Parameters:

customEffect - CustomEffect.Builder.setParameter(String, Object)

setFilterEffect

public void setFilterEffect(PhotoFilter filterType)

Set pre-define filter available

Parameters:

filterType - type of filter want to apply PhotoEditor

saveAsFile

public void saveAsFile(java.lang.String imagePath,
                       PhotoEditor.OnSaveListener onSaveListener)

Save the edited image on given path

Parameters:

imagePath - path on which image to be saved

onSaveListener - callback for saving image

See Also:

PhotoEditor.OnSaveListener

saveAsFile

public void saveAsFile(java.lang.String imagePath,
                       SaveSettings saveSettings,
                       PhotoEditor.OnSaveListener onSaveListener)

Save the edited image on given path

Parameters:

imagePath - path on which image to be saved

saveSettings - builder for multiple save options SaveSettings

onSaveListener - callback for saving image

See Also:

PhotoEditor.OnSaveListener

saveAsBitmap

public void saveAsBitmap(OnSaveBitmap onSaveBitmap)

Save the edited image as bitmap

Parameters:

onSaveBitmap - callback for saving image as bitmap

See Also:

OnSaveBitmap

saveAsBitmap

public void saveAsBitmap(SaveSettings saveSettings,
                         OnSaveBitmap onSaveBitmap)

Save the edited image as bitmap

Parameters:

saveSettings - builder for multiple save options SaveSettings

onSaveBitmap - callback for saving image as bitmap

See Also:

OnSaveBitmap

setOnPhotoEditorListener

public void setOnPhotoEditorListener(OnPhotoEditorListener onPhotoEditorListener)

Callback on editing operation perform on PhotoEditorView

Parameters:

onPhotoEditorListener - OnPhotoEditorListener

isCacheEmpty

public boolean isCacheEmpty()

Check if any changes made need to save

Returns:

true if nothing is there to change

onViewAdd

public void onViewAdd(BrushDrawingView brushDrawingView)

onViewRemoved

public void onViewRemoved(BrushDrawingView brushDrawingView)

onStartDrawing

public void onStartDrawing()

onStopDrawing

public void onStopDrawing()

getEmojis

public static java.util.ArrayList<java.lang.String> getEmojis(android.content.Context context)

Provide the list of emoji in form of unicode string

Parameters:

context - context

Returns:

list of emoji unicode