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:

AspectConfigInterface, DataSourceInterface<AbstractConfig.BindData>, FrameConfigInterface

public class FrameConfig
extends AbstractConfig
implements FrameConfigInterface

Nested Class Summary

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

AbstractConfig.BindData

Field Summary

Fields

Modifier and Type	Field and Description
static <any>	CREATOR

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

isDirty, ORIGINAL_THUMBNAIL_SIZE

Constructor Summary

Constructors

Modifier	Constructor and Description
	FrameConfig(int name, int drawableId, CustomPatchFrameConfig frameConfig) Creates a Frame Config with unspecific aspect
	FrameConfig(int name, int drawableId, CustomPatchFrameConfig frameConfig, float fixedRelativeScale) Creates a Frame Config with unspecific aspect
	FrameConfig(int name, int drawableId, int frameId, AspectConfigInterface aspectConfig, int groupId) Creates a Frame Config
	FrameConfig(int name, int drawableId, int frameId, int frameMaskId, AspectConfigInterface aspectConfig, int groupId) Creates a Frame Config
protected	FrameConfig(Parcel in)

Method Summary

Modifier and Type	Method and Description
Rect	calculateInnerRect(Rect inputFullRect)
float[]	calculateOuterOffsetAndScale()
Rect	calculateOuterRect(Rect inputFullRect)
float	calculateScale(Rect 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)
java.math.BigDecimal	getAspect()
int	getCropHeight()
int	getCropWidth()
float	getFixedRelativeScale()
java.math.BigDecimal	getFrameAspect()
CustomPatchFrameConfig	getFrameConfig()
Rect	getFrameLimit()
ImageSource	getFrameMaskSource() This can get a separate mask ImageSource, it can be also null.
ImageSource	getFrameSource() Get frame image source, it can be null.
int	getGroupId()
Rect	getImageLimit() Gets the Region of the Image.
int	getLayout() Get the layout res id of the list item view.
Rect	getOuterLimit()
boolean	hasEqualAspect(AspectConfigInterface o)
boolean	hasFixedRelativeScale()
int	hashCode()
boolean	hasMask()
boolean	hasSpecificSize()
boolean	isAspectFittingFrame()
boolean	isFreeCrop()
boolean	isNonFrame()
boolean	isSelectable()
void	writeToParcel(Parcel dest, int flags)

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

createViewHolder, generateBindData, generateBindDataAsync, getName, getThumbnailBitmap, getThumbnailBitmap, getThumbnailResId, getThumbnailSource, 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.interfaces.DataSourceInterface

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

Field Detail

CREATOR

public static final <any> CREATOR

Constructor Detail

FrameConfig

public FrameConfig(@StringRes
                   int name,
                   @DrawableRes
                   int drawableId,
                   CustomPatchFrameConfig frameConfig)

Creates a Frame Config with unspecific aspect

Parameters:

name - name of this frame

drawableId - preview icon resource

frameConfig - the frame image resource

FrameConfig

public FrameConfig(@StringRes
                   int name,
                   @DrawableRes
                   int drawableId,
                   CustomPatchFrameConfig frameConfig,
                   float fixedRelativeScale)

Creates a Frame Config with unspecific aspect

Parameters:

name - name of this frame

drawableId - preview icon resource

frameConfig - the frame image resource

FrameConfig

public FrameConfig(@StringRes
                   int name,
                   @DrawableRes
                   int drawableId,
                   @DrawableRes
                   int frameId,
                   @Nullable
                   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
                   int drawableId,
                   @DrawableRes
                   int frameId,
                   @DrawableRes
                   int frameMaskId,
                   @Nullable
                   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(Parcel in)

Method Detail

calculateInnerRect

public Rect calculateInnerRect(Rect inputFullRect)

Specified by:

calculateInnerRect in interface FrameConfigInterface

calculateOuterOffsetAndScale

public float[] calculateOuterOffsetAndScale()

Specified by:

calculateOuterOffsetAndScale in interface FrameConfigInterface

calculateOuterRect

public Rect calculateOuterRect(Rect inputFullRect)

Specified by:

calculateOuterRect in interface FrameConfigInterface

calculateScale

public float calculateScale(Rect inputFullRect)

Specified by:

calculateScale in interface FrameConfigInterface

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.

describeContents

public int describeContents()

Overrides:

describeContents in class AbstractConfig

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

getAspect

public java.math.BigDecimal getAspect()

Specified by:

getAspect in interface AspectConfigInterface

getCropHeight

public int getCropHeight()

Specified by:

getCropHeight in interface AspectConfigInterface

getCropWidth

public int getCropWidth()

Specified by:

getCropWidth in interface AspectConfigInterface

getFixedRelativeScale

public float getFixedRelativeScale()

Specified by:

getFixedRelativeScale in interface FrameConfigInterface

getFrameAspect

public java.math.BigDecimal getFrameAspect()

Specified by:

getFrameAspect in interface FrameConfigInterface

getFrameConfig

public CustomPatchFrameConfig getFrameConfig()

Specified by:

getFrameConfig in interface FrameConfigInterface

getFrameLimit

public Rect getFrameLimit()

getFrameMaskSource

@Nullable
public ImageSource getFrameMaskSource()

This can get a separate mask ImageSource, it can be also null.

Specified by:

getFrameMaskSource in interface FrameConfigInterface

Returns:

the image source;

getFrameSource

@Nullable
public ImageSource getFrameSource()

Get frame image source, it can be null. can be a non transparent source @see #getFrameMaskSource()

Specified by:

getFrameSource in interface FrameConfigInterface

Returns:

the image source;

getGroupId

public int getGroupId()

Specified by:

getGroupId in interface FrameConfigInterface

getImageLimit

public Rect getImageLimit()

Gets the Region of the Image.

Specified by:

getImageLimit in interface FrameConfigInterface

Returns:

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.

getOuterLimit

public Rect getOuterLimit()

hasEqualAspect

public boolean hasEqualAspect(@Nullable
                              AspectConfigInterface o)

Specified by:

hasEqualAspect in interface AspectConfigInterface

Specified by:

hasEqualAspect in interface FrameConfigInterface

hasFixedRelativeScale

public boolean hasFixedRelativeScale()

Specified by:

hasFixedRelativeScale in interface FrameConfigInterface

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

hasMask

public boolean hasMask()

Specified by:

hasMask in interface FrameConfigInterface

hasSpecificSize

public boolean hasSpecificSize()

Specified by:

hasSpecificSize in interface AspectConfigInterface

isAspectFittingFrame

public boolean isAspectFittingFrame()

Specified by:

isAspectFittingFrame in interface FrameConfigInterface

isFreeCrop

public boolean isFreeCrop()

Specified by:

isFreeCrop in interface AspectConfigInterface

isNonFrame

public boolean isNonFrame()

Specified by:

isNonFrame in interface FrameConfigInterface

isSelectable

public boolean isSelectable()

Specified by:

isSelectable in interface DataSourceInterface<AbstractConfig.BindData>

writeToParcel

public void writeToParcel(Parcel dest,
                          int flags)

Overrides:

writeToParcel in class AbstractConfig