AdapterViewAnimator
public
abstract
class
AdapterViewAnimator
implements
Advanceable
| android.widget.AdapterViewAnimator |
Base class for a AdapterView that will perform animations
when switching between its views.
Summary
XML attributes | |
|---|---|
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. |
Public constructors | |
|---|---|
AdapterViewAnimator(Context context)
|
|
AdapterViewAnimator(Context context, AttributeSet attrs)
|
|
AdapterViewAnimator(Context context, AttributeSet attrs, int defStyleAttr)
|
|
AdapterViewAnimator(Context context, AttributeSet attrs, int defStyleAttr, int defStyleRes)
|
|
Public methods | |
|---|---|
void
|
advance()
Called by an |
void
|
deferNotifyDataSetChanged()
This defers a notifyDataSetChanged on the pending RemoteViewsAdapter if it has not connected yet. |
void
|
fyiWillBeAdvancedByHostKThx()
Called by an |
CharSequence
|
getAccessibilityClassName()
Return the class name of this object to be used for accessibility purposes. |
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()
|
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 |
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(ObjectAnimator outAnimation)
Specifies the animation used to animate a View that exit the screen. |
void
|
setOutAnimation(Context context, int resourceID)
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. |
Inherited methods | |
|---|---|
XML attributes
android:animateFirstView
Defines whether to animate the current View when the ViewAnimation is first displayed.
May be a boolean value, such as "true" or
"false".
android:inAnimation
Identifier for the animation to use when a view is shown.
May be a reference to another resource, in the form
"@[+][package:]type/name" or a theme
attribute in the form
"?[package:]type/name".
android:loopViews
Defines whether the animator loops to the first view once it has reached the end of the list.
May be a boolean value, such as "true" or
"false".
android:outAnimation
Identifier for the animation to use when a view is hidden.
May be a reference to another resource, in the form
"@[+][package:]type/name" or a theme
attribute in the form
"?[package:]type/name".
Public constructors
AdapterViewAnimator
public AdapterViewAnimator (Context context)
| Parameters | |
|---|---|
context |
Context |
AdapterViewAnimator
public AdapterViewAnimator (Context context, AttributeSet attrs)
| Parameters | |
|---|---|
context |
Context |
attrs |
AttributeSet |
AdapterViewAnimator
public AdapterViewAnimator (Context context, AttributeSet attrs, int defStyleAttr)
| Parameters | |
|---|---|
context |
Context |
attrs |
AttributeSet |
defStyleAttr |
int |
AdapterViewAnimator
public AdapterViewAnimator (Context context, AttributeSet attrs, int defStyleAttr, int defStyleRes)
| Parameters | |
|---|---|
context |
Context |
attrs |
AttributeSet |
defStyleAttr |
int |
defStyleRes |
int |
Public methods
advance
public void advance ()
Called by an AppWidgetHost in order to advance the current view when
it is being used within an app widget.
deferNotifyDataSetChanged
public void deferNotifyDataSetChanged ()
This defers a notifyDataSetChanged on the pending RemoteViewsAdapter if it has not connected yet.
fyiWillBeAdvancedByHostKThx
public void fyiWillBeAdvancedByHostKThx ()
Called by an AppWidgetHost to indicate that it will be
automatically advancing the views of this AdapterViewAnimator by calling
AdapterViewAnimator#advance() at some point in the future. This allows subclasses to
perform any required setup, for example, to stop automatically advancing their children.
getAccessibilityClassName
public CharSequence getAccessibilityClassName ()
Return the class name of this object to be used for accessibility purposes.
Subclasses should only override this if they are implementing something that
should be seen as a completely new class of view when used by accessibility,
unrelated to the class it is deriving from. This is used to fill in
AccessibilityNodeInfo.setClassName.
| Returns | |
|---|---|
CharSequence |
|
getAdapter
public Adapter getAdapter ()
Returns the adapter currently associated with this widget.
| Returns | |
|---|---|
Adapter |
The adapter used to provide this view's content. |
getBaseline
public int getBaseline ()
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 | |
|---|---|
int |
the offset of the baseline within the widget's bounds or -1 if baseline alignment is not supported |
getCurrentView
public View getCurrentView ()
Returns the View corresponding to the currently displayed child.
| Returns | |
|---|---|
View |
The View currently displayed. |
See also:
getDisplayedChild
public int getDisplayedChild ()
Returns the index of the currently displayed child view.
| Returns | |
|---|---|
int |
|
getInAnimation
public ObjectAnimator getInAnimation ()
Returns the current animation used to animate a View that enters the screen.
| Returns | |
|---|---|
ObjectAnimator |
An Animation or null if none is set. |
getOutAnimation
public ObjectAnimator getOutAnimation ()
Returns the current animation used to animate a View that exits the screen.
| Returns | |
|---|---|
ObjectAnimator |
An Animation or null if none is set. |
getSelectedView
public View getSelectedView ()
| Returns | |
|---|---|
View |
The view corresponding to the currently selected item, or null if nothing is selected |
onRemoteAdapterConnected
public boolean onRemoteAdapterConnected ()
Called back when the adapter connects to the RemoteViewsService.
| Returns | |
|---|---|
boolean |
|
onRemoteAdapterDisconnected
public void onRemoteAdapterDisconnected ()
Called back when the adapter disconnects from the RemoteViewsService.
onRestoreInstanceState
public void onRestoreInstanceState (Parcelable state)
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.
If you override this method you must call through to the
superclass implementation.
| Parameters | |
|---|---|
state |
Parcelable: The frozen state that had previously been returned by
onSaveInstanceState(). |
onSaveInstanceState
public 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. 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.
If you override this method you must call through to the
superclass implementation.
| Returns | |
|---|---|
Parcelable |
Returns a Parcelable object containing the view's current dynamic state, or null if there is nothing interesting to save. |
onTouchEvent
public boolean onTouchEvent (MotionEvent ev)
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_CLICKwhen accessibility features are enabled
| Parameters | |
|---|---|
ev |
MotionEvent: The motion event. |
| Returns | |
|---|---|
boolean |
True if the event was handled, false otherwise. |
setAdapter
public void setAdapter (Adapter adapter)
Sets the adapter that provides the data and the views to represent the data in this widget.
| Parameters | |
|---|---|
adapter |
Adapter: The adapter to use to create this view's content. |
setAnimateFirstView
public void setAnimateFirstView (boolean animate)
Indicates whether the current View should be animated the first time the ViewAnimation is displayed.
| Parameters | |
|---|---|
animate |
boolean: True to animate the current View the first time it is displayed,
false otherwise. |
setDisplayedChild
public void setDisplayedChild (int whichChild)
Sets which child view will be displayed.
| Parameters | |
|---|---|
whichChild |
int: the index of the child view to display |
setInAnimation
public void setInAnimation (ObjectAnimator inAnimation)
Specifies the animation used to animate a View that enters the screen.
| Parameters | |
|---|---|
inAnimation |
ObjectAnimator: The animation started when a View enters the screen. |
setInAnimation
public void setInAnimation (Context context, int resourceID)
Specifies the animation used to animate a View that enters the screen.
| Parameters | |
|---|---|
context |
Context: The application's environment. |
resourceID |
int: The resource id of the animation. |
setOutAnimation
public void setOutAnimation (ObjectAnimator outAnimation)
Specifies the animation used to animate a View that exit the screen.
| Parameters | |
|---|---|
outAnimation |
ObjectAnimator: The animation started when a View exit the screen. |
setOutAnimation
public void setOutAnimation (Context context, int resourceID)
Specifies the animation used to animate a View that exit the screen.
| Parameters | |
|---|---|
context |
Context: The application's environment. |
resourceID |
int: The resource id of the animation. |
setRemoteViewsAdapter
public void setRemoteViewsAdapter (Intent intent)
Sets up this AdapterViewAnimator to use a remote views adapter which connects to a RemoteViewsService through the specified intent.
| Parameters | |
|---|---|
intent |
Intent: the intent used to identify the RemoteViewsService for the adapter to
connect to. |
setSelection
public void setSelection (int position)
Sets the currently selected item. To support accessibility subclasses that override this method must invoke the overridden super method first.
| Parameters | |
|---|---|
position |
int: Index (starting at 0) of the data item to be selected. |
Protected methods
onLayout
protected 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. Derived classes with children should override this method and call layout on each of their children.
| Parameters | |
|---|---|
changed |
boolean: This is a new size or position for this view |
left |
int: Left position, relative to parent |
top |
int: Top position, relative to parent |
right |
int: Right position, relative to parent |
bottom |
int: Bottom position, relative to parent |
onMeasure
protected void onMeasure (int widthMeasureSpec,
int heightMeasureSpec)
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 overridden 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 |
int: horizontal space requirements as imposed by the parent.
The requirements are encoded with
View.MeasureSpec. |
heightMeasureSpec |
int: vertical space requirements as imposed by the parent.
The requirements are encoded with
View.MeasureSpec. |
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2023-04-12 UTC.