com.ftinc.scoop

Class Scoop

java.lang.Object

com.ftinc.scoop.Scoop

public class Scoop
extends java.lang.Object

Project: ThemeEngineTest Package: com.ftinc.scoop Created by drew.heavner on 6/7/16.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Scoop.Builder Initialization Builder

Method Summary

Modifier and Type	Method and Description
void	apply(android.app.Activity activity) Apply the current Flavor to the given activity based on the user's selected preference.
void	apply(android.content.Context context, android.view.Menu menu) Apply the attributed menu item tint to all the icons if the attribute R.attr#toolbarItemTint
void	applyDialog(android.app.Activity activity) Apply the current Flavors Dialog theme to the activity to give it a Dialog like appearance based on the user selected preference
void	bind(android.app.Activity activity) Bind all the annotated elements to a given activity
Scoop	bind(java.lang.Object obj, int toppingId, IBinding binding) Provide a custom binding to a certain topping id on a given object.
Scoop	bind(java.lang.Object obj, int toppingId, android.view.View view) Bind a view to a topping on a given object
Scoop	bind(java.lang.Object obj, int toppingId, android.view.View view, ColorAdapter colorAdapter) Bind a view to a topping on a given object with a specified color adapter
Scoop	bind(java.lang.Object obj, int toppingId, android.view.View view, ColorAdapter colorAdapter, android.view.animation.Interpolator interpolator) Bind a view to a topping on a given object with a specified color adapter and change animation interpolator
Scoop	bindStatusBar(android.app.Activity activity, int toppingId) Bind the status bar of an activity to a topping so that it's color is updated when the user/developer updates the color for that topping id
Scoop	bindStatusBar(android.app.Activity activity, int toppingId, android.view.animation.Interpolator interpolator) Bind the status bar of an activity to a topping so that it's color is updated when the user/developer updates the color for that topping id and animation it's color change using the provided interpolator
void	choose(Flavor item) Choose a given flavor
void	chooseDayNightMode(int mode) Choose the DayNight mode you want to use for selected day/night mode themes
Flavor	getCurrentFlavor() Get the current flavor to apply
int	getDayNightMode() Get the selected day night mode to use with certain themes
java.util.List<Flavor>	getFlavors() Get the list of available flavors that you can scoop from
static Scoop	getInstance()
static void	setDebug(boolean flag) Enable debug logging
static SugarCone	sugarCone() Deprecated. Please just use the getInstance() method of Scoop to access the bind methods
void	unbind(java.lang.Object obj) Unbind all bindings on a certain class
Scoop	update(int toppingId, int color) Update a topping, i.e.
static Scoop.Builder	waffleCone() Create a builder instance for this class to initialize the library

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static Scoop getInstance()

waffleCone

public static Scoop.Builder waffleCone()

Create a builder instance for this class to initialize the library

Returns:

the Builder to initialize the library with

sugarCone

@Deprecated
public static SugarCone sugarCone()

Deprecated. Please just use the getInstance() method of Scoop to access the bind methods

setDebug

public static void setDebug(boolean flag)

Enable debug logging

getDayNightMode

public int getDayNightMode()

Get the selected day night mode to use with certain themes

Returns:

the day night mode to use

getFlavors

public java.util.List<Flavor> getFlavors()

Get the list of available flavors that you can scoop from

Returns:

getCurrentFlavor

public Flavor getCurrentFlavor()

Get the current flavor to apply

Returns:

one scoop of ice cream

apply

public void apply(android.app.Activity activity)

Apply the current Flavor to the given activity based on the user's selected preference.

Parameters:

activity - the activity to apply the selected theme configuration to

applyDialog

public void applyDialog(android.app.Activity activity)

Apply the current Flavors Dialog theme to the activity to give it a Dialog like appearance based on the user selected preference

Parameters:

activity - the activity to apply the dialog theme to

apply

public void apply(android.content.Context context,
                  android.view.Menu menu)

Apply the attributed menu item tint to all the icons if the attribute R.attr#toolbarItemTint

Parameters:

context - the application context to derive the attr color from

menu - the menu to apply to

choose

public void choose(Flavor item)

Choose a given flavor

Parameters:

item - the flavor to scoop

chooseDayNightMode

public void chooseDayNightMode(int mode)

Choose the DayNight mode you want to use for selected day/night mode themes

Parameters:

mode - the daynight mode you wish to use

bind

public void bind(android.app.Activity activity)

Bind all the annotated elements to a given activity

Parameters:

activity - the activity to bind to

See Also:

BindTopping, BindToppingStatus

bind

public Scoop bind(java.lang.Object obj,
                  int toppingId,
                  android.view.View view)

Bind a view to a topping on a given object

Parameters:

obj - the class the view belongs to

toppingId - the id of the topping to bind to

view - the view to bind

Returns:

self for chaining

bind

public Scoop bind(java.lang.Object obj,
                  int toppingId,
                  android.view.View view,
                  ColorAdapter colorAdapter)

Bind a view to a topping on a given object with a specified color adapter

Parameters:

obj - the classs the view belongs to

toppingId - the id of the topping

view - the view to bind

colorAdapter - the color adapter to bind with

Returns:

self for chaining

bind

public Scoop bind(java.lang.Object obj,
                  int toppingId,
                  android.view.View view,
                  ColorAdapter colorAdapter,
                  android.view.animation.Interpolator interpolator)

Bind a view to a topping on a given object with a specified color adapter and change animation interpolator

Parameters:

obj - the class the view belongs to

toppingId - the id of the topping

view - the view to bind

colorAdapter - the color adapter to bind with

interpolator - the interpolator to use when switching colors

Returns:

self for chaining

bindStatusBar

public Scoop bindStatusBar(android.app.Activity activity,
                           int toppingId)

Bind the status bar of an activity to a topping so that it's color is updated when the user/developer updates the color for that topping id

Parameters:

activity - the activity whoes status bar to bind to

toppingId - the id of the topping to bind with

Returns:

self for chaining

bindStatusBar

public Scoop bindStatusBar(android.app.Activity activity,
                           int toppingId,
                           android.view.animation.Interpolator interpolator)

Bind the status bar of an activity to a topping so that it's color is updated when the user/developer updates the color for that topping id and animation it's color change using the provided interpolator

Parameters:

activity - the activity whoes status bar to bind to

toppingId - the id of the topping to bind with

interpolator - the interpolator that defines how the animation for the color change will run

Returns:

self for chaining

bind

public Scoop bind(java.lang.Object obj,
                  int toppingId,
                  IBinding binding)

Provide a custom binding to a certain topping id on a given object. This allows you to customize the changes between color on certain properties, i.e. Toppings, to define it to your use case

Parameters:

obj - the object to bind on

toppingId - the topping id to bind to

binding - the binding that defines how your custom properties are updated

Returns:

self for chaining

unbind

public void unbind(java.lang.Object obj)

Unbind all bindings on a certain class

Parameters:

obj - the class/object that you previously made bindings to (i.e. an Activity, or Fragment)

update

public Scoop update(int toppingId,
                    int color)

Update a topping, i.e. color property, with a new color and therefore sending it out to all your bindings

Parameters:

toppingId - the id of the topping you wish to update

color - the updated color to update to

Returns:

self for chaining.