IconicsAnimationProcessor (library-core API)

java.lang.Object
- com.mikepenz.iconics.animation.IconicsAnimationProcessor

Direct Known Subclasses:

BlinkAlphaProcessor, BlinkScaleProcessor, SpinProcessor
```
public abstract class IconicsAnimationProcessor
extends java.lang.Object
```

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`INFINITE` This value used used with the `repeatCount(int)` property to repeat the animation indefinitely.
`protected long`	`mDuration`
`protected android.animation.TimeInterpolator`	`mInterpolator`
`protected boolean`	`mIsStartImmediately`
`protected int`	`mRepeatCount`
`protected int`	`mRepeatMode`
`static int`	`RESTART` When the animation reaches the end and `repeatCount` is INFINITE or a positive value, the animation restarts from the beginning.
`static int`	`REVERSE` When the animation reaches the end and `repeatCount` is INFINITE or a positive value, the animation reverses direction on every iteration.

Constructor Summary

Constructors
Constructor and Description

IconicsAnimationProcessor()

Constructors
Constructor and Description
`IconicsAnimationProcessor()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`IconicsAnimationProcessor`	`addListener(IconicsAnimationListener listener)` Adds a listener to the set of listeners that are sent events through the life of an processor, such as start, repeat, and end.
`IconicsAnimationProcessor`	`addPauseListener(IconicsAnimationPauseListener listener)` Adds a pause listener to this processor.
`abstract java.lang.String`	`animationTag()`
`void`	`cancel()` Cancels the animation.
`IconicsAnimationProcessor`	`duration(long duration, java.util.concurrent.TimeUnit timeUnit)` Sets the length of the animation.
`void`	`end()` Ends the animation.
`protected float`	`getAnimatedPercent()`
`protected android.graphics.Rect`	`getDrawableBounds()` Return the drawable's bounds Rect.
`protected int[]`	`getDrawableState()` Return the drawable's current state
`IconicsAnimationProcessor`	`interpolator(android.animation.TimeInterpolator interpolator)` The time interpolator used in calculating the elapsed fraction of this animation.
`boolean`	`isPaused()` Returns whether this processor is currently in a paused state.
`boolean`	`isRunning()`
`boolean`	`isStarted()`
`protected void`	`onDrawableAttached()` Called when a drawable was attached and now `getDrawableBounds()` and `getDrawableState()` will return valid values.
`protected void`	`onDrawableDetached()` Called when a drawable was detached and now `getDrawableBounds()` and `getDrawableState()` will return `null`.
`void`	`pause()` Pauses a running processor.
`protected void`	`processPostDraw(android.graphics.Canvas canvas)` Will be called after `.draw(Canvas)`.
`protected void`	`processPreDraw(android.graphics.Canvas canvas, IconicsBrush<android.text.TextPaint> iconBrush, IconicsBrush<android.graphics.Paint> iconContourBrush, IconicsBrush<android.graphics.Paint> backgroundBrush, IconicsBrush<android.graphics.Paint> backgroundContourBrush)` Will be called before `.draw(Canvas)`.
`void`	`removeAllListeners()` Removes all `listeners` and `pauseListeners` from this processor.
`void`	`removeListener(IconicsAnimationListener listener)` Removes a listener from the set listening to this processor.
`void`	`removePauseListener(IconicsAnimationPauseListener listener)` Removes a pause listener from the set listening to this processor.
`IconicsAnimationProcessor`	`repeatCount(int repeatCount)` Sets how many times the animation should be repeated.
`IconicsAnimationProcessor`	`repeatMode(int value)` Defines what this animation should do when it reaches the end.
`void`	`resume()` Resumes a paused processor, causing the processor to pick up where it left off when it was paused.
`void`	`reverse()` Plays the processor in reverse.
`IconicsAnimationProcessor`	`start()` Starts the animation, if processor is attached to drawable, otherwise sets flag to start animation immediately after attaching
`IconicsAnimationProcessor`	`startImmediately(boolean startImmediately)` Set the flag for starting animation immediately after attach to drawable and after drawable with the view is attached to window.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - RESTART
```
public static final int RESTART
```
    When the animation reaches the end and repeatCount is INFINITE or a positive value, the animation restarts from the beginning.
    
    See Also:
    
    Constant Field Values
  - REVERSE
```
public static final int REVERSE
```
    When the animation reaches the end and repeatCount is INFINITE or a positive value, the animation reverses direction on every iteration.
    
    See Also:
    
    Constant Field Values
  - INFINITE
```
public static final int INFINITE
```
    This value used used with the repeatCount(int) property to repeat the animation indefinitely.
    
    See Also:
    
    Constant Field Values
  - mInterpolator
```
protected android.animation.TimeInterpolator mInterpolator
```
  - mDuration
```
protected long mDuration
```
  - mRepeatCount
```
protected int mRepeatCount
```
  - mRepeatMode
```
protected int mRepeatMode
```
  - mIsStartImmediately
```
protected boolean mIsStartImmediately
```
- Constructor Detail
  - IconicsAnimationProcessor
```
public IconicsAnimationProcessor()
```
- Method Detail
  - animationTag
```
public abstract java.lang.String animationTag()
```
    Returns:
    
    Tag which will be used to apply this processor via xml
  - duration
```
public IconicsAnimationProcessor duration(long duration,
                                          java.util.concurrent.TimeUnit timeUnit)
```
    Sets the length of the animation. The default duration is 300 milliseconds.
    
    Parameters:
    
    duration - The length of the animation. This value cannot be negative.
  - repeatMode
```
public IconicsAnimationProcessor repeatMode(int value)
```
    Defines what this animation should do when it reaches the end. This setting is applied only when the repeat count is either greater than 0 or INFINITE. Defaults to RESTART.
    
    Parameters:
    
    value - RESTART or REVERSE
  - repeatCount
```
public IconicsAnimationProcessor repeatCount(int repeatCount)
```
    Sets how many times the animation should be repeated. If the repeat count is 0, the animation is never repeated. If the repeat count is greater than 0 or INFINITE, the repeat mode will be taken into account. The repeat count is INFINITE by default.
    
    Parameters:
    
    repeatCount - the number of times the animation should be repeated
  - interpolator
```
public IconicsAnimationProcessor interpolator(android.animation.TimeInterpolator interpolator)
```
    The time interpolator used in calculating the elapsed fraction of this animation. The interpolator determines whether the animation runs with linear or non-linear motion, such as acceleration and deceleration. The default value is LinearInterpolator
    
    Parameters:
    
    interpolator - the interpolator to be used by this processor. A value of null will result in linear interpolation.
  - startImmediately
```
public IconicsAnimationProcessor startImmediately(boolean startImmediately)
```
    Set the flag for starting animation immediately after attach to drawable and after drawable with the view is attached to window. Default value is true.
    
    Parameters:
    
    startImmediately - the flag
  - start
```
public IconicsAnimationProcessor start()
```
    Starts the animation, if processor is attached to drawable, otherwise sets flag to start animation immediately after attaching
  - addListener
```
public IconicsAnimationProcessor addListener(IconicsAnimationListener listener)
```
    Adds a listener to the set of listeners that are sent events through the life of an processor, such as start, repeat, and end.
    
    Parameters:
    
    listener - the listener to be added to the current set of listeners for this processor.
  - removeListener
```
public void removeListener(IconicsAnimationListener listener)
```
    Removes a listener from the set listening to this processor.
    
    Parameters:
    
    listener - the listener to be removed from the current set of listeners for this processor.
  - addPauseListener
```
public IconicsAnimationProcessor addPauseListener(IconicsAnimationPauseListener listener)
```
    Adds a pause listener to this processor.
    
    Parameters:
    
    listener - the listener to be added to the current set of pause listeners for this processor.
  - removePauseListener
```
public void removePauseListener(IconicsAnimationPauseListener listener)
```
    Removes a pause listener from the set listening to this processor.
    
    Parameters:
    
    listener - the listener to be removed from the current set of pause listeners for this processor.
  - removeAllListeners
```
public void removeAllListeners()
```
    Removes all listeners and pauseListeners from this processor.
  - cancel
```
public void cancel()
```
    Cancels the animation. Unlike end(), cancel() causes the animation to stop in its tracks, sending an IconicsAnimationListener.onAnimationCancel(IconicsAnimationProcessor) to its listeners, followed by an IconicsAnimationListener.onAnimationEnd(IconicsAnimationProcessor) message.
    This method must be called on the thread that is running the processor.
  - end
```
public void end()
```
    Ends the animation. This causes the processor to assign the end value of the property being animated, then calling the IconicsAnimationListener.onAnimationEnd(IconicsAnimationProcessor) method on its listeners.
    This method must be called on the thread that is running the processor.
  - isStarted
```
public boolean isStarted()
```
    Returns:
    
    Whether the processor has been started and not yet ended.
  - isRunning
```
public boolean isRunning()
```
    Returns:
    
    Whether the processor is running.
  - reverse
```
public void reverse()
```
    Plays the processor in reverse. If the processor is already running, it will stop itself and play backwards from the point reached when reverse was called. If the processor is not currently running, then it will start from the end and play backwards.
  - pause
```
public void pause()
```
    Pauses a running processor. This method should only be called on the same thread on which the animation was started. If the animation has not yet been started or has since ended, then the call is ignored. Paused processors can be resumed by calling resume().
    
    See Also:
    
    resume(), isPaused()
  - resume
```
public void resume()
```
    Resumes a paused processor, causing the processor to pick up where it left off when it was paused. This method should only be called on the same thread on which the processor was started. Calls to resume() on an processor that is not currently paused will be ignored.
    
    See Also:
    
    pause(), isPaused()
  - isPaused
```
public boolean isPaused()
```
    Returns whether this processor is currently in a paused state.
    
    Returns:
    
    True if the processor is currently paused, false otherwise.
    
    See Also:
    
    pause(), resume()
  - processPreDraw
```
protected void processPreDraw(android.graphics.Canvas canvas,
                              IconicsBrush<android.text.TextPaint> iconBrush,
                              IconicsBrush<android.graphics.Paint> iconContourBrush,
                              IconicsBrush<android.graphics.Paint> backgroundBrush,
                              IconicsBrush<android.graphics.Paint> backgroundContourBrush)
```
    Will be called before .draw(Canvas). Useful for some changes, based on Paint
  - processPostDraw
```
protected void processPostDraw(android.graphics.Canvas canvas)
```
    Will be called after .draw(Canvas). Useful for some changes, based on canvas and need to restore canvas after drawing the icon (scale, rotate etc.).
  - getDrawableState
```
protected int[] getDrawableState()
```
    Return the drawable's current state
    Nullability contract: calling this into processPreDraw(Canvas, IconicsBrush, IconicsBrush, IconicsBrush, IconicsBrush) or processPostDraw(Canvas) is guaranteed return @NonNull value, otherwise it can be @Nullable.
    
    Returns:
    
    The current state of the drawable
  - getDrawableBounds
```
protected android.graphics.Rect getDrawableBounds()
```
    Return the drawable's bounds Rect. Note: for efficiency, the returned object may be the same object stored in the drawable (though this is not guaranteed).
    Nullability contract: calling this into processPreDraw(Canvas, IconicsBrush, IconicsBrush, IconicsBrush, IconicsBrush) or processPostDraw(Canvas) is guaranteed return @NonNull value, otherwise it can be @Nullable.
    
    Returns:
    
    The bounds of the drawable (which may change later, so caller beware). DO NOT ALTER the returned object as it may change the stored bounds of this drawable.
  - getAnimatedPercent
```
protected float getAnimatedPercent()
```
    Returns:
    
    completed percent of animation
  - onDrawableAttached
```
protected void onDrawableAttached()
```
    Called when a drawable was attached and now getDrawableBounds() and getDrawableState() will return valid values. Good place to set some drawable-dependent fields
  - onDrawableDetached
```
protected void onDrawableDetached()
```
    Called when a drawable was detached and now getDrawableBounds() and getDrawableState() will return null. Good place to reset some drawable-dependent fields

Class IconicsAnimationProcessor

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

RESTART

REVERSE

INFINITE

mInterpolator

mDuration

mRepeatCount

mRepeatMode

mIsStartImmediately

Constructor Detail

IconicsAnimationProcessor

Method Detail

animationTag

duration

repeatMode

repeatCount

interpolator

startImmediately

start

addListener

removeListener

addPauseListener

removePauseListener

removeAllListeners

cancel

end

isStarted

isRunning

reverse

pause

resume

isPaused

processPreDraw

processPostDraw

getDrawableState

getDrawableBounds

getAnimatedPercent

onDrawableAttached

onDrawableDetached