ly.img.android.sdk.models.config

Class FrameConfig

java.lang.Object

ly.img.android.sdk.models.config.AbstractConfig

ly.img.android.sdk.models.config.FrameConfig

All Implemented Interfaces:

android.os.Parcelable, AbstractConfig.AspectConfigInterface, AbstractConfig.FrameConfigInterface, DataSourceInterface<AbstractConfig.BindData>

public class FrameConfig
extends AbstractConfig
implements AbstractConfig.FrameConfigInterface

Nested Class Summary

Nested classes/interfaces inherited from class ly.img.android.sdk.models.config.AbstractConfig

AbstractConfig.AspectConfigInterface, AbstractConfig.BindData, AbstractConfig.ColorConfigInterface, AbstractConfig.ConfigViewHolder, AbstractConfig.FontConfigInterface<T>, AbstractConfig.FrameConfigInterface, AbstractConfig.ImageFilterInterface, AbstractConfig.StickerConfigInterface, AbstractConfig.ToolConfigInterface

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<FrameConfig>	CREATOR

Fields inherited from class ly.img.android.sdk.models.config.AbstractConfig

isDirty, NO_STATIC_THUMBNAIL_ID, ORIGINAL_THUMBNAIL_SIZE, thumbnailUri

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Modifier	Constructor and Description
	FrameConfig(int name, int drawableId, int frameId, AbstractConfig.AspectConfigInterface aspectConfig, int groupId) Creates a Frame Config
	FrameConfig(int name, int drawableId, int frameId, int frameMaskId, AbstractConfig.AspectConfigInterface aspectConfig, int groupId) Creates a Frame Config
protected	FrameConfig(android.os.Parcel in)

Method Summary

Modifier and Type	Method and Description
android.graphics.Rect	calculateInnerRect(android.graphics.Rect inputFullRect)
RelativeRect	calculateInnerRect(RelativeRect inputFullRect)
float[]	calculateOuterOffsetAndScale()
android.graphics.Rect	calculateOuterRect(android.graphics.Rect inputFullRect)
RelativeRect	calculateOuterRect(RelativeRect inputFullRect)
float	calculateScale(android.graphics.Rect inputFullRect)
java.math.BigDecimal	calculateScale(RelativeRect inputFullRect)
static FrameConfig	createNonFrameConfig(int name, int drawableId) Creates the non-frame option to remove the frame
int	describeContents()
boolean	equals(java.lang.Object o)
float	getAspect()
int	getCropHeight()
int	getCropWidth()
float	getFrameAspect()
int	getFrameId() Get frame drawable resource id, it can be a drawable or raw resource.
android.graphics.Rect	getFrameLimit()
int	getFrameMaskId() This can get a separate mask drawable resource id, it can be a drawable or raw resource.
int	getGroupId()
android.graphics.Rect	getImageLimit() Gets the Region of the Image.
int	getLayout() Get the layout res id of the list item view.
android.graphics.Rect	getOuterLimit()
boolean	hasEqualAspect(AbstractConfig.AspectConfigInterface o)
int	hashCode()
boolean	hasMask()
boolean	hasSpecificSize()
boolean	isFreeCrop()
boolean	isNonFrame()
boolean	isSelectable()
void	writeToParcel(android.os.Parcel dest, int flags)

Methods inherited from class ly.img.android.sdk.models.config.AbstractConfig

createViewHolder, generateBindData, generateBindDataAsync, getName, getThumbnailBitmap, getThumbnailBitmap, getThumbnailResId, getTitle, getVerticalLayout, hasStaticThumbnail, isClickable, isDirty, setDirtyFlag

Methods inherited from class java.lang.Object

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

Methods inherited from interface ly.img.android.sdk.models.config.DataSourceInterface

createViewHolder, generateBindData, generateBindDataAsync, getName, getVerticalLayout, isDirty, setDirtyFlag

Field Detail

CREATOR

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

Constructor Detail

FrameConfig

public FrameConfig(@StringRes
                   int name,
                   @DrawableRes @RawRes
                   int drawableId,
                   @DrawableRes @RawRes
                   int frameId,
                   @Nullable
                   AbstractConfig.AspectConfigInterface aspectConfig,
                   int groupId)

Creates a Frame Config

Parameters:

name - name of this frame

drawableId - preview icon resource

frameId - the frame image resource

aspectConfig - the aspect that enable this frame.

groupId - the group number to identifier a equal frame with different aspect. If the crop aspect changed the unfitting frame are replaced with a frame that fit the aspect and has the same group id.

FrameConfig

public FrameConfig(@StringRes
                   int name,
                   @DrawableRes @RawRes
                   int drawableId,
                   @DrawableRes @RawRes
                   int frameId,
                   @DrawableRes @RawRes
                   int frameMaskId,
                   @Nullable
                   AbstractConfig.AspectConfigInterface aspectConfig,
                   int groupId)

Creates a Frame Config

Parameters:

name - name of this frame

drawableId - preview icon resource

frameId - the frame image resource

frameMaskId - the mask of this frame as a blank and white image, full black are 100% transparent full white are opaque. this is Usefull for use JPEG's frames.
!!! NOTE: if, your mask is an PNG image, you need to save it as an 24bit or 32bit png and add an extra pixel line with rainbow colors, this is because Android itself has an bug !!!

aspectConfig - the aspect that enable this frame.

groupId - the group number to identifier a equal frame with different aspect. If the crop aspect changed the unfitting frame are replaced with a frame that fit the aspect and has the same group id.

FrameConfig

protected FrameConfig(android.os.Parcel in)

Method Detail

createNonFrameConfig

public static FrameConfig createNonFrameConfig(@StringRes
                                               int name,
                                               @DrawableRes @RawRes
                                               int drawableId)

Creates the non-frame option to remove the frame

Parameters:

name - custom name of this option

drawableId - custom icon of this option

Returns:

the non-frame option.

getFrameId

@DrawableRes
 @RawRes
public int getFrameId()

Get frame drawable resource id, it can be a drawable or raw resource. can be a png or jpeg @see #getFrameMaskId()

Specified by:

getFrameId in interface AbstractConfig.FrameConfigInterface

Returns:

the drawable resource id;

getFrameMaskId

@DrawableRes
 @RawRes
public int getFrameMaskId()

This can get a separate mask drawable resource id, it can be a drawable or raw resource.

Specified by:

getFrameMaskId in interface AbstractConfig.FrameConfigInterface

Returns:

the drawable resource id;

hasMask

public boolean hasMask()

Specified by:

hasMask in interface AbstractConfig.FrameConfigInterface

isNonFrame

public boolean isNonFrame()

Specified by:

isNonFrame in interface AbstractConfig.FrameConfigInterface

getImageLimit

public android.graphics.Rect getImageLimit()

Gets the Region of the Image.

Specified by:

getImageLimit in interface AbstractConfig.FrameConfigInterface

Returns:

calculateOuterRect

public android.graphics.Rect calculateOuterRect(android.graphics.Rect inputFullRect)

Specified by:

calculateOuterRect in interface AbstractConfig.FrameConfigInterface

calculateOuterRect

public RelativeRect calculateOuterRect(RelativeRect inputFullRect)

Specified by:

calculateOuterRect in interface AbstractConfig.FrameConfigInterface

calculateInnerRect

public android.graphics.Rect calculateInnerRect(android.graphics.Rect inputFullRect)

Specified by:

calculateInnerRect in interface AbstractConfig.FrameConfigInterface

calculateInnerRect

public RelativeRect calculateInnerRect(RelativeRect inputFullRect)

Specified by:

calculateInnerRect in interface AbstractConfig.FrameConfigInterface

getFrameAspect

public float getFrameAspect()

Specified by:

getFrameAspect in interface AbstractConfig.FrameConfigInterface

getFrameLimit

public android.graphics.Rect getFrameLimit()

calculateScale

public float calculateScale(android.graphics.Rect inputFullRect)

Specified by:

calculateScale in interface AbstractConfig.FrameConfigInterface

calculateScale

public java.math.BigDecimal calculateScale(RelativeRect inputFullRect)

calculateOuterOffsetAndScale

public float[] calculateOuterOffsetAndScale()

Specified by:

calculateOuterOffsetAndScale in interface AbstractConfig.FrameConfigInterface

hasEqualAspect

public boolean hasEqualAspect(@Nullable
                              AbstractConfig.AspectConfigInterface o)

Specified by:

hasEqualAspect in interface AbstractConfig.AspectConfigInterface

Specified by:

hasEqualAspect in interface AbstractConfig.FrameConfigInterface

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getLayout

public int getLayout()

Description copied from interface: DataSourceInterface

Get the layout res id of the list item view.

Specified by:

getLayout in interface DataSourceInterface<AbstractConfig.BindData>

Returns:

Layout resource.

isSelectable

public boolean isSelectable()

Specified by:

isSelectable in interface DataSourceInterface<AbstractConfig.BindData>

getOuterLimit

public android.graphics.Rect getOuterLimit()

isFreeCrop

public boolean isFreeCrop()

Specified by:

isFreeCrop in interface AbstractConfig.AspectConfigInterface

getAspect

public float getAspect()

Specified by:

getAspect in interface AbstractConfig.AspectConfigInterface

getGroupId

public int getGroupId()

Specified by:

getGroupId in interface AbstractConfig.FrameConfigInterface

hasSpecificSize

public boolean hasSpecificSize()

Specified by:

hasSpecificSize in interface AbstractConfig.AspectConfigInterface

getCropWidth

public int getCropWidth()

Specified by:

getCropWidth in interface AbstractConfig.AspectConfigInterface

getCropHeight

public int getCropHeight()

Specified by:

getCropHeight in interface AbstractConfig.AspectConfigInterface

describeContents

public int describeContents()

Specified by:

describeContents in interface android.os.Parcelable

Overrides:

describeContents in class AbstractConfig

writeToParcel

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

Specified by:

writeToParcel in interface android.os.Parcelable

Overrides:

writeToParcel in class AbstractConfig