com.actinarium.rhythm

Class RhythmDrawable

java.lang.Object

android.graphics.drawable.Drawable

com.actinarium.rhythm.RhythmDrawable

public class RhythmDrawable
extends android.graphics.drawable.Drawable

Renders the currently assigned RhythmOverlay and serves as an adapter between Rhythm (which sets the overlay to draw by this drawable at the moment) and the views where the overlay (grids, keylines etc) must be applied. You can use it as any other Drawable from Android SDK, e.g. assign it as background, foreground, overlay etc, but keep in mind that for different views, separate drawable instances must be created.

For easy integration with existing layouts, RhythmDrawable can decorate another Drawable — that is, draw the decorated one below and then the overlay atop. This can be especially useful when decorating the views that already have backgrounds. Note: as of this version, decoration logic is very limited for the sake of simplicity, therefore in some cases (e.g. when decorated drawable is a state list or a level list), it may not respond correctly to state and level changes (e.g. pressing a decorated button won’t highlight it). But since decoration is mostly intended for ViewGroups, it’s unlikely that this should be an issue under normal use.

Normally you shouldn’t extend this class. If you need to perform custom drawing, consider creating a custom RhythmSpecLayer implementation instead.

Nested Class Summary

Nested classes/interfaces inherited from class android.graphics.drawable.Drawable

android.graphics.drawable.Drawable.Callback, android.graphics.drawable.Drawable.ConstantState

Field Summary

Fields

Modifier and Type	Field and Description
protected android.graphics.drawable.Drawable	mDecorated
protected RhythmOverlay	mOverlay

Constructor Summary

Constructors

Constructor and Description
RhythmDrawable(RhythmOverlay overlay) Create a Rhythm drawable for given Rhythm overlay.

Method Summary

Modifier and Type	Method and Description
void	draw(android.graphics.Canvas canvas)
android.graphics.drawable.Drawable	getDecorated() Get decorated drawable (the one drawn under the overlay) if present
int	getOpacity()
RhythmOverlay	getOverlay() Get current overlay
boolean	getPadding(android.graphics.Rect padding)
int[]	getState()
boolean	isStateful()
protected void	onBoundsChange(android.graphics.Rect bounds)
protected boolean	onLevelChange(int level)
protected boolean	onStateChange(int[] state)
void	setAlpha(int alpha)
void	setColorFilter(android.graphics.ColorFilter colorFilter)
void	setDecorated(android.graphics.drawable.Drawable decorated) Set a Drawable to decorate.
void	setOverlay(RhythmOverlay overlay) Set a RhythmOverlay for this drawable.
boolean	setState(int[] stateSet)

Methods inherited from class android.graphics.drawable.Drawable

applyTheme, canApplyTheme, clearColorFilter, copyBounds, copyBounds, createFromPath, createFromResourceStream, createFromResourceStream, createFromStream, createFromXml, createFromXml, createFromXmlInner, createFromXmlInner, getAlpha, getBounds, getCallback, getChangingConfigurations, getColorFilter, getConstantState, getCurrent, getDirtyBounds, getHotspotBounds, getIntrinsicHeight, getIntrinsicWidth, getLayoutDirection, getLevel, getMinimumHeight, getMinimumWidth, getOutline, getTransparentRegion, inflate, inflate, invalidateSelf, isAutoMirrored, isFilterBitmap, isVisible, jumpToCurrentState, mutate, onLayoutDirectionChanged, resolveOpacity, scheduleSelf, setAutoMirrored, setBounds, setBounds, setCallback, setChangingConfigurations, setColorFilter, setDither, setFilterBitmap, setHotspot, setHotspotBounds, setLayoutDirection, setLevel, setTint, setTintList, setTintMode, setVisible, unscheduleSelf

Methods inherited from class java.lang.Object

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

Field Detail

mOverlay

protected RhythmOverlay mOverlay

mDecorated

protected android.graphics.drawable.Drawable mDecorated

Constructor Detail

RhythmDrawable

public RhythmDrawable(@Nullable
                      RhythmOverlay overlay)

Create a Rhythm drawable for given Rhythm overlay. You can then change the displayed overlay via setOverlay(RhythmOverlay) method.

Parameters:

overlay - Rhythm overlay to render into this drawable, can be null.

Method Detail

draw

public void draw(android.graphics.Canvas canvas)

Specified by:

draw in class android.graphics.drawable.Drawable

getOverlay

public RhythmOverlay getOverlay()

Get current overlay

Returns:

Currently active Rhythm overlay, or null if no overlay is set

setOverlay

public void setOverlay(@Nullable
                       RhythmOverlay overlay)

Set a RhythmOverlay for this drawable. Will request redraw of this drawable’s view.

Parameters:

overlay - Overlay to draw. Provide null to disable overlay.

getDecorated

public android.graphics.drawable.Drawable getDecorated()

Get decorated drawable (the one drawn under the overlay) if present

Returns:

Decorated drawable or null

setDecorated

public void setDecorated(@Nullable
                         android.graphics.drawable.Drawable decorated)

Set a Drawable to decorate. Should be used when decorating an existing background or foreground of a view — this way the original drawable will be preserved and the overlay will be drawn atop. Note: to function properly, the decorated drawable’s callbacks must be set. Also see the class’ description for more info on decoration support.

Parameters:

decorated - A drawable to draw below the overlay. Set null to remove decorated drawable.

setAlpha

public void setAlpha(int alpha)

Specified by:

setAlpha in class android.graphics.drawable.Drawable

setColorFilter

public void setColorFilter(android.graphics.ColorFilter colorFilter)

Specified by:

setColorFilter in class android.graphics.drawable.Drawable

getOpacity

public int getOpacity()

Specified by:

getOpacity in class android.graphics.drawable.Drawable

isStateful

public boolean isStateful()

Overrides:

isStateful in class android.graphics.drawable.Drawable

setState

public boolean setState(int[] stateSet)

Overrides:

setState in class android.graphics.drawable.Drawable

getState

public int[] getState()

Overrides:

getState in class android.graphics.drawable.Drawable

getPadding

public boolean getPadding(@NonNull
                          android.graphics.Rect padding)

Overrides:

getPadding in class android.graphics.drawable.Drawable

onStateChange

protected boolean onStateChange(int[] state)

Overrides:

onStateChange in class android.graphics.drawable.Drawable

onLevelChange

protected boolean onLevelChange(int level)

Overrides:

onLevelChange in class android.graphics.drawable.Drawable

onBoundsChange

protected void onBoundsChange(android.graphics.Rect bounds)

Overrides:

onBoundsChange in class android.graphics.drawable.Drawable