com.furdei.furdroid.components.graphics.drawable

Class TintedDrawable

java.lang.Object

android.graphics.drawable.Drawable

android.graphics.drawable.DrawableContainer

android.graphics.drawable.StateListDrawable

com.furdei.furdroid.components.graphics.drawable.TintedDrawable

All Implemented Interfaces:

android.graphics.drawable.Drawable.Callback

public class TintedDrawable
extends android.graphics.drawable.StateListDrawable

TintedDrawable implements support for color tinting introduced in Android API 21. It takes another drawable as a 'pattern' for tinting and a tint color or a ColorStateList for state-based tinting.

You should provide pattern drawable and tint color or ColorStateList through constructor arguments. You can also customize tint mode by calling a setTintMode(android.graphics.PorterDuff.Mode) method. The default mode is the most commonly used PorterDuff.Mode.SRC_IN mode.

This implementation tints drawable resource by changing a pattern's color filter based on the state of TintedDrawable instance. It stores only one copy of the pattern drawable so does not consume a significant amount of additional memory.

Feel free to use TintedDrawable for both API 21 and lower. This implementation will use API 21 if running on Lollipop devices or higher and fall back to custom implementation on the lower API versions.

Author:

Stepan Furdey

See Also:

PorterDuff.Mode

Nested Class Summary

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

android.graphics.drawable.DrawableContainer.DrawableContainerState

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
static int	NO_TINT This color means 'no tint', e.g. the source drawable will be shown as is.

Constructor Summary

Constructors

Constructor and Description
TintedDrawable(android.graphics.drawable.Drawable patternDrawable, android.content.res.ColorStateList colorStateList)
TintedDrawable(android.graphics.drawable.Drawable patternDrawable, int tint)

Method Summary

Methods

Modifier and Type	Method and Description
void	applyTheme(android.content.res.Resources.Theme t) Applies the specified theme to this Drawable and its children.
boolean	canApplyTheme()
void	draw(android.graphics.Canvas canvas) Draw in its bounds (set via setBounds) respecting optional effects such as alpha (set via setAlpha) and color filter (set via setColorFilter).
int	getAlpha() Gets the current alpha value for the drawable. 0 means fully transparent, 255 means fully opaque.
android.graphics.ColorFilter	getColorFilter() Returns the current color filter, or null if none set.
android.graphics.drawable.Drawable.ConstantState	getConstantState() Return a Drawable.ConstantState instance that holds the shared state of this Drawable.
int	getIntrinsicHeight() Return the intrinsic height of the underlying drawable object.
int	getIntrinsicWidth() Return the intrinsic width of the underlying drawable object.
int	getMinimumHeight() Returns the minimum height suggested by this Drawable.
int	getMinimumWidth() Returns the minimum width suggested by this Drawable.
int	getOpacity() Return the opacity/transparency of this Drawable.
void	getOutline(android.graphics.Outline outline) Called to get the drawable to populate the Outline that defines its drawing area.
boolean	getPadding(android.graphics.Rect padding) Return in padding the insets suggested by this Drawable for placing content inside the drawable's bounds.
android.graphics.drawable.Drawable	getPatternDrawable() Returns a pattern drawable
android.graphics.Region	getTransparentRegion() Returns a Region representing the part of the Drawable that is completely transparent.
void	invalidateSelf() Use the current Drawable.Callback implementation to have this Drawable redrawn.
boolean	isAutoMirrored() Tells if this Drawable will be automatically mirrored when its layout direction is RTL right-to-left.
boolean	isStateful() Indicates whether this drawable will change its appearance based on state.
void	jumpToCurrentState() If this Drawable does transition animations between states, ask that it immediately jump to the current state and skip any active animations.
android.graphics.drawable.Drawable	mutate() Make this drawable mutable.
protected void	onBoundsChange(android.graphics.Rect bounds) Override this in your subclass to change appearance if you vary based on the bounds.
protected boolean	onLevelChange(int level) Override this in your subclass to change appearance if you vary based on level.
protected boolean	onStateChange(int[] state) Override this in your subclass to change appearance if you recognize the specified state.
void	scheduleSelf(Runnable what, long when) Use the current Drawable.Callback implementation to have this Drawable scheduled.
void	setAlpha(int alpha) Specify an alpha value for the drawable. 0 means fully transparent, and 255 means fully opaque.
void	setAutoMirrored(boolean mirrored) Set whether this Drawable is automatically mirrored when its layout direction is RTL (right-to left).
void	setChangingConfigurations(int configs) Set a mask of the configuration parameters for which this drawable may change, requiring that it be re-created.
void	setColorFilter(android.graphics.ColorFilter cf) Specify an optional color filter for the drawable.
void	setDither(boolean dither) Set to true to have the drawable dither its colors when drawn to a device with fewer than 8-bits per color component.
void	setFilterBitmap(boolean filter) Set to true to have the drawable filter its bitmap when scaled or rotated (for drawables that use bitmaps).
void	setHotspot(float x, float y) Specifies the hotspot's location within the drawable.
void	setHotspotBounds(int left, int top, int right, int bottom) Sets the bounds to which the hotspot is constrained, if they should be different from the drawable bounds.
void	setTint(int tint) Specifies a tint for this drawable.
void	setTintList(android.content.res.ColorStateList tint) Specifies a tint for this drawable as a color state list.
void	setTintMode(android.graphics.PorterDuff.Mode tintMode) Specifies a tint blending mode for this drawable.
boolean	setVisible(boolean visible, boolean restart) Set whether this Drawable is visible.
void	unscheduleSelf(Runnable what) Use the current Drawable.Callback implementation to have this Drawable unscheduled.

Methods inherited from class android.graphics.drawable.StateListDrawable

addState, inflate

Methods inherited from class android.graphics.drawable.DrawableContainer

getChangingConfigurations, getCurrent, invalidateDrawable, scheduleDrawable, selectDrawable, setConstantState, setEnterFadeDuration, setExitFadeDuration, unscheduleDrawable

Methods inherited from class android.graphics.drawable.Drawable

clearColorFilter, copyBounds, copyBounds, createFromPath, createFromResourceStream, createFromResourceStream, createFromStream, createFromXml, createFromXml, createFromXmlInner, createFromXmlInner, getBounds, getCallback, getDirtyBounds, getLevel, getState, inflate, isVisible, resolveOpacity, setBounds, setBounds, setCallback, setColorFilter, setLevel, setState

Methods inherited from class java.lang.Object

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

Field Detail

NO_TINT

public static final int NO_TINT

This color means 'no tint', e.g. the source drawable will be shown as is.

See Also:

Constant Field Values

Constructor Detail

TintedDrawable

public TintedDrawable(android.graphics.drawable.Drawable patternDrawable,
              android.content.res.ColorStateList colorStateList)

TintedDrawable

public TintedDrawable(android.graphics.drawable.Drawable patternDrawable,
              int tint)

Method Detail

draw

public void draw(android.graphics.Canvas canvas)

Draw in its bounds (set via setBounds) respecting optional effects such as alpha (set via setAlpha) and color filter (set via setColorFilter).

Overrides:

draw in class android.graphics.drawable.DrawableContainer

Parameters:

canvas - The canvas to draw into

setChangingConfigurations

public void setChangingConfigurations(int configs)

Set a mask of the configuration parameters for which this drawable may change, requiring that it be re-created.

Overrides:

setChangingConfigurations in class android.graphics.drawable.Drawable

Parameters:

configs - A mask of the changing configuration parameters, as defined by android.content.pm.ActivityInfo.

See Also:

android.content.pm.ActivityInfo

setDither

public void setDither(boolean dither)

Set to true to have the drawable dither its colors when drawn to a device with fewer than 8-bits per color component. This can improve the look on those devices, but can also slow down the drawing a little.

Overrides:

setDither in class android.graphics.drawable.DrawableContainer

Parameters:

dither -

setFilterBitmap

public void setFilterBitmap(boolean filter)

Set to true to have the drawable filter its bitmap when scaled or rotated (for drawables that use bitmaps). If the drawable does not use bitmaps, this call is ignored. This can improve the look when scaled or rotated, but also slows down the drawing.

Overrides:

setFilterBitmap in class android.graphics.drawable.Drawable

Parameters:

filter -

invalidateSelf

public void invalidateSelf()

Use the current Drawable.Callback implementation to have this Drawable redrawn. Does nothing if there is no Callback attached to the Drawable.

Overrides:

invalidateSelf in class android.graphics.drawable.Drawable

See Also:

Drawable.Callback.invalidateDrawable(android.graphics.drawable.Drawable), Drawable.getCallback(), Drawable.setCallback(android.graphics.drawable.Drawable.Callback)

scheduleSelf

public void scheduleSelf(Runnable what,
                long when)

Use the current Drawable.Callback implementation to have this Drawable scheduled. Does nothing if there is no Callback attached to the Drawable.

Overrides:

scheduleSelf in class android.graphics.drawable.Drawable

Parameters:

what - The action being scheduled.

when - The time (in milliseconds) to run.

See Also:

Drawable.Callback.scheduleDrawable(android.graphics.drawable.Drawable, java.lang.Runnable, long)

unscheduleSelf

public void unscheduleSelf(Runnable what)

Use the current Drawable.Callback implementation to have this Drawable unscheduled. Does nothing if there is no Callback attached to the Drawable.

Overrides:

unscheduleSelf in class android.graphics.drawable.Drawable

Parameters:

what - The runnable that you no longer want called.

See Also:

Drawable.Callback.unscheduleDrawable(android.graphics.drawable.Drawable, java.lang.Runnable)

setAlpha

public void setAlpha(int alpha)

Specify an alpha value for the drawable. 0 means fully transparent, and 255 means fully opaque.

Overrides:

setAlpha in class android.graphics.drawable.DrawableContainer

Parameters:

alpha -

getAlpha

public int getAlpha()

Gets the current alpha value for the drawable. 0 means fully transparent, 255 means fully opaque. This method is implemented by Drawable subclasses and the value returned is specific to how that class treats alpha. The default return value is 255 if the class does not override this method to return a value specific to its use of alpha.

Overrides:

getAlpha in class android.graphics.drawable.DrawableContainer

setColorFilter

public void setColorFilter(android.graphics.ColorFilter cf)

Specify an optional color filter for the drawable. Pass null to remove any existing color filter.

Overrides:

setColorFilter in class android.graphics.drawable.DrawableContainer

Parameters:

cf - the color filter to apply, or null to remove the existing color filter

setTint

public void setTint(int tint)

Specifies a tint for this drawable.

Setting a color filter via setColorFilter(android.graphics.ColorFilter) overrides tint.

Overrides:

setTint in class android.graphics.drawable.Drawable

Parameters:

tint - Color to use for tinting this drawable

See Also:

setTintMode(android.graphics.PorterDuff.Mode)

setTintList

public void setTintList(android.content.res.ColorStateList tint)

Specifies a tint for this drawable as a color state list.

Setting a color filter via setColorFilter(android.graphics.ColorFilter) overrides tint.

Overrides:

setTintList in class android.graphics.drawable.DrawableContainer

Parameters:

tint - Color state list to use for tinting this drawable, or null to clear the tint

See Also:

setTintMode(android.graphics.PorterDuff.Mode)

setTintMode

public void setTintMode(android.graphics.PorterDuff.Mode tintMode)

Specifies a tint blending mode for this drawable.

Setting a color filter via setColorFilter(android.graphics.ColorFilter) overrides tint.

Overrides:

setTintMode in class android.graphics.drawable.DrawableContainer

Parameters:

tintMode - Color state list to use for tinting this drawable, or null to clear the tint

getColorFilter

public android.graphics.ColorFilter getColorFilter()

Returns the current color filter, or null if none set.

Overrides:

getColorFilter in class android.graphics.drawable.Drawable

Returns:

the current color filter, or null if none set

setHotspot

public void setHotspot(float x,
              float y)

Specifies the hotspot's location within the drawable.

Overrides:

setHotspot in class android.graphics.drawable.DrawableContainer

Parameters:

x - The X coordinate of the center of the hotspot

y - The Y coordinate of the center of the hotspot

setHotspotBounds

public void setHotspotBounds(int left,
                    int top,
                    int right,
                    int bottom)

Sets the bounds to which the hotspot is constrained, if they should be different from the drawable bounds.

Overrides:

setHotspotBounds in class android.graphics.drawable.DrawableContainer

Parameters:

left -

top -

right -

bottom -

isStateful

public boolean isStateful()

Indicates whether this drawable will change its appearance based on state. Clients can use this to determine whether it is necessary to calculate their state and call setState.

Overrides:

isStateful in class android.graphics.drawable.StateListDrawable

Returns:

True if this drawable changes its appearance based on state, false otherwise.

See Also:

Drawable.setState(int[])

jumpToCurrentState

public void jumpToCurrentState()

If this Drawable does transition animations between states, ask that it immediately jump to the current state and skip any active animations.

Overrides:

jumpToCurrentState in class android.graphics.drawable.DrawableContainer

setVisible

public boolean setVisible(boolean visible,
                 boolean restart)

Set whether this Drawable is visible. This generally does not impact the Drawable's behavior, but is a hint that can be used by some Drawables, for example, to decide whether run animations.

Overrides:

setVisible in class android.graphics.drawable.DrawableContainer

Parameters:

visible - Set to true if visible, false if not.

restart - You can supply true here to force the drawable to behave as if it has just become visible, even if it had last been set visible. Used for example to force animations to restart.

Returns:

boolean Returns true if the new visibility is different than its previous state.

setAutoMirrored

public void setAutoMirrored(boolean mirrored)

Set whether this Drawable is automatically mirrored when its layout direction is RTL (right-to left). See LayoutDirection.

Overrides:

setAutoMirrored in class android.graphics.drawable.DrawableContainer

Parameters:

mirrored - Set to true if the Drawable should be mirrored, false if not.

isAutoMirrored

public boolean isAutoMirrored()

Tells if this Drawable will be automatically mirrored when its layout direction is RTL right-to-left. See LayoutDirection.

Overrides:

isAutoMirrored in class android.graphics.drawable.DrawableContainer

Returns:

boolean Returns true if this Drawable will be automatically mirrored.

applyTheme

public void applyTheme(android.content.res.Resources.Theme t)

Applies the specified theme to this Drawable and its children.

Overrides:

applyTheme in class android.graphics.drawable.DrawableContainer

Parameters:

t -

canApplyTheme

public boolean canApplyTheme()

Overrides:

canApplyTheme in class android.graphics.drawable.DrawableContainer

getOpacity

public int getOpacity()

Return the opacity/transparency of this Drawable. The returned value is one of the abstract format constants in PixelFormat: PixelFormat.UNKNOWN, PixelFormat.TRANSLUCENT, PixelFormat.TRANSPARENT, or PixelFormat.OPAQUE.

Generally a Drawable should be as conservative as possible with the value it returns. For example, if it contains multiple child drawables and only shows one of them at a time, if only one of the children is TRANSLUCENT and the others are OPAQUE then TRANSLUCENT should be returned. You can use the method Drawable.resolveOpacity(int, int) to perform a standard reduction of two opacities to the appropriate single output.

Note that the returned value does not take into account a custom alpha or color filter that has been applied by the client through the setAlpha(int) or setColorFilter(android.graphics.ColorFilter) methods.

Overrides:

getOpacity in class android.graphics.drawable.DrawableContainer

Returns:

int The opacity class of the Drawable.

See Also:

PixelFormat

getTransparentRegion

public android.graphics.Region getTransparentRegion()

Returns a Region representing the part of the Drawable that is completely transparent. This can be used to perform drawing operations, identifying which parts of the target will not change when rendering the Drawable. The default implementation returns null, indicating no transparent region; subclasses can optionally override this to return an actual Region if they want to supply this optimization information, but it is not required that they do so.

Overrides:

getTransparentRegion in class android.graphics.drawable.Drawable

Returns:

Returns null if the Drawables has no transparent region to report, else a Region holding the parts of the Drawable's bounds that are transparent.

onStateChange

protected boolean onStateChange(int[] state)

Override this in your subclass to change appearance if you recognize the specified state.

Overrides:

onStateChange in class android.graphics.drawable.StateListDrawable

Parameters:

state -

Returns:

Returns true if the state change has caused the appearance of the Drawable to change (that is, it needs to be drawn), else false if it looks the same and there is no need to redraw it since its last state.

onLevelChange

protected boolean onLevelChange(int level)

Override this in your subclass to change appearance if you vary based on level.

Overrides:

onLevelChange in class android.graphics.drawable.DrawableContainer

Parameters:

level -

Returns:

Returns true if the level change has caused the appearance of the Drawable to change (that is, it needs to be drawn), else false if it looks the same and there is no need to redraw it since its last level.

onBoundsChange

protected void onBoundsChange(android.graphics.Rect bounds)

Override this in your subclass to change appearance if you vary based on the bounds.

Overrides:

onBoundsChange in class android.graphics.drawable.DrawableContainer

Parameters:

bounds -

getIntrinsicWidth

public int getIntrinsicWidth()

Return the intrinsic width of the underlying drawable object. Returns -1 if it has no intrinsic width, such as with a solid color.

Overrides:

getIntrinsicWidth in class android.graphics.drawable.DrawableContainer

getIntrinsicHeight

public int getIntrinsicHeight()

Return the intrinsic height of the underlying drawable object. Returns -1 if it has no intrinsic height, such as with a solid color.

Overrides:

getIntrinsicHeight in class android.graphics.drawable.DrawableContainer

getMinimumWidth

public int getMinimumWidth()

Returns the minimum width suggested by this Drawable. If a View uses this Drawable as a background, it is suggested that the View use at least this value for its width. (There will be some scenarios where this will not be possible.) This value should INCLUDE any padding.

Overrides:

getMinimumWidth in class android.graphics.drawable.DrawableContainer

Returns:

The minimum width suggested by this Drawable. If this Drawable doesn't have a suggested minimum width, 0 is returned.

getMinimumHeight

public int getMinimumHeight()

Returns the minimum height suggested by this Drawable. If a View uses this Drawable as a background, it is suggested that the View use at least this value for its height. (There will be some scenarios where this will not be possible.) This value should INCLUDE any padding.

Overrides:

getMinimumHeight in class android.graphics.drawable.DrawableContainer

Returns:

The minimum height suggested by this Drawable. If this Drawable doesn't have a suggested minimum height, 0 is returned.

getPadding

public boolean getPadding(android.graphics.Rect padding)

Return in padding the insets suggested by this Drawable for placing content inside the drawable's bounds. Positive values move toward the center of the Drawable (set Rect.inset).

Overrides:

getPadding in class android.graphics.drawable.DrawableContainer

Parameters:

padding -

Returns:

true if this drawable actually has a padding, else false. When false is returned, the padding is always set to 0.

getOutline

public void getOutline(android.graphics.Outline outline)

Called to get the drawable to populate the Outline that defines its drawing area.

This method is called by the default ViewOutlineProvider to define the outline of the View.

The default behavior defines the outline to be the bounding rectangle of 0 alpha. Subclasses that wish to convey a different shape or alpha value must override this method.

Overrides:

getOutline in class android.graphics.drawable.DrawableContainer

Parameters:

outline -

See Also:

View.setOutlineProvider(android.view.ViewOutlineProvider)

mutate

public android.graphics.drawable.Drawable mutate()

Make this drawable mutable. This operation cannot be reversed. A mutable drawable is guaranteed to not share its state with any other drawable. This is especially useful when you need to modify properties of drawables loaded from resources. By default, all drawables instances loaded from the same resource share a common state; if you modify the state of one instance, all the other instances will receive the same modification.

Calling this method on a mutable Drawable will have no effect.

Overrides:

mutate in class android.graphics.drawable.StateListDrawable

Returns:

This drawable.

See Also:

Drawable.ConstantState, getConstantState()

getConstantState

public android.graphics.drawable.Drawable.ConstantState getConstantState()

Return a Drawable.ConstantState instance that holds the shared state of this Drawable.

Overrides:

getConstantState in class android.graphics.drawable.DrawableContainer

Returns:

The ConstantState associated to that Drawable.

See Also:

Drawable.ConstantState, Drawable.mutate()

getPatternDrawable

public android.graphics.drawable.Drawable getPatternDrawable()

Returns a pattern drawable