co.lemnisk.app.android.carousel.SliderTypes

Class BaseSliderView

java.lang.Object

co.lemnisk.app.android.carousel.SliderTypes.Buttons

co.lemnisk.app.android.carousel.SliderTypes.BaseSliderView

Direct Known Subclasses:

DefaultSliderView, TextSliderView

public abstract class BaseSliderView
extends Buttons

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	BaseSliderView.ImageLoadListener
static interface	BaseSliderView.OnSliderClickListener
static class	BaseSliderView.ScaleType

Field Summary

Fields

Modifier and Type	Field and Description
protected android.content.Context	mContext
protected BaseSliderView.OnSliderClickListener	mOnSliderClickListener

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseSliderView(android.content.Context context)

Method Summary

Modifier and Type	Method and Description
BaseSliderView	align(java.lang.String align) the layout elements alignment a slider image.
protected void	bindEventAndShow(android.view.View v, android.widget.ImageView targetImageView) When you want to implement your own slider view, please call this method in the end in `getView()` method
BaseSliderView	blockAlign(java.lang.String align) the layout elements alignment a slider image.
BaseSliderView	bundle(android.os.Bundle bundle) lets users add a bundle of additional information
BaseSliderView	button(java.lang.String button, int index) the button of a slider image.
BaseSliderView	buttonColor(java.lang.String buttonColor, int index) the button color of a slider image.
BaseSliderView	buttonDeepLink(java.lang.String buttonDeepLink, int index) the button color of a slider image.
BaseSliderView	buttonSize(int buttonSize, int index) the button size of a slider image.
BaseSliderView	buttonTextColor(java.lang.String buttonTextColor, int index) the button text color of a slider image.
BaseSliderView	deeplink(java.lang.String deeplink) the deeplink of a slider image.
BaseSliderView	description(java.lang.String description) the description of a slider image.
BaseSliderView	descriptionColor(java.lang.String descriptionColor) the description color of a slider image.
BaseSliderView	descriptionSize(int descriptionSize) the description size of a slider image.
BaseSliderView	empty(int resId) the placeholder image when loading image from url or file.
BaseSliderView	error(int resId) if you set errorDisappear false, this will set a error placeholder image.
BaseSliderView	errorDisappear(boolean disappear) determine whether remove the image which failed to download or load from file
int	getAlignment()
int[]	getBlockAlignment()
android.os.Bundle	getBundle() when you have some extra information, please put it in this bundle.
protected java.lang.String	getButton(int index)
protected java.lang.String	getButtonColor(int index)
protected java.lang.String	getButtonDeepLink(int index)
protected int	getButtonSize(int index)
protected java.lang.String	getButtonTextColor(int index)
android.content.Context	getContext()
protected java.lang.String	getDeepLink()
protected java.lang.String	getDescription()
protected java.lang.String	getDescriptionColor()
protected int	getDescriptionSize()
protected int	getDpFromPixels(int pixels)
protected int	getEmpty()
protected int	getError()
android.os.Bundle	getmExtras()
int	getNumberOfButtons()
com.squareup.picasso.Picasso	getPicasso() Get the last instance set via setPicasso(), or null if no user provided instance was set
BaseSliderView.ScaleType	getScaleType()
protected int	getTitleSize()
protected java.lang.String	getTitleText()
protected java.lang.String	getTitleTextColor()
protected java.lang.String	getUrl()
abstract android.view.View	getView() the extended class have to implement getView(), which is called by the adapter, every extended class response to render their own view.
BaseSliderView	image(java.io.File file) set a file as a image that will to load
BaseSliderView	image(int res)
BaseSliderView	image(java.lang.String url) set a url as a image that preparing to load
boolean	isErrorDisappear()
BaseSliderView	numberOfButtons(int numberOfButtons) the number of buttons of a slider image.
BaseSliderView	onClick(java.lang.String mDeepLink) set a slider image click listener
void	setmExtras(android.os.Bundle mExtras)
void	setOnImageLoadListener(BaseSliderView.ImageLoadListener l) set a listener to get a message , if load error.
BaseSliderView	setOnSliderClickListener(BaseSliderView.OnSliderClickListener l) set a slider image click listener
void	setPicasso(com.squareup.picasso.Picasso picasso) Provide a Picasso instance to use when loading pictures, this is useful if you have a particular HTTP cache you would like to share.
BaseSliderView	setScaleType(BaseSliderView.ScaleType type)
BaseSliderView	title(java.lang.String title) the title of a slider image.
BaseSliderView	titleColor(java.lang.String titleColor) the title color of a slider image.
BaseSliderView	titleSize(int titleSize) the title of a slider image.

Methods inherited from class co.lemnisk.app.android.carousel.SliderTypes.Buttons

getmButton, getmButtonColor, getmButtonDeepLink, getmButtonLandingPage, getmButtonSize, getmButtonTextColor, setmButton, setmButtonColor, setmButtonDeepLink, setmButtonLandingPage, setmButtonSize, setmButtonTextColor

Methods inherited from class java.lang.Object

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

Field Detail

mContext

protected android.content.Context mContext

mOnSliderClickListener

protected BaseSliderView.OnSliderClickListener mOnSliderClickListener

Constructor Detail

BaseSliderView

protected BaseSliderView(android.content.Context context)

Method Detail

empty

public BaseSliderView empty(int resId)

the placeholder image when loading image from url or file.

Parameters:

resId - Image resource id

errorDisappear

public BaseSliderView errorDisappear(boolean disappear)

determine whether remove the image which failed to download or load from file

error

public BaseSliderView error(int resId)

if you set errorDisappear false, this will set a error placeholder image.

Parameters:

resId - image resource id

title

public BaseSliderView title(java.lang.String title)

the title of a slider image.

description

public BaseSliderView description(java.lang.String description)

the description of a slider image.

deeplink

public BaseSliderView deeplink(java.lang.String deeplink)

the deeplink of a slider image.

numberOfButtons

public BaseSliderView numberOfButtons(int numberOfButtons)

the number of buttons of a slider image.

button

public BaseSliderView button(java.lang.String button,
                             int index)

the button of a slider image.

titleSize

public BaseSliderView titleSize(int titleSize)

the title of a slider image.

descriptionSize

public BaseSliderView descriptionSize(int descriptionSize)

the description size of a slider image.

buttonSize

public BaseSliderView buttonSize(int buttonSize,
                                 int index)

the button size of a slider image.

titleColor

public BaseSliderView titleColor(java.lang.String titleColor)

the title color of a slider image.

descriptionColor

public BaseSliderView descriptionColor(java.lang.String descriptionColor)

the description color of a slider image.

buttonTextColor

public BaseSliderView buttonTextColor(java.lang.String buttonTextColor,
                                      int index)

the button text color of a slider image.

buttonColor

public BaseSliderView buttonColor(java.lang.String buttonColor,
                                  int index)

the button color of a slider image.

buttonDeepLink

public BaseSliderView buttonDeepLink(java.lang.String buttonDeepLink,
                                     int index)

the button color of a slider image.

align

public BaseSliderView align(java.lang.String align)

the layout elements alignment a slider image.

blockAlign

public BaseSliderView blockAlign(java.lang.String align)

the layout elements alignment a slider image.

image

public BaseSliderView image(java.lang.String url)

set a url as a image that preparing to load

image

public BaseSliderView image(java.io.File file)

set a file as a image that will to load

image

public BaseSliderView image(int res)

bundle

public BaseSliderView bundle(android.os.Bundle bundle)

lets users add a bundle of additional information

getUrl

protected java.lang.String getUrl()

isErrorDisappear

public boolean isErrorDisappear()

getEmpty

protected int getEmpty()

getError

protected int getError()

getDescription

protected java.lang.String getDescription()

getTitleText

protected java.lang.String getTitleText()

getDeepLink

protected java.lang.String getDeepLink()

getButton

protected java.lang.String getButton(int index)

getTitleSize

protected int getTitleSize()

getDescriptionSize

protected int getDescriptionSize()

getButtonSize

protected int getButtonSize(int index)

getTitleTextColor

protected java.lang.String getTitleTextColor()

getDescriptionColor

protected java.lang.String getDescriptionColor()

getButtonTextColor

protected java.lang.String getButtonTextColor(int index)

getButtonColor

protected java.lang.String getButtonColor(int index)

getButtonDeepLink

protected java.lang.String getButtonDeepLink(int index)

getAlignment

public int getAlignment()

getBlockAlignment

public int[] getBlockAlignment()

getNumberOfButtons

public int getNumberOfButtons()

getContext

public android.content.Context getContext()

setOnSliderClickListener

public BaseSliderView setOnSliderClickListener(BaseSliderView.OnSliderClickListener l)

set a slider image click listener

onClick

public BaseSliderView onClick(java.lang.String mDeepLink)

set a slider image click listener

bindEventAndShow

protected void bindEventAndShow(android.view.View v,
                                android.widget.ImageView targetImageView)

When you want to implement your own slider view, please call this method in the end in `getView()` method

Parameters:

v - the whole view

targetImageView - where to place image

setScaleType

public BaseSliderView setScaleType(BaseSliderView.ScaleType type)

getScaleType

public BaseSliderView.ScaleType getScaleType()

getView

public abstract android.view.View getView()

the extended class have to implement getView(), which is called by the adapter, every extended class response to render their own view.

getDpFromPixels

protected int getDpFromPixels(int pixels)

setOnImageLoadListener

public void setOnImageLoadListener(BaseSliderView.ImageLoadListener l)

set a listener to get a message , if load error.

getBundle

public android.os.Bundle getBundle()

when you have some extra information, please put it in this bundle.

getPicasso

public com.squareup.picasso.Picasso getPicasso()

Get the last instance set via setPicasso(), or null if no user provided instance was set

Returns:

The current user-provided Picasso instance, or null if none

setPicasso

public void setPicasso(com.squareup.picasso.Picasso picasso)

Provide a Picasso instance to use when loading pictures, this is useful if you have a particular HTTP cache you would like to share.

Parameters:

picasso - The Picasso instance to use, may be null to let the system use the default instance

getmExtras

public android.os.Bundle getmExtras()

setmExtras

public void setmExtras(android.os.Bundle mExtras)