ContextQMD
Back to Fresco

FadeDrawable

docs/javadoc/reference/com/facebook/drawee/drawable/FadeDrawable.html

3.6.030.0 KB
Original Source

Fresco

|

|

Packages | Classes

Interfaces

Classes

Enums

Packages | Classes

Summary: Nested Classes | Constants | Ctors | Methods | Protected Methods | Inherited Methods | [Expand All]

public class

FadeDrawable

extends ArrayDrawable

| java.lang.Object | | ↳ | android.graphics.drawable.Drawable | | | ↳ | com.facebook.drawee.drawable.ArrayDrawable | | | | ↳ | com.facebook.drawee.drawable.FadeDrawable |

Class Overview

A drawable that fades to the specific layer.

Arbitrary number of layers is supported. 5 Different fade methods are supported. Once the transition starts we will animate layers in or out based on used fade method. fadeInLayer fades in specified layer to full opacity. fadeOutLayer fades out specified layer to zero opacity. fadeOutAllLayers fades out all layers to zero opacity. fadeToLayer fades in specified layer to full opacity, fades out all other layers to zero opacity. fadeUpToLayer fades in all layers up to specified layer to full opacity and fades out all other layers to zero opacity.

Summary

Nested Classes
interface
Constants
int
int
int
Public Constructors
Creates a new fade drawable.
Creates a new fade drawable.
Public Methods
void
Begins the batch mode so that it doesn't invalidate self on every operation.
void
void
Ends the batch mode and invalidates.
void
Starts fading in all layers.
void
Starts fading in the specified layer.
void
Starts fading out all layers.
void
Starts fading out the specified layer.
void
Starts fading to the specified layer.
void
Starts fading up to the specified layer.
void
Finishes transition immediately.
int
int
Gets the transition duration.
int
Gets the transition state (STARTING, RUNNING, NONE).
void
Makes the specified layer fully transparent
void
boolean
boolean
void
Resets to the initial state.
void
void
void
Sets the duration of the current transition in milliseconds.
void
Makes the specified layer fully opaque
Protected Methods
long
Returns current time.

| [Expand] Inherited Methods | | --- | | From class com.facebook.drawee.drawable.ArrayDrawable

| void | draw(Canvas canvas) | | Drawable | getDrawable(int index) Gets the drawable at the specified index. | | DrawableParent | getDrawableParentForIndex(int index) Gets the DrawableParent for index. | | int | getIntrinsicHeight() | | int | getIntrinsicWidth() | | int | getNumberOfLayers() Gets the number of layers. | | int | getOpacity() | | boolean | getPadding(Rect padding) | | void | getRootBounds(RectF bounds) Called when the drawable needs to get its root bounds. | | void | getTransform(Matrix transform) TransformationCallback methods | | void | invalidateDrawable(Drawable who) Drawable.Callback methods | | boolean | isStateful() | | Drawable | mutate() | | void | onBoundsChange(Rect bounds) | | boolean | onLevelChange(int level) | | boolean | onStateChange(int[] state) | | void | scheduleDrawable(Drawable who, Runnable what, long when) | | void | setAlpha(int alpha) | | void | setColorFilter(ColorFilter colorFilter) | | void | setDither(boolean dither) | | Drawable | setDrawable(int index, Drawable drawable) Sets a new drawable at the specified index, and return the previous drawable, if any. | | void | setFilterBitmap(boolean filterBitmap) | | void | setHotspot(float x, float y) | | void | setTransformCallback(TransformCallback transformCallback) TransformationCallbackSetter method | | boolean | setVisible(boolean visible, boolean restart) | | void | unscheduleDrawable(Drawable who, Runnable what) |

| | From class android.graphics.drawable.Drawable

| void | applyTheme(Resources.Theme arg0) | | boolean | canApplyTheme() | | void | clearColorFilter() | | final Rect | copyBounds() | | final void | copyBounds(Rect arg0) | | static Drawable | createFromPath(String arg0) | | static Drawable | createFromResourceStream(Resources arg0, TypedValue arg1, InputStream arg2, String arg3, BitmapFactory.Options arg4) | | static Drawable | createFromResourceStream(Resources arg0, TypedValue arg1, InputStream arg2, String arg3) | | static Drawable | createFromStream(InputStream arg0, String arg1) | | static Drawable | createFromXml(Resources arg0, XmlPullParser arg1) | | static Drawable | createFromXml(Resources arg0, XmlPullParser arg1, Resources.Theme arg2) | | static Drawable | createFromXmlInner(Resources arg0, XmlPullParser arg1, AttributeSet arg2, Resources.Theme arg3) | | static Drawable | createFromXmlInner(Resources arg0, XmlPullParser arg1, AttributeSet arg2) | | abstract void | draw(Canvas arg0) | | int | getAlpha() | | final Rect | getBounds() | | Drawable.Callback | getCallback() | | int | getChangingConfigurations() | | ColorFilter | getColorFilter() | | Drawable.ConstantState | getConstantState() | | Drawable | getCurrent() | | Rect | getDirtyBounds() | | void | getHotspotBounds(Rect arg0) | | int | getIntrinsicHeight() | | int | getIntrinsicWidth() | | int | getLayoutDirection() | | final int | getLevel() | | int | getMinimumHeight() | | int | getMinimumWidth() | | abstract int | getOpacity() | | void | getOutline(Outline arg0) | | boolean | getPadding(Rect arg0) | | int[] | getState() | | Region | getTransparentRegion() | | void | inflate(Resources arg0, XmlPullParser arg1, AttributeSet arg2, Resources.Theme arg3) | | void | inflate(Resources arg0, XmlPullParser arg1, AttributeSet arg2) | | void | invalidateSelf() | | boolean | isAutoMirrored() | | boolean | isFilterBitmap() | | boolean | isStateful() | | final boolean | isVisible() | | void | jumpToCurrentState() | | Drawable | mutate() | | void | onBoundsChange(Rect arg0) | | boolean | onLayoutDirectionChanged(int arg0) | | boolean | onLevelChange(int arg0) | | boolean | onStateChange(int[] arg0) | | static int | resolveOpacity(int arg0, int arg1) | | void | scheduleSelf(Runnable arg0, long arg1) | | abstract void | setAlpha(int arg0) | | void | setAutoMirrored(boolean arg0) | | void | setBounds(int arg0, int arg1, int arg2, int arg3) | | void | setBounds(Rect arg0) | | final void | setCallback(Drawable.Callback arg0) | | void | setChangingConfigurations(int arg0) | | void | setColorFilter(int arg0, PorterDuff.Mode arg1) | | abstract void | setColorFilter(ColorFilter arg0) | | void | setDither(boolean arg0) | | void | setFilterBitmap(boolean arg0) | | void | setHotspot(float arg0, float arg1) | | void | setHotspotBounds(int arg0, int arg1, int arg2, int arg3) | | final boolean | setLayoutDirection(int arg0) | | final boolean | setLevel(int arg0) | | boolean | setState(int[] arg0) | | void | setTint(int arg0) | | void | setTintList(ColorStateList arg0) | | void | setTintMode(PorterDuff.Mode arg0) | | boolean | setVisible(boolean arg0, boolean arg1) | | void | unscheduleSelf(Runnable arg0) |

| | From class java.lang.Object

| Object | clone() | | boolean | equals(Object arg0) | | void | finalize() | | final Class<?> | getClass() | | int | hashCode() | | final void | notify() | | final void | notifyAll() | | String | toString() | | final void | wait(long arg0, int arg1) | | final void | wait(long arg0) | | final void | wait() |

| | From interface android.graphics.drawable.Drawable.Callback

| abstract void | invalidateDrawable(Drawable arg0) | | abstract void | scheduleDrawable(Drawable arg0, Runnable arg1, long arg2) | | abstract void | unscheduleDrawable(Drawable arg0, Runnable arg1) |

| | From interface com.facebook.drawee.drawable.TransformAwareDrawable

| abstract void | setTransformCallback(TransformCallback transformCallback) Sets a transform callback. |

| | From interface com.facebook.drawee.drawable.TransformCallback

| abstract void | getRootBounds(RectF bounds) Called when the drawable needs to get its root bounds. | | abstract void | getTransform(Matrix transform) Called when the drawable needs to get all matrices applied to it. |

|

Constants

public static final int TRANSITION_NONE

No transition will be applied.

Constant Value: 2 (0x00000002)

public static final int TRANSITION_RUNNING

The transition has started and the animation is in progress.

Constant Value: 1 (0x00000001)

public static final int TRANSITION_STARTING

A transition is about to start.

Constant Value: 0 (0x00000000)

Public Constructors

public FadeDrawable(Drawable[] layers)

Creates a new fade drawable. The first layer is displayed with full opacity whereas all other layers are invisible.

Parameters

| layers | layers to fade between |

public FadeDrawable(Drawable[] layers, boolean allLayersVisible, int actualImageLayer)

Creates a new fade drawable. The first layer is displayed with full opacity whereas all other layers are invisible if allLayersVisible is false. Otherwise, all layers will be displayed with full opacity.

Parameters

| layers | layers to fade between | | allLayersVisible | true if all layers should be visible per default | | actualImageLayer | The index of the layer that contains the actual image |

Public Methods

public void beginBatchMode()

Begins the batch mode so that it doesn't invalidate self on every operation.

public void draw(Canvas canvas)

public void endBatchMode()

Ends the batch mode and invalidates.

public void fadeInAllLayers()

Starts fading in all layers.

public void fadeInLayer(int index)

Starts fading in the specified layer.

Parameters

| index | the index of the layer to fade in. |

public void fadeOutAllLayers()

Starts fading out all layers.

public void fadeOutLayer(int index)

Starts fading out the specified layer.

Parameters

| index | the index of the layer to fade out. |

public void fadeToLayer(int index)

Starts fading to the specified layer.

Parameters

| index | the index of the layer to fade to |

public void fadeUpToLayer(int index)

Starts fading up to the specified layer.

Layers up to the specified layer inclusive will fade in, other layers will fade out.

Parameters

| index | the index of the layer to fade up to. |

public void finishTransitionImmediately()

Finishes transition immediately.

public int getAlpha()

public int getTransitionDuration()

Gets the transition duration.

Returns
  • transition duration in milliseconds.

public int getTransitionState()

Gets the transition state (STARTING, RUNNING, NONE). Useful for testing purposes.

Returns
  • transition state

public void hideLayerImmediately(int index)

Makes the specified layer fully transparent

Parameters

| index | the index of the layer to be hidden |

public void invalidateSelf()

public boolean isDefaultLayerIsOn()

public boolean isLayerOn(int index)

public void reset()

Resets to the initial state.

public void setAlpha(int alpha)

public void setOnFadeListener(FadeDrawable.OnFadeListener onFadeListener)

public void setTransitionDuration(int durationMs)

Sets the duration of the current transition in milliseconds.

public void showLayerImmediately(int index)

Makes the specified layer fully opaque

Parameters

| index | the index of the layer to be shown |

Protected Methods

protected long getCurrentTimeMs()

Returns current time. Absolute reference is not important as only time deltas are used. Extracting this to a separate method allows better testing.

Returns
  • current time in milliseconds

+Generated by Doclava. +