EdgeEffect Class

Definition

Namespace:

Android.Widget

Assembly:

Mono.Android.dll

This class performs the graphical effect used at the edges of scrollable widgets when the user scrolls beyond the content bounds in 2D space.

[Android.Runtime.Register("android/widget/EdgeEffect", DoNotGenerateAcw=true)]
public class EdgeEffect : Java.Lang.Object

[<Android.Runtime.Register("android/widget/EdgeEffect", DoNotGenerateAcw=true)>]
type EdgeEffect = class
    inherit Object

Inheritance

Object

Object

EdgeEffect

Attributes

RegisterAttribute

Remarks

This class performs the graphical effect used at the edges of scrollable widgets when the user scrolls beyond the content bounds in 2D space.

EdgeEffect is stateful. Custom widgets using EdgeEffect should create an instance for each edge that should show the effect, feed it input data using the methods #onAbsorb(int), #onPull(float), and #onRelease(), and draw the effect using #draw(Canvas) in the widget's overridden android.view.View#draw(Canvas) method. If #isFinished() returns false after drawing, the edge effect's animation is not yet complete and the widget should schedule another drawing pass to continue the animation.

When drawing, widgets should draw their main content and child views first, usually by invoking super.draw(canvas) from an overridden draw method. (This will invoke onDraw and dispatch drawing to child views as needed.) The edge effect may then be drawn on top of the view's content using the #draw(Canvas) method.

Java documentation for android.widget.EdgeEffect.

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Constructors

EdgeEffect(Context)	Construct a new EdgeEffect with a theme appropriate for the provided context.
EdgeEffect(Context, IAttributeSet)	Construct a new EdgeEffect with a theme appropriate for the provided context.
EdgeEffect(IntPtr, JniHandleOwnership)	A constructor used when creating managed representations of JNI objects; called by the runtime.

Properties

BlendMode	Returns the blend mode. -or- Set or clear the blend mode.
Class	Returns the runtime class of this Object. (Inherited from Object)
Color	Return the color of this edge effect in argb.
DefaultBlendMode	The default blend mode used by EdgeEffect.
Distance	Returns the pull distance needed to be released to remove the showing effect.
Handle	The handle to the underlying Android instance. (Inherited from Object)
IsFinished	Reports if this EdgeEffect's animation is finished.
JniIdentityHashCode	(Inherited from Object)
JniPeerMembers
MaxHeight	Return the maximum height that the edge effect will be drawn at given the original #setSize(int, int) input size.
PeerReference	(Inherited from Object)
ThresholdClass	This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.
ThresholdType	This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.

Methods

Clone()	Creates and returns a copy of this object. (Inherited from Object)
Dispose()	(Inherited from Object)
Dispose(Boolean)	(Inherited from Object)
Draw(Canvas)	Draw into the provided canvas.
Equals(Object)	Indicates whether some other object is "equal to" this one. (Inherited from Object)
Finish()	Immediately finish the current animation.
GetHashCode()	Returns a hash code value for the object. (Inherited from Object)
JavaFinalize()	Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. (Inherited from Object)
Notify()	Wakes up a single thread that is waiting on this object's monitor. (Inherited from Object)
NotifyAll()	Wakes up all threads that are waiting on this object's monitor. (Inherited from Object)
OnAbsorb(Int32)	Call when the effect absorbs an impact at the given velocity.
OnPull(Single)	A view should call this when content is pulled away from an edge by the user.
OnPull(Single, Single)	A view should call this when content is pulled away from an edge by the user.
OnPullDistance(Single, Single)	A view should call this when content is pulled away from an edge by the user.
OnRelease()	Call when the object is released after being pulled.
SetColor(Color)	Set the color of this edge effect in argb.
SetHandle(IntPtr, JniHandleOwnership)	Sets the Handle property. (Inherited from Object)
SetSize(Int32, Int32)	Set the size of this edge effect in pixels.
ToArray<T>()	(Inherited from Object)
ToString()	Returns a string representation of the object. (Inherited from Object)
UnregisterFromRuntime()	(Inherited from Object)
Wait()	Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>. (Inherited from Object)
Wait(Int64)	Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed. (Inherited from Object)
Wait(Int64, Int32)	Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed. (Inherited from Object)

Explicit Interface Implementations

IJavaPeerable.Disposed()	(Inherited from Object)
IJavaPeerable.DisposeUnlessReferenced()	(Inherited from Object)
IJavaPeerable.Finalized()	(Inherited from Object)
IJavaPeerable.JniManagedPeerState	(Inherited from Object)
IJavaPeerable.SetJniIdentityHashCode(Int32)	(Inherited from Object)
IJavaPeerable.SetJniManagedPeerState(JniManagedPeerStates)	(Inherited from Object)
IJavaPeerable.SetPeerReference(JniObjectReference)	(Inherited from Object)

Extension Methods

JavaCast<TResult>(IJavaObject)	Performs an Android runtime-checked type conversion.
JavaCast<TResult>(IJavaObject)
GetJniTypeName(IJavaPeerable)