Android APIs
public abstract class

AdapterViewAnimator

extends AdapterView<T extends Adapter>
implements Advanceable
java.lang.Object
   ↳ android.view.View
     ↳ android.view.ViewGroup
       ↳ android.widget.AdapterView<T extends android.widget.Adapter>
         ↳ android.widget.AdapterViewAnimator
Known Direct Subclasses

Class Overview

Base class for a AdapterView that will perform animations when switching between its views.

Summary

XML Attributes
Attribute Name Related Method Description
android:animateFirstView Defines whether to animate the current View when the ViewAnimation is first displayed. 
android:inAnimation Identifier for the animation to use when a view is shown. 
android:loopViews Defines whether the animator loops to the first view once it has reached the end of the list. 
android:outAnimation Identifier for the animation to use when a view is hidden. 
[Expand]
Inherited XML Attributes
From class android.view.ViewGroup
From class android.view.View
[Expand]
Inherited Constants
From class android.widget.AdapterView
From class android.view.ViewGroup
From class android.view.View
[Expand]
Inherited Fields
From class android.view.View
Public Constructors
AdapterViewAnimator(Context context)
AdapterViewAnimator(Context context, AttributeSet attrs)
AdapterViewAnimator(Context context, AttributeSet attrs, int defStyleAttr)
Public Methods
void advance()
Called by an AppWidgetHost in order to advance the current view when it is being used within an app widget.
void deferNotifyDataSetChanged()
This defers a notifyDataSetChanged on the pending RemoteViewsAdapter if it has not connected yet.
void fyiWillBeAdvancedByHostKThx()
Called by an AppWidgetHost to indicate that it will be automatically advancing the views of this AdapterViewAnimator by calling advance() at some point in the future.
Adapter getAdapter()
Returns the adapter currently associated with this widget.
int getBaseline()

Return the offset of the widget's text baseline from the widget's top boundary.

View getCurrentView()
Returns the View corresponding to the currently displayed child.
int getDisplayedChild()
Returns the index of the currently displayed child view.
ObjectAnimator getInAnimation()
Returns the current animation used to animate a View that enters the screen.
ObjectAnimator getOutAnimation()
Returns the current animation used to animate a View that exits the screen.
View getSelectedView()
void onInitializeAccessibilityEvent(AccessibilityEvent event)
Initializes an AccessibilityEvent with information about this View which is the event source.
void onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo info)
Initializes an AccessibilityNodeInfo with information about this view.
boolean onRemoteAdapterConnected()
Called back when the adapter connects to the RemoteViewsService.
void onRemoteAdapterDisconnected()
Called back when the adapter disconnects from the RemoteViewsService.
void onRestoreInstanceState(Parcelable state)
Hook allowing a view to re-apply a representation of its internal state that had previously been generated by onSaveInstanceState().
Parcelable onSaveInstanceState()
Hook allowing a view to generate a representation of its internal state that can later be used to create a new instance with that same state.
boolean onTouchEvent(MotionEvent ev)
Implement this method to handle touch screen motion events.
void setAdapter(Adapter adapter)
Sets the adapter that provides the data and the views to represent the data in this widget.
void setAnimateFirstView(boolean animate)
Indicates whether the current View should be animated the first time the ViewAnimation is displayed.
void setDisplayedChild(int whichChild)
Sets which child view will be displayed.
void setInAnimation(ObjectAnimator inAnimation)
Specifies the animation used to animate a View that enters the screen.
void setInAnimation(Context context, int resourceID)
Specifies the animation used to animate a View that enters the screen.
void setOutAnimation(Context context, int resourceID)
Specifies the animation used to animate a View that exit the screen.
void setOutAnimation(ObjectAnimator outAnimation)
Specifies the animation used to animate a View that exit the screen.
void setRemoteViewsAdapter(Intent intent)
Sets up this AdapterViewAnimator to use a remote views adapter which connects to a RemoteViewsService through the specified intent.
void setSelection(int position)
Sets the currently selected item.
void showNext()
Manually shows the next child.
void showPrevious()
Manually shows the previous child.
Protected Methods
void onLayout(boolean changed, int left, int top, int right, int bottom)
Called from layout when this view should assign a size and position to each of its children.
void onMeasure(int widthMeasureSpec, int heightMeasureSpec)

Measure the view and its content to determine the measured width and the measured height.

[Expand]
Inherited Methods
From class android.widget.AdapterView
From class android.view.ViewGroup
From class android.view.View
From class java.lang.Object
From interface android.graphics.drawable.Drawable.Callback
From interface android.view.KeyEvent.Callback
From interface android.view.ViewManager
From interface android.view.ViewParent
From interface android.view.accessibility.AccessibilityEventSource
From interface android.widget.Advanceable

XML Attributes

android:animateFirstView

Defines whether to animate the current View when the ViewAnimation is first displayed.

Must be a boolean value, either "true" or "false".

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol animateFirstView.

Related Methods

android:inAnimation

Identifier for the animation to use when a view is shown.

Must be a reference to another resource, in the form "@[+][package:]type:name" or to a theme attribute in the form "?[package:][type:]name".

This corresponds to the global attribute resource symbol inAnimation.

Related Methods

android:loopViews

Defines whether the animator loops to the first view once it has reached the end of the list.

Must be a boolean value, either "true" or "false".

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol loopViews.

Related Methods

android:outAnimation

Identifier for the animation to use when a view is hidden.

Must be a reference to another resource, in the form "@[+][package:]type:name" or to a theme attribute in the form "?[package:][type:]name".

This corresponds to the global attribute resource symbol outAnimation.

Related Methods

Public Constructors

public AdapterViewAnimator (Context context)

Added in API level 11

public AdapterViewAnimator (Context context, AttributeSet attrs)

Added in API level 11

public AdapterViewAnimator (Context context, AttributeSet attrs, int defStyleAttr)

Added in API level 14

Public Methods

public void advance ()

Added in API level 11

Called by an AppWidgetHost in order to advance the current view when it is being used within an app widget.

public void deferNotifyDataSetChanged ()

Added in API level 14

This defers a notifyDataSetChanged on the pending RemoteViewsAdapter if it has not connected yet.

public void fyiWillBeAdvancedByHostKThx ()

Added in API level 11

Called by an AppWidgetHost to indicate that it will be automatically advancing the views of this AdapterViewAnimator by calling advance() at some point in the future. This allows subclasses to perform any required setup, for example, to stop automatically advancing their children.

public Adapter getAdapter ()

Added in API level 11

Returns the adapter currently associated with this widget.

Returns
  • The adapter used to provide this view's content.

public int getBaseline ()

Added in API level 11

Return the offset of the widget's text baseline from the widget's top boundary. If this widget does not support baseline alignment, this method returns -1.

Returns
  • the offset of the baseline within the widget's bounds or -1 if baseline alignment is not supported

public View getCurrentView ()

Added in API level 11

Returns the View corresponding to the currently displayed child.

Returns
  • The View currently displayed.

public int getDisplayedChild ()

Added in API level 11

Returns the index of the currently displayed child view.

public ObjectAnimator getInAnimation ()

Added in API level 11

Returns the current animation used to animate a View that enters the screen.

Returns
  • An Animation or null if none is set.

public ObjectAnimator getOutAnimation ()

Added in API level 11

Returns the current animation used to animate a View that exits the screen.

Returns
  • An Animation or null if none is set.

public View getSelectedView ()

Added in API level 11

Returns
  • The view corresponding to the currently selected item, or null if nothing is selected

public void onInitializeAccessibilityEvent (AccessibilityEvent event)

Added in API level 14

Initializes an AccessibilityEvent with information about this View which is the event source. In other words, the source of an accessibility event is the view whose state change triggered firing the event.

Example: Setting the password property of an event in addition to properties set by the super implementation:

 public void onInitializeAccessibilityEvent(AccessibilityEvent event) {
     super.onInitializeAccessibilityEvent(event);
     event.setPassword(true);
 }

If an View.AccessibilityDelegate has been specified via calling setAccessibilityDelegate(AccessibilityDelegate) its onInitializeAccessibilityEvent(View, AccessibilityEvent) is responsible for handling this call.

Note: Always call the super implementation before adding information to the event, in case the default implementation has basic information to add.

Parameters
event The event to initialize.

public void onInitializeAccessibilityNodeInfo (AccessibilityNodeInfo info)

Added in API level 14

Initializes an AccessibilityNodeInfo with information about this view. The base implementation sets:

Subclasses should override this method, call the super implementation, and set additional attributes.

If an View.AccessibilityDelegate has been specified via calling setAccessibilityDelegate(AccessibilityDelegate) its onInitializeAccessibilityNodeInfo(View, AccessibilityNodeInfo) is responsible for handling this call.

Parameters
info The instance to initialize.

public boolean onRemoteAdapterConnected ()

Added in API level 11

Called back when the adapter connects to the RemoteViewsService.

public void onRemoteAdapterDisconnected ()

Added in API level 11

Called back when the adapter disconnects from the RemoteViewsService.

public void onRestoreInstanceState (Parcelable state)

Added in API level 11

Hook allowing a view to re-apply a representation of its internal state that had previously been generated by onSaveInstanceState(). This function will never be called with a null state.

Parameters
state The frozen state that had previously been returned by onSaveInstanceState().

public Parcelable onSaveInstanceState ()

Added in API level 11

Hook allowing a view to generate a representation of its internal state that can later be used to create a new instance with that same state. This state should only contain information that is not persistent or can not be reconstructed later. For example, you will never store your current position on screen because that will be computed again when a new instance of the view is placed in its view hierarchy.

Some examples of things you may store here: the current cursor position in a text view (but usually not the text itself since that is stored in a content provider or other persistent storage), the currently selected item in a list view.

Returns
  • Returns a Parcelable object containing the view's current dynamic state, or null if there is nothing interesting to save. The default implementation returns null.

public boolean onTouchEvent (MotionEvent ev)

Added in API level 11

Implement this method to handle touch screen motion events.

If this method is used to detect click actions, it is recommended that the actions be performed by implementing and calling performClick(). This will ensure consistent system behavior, including:

  • obeying click sound preferences
  • dispatching OnClickListener calls
  • handling ACTION_CLICK when accessibility features are enabled

Parameters
ev The motion event.
Returns
  • True if the event was handled, false otherwise.

public void setAdapter (Adapter adapter)

Added in API level 11

Sets the adapter that provides the data and the views to represent the data in this widget.

Parameters
adapter The adapter to use to create this view's content.

public void setAnimateFirstView (boolean animate)

Added in API level 11

Indicates whether the current View should be animated the first time the ViewAnimation is displayed.

Parameters
animate True to animate the current View the first time it is displayed, false otherwise.

public void setDisplayedChild (int whichChild)

Added in API level 11

Sets which child view will be displayed.

Parameters
whichChild the index of the child view to display

public void setInAnimation (ObjectAnimator inAnimation)

Added in API level 11

Specifies the animation used to animate a View that enters the screen.

Parameters
inAnimation The animation started when a View enters the screen.

public void setInAnimation (Context context, int resourceID)

Added in API level 11

Specifies the animation used to animate a View that enters the screen.

Parameters
context The application's environment.
resourceID The resource id of the animation.

public void setOutAnimation (Context context, int resourceID)

Added in API level 11

Specifies the animation used to animate a View that exit the screen.

Parameters
context The application's environment.
resourceID The resource id of the animation.

public void setOutAnimation (ObjectAnimator outAnimation)

Added in API level 11

Specifies the animation used to animate a View that exit the screen.

Parameters
outAnimation The animation started when a View exit the screen.

public void setRemoteViewsAdapter (Intent intent)

Added in API level 11

Sets up this AdapterViewAnimator to use a remote views adapter which connects to a RemoteViewsService through the specified intent.

Parameters
intent the intent used to identify the RemoteViewsService for the adapter to connect to.

public void setSelection (int position)

Added in API level 11

Sets the currently selected item. To support accessibility subclasses that override this method must invoke the overriden super method first.

Parameters
position Index (starting at 0) of the data item to be selected.

public void showNext ()

Added in API level 11

Manually shows the next child.

public void showPrevious ()

Added in API level 11

Manually shows the previous child.

Protected Methods

protected void onLayout (boolean changed, int left, int top, int right, int bottom)

Added in API level 11

Called from layout when this view should assign a size and position to each of its children. Derived classes with children should override this method and call layout on each of their children.

Parameters
changed This is a new size or position for this view
left Left position, relative to parent
top Top position, relative to parent
right Right position, relative to parent
bottom Bottom position, relative to parent

protected void onMeasure (int widthMeasureSpec, int heightMeasureSpec)

Added in API level 11

Measure the view and its content to determine the measured width and the measured height. This method is invoked by measure(int, int) and should be overriden by subclasses to provide accurate and efficient measurement of their contents.

CONTRACT: When overriding this method, you must call setMeasuredDimension(int, int) to store the measured width and height of this view. Failure to do so will trigger an IllegalStateException, thrown by measure(int, int). Calling the superclass' onMeasure(int, int) is a valid use.

The base class implementation of measure defaults to the background size, unless a larger size is allowed by the MeasureSpec. Subclasses should override onMeasure(int, int) to provide better measurements of their content.

If this method is overridden, it is the subclass's responsibility to make sure the measured height and width are at least the view's minimum height and width (getSuggestedMinimumHeight() and getSuggestedMinimumWidth()).

Parameters
widthMeasureSpec horizontal space requirements as imposed by the parent. The requirements are encoded with View.MeasureSpec.
heightMeasureSpec vertical space requirements as imposed by the parent. The requirements are encoded with View.MeasureSpec.