AbsListView
public
abstract
class
AbsListView
extends AdapterView<ListAdapter>
implements
Filter.FilterListener,
TextWatcher,
ViewTreeObserver.OnGlobalLayoutListener,
ViewTreeObserver.OnTouchModeChangeListener
java.lang.Object | ||||
↳ | android.view.View | |||
↳ | android.view.ViewGroup | |||
↳ | android.widget.AdapterView<android.widget.ListAdapter> | |||
↳ | android.widget.AbsListView |
Base class that can be used to implement virtualized lists of items. A list does not have a spatial definition here. For instance, subclasses of this class can display the content of the list in a grid, in a carousel, as stack, etc.
Summary
Nested classes | ||
---|---|---|
class |
AbsListView.LayoutParams
AbsListView extends LayoutParams to provide a place to hold the view type. |
|
interface |
AbsListView.MultiChoiceModeListener
A MultiChoiceModeListener receives events for |
|
interface |
AbsListView.OnScrollListener
Interface definition for a callback to be invoked when the list or grid has been scrolled. |
|
interface |
AbsListView.RecyclerListener
A RecyclerListener is used to receive a notification whenever a View is placed inside the RecycleBin's scrap heap. |
|
interface |
AbsListView.SelectionBoundsAdjuster
The top-level view of a list item can implement this interface to allow itself to modify the bounds of the selection shown for that item. |
XML attributes | ||
---|---|---|
android:cacheColorHint |
Indicates that this list will always be drawn on top of solid, single-color opaque background. | |
android:choiceMode |
Defines the choice behavior for the view. | |
android:drawSelectorOnTop |
When set to true, the selector will be drawn over the selected item. | |
android:fastScrollEnabled |
Enables the fast scroll thumb that can be dragged to quickly scroll through the list. | |
android:listSelector |
Drawable used to indicate the currently selected item in the list. | |
android:scrollingCache |
When set to true, the list uses a drawing cache during scrolling. | |
android:smoothScrollbar |
When set to true, the list will use a more refined calculation method based on the pixels height of the items visible on screen. | |
android:stackFromBottom |
Used by ListView and GridView to stack their content from the bottom. | |
android:textFilterEnabled |
When set to true, the list will filter results as the user types. | |
android:transcriptMode |
Sets the transcript mode for the list. |
Inherited XML attributes | |
---|---|
Constants | |
---|---|
int |
CHOICE_MODE_MULTIPLE
The list allows multiple choices |
int |
CHOICE_MODE_MULTIPLE_MODAL
The list allows multiple choices in a modal selection mode |
int |
CHOICE_MODE_NONE
Normal list that does not indicate choices |
int |
CHOICE_MODE_SINGLE
The list allows up to one choice |
int |
TRANSCRIPT_MODE_ALWAYS_SCROLL
The list will automatically scroll to the bottom, no matter what items are currently visible. |
int |
TRANSCRIPT_MODE_DISABLED
Disables the transcript mode. |
int |
TRANSCRIPT_MODE_NORMAL
The list will automatically scroll to the bottom when a data set change notification is received and only if the last item is already visible on screen. |
Inherited constants |
---|
Inherited fields |
---|
Public constructors | |
---|---|
AbsListView(Context context)
|
|
AbsListView(Context context, AttributeSet attrs)
|
|
AbsListView(Context context, AttributeSet attrs, int defStyleAttr)
|
|
AbsListView(Context context, AttributeSet attrs, int defStyleAttr, int defStyleRes)
|
Public methods | |
---|---|
void
|
addTouchables(ArrayList<View> views)
Add any touchable views that are descendants of this view (possibly including this view if it is touchable itself) to views. |
void
|
afterTextChanged(Editable s)
For our text watcher that is associated with the text filter. |
void
|
beforeTextChanged(CharSequence s, int start, int count, int after)
For our text watcher that is associated with the text filter. |
boolean
|
canScrollList(int direction)
Check if the items in the list can be scrolled in a certain direction. |
boolean
|
checkInputConnectionProxy(View view)
For filtering we proxy an input connection to an internal text editor, and this allows the proxying to happen. |
void
|
clearChoices()
Clear any choices previously set |
void
|
clearTextFilter()
Clear the text filter. |
void
|
deferNotifyDataSetChanged()
This defers a notifyDataSetChanged on the pending RemoteViewsAdapter if it has not connected yet. |
void
|
dispatchDrawableHotspotChanged(float x, float y)
Dispatches drawable hotspot changes to child views that meet at least one of the following criteria:
|
void
|
draw(Canvas canvas)
Manually render this view (and all of its children) to the given Canvas. |
void
|
fling(int velocityY)
Initiate a fling with the given velocity. |
AbsListView.LayoutParams
|
generateLayoutParams(AttributeSet attrs)
Returns a new set of layout parameters based on the supplied attributes set. |
CharSequence
|
getAccessibilityClassName()
A TYPE_VIEW_SCROLLED event should be sent whenever a scroll happens, even if the mFirstPosition and the child count have not changed. |
int
|
getBottomEdgeEffectColor()
Returns the bottom edge effect color. |
int
|
getCacheColorHint()
When set to a non-zero value, the cache color hint indicates that this list is always drawn on top of a solid, single-color, opaque background |
int
|
getCheckedItemCount()
Returns the number of items currently selected. |
long[]
|
getCheckedItemIds()
Returns the set of checked items ids. |
int
|
getCheckedItemPosition()
Returns the currently checked item. |
SparseBooleanArray
|
getCheckedItemPositions()
Returns the set of checked items in the list. |
int
|
getChoiceMode()
|
void
|
getFocusedRect(Rect r)
When a view has focus and the user navigates away from it, the next view is searched for starting from the rectangle filled in by this method. |
int
|
getListPaddingBottom()
List padding is the maximum of the normal view's padding and the padding of the selector. |
int
|
getListPaddingLeft()
List padding is the maximum of the normal view's padding and the padding of the selector. |
int
|
getListPaddingRight()
List padding is the maximum of the normal view's padding and the padding of the selector. |
int
|
getListPaddingTop()
List padding is the maximum of the normal view's padding and the padding of the selector. |
View
|
getSelectedView()
|
Drawable
|
getSelector()
Returns the selector |
int
|
getSolidColor()
Override this if your view is known to always be drawn on top of a solid color background, and needs to draw fading edges. |
CharSequence
|
getTextFilter()
Returns the list's text filter, if available. |
int
|
getTopEdgeEffectColor()
Returns the top edge effect color. |
int
|
getTranscriptMode()
Returns the current transcript mode. |
int
|
getVerticalScrollbarWidth()
Returns the width of the vertical scrollbar. |
boolean
|
hasTextFilter()
Returns if the ListView currently has a text filter. |
void
|
invalidateViews()
Causes all the views to be rebuilt and redrawn. |
boolean
|
isDrawSelectorOnTop()
Returns whether the selection highlight drawable should be drawn on top of the item or behind it. |
boolean
|
isFastScrollAlwaysVisible()
Returns true if the fast scroller is set to always show on this view. |
boolean
|
isFastScrollEnabled()
Returns true if the fast scroller is enabled. |
boolean
|
isItemChecked(int position)
Returns the checked state of the specified position. |
boolean
|
isScrollingCacheEnabled()
Indicates whether the children's drawing cache is used during a scroll. |
boolean
|
isSelectedChildViewEnabled()
Returns whether the selected child view (from the adapter's getView) is enabled. |
boolean
|
isSmoothScrollbarEnabled()
Returns the current state of the fast scroll feature. |
boolean
|
isStackFromBottom()
Indicates whether the content of this view is pinned to, or stacked from, the bottom edge. |
boolean
|
isTextFilterEnabled()
Indicates whether type filtering is enabled for this view |
void
|
jumpDrawablesToCurrentState()
Call |
void
|
onCancelPendingInputEvents()
Called as the result of a call to |
InputConnection
|
onCreateInputConnection(EditorInfo outAttrs)
Return an InputConnection for editing of the filter text. |
void
|
onFilterComplete(int count)
Notifies the end of a filtering operation. |
boolean
|
onGenericMotionEvent(MotionEvent event)
Implement this method to handle generic motion events. |
void
|
onGlobalLayout()
Callback method to be invoked when the global layout state or the visibility of views within the view tree changes |
void
|
onInitializeAccessibilityNodeInfoForItem(View view, int position, AccessibilityNodeInfo info)
Initializes an |
boolean
|
onInterceptHoverEvent(MotionEvent event)
Implement this method to intercept hover events before they are handled by child views. |
boolean
|
onInterceptTouchEvent(MotionEvent ev)
Implement this method to intercept all touch screen motion events. |
boolean
|
onKeyDown(int keyCode, KeyEvent event)
Default implementation of |
boolean
|
onKeyUp(int keyCode, KeyEvent event)
Default implementation of |
boolean
|
onNestedFling(View target, float velocityX, float velocityY, boolean consumed)
Request a fling from a nested scroll. |
void
|
onNestedScroll(View target, int dxConsumed, int dyConsumed, int dxUnconsumed, int dyUnconsumed)
React to a nested scroll in progress. |
void
|
onNestedScrollAccepted(View child, View target, int axes)
React to the successful claiming of a nested scroll operation. |
void
|
onProvideContentCaptureStructure(ViewStructure structure, int flags)
Populates a |
boolean
|
onRemoteAdapterConnected()
Called back when the adapter connects to the RemoteViewsService. |
void
|
onRemoteAdapterDisconnected()
Called back when the adapter disconnects from the RemoteViewsService. |
PointerIcon
|
onResolvePointerIcon(MotionEvent event, int pointerIndex)
Resolve the pointer icon that should be used for specified pointer in the motion event. |
void
|
onRestoreInstanceState(Parcelable state)
Hook allowing a view to re-apply a representation of its internal state that had previously
been generated by |
void
|
onRtlPropertiesChanged(int layoutDirection)
Called when any RTL property (layout direction or text direction or text alignment) has been changed. |
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
|
onStartNestedScroll(View child, View target, int nestedScrollAxes)
React to a descendant view initiating a nestable scroll operation, claiming the nested scroll operation if appropriate. |
void
|
onTextChanged(CharSequence s, int start, int before, int count)
For our text watcher that is associated with the text filter. |
boolean
|
onTouchEvent(MotionEvent ev)
Implement this method to handle pointer events. |
void
|
onTouchModeChanged(boolean isInTouchMode)
Callback method to be invoked when the touch mode changes. |
void
|
onWindowFocusChanged(boolean hasWindowFocus)
Called when the window containing this view gains or loses focus. |
boolean
|
performItemClick(View view, int position, long id)
Call the OnItemClickListener, if it is defined. |
int
|
pointToPosition(int x, int y)
Maps a point to a position in the list. |
long
|
pointToRowId(int x, int y)
Maps a point to a the rowId of the item which intersects that point. |
void
|
reclaimViews(List<View> views)
Move all views (excluding headers and footers) held by this AbsListView into the supplied List. |
void
|
requestDisallowInterceptTouchEvent(boolean disallowIntercept)
Called when a child does not want this parent and its ancestors to
intercept touch events with
|
void
|
requestLayout()
Call this when something has changed which has invalidated the layout of this view. |
void
|
scrollListBy(int y)
Scrolls the list items within the view by a specified number of pixels. |
void
|
setAdapter(ListAdapter adapter)
Sets the adapter that provides the data and the views to represent the data in this widget. |
void
|
setBottomEdgeEffectColor(int color)
Sets the bottom edge effect color. |
void
|
setCacheColorHint(int color)
When set to a non-zero value, the cache color hint indicates that this list is always drawn on top of a solid, single-color, opaque background. |
void
|
setChoiceMode(int choiceMode)
Defines the choice behavior for the List. |
void
|
setDrawSelectorOnTop(boolean onTop)
Controls whether the selection highlight drawable should be drawn on top of the item or behind it. |
void
|
setEdgeEffectColor(int color)
Sets the edge effect color for both top and bottom edge effects. |
void
|
setFastScrollAlwaysVisible(boolean alwaysShow)
Set whether or not the fast scroller should always be shown in place of the standard scroll bars. |
void
|
setFastScrollEnabled(boolean enabled)
Specifies whether fast scrolling is enabled or disabled. |
void
|
setFastScrollStyle(int styleResId)
Specifies the style of the fast scroller decorations. |
void
|
setFilterText(String filterText)
Sets the initial value for the text filter. |
void
|
setFriction(float friction)
The amount of friction applied to flings. |
void
|
setItemChecked(int position, boolean value)
Sets the checked state of the specified position. |
void
|
setMultiChoiceModeListener(AbsListView.MultiChoiceModeListener listener)
Set a |
void
|
setOnScrollListener(AbsListView.OnScrollListener l)
Set the listener that will receive notifications every time the list scrolls. |
void
|
setRecyclerListener(AbsListView.RecyclerListener listener)
Sets the recycler listener to be notified whenever a View is set aside in the recycler for later reuse. |
void
|
setRemoteViewsAdapter(Intent intent)
Sets up this AbsListView to use a remote views adapter which connects to a RemoteViewsService through the specified intent. |
void
|
setScrollBarStyle(int style)
Specify the style of the scrollbars. |
void
|
setScrollIndicators(View up, View down)
|
void
|
setScrollingCacheEnabled(boolean enabled)
Enables or disables the children's drawing cache during a scroll. |
void
|
setSelectedChildViewEnabled(boolean selectedChildViewEnabled)
Set whether the selected child view (from the adapter's getView) is enabled. |
void
|
setSelectionFromTop(int position, int y)
Sets the selected item and positions the selection y pixels from the top edge of the ListView. |
void
|
setSelector(int resID)
Set a Drawable that should be used to highlight the currently selected item. |
void
|
setSelector(Drawable sel)
|
void
|
setSmoothScrollbarEnabled(boolean enabled)
When smooth scrollbar is enabled, the position and size of the scrollbar thumb is computed based on the number of visible pixels in the visible items. |
void
|
setStackFromBottom(boolean stackFromBottom)
When stack from bottom is set to true, the list fills its content starting from the bottom of the view. |
void
|
setTextFilterEnabled(boolean textFilterEnabled)
Enables or disables the type filter window. |
void
|
setTopEdgeEffectColor(int color)
Sets the top edge effect color. |
void
|
setTranscriptMode(int mode)
Puts the list or grid into transcript mode. |
void
|
setVelocityScale(float scale)
Sets a scale factor for the fling velocity. |
void
|
setVerticalScrollbarPosition(int position)
Set the position of the vertical scroll bar. |
boolean
|
showContextMenu(float x, float y)
Shows the context menu for this view anchored to the specified view-relative coordinate. |
boolean
|
showContextMenu()
Shows the context menu for this view. |
boolean
|
showContextMenuForChild(View originalView, float x, float y)
Shows the context menu for the specified view or its ancestors anchored to the specified view-relative coordinate. |
boolean
|
showContextMenuForChild(View originalView)
Shows the context menu for the specified view or its ancestors. |
void
|
smoothScrollBy(int distance, int duration)
Smoothly scroll by distance pixels over duration milliseconds. |
void
|
smoothScrollToPosition(int position)
Smoothly scroll to the specified adapter position. |
void
|
smoothScrollToPosition(int position, int boundPosition)
Smoothly scroll to the specified adapter position. |
void
|
smoothScrollToPositionFromTop(int position, int offset, int duration)
Smoothly scroll to the specified adapter position. |
void
|
smoothScrollToPositionFromTop(int position, int offset)
Smoothly scroll to the specified adapter position. |
boolean
|
verifyDrawable(Drawable dr)
If your view subclass is displaying its own Drawable objects, it should override this function and return true for any Drawable it is displaying. |
Protected methods | |
---|---|
boolean
|
checkLayoutParams(ViewGroup.LayoutParams p)
|
int
|
computeVerticalScrollExtent()
Compute the vertical extent of the vertical scrollbar's thumb within the vertical range. |
int
|
computeVerticalScrollOffset()
Compute the vertical offset of the vertical scrollbar's thumb within the horizontal range. |
int
|
computeVerticalScrollRange()
Compute the vertical range that the vertical scrollbar represents. |
void
|
dispatchDraw(Canvas canvas)
Called by draw to draw the child views. |
void
|
dispatchSetPressed(boolean pressed)
Dispatch setPressed to all of this View's children. |
void
|
drawableStateChanged()
This function is called whenever the state of the view changes in such a way that it impacts the state of drawables being shown. |
ViewGroup.LayoutParams
|
generateDefaultLayoutParams()
Returns a set of default layout parameters. |
ViewGroup.LayoutParams
|
generateLayoutParams(ViewGroup.LayoutParams p)
Returns a safe set of layout parameters based on the supplied layout params. |
float
|
getBottomFadingEdgeStrength()
Returns the strength, or intensity, of the bottom faded edge. |
int
|
getBottomPaddingOffset()
Amount by which to extend the bottom fading region. |
ContextMenu.ContextMenuInfo
|
getContextMenuInfo()
Views should implement this if they have extra information to associate with the context menu. |
int
|
getLeftPaddingOffset()
Amount by which to extend the left fading region. |
int
|
getRightPaddingOffset()
Amount by which to extend the right fading region. |
float
|
getTopFadingEdgeStrength()
Returns the strength, or intensity, of the top faded edge. |
int
|
getTopPaddingOffset()
Amount by which to extend the top fading region. |
void
|
handleDataChanged()
|
boolean
|
isInFilterMode()
|
boolean
|
isPaddingOffsetRequired()
If the View draws content inside its padding and enables fading edges, it needs to support padding offsets. |
void
|
layoutChildren()
Subclasses must override this method to layout their children. |
void
|
onAttachedToWindow()
This is called when the view is attached to a window. |
void
|
onDetachedFromWindow()
This is called when the view is detached from a window. |
void
|
onDisplayHint(int hint)
Gives this view a hint about whether is displayed or not. |
void
|
onFocusChanged(boolean gainFocus, int direction, Rect previouslyFocusedRect)
Called by the view system when the focus state of this view changes. |
void
|
onLayout(boolean changed, int l, int t, int r, int b)
Subclasses should NOT override this method but
|
void
|
onMeasure(int widthMeasureSpec, int heightMeasureSpec)
Measure the view and its content to determine the measured width and the measured height. |
void
|
onOverScrolled(int scrollX, int scrollY, boolean clampedX, boolean clampedY)
Called by |
void
|
onSizeChanged(int w, int h, int oldw, int oldh)
This is called during layout when the size of this view has changed. |
Inherited methods | |
---|---|
XML attributes
android:cacheColorHint
Indicates that this list will always be drawn on top of solid, single-color opaque background. This allows the list to optimize drawing.
May be a color value, in the form of "#rgb
",
"#argb
", "#rrggbb
", or
"#aarrggbb
".
android:choiceMode
Defines the choice behavior for the view. By default, lists do not have
any choice behavior. By setting the choiceMode to singleChoice, the list
allows up to one item to be in a chosen state. By setting the choiceMode to
multipleChoice, the list allows any number of items to be chosen.
Finally, by setting the choiceMode to multipleChoiceModal the list allows
any number of items to be chosen in a special selection mode.
The application will supply a
AbsListView.MultiChoiceModeListener
using
AbsListView.setMultiChoiceModeListener(MultiChoiceModeListener)
to control the
selection mode. This uses the ActionMode
API.
Must be one of the following constant values.
Constant | Value | Description |
---|---|---|
multipleChoice | 2 | The list allows multiple choices. |
multipleChoiceModal | 3 | The list allows multiple choices in a custom selection mode. |
none | 0 | Normal list that does not indicate choices. |
singleChoice | 1 | The list allows up to one choice. |
android:drawSelectorOnTop
When set to true, the selector will be drawn over the selected item. Otherwise the selector is drawn behind the selected item. The default value is false.
May be a boolean value, such as "true
" or
"false
".
Related methods:
android:fastScrollEnabled
Enables the fast scroll thumb that can be dragged to quickly scroll through the list.
May be a boolean value, such as "true
" or
"false
".
android:listSelector
Drawable used to indicate the currently selected item in the list.
May be a reference to another resource, in the form
"@[+][package:]type/name
" or a theme
attribute in the form
"?[package:]type/name
".
May be a color value, in the form of "#rgb
",
"#argb
", "#rrggbb
", or
"#aarrggbb
".
Related methods:
android:scrollingCache
When set to true, the list uses a drawing cache during scrolling. This makes the rendering faster but uses more memory. The default value is true.
May be a boolean value, such as "true
" or
"false
".
android:smoothScrollbar
When set to true, the list will use a more refined calculation method based on the pixels height of the items visible on screen. This property is set to true by default but should be set to false if your adapter will display items of varying heights. When this property is set to true and your adapter displays items of varying heights, the scrollbar thumb will change size as the user scrolls through the list. When set to false, the list will use only the number of items in the adapter and the number of items visible on screen to determine the scrollbar's properties.
May be a boolean value, such as "true
" or
"false
".
Related methods:
android:stackFromBottom
Used by ListView and GridView to stack their content from the bottom.
May be a boolean value, such as "true
" or
"false
".
android:textFilterEnabled
When set to true, the list will filter results as the user types. The List's adapter must support the Filterable interface for this to work.
May be a boolean value, such as "true
" or
"false
".
android:transcriptMode
Sets the transcript mode for the list. In transcript mode, the list scrolls to the bottom to make new items visible when they are added.
Must be one of the following constant values.
Constant | Value | Description |
---|---|---|
alwaysScroll | 2 | The list will automatically scroll to the bottom, no matter what items are currently visible. |
disabled | 0 | Disables transcript mode. This is the default value. |
normal | 1 | The list will automatically scroll to the bottom when a data set change notification is received and only if the last item is already visible on screen. |
Constants
CHOICE_MODE_MULTIPLE
public static final int CHOICE_MODE_MULTIPLE
The list allows multiple choices
Constant Value: 2 (0x00000002)
CHOICE_MODE_MULTIPLE_MODAL
public static final int CHOICE_MODE_MULTIPLE_MODAL
The list allows multiple choices in a modal selection mode
Constant Value: 3 (0x00000003)
CHOICE_MODE_NONE
public static final int CHOICE_MODE_NONE
Normal list that does not indicate choices
Constant Value: 0 (0x00000000)
CHOICE_MODE_SINGLE
public static final int CHOICE_MODE_SINGLE
The list allows up to one choice
Constant Value: 1 (0x00000001)
TRANSCRIPT_MODE_ALWAYS_SCROLL
public static final int TRANSCRIPT_MODE_ALWAYS_SCROLL
The list will automatically scroll to the bottom, no matter what items are currently visible.
See also:
Constant Value: 2 (0x00000002)
TRANSCRIPT_MODE_DISABLED
public static final int TRANSCRIPT_MODE_DISABLED
Disables the transcript mode.
See also:
Constant Value: 0 (0x00000000)
TRANSCRIPT_MODE_NORMAL
public static final int TRANSCRIPT_MODE_NORMAL
The list will automatically scroll to the bottom when a data set change notification is received and only if the last item is already visible on screen.
See also:
Constant Value: 1 (0x00000001)
Public constructors
AbsListView
public AbsListView (Context context, AttributeSet attrs)
Parameters | |
---|---|
context |
Context |
attrs |
AttributeSet |
AbsListView
public AbsListView (Context context, AttributeSet attrs, int defStyleAttr)
Parameters | |
---|---|
context |
Context |
attrs |
AttributeSet |
defStyleAttr |
int |
AbsListView
public AbsListView (Context context, AttributeSet attrs, int defStyleAttr, int defStyleRes)
Parameters | |
---|---|
context |
Context |
attrs |
AttributeSet |
defStyleAttr |
int |
defStyleRes |
int |
Public methods
addTouchables
public void addTouchables (ArrayList<View> views)
Add any touchable views that are descendants of this view (possibly including this view if it is touchable itself) to views.
Parameters | |
---|---|
views |
ArrayList : Touchable views found so far |
afterTextChanged
public void afterTextChanged (Editable s)
For our text watcher that is associated with the text filter. Does nothing.
Parameters | |
---|---|
s |
Editable |
beforeTextChanged
public void beforeTextChanged (CharSequence s, int start, int count, int after)
For our text watcher that is associated with the text filter. Does nothing.
Parameters | |
---|---|
s |
CharSequence |
start |
int |
count |
int |
after |
int |
canScrollList
public boolean canScrollList (int direction)
Check if the items in the list can be scrolled in a certain direction.
Parameters | |
---|---|
direction |
int : Negative to check scrolling up, positive to check
scrolling down. |
Returns | |
---|---|
boolean |
true if the list can be scrolled in the specified direction, false otherwise. |
See also:
checkInputConnectionProxy
public boolean checkInputConnectionProxy (View view)
For filtering we proxy an input connection to an internal text editor, and this allows the proxying to happen.
Parameters | |
---|---|
view |
View : The View that is making the InputMethodManager call. |
Returns | |
---|---|
boolean |
Return true to allow the call, false to reject. |
deferNotifyDataSetChanged
public void deferNotifyDataSetChanged ()
This defers a notifyDataSetChanged on the pending RemoteViewsAdapter if it has not connected yet.
dispatchDrawableHotspotChanged
public void dispatchDrawableHotspotChanged (float x, float y)
Dispatches drawable hotspot changes to child views that meet at least one of the following criteria:
- Returns
false
from bothView.isClickable()
andView.isLongClickable()
- Requests duplication of parent state via
View.setDuplicateParentStateEnabled(boolean)
Parameters | |
---|---|
x |
float : hotspot x coordinate |
y |
float : hotspot y coordinate |
draw
public void draw (Canvas canvas)
Manually render this view (and all of its children) to the given Canvas.
The view must have already done a full layout before this function is
called. When implementing a view, implement
onDraw(android.graphics.Canvas)
instead of overriding this method.
If you do need to override this method, call the superclass version.
If you override this method you must call through to the
superclass implementation.
Parameters | |
---|---|
canvas |
Canvas : The Canvas to which the View is rendered.
This value cannot be null . |
fling
public void fling (int velocityY)
Initiate a fling with the given velocity.
Applications can use this method to manually initiate a fling as if the user initiated it via touch interaction.
Parameters | |
---|---|
velocityY |
int : Vertical velocity in pixels per second. Note that this is velocity of
content, not velocity of a touch that initiated the fling. |
generateLayoutParams
public AbsListView.LayoutParams generateLayoutParams (AttributeSet attrs)
Returns a new set of layout parameters based on the supplied attributes set.
Parameters | |
---|---|
attrs |
AttributeSet : the attributes to build the layout parameters from |
Returns | |
---|---|
AbsListView.LayoutParams |
an instance of ViewGroup.LayoutParams or one
of its descendants |
getAccessibilityClassName
public CharSequence getAccessibilityClassName ()
A TYPE_VIEW_SCROLLED event should be sent whenever a scroll happens, even if the mFirstPosition and the child count have not changed.
Returns | |
---|---|
CharSequence |
getBottomEdgeEffectColor
public int getBottomEdgeEffectColor ()
Returns the bottom edge effect color.
Returns | |
---|---|
int |
The bottom edge effect color. |
getCacheColorHint
public int getCacheColorHint ()
When set to a non-zero value, the cache color hint indicates that this list is always drawn on top of a solid, single-color, opaque background
Returns | |
---|---|
int |
The cache color hint |
getCheckedItemCount
public int getCheckedItemCount ()
Returns the number of items currently selected. This will only be valid
if the choice mode is not CHOICE_MODE_NONE
(default).
To determine the specific items that are currently selected, use one of
the getChecked*
methods.
Returns | |
---|---|
int |
The number of items currently selected |
getCheckedItemIds
public long[] getCheckedItemIds ()
Returns the set of checked items ids. The result is only valid if the
choice mode has not been set to CHOICE_MODE_NONE
and the adapter
has stable IDs. (ListAdapter.hasStableIds()
== true
)
Returns | |
---|---|
long[] |
A new array which contains the id of each checked item in the list. |
getCheckedItemPosition
public int getCheckedItemPosition ()
Returns the currently checked item. The result is only valid if the choice
mode has been set to CHOICE_MODE_SINGLE
.
Returns | |
---|---|
int |
The position of the currently checked item or
AdapterView.INVALID_POSITION if nothing is selected |
See also:
getCheckedItemPositions
public SparseBooleanArray getCheckedItemPositions ()
Returns the set of checked items in the list. The result is only valid if
the choice mode has not been set to CHOICE_MODE_NONE
.
Returns | |
---|---|
SparseBooleanArray |
A SparseBooleanArray which will return true for each call to
get(int position) where position is a checked position in the
list and false otherwise, or null if the choice
mode is set to CHOICE_MODE_NONE . |
getChoiceMode
public int getChoiceMode ()
Returns | |
---|---|
int |
The current choice mode |
See also:
getFocusedRect
public void getFocusedRect (Rect r)
When a view has focus and the user navigates away from it, the next view is searched for
starting from the rectangle filled in by this method.
By default, the rectangle is the getDrawingRect(android.graphics.Rect)
)
of the view. However, if your view maintains some idea of internal selection,
such as a cursor, or a selected row or column, you should override this method and
fill in a more specific rectangle.
Parameters | |
---|---|
r |
Rect : The rectangle to fill in, in this view's coordinates. |
getListPaddingBottom
public int getListPaddingBottom ()
List padding is the maximum of the normal view's padding and the padding of the selector.
Returns | |
---|---|
int |
The bottom list padding. |
See also:
getListPaddingLeft
public int getListPaddingLeft ()
List padding is the maximum of the normal view's padding and the padding of the selector.
Returns | |
---|---|
int |
The left list padding. |
See also:
getListPaddingRight
public int getListPaddingRight ()
List padding is the maximum of the normal view's padding and the padding of the selector.
Returns | |
---|---|
int |
The right list padding. |
See also:
getListPaddingTop
public int getListPaddingTop ()
List padding is the maximum of the normal view's padding and the padding of the selector.
Returns | |
---|---|
int |
The top list padding. |
See also:
getSelectedView
public View getSelectedView ()
Returns | |
---|---|
View |
The view corresponding to the currently selected item, or null if nothing is selected |
getSelector
public Drawable getSelector ()
Returns the selector Drawable
that is used to draw the
selection in the list.
Returns | |
---|---|
Drawable |
the drawable used to display the selector |
getSolidColor
public int getSolidColor ()
Override this if your view is known to always be drawn on top of a solid color background, and needs to draw fading edges. Returning a non-zero color enables the view system to optimize the drawing of the fading edges. If you do return a non-zero color, the alpha should be set to 0xFF.
Returns | |
---|---|
int |
The known solid color background for this view, or 0 if the color may vary |
getTextFilter
public CharSequence getTextFilter ()
Returns the list's text filter, if available.
Returns | |
---|---|
CharSequence |
the list's text filter or null if filtering isn't enabled |
getTopEdgeEffectColor
public int getTopEdgeEffectColor ()
Returns the top edge effect color.
Returns | |
---|---|
int |
The top edge effect color. |
getTranscriptMode
public int getTranscriptMode ()
Returns the current transcript mode.
Returns | |
---|---|
int |
TRANSCRIPT_MODE_DISABLED , TRANSCRIPT_MODE_NORMAL or
TRANSCRIPT_MODE_ALWAYS_SCROLL |
getVerticalScrollbarWidth
public int getVerticalScrollbarWidth ()
Returns the width of the vertical scrollbar.
Returns | |
---|---|
int |
The width in pixels of the vertical scrollbar or 0 if there is no vertical scrollbar. |
hasTextFilter
public boolean hasTextFilter ()
Returns if the ListView currently has a text filter.
Returns | |
---|---|
boolean |
invalidateViews
public void invalidateViews ()
Causes all the views to be rebuilt and redrawn.
isDrawSelectorOnTop
public boolean isDrawSelectorOnTop ()
Returns whether the selection highlight drawable should be drawn on top of the item or behind it.
Related XML Attributes:
Returns | |
---|---|
boolean |
true if selector is drawn on top, false otherwise |
isFastScrollAlwaysVisible
public boolean isFastScrollAlwaysVisible ()
Returns true if the fast scroller is set to always show on this view.
Returns | |
---|---|
boolean |
true if the fast scroller will always show |
See also:
isFastScrollEnabled
public boolean isFastScrollEnabled ()
Returns true if the fast scroller is enabled.
Returns | |
---|---|
boolean |
true if fast scroll is enabled, false otherwise |
See also:
isItemChecked
public boolean isItemChecked (int position)
Returns the checked state of the specified position. The result is only
valid if the choice mode has been set to CHOICE_MODE_SINGLE
or CHOICE_MODE_MULTIPLE
.
Parameters | |
---|---|
position |
int : The item whose checked state to return |
Returns | |
---|---|
boolean |
The item's checked state or false if choice mode
is invalid |
See also:
isScrollingCacheEnabled
public boolean isScrollingCacheEnabled ()
Indicates whether the children's drawing cache is used during a scroll. By default, the drawing cache is enabled but this will consume more memory.
Returns | |
---|---|
boolean |
true if the scrolling cache is enabled, false otherwise |
isSelectedChildViewEnabled
public boolean isSelectedChildViewEnabled ()
Returns whether the selected child view (from the adapter's getView) is enabled.
Returns | |
---|---|
boolean |
true if enabled |
isSmoothScrollbarEnabled
public boolean isSmoothScrollbarEnabled ()
Returns the current state of the fast scroll feature.
Returns | |
---|---|
boolean |
True if smooth scrollbar is enabled is enabled, false otherwise. |
See also:
isStackFromBottom
public boolean isStackFromBottom ()
Indicates whether the content of this view is pinned to, or stacked from, the bottom edge.
Returns | |
---|---|
boolean |
true if the content is stacked from the bottom edge, false otherwise |
isTextFilterEnabled
public boolean isTextFilterEnabled ()
Indicates whether type filtering is enabled for this view
Returns | |
---|---|
boolean |
true if type filtering is enabled, false otherwise |
See also:
jumpDrawablesToCurrentState
public void jumpDrawablesToCurrentState ()
Call Drawable.jumpToCurrentState()
on all Drawable objects associated with this view.
Also calls StateListAnimator.jumpToCurrentState()
if there is a StateListAnimator
attached to this view.
If you override this method you must call through to the
superclass implementation.
onCancelPendingInputEvents
public void onCancelPendingInputEvents ()
Called as the result of a call to cancelPendingInputEvents()
on this view or
a parent view.
This method is responsible for removing any pending high-level input events that were
posted to the event queue to run later. Custom view classes that post their own deferred
high-level events via post(java.lang.Runnable)
, postDelayed(java.lang.Runnable, long)
or
Handler
should override this method, call
super.onCancelPendingInputEvents()
and remove those callbacks as appropriate.
onCreateInputConnection
public InputConnection onCreateInputConnection (EditorInfo outAttrs)
Return an InputConnection for editing of the filter text.
Parameters | |
---|---|
outAttrs |
EditorInfo : Fill in with attribute information about the connection. |
Returns | |
---|---|
InputConnection |
onFilterComplete
public void onFilterComplete (int count)
Notifies the end of a filtering operation.
Parameters | |
---|---|
count |
int : the number of values computed by the filter |
onGenericMotionEvent
public boolean onGenericMotionEvent (MotionEvent event)
Implement this method to handle generic motion events.
Generic motion events describe joystick movements, hover events from mouse or stylus
devices, trackpad touches, scroll wheel movements and other motion events not handled
by onTouchEvent(android.view.MotionEvent)
or onTrackballEvent(android.view.MotionEvent)
.
The source
of the motion event specifies
the class of input that was received. Implementations of this method
must examine the bits in the source before processing the event.
The following code example shows how this is done.
Generic motion events with source class InputDevice.SOURCE_CLASS_POINTER
are delivered to the view under the pointer. All other generic motion events are
delivered to the focused view.
public boolean onGenericMotionEvent(MotionEvent event) { if (event.isFromSource(InputDevice.SOURCE_CLASS_JOYSTICK)) { if (event.getAction() == MotionEvent.ACTION_MOVE) { // process the joystick movement... return true; } } if (event.isFromSource(InputDevice.SOURCE_CLASS_POINTER)) { switch (event.getAction()) { case MotionEvent.ACTION_HOVER_MOVE: // process the hover movement... return true; case MotionEvent.ACTION_SCROLL: // process the scroll wheel movement... return true; } } return super.onGenericMotionEvent(event); }
Parameters | |
---|---|
event |
MotionEvent : The generic motion event being processed. |
Returns | |
---|---|
boolean |
True if the event was handled, false otherwise. |
onGlobalLayout
public void onGlobalLayout ()
Callback method to be invoked when the global layout state or the visibility of views within the view tree changes
onInitializeAccessibilityNodeInfoForItem
public void onInitializeAccessibilityNodeInfoForItem (View view, int position, AccessibilityNodeInfo info)
Initializes an AccessibilityNodeInfo
with information about a
particular item in the list.
Parameters | |
---|---|
view |
View : View representing the list item. |
position |
int : Position of the list item within the adapter. |
info |
AccessibilityNodeInfo : Node info to populate. |
onInterceptHoverEvent
public boolean onInterceptHoverEvent (MotionEvent event)
Implement this method to intercept hover events before they are handled by child views.
This method is called before dispatching a hover event to a child of
the view group or to the view group's own View.onHoverEvent(MotionEvent)
to allow
the view group a chance to intercept the hover event.
This method can also be used to watch all pointer motions that occur within
the bounds of the view group even when the pointer is hovering over
a child of the view group rather than over the view group itself.
The view group can prevent its children from receiving hover events by
implementing this method and returning true
to indicate
that it would like to intercept hover events. The view group must
continuously return true
from onInterceptHoverEvent(MotionEvent)
for as long as it wishes to continue intercepting hover events from
its children.
Interception preserves the invariant that at most one view can be hovered at a time by transferring hover focus from the currently hovered child to the view group or vice-versa as needed.
If this method returns true
and a child is already hovered, then the
child view will first receive a hover exit event and then the view group
itself will receive a hover enter event in View.onHoverEvent(MotionEvent)
.
Likewise, if this method had previously returned true
to intercept hover
events and instead returns false
while the pointer is hovering
within the bounds of one of a child, then the view group will first receive a
hover exit event in View.onHoverEvent(MotionEvent)
and then the hovered child will
receive a hover enter event.
The default implementation handles mouse hover on the scroll bars.
Parameters | |
---|---|
event |
MotionEvent : The motion event that describes the hover. |
Returns | |
---|---|
boolean |
True if the view group would like to intercept the hover event and prevent its children from receiving it. |
onInterceptTouchEvent
public boolean onInterceptTouchEvent (MotionEvent ev)
Implement this method to intercept all touch screen motion events. This allows you to watch events as they are dispatched to your children, and take ownership of the current gesture at any point.
Using this function takes some care, as it has a fairly complicated
interaction with View.onTouchEvent(MotionEvent)
, and using it requires implementing
that method as well as this one in the correct way. Events will be
received in the following order:
- You will receive the down event here.
- The down event will be handled either by a child of this view group, or given to your own onTouchEvent() method to handle; this means you should implement onTouchEvent() to return true, so you will continue to see the rest of the gesture (instead of looking for a parent view to handle it). Also, by returning true from onTouchEvent(), you will not receive any following events in onInterceptTouchEvent() and all touch processing must happen in onTouchEvent() like normal.
- For as long as you return false from this function, each following event (up to and including the final up) will be delivered first here and then to the target's onTouchEvent().
- If you return true from here, you will not receive any
following events: the target view will receive the same event but
with the action
MotionEvent.ACTION_CANCEL
, and all further events will be delivered to your onTouchEvent() method and no longer appear here.
Parameters | |
---|---|
ev |
MotionEvent : The motion event being dispatched down the hierarchy. |
Returns | |
---|---|
boolean |
Return true to steal motion events from the children and have them dispatched to this ViewGroup through onTouchEvent(). The current target will receive an ACTION_CANCEL event, and no further messages will be delivered here. |
onKeyDown
public boolean onKeyDown (int keyCode, KeyEvent event)
Default implementation of KeyEvent.Callback.onKeyDown()
: perform press of the view
when KeyEvent.KEYCODE_DPAD_CENTER
or KeyEvent.KEYCODE_ENTER
is released, if the view is enabled and clickable.
Key presses in software keyboards will generally NOT trigger this listener, although some may elect to do so in some situations. Do not rely on this to catch software key presses.
Parameters | |
---|---|
keyCode |
int : a key code that represents the button pressed, from
KeyEvent |
event |
KeyEvent : the KeyEvent object that defines the button action |
Returns | |
---|---|
boolean |
If you handled the event, return true. If you want to allow the event to be handled by the next receiver, return false. |
onKeyUp
public boolean onKeyUp (int keyCode, KeyEvent event)
Default implementation of KeyEvent.Callback.onKeyUp()
: perform clicking of the view
when KeyEvent.KEYCODE_DPAD_CENTER
, KeyEvent.KEYCODE_ENTER
or KeyEvent.KEYCODE_SPACE
is released.
Key presses in software keyboards will generally NOT trigger this listener, although some may elect to do so in some situations. Do not rely on this to catch software key presses.
Parameters | |
---|---|
keyCode |
int : A key code that represents the button pressed, from
KeyEvent . |
event |
KeyEvent : The KeyEvent object that defines the button action. |
Returns | |
---|---|
boolean |
If you handled the event, return true. If you want to allow the event to be handled by the next receiver, return false. |
onNestedFling
public boolean onNestedFling (View target, float velocityX, float velocityY, boolean consumed)
Request a fling from a nested scroll.
This method signifies that a nested scrolling child has detected suitable conditions
for a fling. Generally this means that a touch scroll has ended with a
velocity
in the direction of scrolling that meets or exceeds
the minimum fling velocity
along a scrollable axis.
If a nested scrolling child view would normally fling but it is at the edge of its own content, it can use this method to delegate the fling to its nested scrolling parent instead. The parent may optionally consume the fling or observe a child fling.
Parameters | |
---|---|
target |
View : View that initiated the nested scroll
This value cannot be null . |
velocityX |
float : Horizontal velocity in pixels per second |
velocityY |
float : Vertical velocity in pixels per second |
consumed |
boolean : true if the child consumed the fling, false otherwise |
Returns | |
---|---|
boolean |
true if this parent consumed or otherwise reacted to the fling |
onNestedScroll
public void onNestedScroll (View target, int dxConsumed, int dyConsumed, int dxUnconsumed, int dyUnconsumed)
React to a nested scroll in progress.
This method will be called when the ViewParent's current nested scrolling child view
dispatches a nested scroll event. To receive calls to this method the ViewParent must have
previously returned true
for a call to
onStartNestedScroll(android.view.View, android.view.View, int)
.
Both the consumed and unconsumed portions of the scroll distance are reported to the ViewParent. An implementation may choose to use the consumed portion to match or chase scroll position of multiple child elements, for example. The unconsumed portion may be used to allow continuous dragging of multiple scrolling or draggable elements, such as scrolling a list within a vertical drawer where the drawer begins dragging once the edge of inner scrolling content is reached.
Parameters | |
---|---|
target |
View : The descendent view controlling the nested scroll
This value cannot be null . |
dxConsumed |
int : Horizontal scroll distance in pixels already consumed by target |
dyConsumed |
int : Vertical scroll distance in pixels already consumed by target |
dxUnconsumed |
int : Horizontal scroll distance in pixels not consumed by target |
dyUnconsumed |
int : Vertical scroll distance in pixels not consumed by target |
onNestedScrollAccepted
public void onNestedScrollAccepted (View child, View target, int axes)
React to the successful claiming of a nested scroll operation.
This method will be called after
onStartNestedScroll
returns true. It offers
an opportunity for the view and its superclasses to perform initial configuration
for the nested scroll. Implementations of this method should always call their superclass's
implementation of this method if one is present.
Parameters | |
---|---|
child |
View : Direct child of this ViewParent containing target
This value cannot be null . |
target |
View : View that initiated the nested scroll
This value cannot be null . |
axes |
int : Flags consisting of View.SCROLL_AXIS_HORIZONTAL ,
View.SCROLL_AXIS_VERTICAL or both |
onProvideContentCaptureStructure
public void onProvideContentCaptureStructure (ViewStructure structure, int flags)
Populates a ViewStructure
for content capture.
This method is called after a view that is eligible for content capture
(for example, if it isImportantForContentCapture()
, an intelligence service is
enabled for the user, and the activity rendering the view is enabled for content capture)
is laid out and is visible. The populated structure is then passed to the service through
ContentCaptureSession.notifyViewAppeared(ViewStructure)
.
The default implementation of this method sets the most relevant properties based on
related View
methods, and views in the standard Android widgets library also
override it to set their relevant properties. Therefore, if overriding this method, it
is recommended to call super.onProvideContentCaptureStructure()
.
Note: views that manage a virtual structure under this view must populate just
the node representing this view and return right away, then asynchronously report (not
necessarily in the UI thread) when the children nodes appear, disappear or have their text
changed by calling
ContentCaptureSession.notifyViewAppeared(ViewStructure)
,
ContentCaptureSession.notifyViewDisappeared(AutofillId)
, and
ContentCaptureSession.notifyViewTextChanged(AutofillId, CharSequence)
respectively. The structure for a child must be created using
ContentCaptureSession.newVirtualViewStructure(AutofillId, long)
, and the
autofillId
for a child can be obtained either through
childStructure.getAutofillId()
or
ContentCaptureSession.newAutofillId(AutofillId, long)
.
When the virtual view hierarchy represents a web page, you should also:
- Call
ContentCaptureManager.getContentCaptureConditions()
to infer content capture events should be generate for that URL. - Create a new
ContentCaptureSession
child for every HTML element that renders a new URL (like anIFRAME
) and use that session to notify events from that subtree.
Note: the following methods of the structure
will be ignored:
ViewStructure.setChildCount(int)
ViewStructure.addChildCount(int)
ViewStructure.getChildCount()
ViewStructure.newChild(int)
ViewStructure.asyncNewChild(int)
ViewStructure.asyncCommit()
ViewStructure.setWebDomain(String)
ViewStructure.newHtmlInfoBuilder(String)
ViewStructure.setHtmlInfo(android.view.ViewStructure.HtmlInfo)
ViewStructure.setDataIsSensitive(boolean)
ViewStructure.setAlpha(float)
ViewStructure.setElevation(float)
ViewStructure.setTransformation(Matrix)
ViewStructure
using the base implementation in View
. On API level 33 and higher, it may also
write information about the positions of active views to the extras bundle provided by the
ViewStructure
.
NOTE: When overriding this method on API level 33, if not calling super() or if changing the
logic for child views, be sure to provide values for the first active child view position and
the list of active child views in the ViewStructure
's extras Bundle
using the
"android.view.ViewStructure.extra.ACTIVE_CHILDREN_IDS" and
"android.view.ViewStructure.extra.FIRST_ACTIVE_POSITION" keys.
Parameters | |
---|---|
structure |
ViewStructure : ViewStructure to be filled in with structured view data.
This value cannot be null . |
flags |
int : optional flags. |
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.
onResolvePointerIcon
public PointerIcon onResolvePointerIcon (MotionEvent event, int pointerIndex)
Resolve the pointer icon that should be used for specified pointer in the motion event.
The default implementation will resolve the pointer icon to one set using
setPointerIcon(android.view.PointerIcon)
for mouse devices. Subclasses may override this to
customize the icon for the given pointer.
For example, to always show the PointerIcon.TYPE_HANDWRITING icon for a stylus pointer,
the event can be resolved in the following way:
@Override
public PointerIcon onResolvePointerIcon(MotionEvent event, int pointerIndex) {
final int toolType = event.getToolType(pointerIndex);
if (!event.isFromSource(InputDevice.SOURCE_MOUSE)
&& event.isFromSource(InputDevice.SOURCE_STYLUS)
&& (toolType == MotionEvent.TOOL_TYPE_STYLUS
|| toolType == MotionEvent.TOOL_TYPE_ERASER)) {
// Show this pointer icon only if this pointer is a stylus.
return PointerIcon.getSystemIcon(mContext, PointerIcon.TYPE_HANDWRITING);
}
// Use the default logic for determining the pointer icon for other non-stylus pointers,
// like for the mouse cursor.
return super.onResolvePointerIcon(event, pointerIndex);
}
Parameters | |
---|---|
event |
MotionEvent : The MotionEvent that requires a pointer icon to be resolved for one of
pointers. |
pointerIndex |
int : The index of the pointer in event for which to retrieve the
PointerIcon . This will be between 0 and MotionEvent.getPointerCount() . |
Returns | |
---|---|
PointerIcon |
the pointer icon to use for specified pointer, or null if a pointer icon
is not specified and the default icon should be used. |
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() . |
onRtlPropertiesChanged
public void onRtlPropertiesChanged (int layoutDirection)
Called when any RTL property (layout direction or text direction or text alignment) has been changed. Subclasses need to override this method to take care of cached information that depends on the resolved layout direction, or to inform child views that inherit their layout direction. The default implementation does nothing.
Parameters | |
---|---|
layoutDirection |
int : the direction of the layout
Value is View.LAYOUT_DIRECTION_LTR , or View.LAYOUT_DIRECTION_RTL |
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. |
onStartNestedScroll
public boolean onStartNestedScroll (View child, View target, int nestedScrollAxes)
React to a descendant view initiating a nestable scroll operation, claiming the nested scroll operation if appropriate.
This method will be called in response to a descendant view invoking
View.startNestedScroll(int)
. Each parent up the view hierarchy will be
given an opportunity to respond and claim the nested scrolling operation by returning
true
.
This method may be overridden by ViewParent implementations to indicate when the view
is willing to support a nested scrolling operation that is about to begin. If it returns
true, this ViewParent will become the target view's nested scrolling parent for the duration
of the scroll operation in progress. When the nested scroll is finished this ViewParent
will receive a call to onStopNestedScroll(android.view.View)
.
Parameters | |
---|---|
child |
View : Direct child of this ViewParent containing target
This value cannot be null . |
target |
View : View that initiated the nested scroll
This value cannot be null . |
nestedScrollAxes |
int : Flags consisting of View.SCROLL_AXIS_HORIZONTAL ,
View.SCROLL_AXIS_VERTICAL or both |
Returns | |
---|---|
boolean |
true if this ViewParent accepts the nested scroll operation |
onTextChanged
public void onTextChanged (CharSequence s, int start, int before, int count)
For our text watcher that is associated with the text filter. Performs the actual filtering as the text changes, and takes care of hiding and showing the popup displaying the currently entered filter text.
Parameters | |
---|---|
s |
CharSequence |
start |
int |
before |
int |
count |
int |
onTouchEvent
public boolean onTouchEvent (MotionEvent ev)
Implement this method to handle pointer events.
This method is called to handle motion events where pointers are down on the view. For example, this could include touchscreen touches, stylus touches, or click-and-drag events from a mouse. However, it is not called for motion events that do not involve pointers being down, such as hover events or mouse scroll wheel movements.
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 |
MotionEvent : The motion event. |
Returns | |
---|---|
boolean |
True if the event was handled, false otherwise. |
onTouchModeChanged
public void onTouchModeChanged (boolean isInTouchMode)
Callback method to be invoked when the touch mode changes.
Parameters | |
---|---|
isInTouchMode |
boolean : True if the view hierarchy is now in touch mode, false otherwise. |
onWindowFocusChanged
public void onWindowFocusChanged (boolean hasWindowFocus)
Called when the window containing this view gains or loses focus. Note that this is separate from view focus: to receive key events, both your view and its window must have focus. If a window is displayed on top of yours that takes input focus, then your own window will lose focus but the view focus will remain unchanged.
Parameters | |
---|---|
hasWindowFocus |
boolean : True if the window containing this view now has
focus, false otherwise. |
performItemClick
public boolean performItemClick (View view, int position, long id)
Call the OnItemClickListener, if it is defined. Performs all normal actions associated with clicking: reporting accessibility event, playing a sound, etc.
Parameters | |
---|---|
view |
View : The view within the AdapterView that was clicked. |
position |
int : The position of the view in the adapter. |
id |
long : The row id of the item that was clicked. |
Returns | |
---|---|
boolean |
True if there was an assigned OnItemClickListener that was called, false otherwise is returned. |
pointToPosition
public int pointToPosition (int x, int y)
Maps a point to a position in the list.
Parameters | |
---|---|
x |
int : X in local coordinate |
y |
int : Y in local coordinate |
Returns | |
---|---|
int |
The position of the item which contains the specified point, or
AdapterView.INVALID_POSITION if the point does not intersect an item. |
pointToRowId
public long pointToRowId (int x, int y)
Maps a point to a the rowId of the item which intersects that point.
Parameters | |
---|---|
x |
int : X in local coordinate |
y |
int : Y in local coordinate |
Returns | |
---|---|
long |
The rowId of the item which contains the specified point, or AdapterView.INVALID_ROW_ID
if the point does not intersect an item. |
reclaimViews
public void reclaimViews (List<View> views)
Move all views (excluding headers and footers) held by this AbsListView into the supplied List. This includes views displayed on the screen as well as views stored in AbsListView's internal view recycler.
Parameters | |
---|---|
views |
List : A list into which to put the reclaimed views |
requestDisallowInterceptTouchEvent
public void requestDisallowInterceptTouchEvent (boolean disallowIntercept)
Called when a child does not want this parent and its ancestors to
intercept touch events with
ViewGroup.onInterceptTouchEvent(MotionEvent)
.
This parent should pass this call onto its parents. This parent must obey this request for the duration of the touch (that is, only clear the flag after this parent has received an up or a cancel.
Parameters | |
---|---|
disallowIntercept |
boolean : True if the child does not want the parent to
intercept touch events. |
requestLayout
public void requestLayout ()
Call this when something has changed which has invalidated the
layout of this view. This will schedule a layout pass of the view
tree. This should not be called while the view hierarchy is currently in a layout
pass (isInLayout()
. If layout is happening, the request may be honored at the
end of the current layout pass (and then layout will run again) or after the current
frame is drawn and the next layout occurs.
Subclasses which override this method should call the superclass method to handle possible request-during-layout errors correctly.
If you override this method you must call through to the superclass implementation.
scrollListBy
public void scrollListBy (int y)
Scrolls the list items within the view by a specified number of pixels.
The actual amount of scroll is capped by the list content viewport height which is the list height minus top and bottom paddings minus one pixel.
Parameters | |
---|---|
y |
int : the amount of pixels to scroll by vertically |
See also:
setAdapter
public void setAdapter (ListAdapter adapter)
Sets the adapter that provides the data and the views to represent the data in this widget.
Parameters | |
---|---|
adapter |
ListAdapter : The adapter to use to create this view's content. |
setBottomEdgeEffectColor
public void setBottomEdgeEffectColor (int color)
Sets the bottom edge effect color.
Parameters | |
---|---|
color |
int : The color for the bottom edge effect. |
setCacheColorHint
public void setCacheColorHint (int color)
When set to a non-zero value, the cache color hint indicates that this list is always drawn
on top of a solid, single-color, opaque background.
Zero means that what's behind this object is translucent (non solid) or is not made of a
single color. This hint will not affect any existing background drawable set on this view (
typically set via View.setBackgroundDrawable(android.graphics.drawable.Drawable)
).
Parameters | |
---|---|
color |
int : The background color |
setChoiceMode
public void setChoiceMode (int choiceMode)
Defines the choice behavior for the List. By default, Lists do not have any choice behavior
(CHOICE_MODE_NONE
). By setting the choiceMode to CHOICE_MODE_SINGLE
, the
List allows up to one item to be in a chosen state. By setting the choiceMode to
CHOICE_MODE_MULTIPLE
, the list allows any number of items to be chosen.
Parameters | |
---|---|
choiceMode |
int : One of CHOICE_MODE_NONE , CHOICE_MODE_SINGLE , or
CHOICE_MODE_MULTIPLE |
setDrawSelectorOnTop
public void setDrawSelectorOnTop (boolean onTop)
Controls whether the selection highlight drawable should be drawn on top of the item or behind it.
Related XML Attributes:
Parameters | |
---|---|
onTop |
boolean : If true, the selector will be drawn on the item it is highlighting. The default
is false. |
setEdgeEffectColor
public void setEdgeEffectColor (int color)
Sets the edge effect color for both top and bottom edge effects.
Parameters | |
---|---|
color |
int : The color for the edge effects. |
setFastScrollAlwaysVisible
public void setFastScrollAlwaysVisible (boolean alwaysShow)
Set whether or not the fast scroller should always be shown in place of the standard scroll bars. This will enable fast scrolling if it is not already enabled.
Fast scrollers shown in this way will not fade out and will be a permanent fixture within the list. This is best combined with an inset scroll bar style to ensure the scroll bar does not overlap content.
Parameters | |
---|---|
alwaysShow |
boolean : true if the fast scroller should always be displayed,
false otherwise |
setFastScrollEnabled
public void setFastScrollEnabled (boolean enabled)
Specifies whether fast scrolling is enabled or disabled.
When fast scrolling is enabled, the user can quickly scroll through lists by dragging the fast scroll thumb.
If the adapter backing this list implements SectionIndexer
, the
fast scroller will display section header previews as the user scrolls.
Additionally, the user will be able to quickly jump between sections by
tapping along the length of the scroll bar.
Parameters | |
---|---|
enabled |
boolean : true to enable fast scrolling, false otherwise |
See also:
setFastScrollStyle
public void setFastScrollStyle (int styleResId)
Specifies the style of the fast scroller decorations.
Parameters | |
---|---|
styleResId |
int : style resource containing fast scroller properties |
See also:
setFilterText
public void setFilterText (String filterText)
Sets the initial value for the text filter.
Parameters | |
---|---|
filterText |
String : The text to use for the filter. |
See also:
setFriction
public void setFriction (float friction)
The amount of friction applied to flings. The default value
is ViewConfiguration.getScrollFriction
.
Parameters | |
---|---|
friction |
float |
setItemChecked
public void setItemChecked (int position, boolean value)
Sets the checked state of the specified position. The is only valid if
the choice mode has been set to CHOICE_MODE_SINGLE
or
CHOICE_MODE_MULTIPLE
.
Parameters | |
---|---|
position |
int : The item whose checked state is to be checked |
value |
boolean : The new checked state for the item |
setMultiChoiceModeListener
public void setMultiChoiceModeListener (AbsListView.MultiChoiceModeListener listener)
Set a MultiChoiceModeListener
that will manage the lifecycle of the
selection ActionMode
. Only used when the choice mode is set to
CHOICE_MODE_MULTIPLE_MODAL
.
Parameters | |
---|---|
listener |
AbsListView.MultiChoiceModeListener : Listener that will manage the selection mode |
See also:
setOnScrollListener
public void setOnScrollListener (AbsListView.OnScrollListener l)
Set the listener that will receive notifications every time the list scrolls.
Parameters | |
---|---|
l |
AbsListView.OnScrollListener : the scroll listener |
setRecyclerListener
public void setRecyclerListener (AbsListView.RecyclerListener listener)
Sets the recycler listener to be notified whenever a View is set aside in the recycler for later reuse. This listener can be used to free resources associated to the View.
Parameters | |
---|---|
listener |
AbsListView.RecyclerListener : The recycler listener to be notified of views set aside
in the recycler. |
See also:
setRemoteViewsAdapter
public void setRemoteViewsAdapter (Intent intent)
Sets up this AbsListView 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. |
setScrollBarStyle
public void setScrollBarStyle (int style)
Specify the style of the scrollbars. The scrollbars can be overlaid or inset. When inset, they add to the padding of the view. And the scrollbars can be drawn inside the padding area or on the edge of the view. For example, if a view has a background drawable and you want to draw the scrollbars inside the padding specified by the drawable, you can use SCROLLBARS_INSIDE_OVERLAY or SCROLLBARS_INSIDE_INSET. If you want them to appear at the edge of the view, ignoring the padding, then you can use SCROLLBARS_OUTSIDE_OVERLAY or SCROLLBARS_OUTSIDE_INSET.
Parameters | |
---|---|
style |
int : the style of the scrollbars. Should be one of
SCROLLBARS_INSIDE_OVERLAY, SCROLLBARS_INSIDE_INSET,
SCROLLBARS_OUTSIDE_OVERLAY or SCROLLBARS_OUTSIDE_INSET.
Value is View.SCROLLBARS_INSIDE_OVERLAY , View.SCROLLBARS_INSIDE_INSET , View.SCROLLBARS_OUTSIDE_OVERLAY , or View.SCROLLBARS_OUTSIDE_INSET |
setScrollIndicators
public void setScrollIndicators (View up, View down)
Parameters | |
---|---|
up |
View |
down |
View |
setScrollingCacheEnabled
public void setScrollingCacheEnabled (boolean enabled)
Enables or disables the children's drawing cache during a scroll.
By default, the drawing cache is enabled but this will use more memory.
When the scrolling cache is enabled, the caches are kept after the
first scrolling. You can manually clear the cache by calling
ViewGroup.setChildrenDrawingCacheEnabled(boolean)
.
Parameters | |
---|---|
enabled |
boolean : true to enable the scroll cache, false otherwise |
setSelectedChildViewEnabled
public void setSelectedChildViewEnabled (boolean selectedChildViewEnabled)
Set whether the selected child view (from the adapter's getView) is enabled. When refreshDrawableState is called, AbsListView will control the "enabled" state of the selector based on this.
Parameters | |
---|---|
selectedChildViewEnabled |
boolean : true if enabled |
setSelectionFromTop
public void setSelectionFromTop (int position, int y)
Sets the selected item and positions the selection y pixels from the top edge of the ListView. (If in touch mode, the item will not be selected but it will still be positioned appropriately.)
Parameters | |
---|---|
position |
int : Index (starting at 0) of the data item to be selected. |
y |
int : The distance from the top edge of the ListView (plus padding) that the
item will be positioned. |
setSelector
public void setSelector (int resID)
Set a Drawable that should be used to highlight the currently selected item.
Related XML Attributes:
Parameters | |
---|---|
resID |
int : A Drawable resource to use as the selection highlight. |
setSmoothScrollbarEnabled
public void setSmoothScrollbarEnabled (boolean enabled)
When smooth scrollbar is enabled, the position and size of the scrollbar thumb is computed based on the number of visible pixels in the visible items. This however assumes that all list items have the same height. If you use a list in which items have different heights, the scrollbar will change appearance as the user scrolls through the list. To avoid this issue, you need to disable this property. When smooth scrollbar is disabled, the position and size of the scrollbar thumb is based solely on the number of items in the adapter and the position of the visible items inside the adapter. This provides a stable scrollbar as the user navigates through a list of items with varying heights.
Related XML Attributes:
Parameters | |
---|---|
enabled |
boolean : Whether or not to enable smooth scrollbar. |
See also:
setStackFromBottom
public void setStackFromBottom (boolean stackFromBottom)
When stack from bottom is set to true, the list fills its content starting from the bottom of the view.
Parameters | |
---|---|
stackFromBottom |
boolean : true to pin the view's content to the bottom edge,
false to pin the view's content to the top edge |
setTextFilterEnabled
public void setTextFilterEnabled (boolean textFilterEnabled)
Enables or disables the type filter window. If enabled, typing when
this view has focus will filter the children to match the users input.
Note that the Adapter
used by this view must implement the
Filterable
interface.
Parameters | |
---|---|
textFilterEnabled |
boolean : true to enable type filtering, false otherwise |
See also:
setTopEdgeEffectColor
public void setTopEdgeEffectColor (int color)
Sets the top edge effect color.
Parameters | |
---|---|
color |
int : The color for the top edge effect. |
setTranscriptMode
public void setTranscriptMode (int mode)
Puts the list or grid into transcript mode. In this mode the list or grid will always scroll to the bottom to show new items.
Parameters | |
---|---|
mode |
int : the transcript mode to set |
setVelocityScale
public void setVelocityScale (float scale)
Sets a scale factor for the fling velocity. The initial scale factor is 1.0.
Parameters | |
---|---|
scale |
float : The scale factor to multiply the velocity by. |
setVerticalScrollbarPosition
public void setVerticalScrollbarPosition (int position)
Set the position of the vertical scroll bar. Should be one of
SCROLLBAR_POSITION_DEFAULT
, SCROLLBAR_POSITION_LEFT
or
SCROLLBAR_POSITION_RIGHT
.
Parameters | |
---|---|
position |
int : Where the vertical scroll bar should be positioned. |
showContextMenu
public boolean showContextMenu (float x, float y)
Shows the context menu for this view anchored to the specified view-relative coordinate.
Parameters | |
---|---|
x |
float : the X coordinate in pixels relative to the view to which the
menu should be anchored, or Float.NaN to disable anchoring |
y |
float : the Y coordinate in pixels relative to the view to which the
menu should be anchored, or Float.NaN to disable anchoring |
Returns | |
---|---|
boolean |
true if the context menu was shown, false
otherwise |
showContextMenu
public boolean showContextMenu ()
Shows the context menu for this view.
Returns | |
---|---|
boolean |
true if the context menu was shown, false
otherwise |
showContextMenuForChild
public boolean showContextMenuForChild (View originalView, float x, float y)
Shows the context menu for the specified view or its ancestors anchored to the specified view-relative coordinate.
In most cases, a subclass does not need to override this. However, if
the subclass is added directly to the window manager (for example,
ViewManager.addView(View, android.view.ViewGroup.LayoutParams)
)
then it should override this and show the context menu.
If a subclass overrides this method it should also override
showContextMenuForChild(android.view.View)
.
Parameters | |
---|---|
originalView |
View : the source view where the context menu was first
invoked |
x |
float : the X coordinate in pixels relative to the original view to
which the menu should be anchored, or Float.NaN to
disable anchoring |
y |
float : the Y coordinate in pixels relative to the original view to
which the menu should be anchored, or Float.NaN to
disable anchoring |
Returns | |
---|---|
boolean |
true if the context menu was shown, false
otherwise |
showContextMenuForChild
public boolean showContextMenuForChild (View originalView)
Shows the context menu for the specified view or its ancestors.
In most cases, a subclass does not need to override this. However, if
the subclass is added directly to the window manager (for example,
ViewManager.addView(View, android.view.ViewGroup.LayoutParams)
)
then it should override this and show the context menu.
Parameters | |
---|---|
originalView |
View : the source view where the context menu was first
invoked |
Returns | |
---|---|
boolean |
true if the context menu was shown, false
otherwise |
smoothScrollBy
public void smoothScrollBy (int distance, int duration)
Smoothly scroll by distance pixels over duration milliseconds.
Parameters | |
---|---|
distance |
int : Distance to scroll in pixels. |
duration |
int : Duration of the scroll animation in milliseconds. |
smoothScrollToPosition
public void smoothScrollToPosition (int position)
Smoothly scroll to the specified adapter position. The view will scroll such that the indicated position is displayed.
Parameters | |
---|---|
position |
int : Scroll to this adapter position. |
smoothScrollToPosition
public void smoothScrollToPosition (int position, int boundPosition)
Smoothly scroll to the specified adapter position. The view will scroll such that the indicated position is displayed, but it will stop early if scrolling further would scroll boundPosition out of view.
Parameters | |
---|---|
position |
int : Scroll to this adapter position. |
boundPosition |
int : Do not scroll if it would move this adapter
position out of view. |
smoothScrollToPositionFromTop
public void smoothScrollToPositionFromTop (int position, int offset, int duration)
Smoothly scroll to the specified adapter position. The view will scroll
such that the indicated position is displayed offset
pixels below
the top edge of the view. If this is impossible, (e.g. the offset would scroll
the first or last item beyond the boundaries of the list) it will get as close
as possible. The scroll will take duration
milliseconds to complete.
Parameters | |
---|---|
position |
int : Position to scroll to |
offset |
int : Desired distance in pixels of position from the top
of the view when scrolling is finished |
duration |
int : Number of milliseconds to use for the scroll |
smoothScrollToPositionFromTop
public void smoothScrollToPositionFromTop (int position, int offset)
Smoothly scroll to the specified adapter position. The view will scroll
such that the indicated position is displayed offset
pixels below
the top edge of the view. If this is impossible, (e.g. the offset would scroll
the first or last item beyond the boundaries of the list) it will get as close
as possible.
Parameters | |
---|---|
position |
int : Position to scroll to |
offset |
int : Desired distance in pixels of position from the top
of the view when scrolling is finished |
verifyDrawable
public boolean verifyDrawable (Drawable dr)
If your view subclass is displaying its own Drawable objects, it should override this function and return true for any Drawable it is displaying. This allows animations for those drawables to be scheduled.
Be sure to call through to the super class when overriding this
function.
If you override this method you must call through to the
superclass implementation.
Parameters | |
---|---|
dr |
Drawable : This value cannot be null . |
Returns | |
---|---|
boolean |
boolean If true then the Drawable is being displayed in the view; else false and it is not allowed to animate. |
Protected methods
checkLayoutParams
protected boolean checkLayoutParams (ViewGroup.LayoutParams p)
Parameters | |
---|---|
p |
ViewGroup.LayoutParams |
Returns | |
---|---|
boolean |
computeVerticalScrollExtent
protected int computeVerticalScrollExtent ()
Compute the vertical extent of the vertical scrollbar's thumb within the vertical range. This value is used to compute the length of the thumb within the scrollbar's track.
The range is expressed in arbitrary units that must be the same as the
units used by computeVerticalScrollRange()
and
computeVerticalScrollOffset()
.
The default extent is the drawing height of this view.
Returns | |
---|---|
int |
the vertical extent of the scrollbar's thumb |
computeVerticalScrollOffset
protected int computeVerticalScrollOffset ()
Compute the vertical offset of the vertical scrollbar's thumb within the horizontal range. This value is used to compute the position of the thumb within the scrollbar's track.
The range is expressed in arbitrary units that must be the same as the
units used by computeVerticalScrollRange()
and
computeVerticalScrollExtent()
.
The default offset is the scroll offset of this view.
Returns | |
---|---|
int |
the vertical offset of the scrollbar's thumb |
computeVerticalScrollRange
protected int computeVerticalScrollRange ()
Compute the vertical range that the vertical scrollbar represents.
The range is expressed in arbitrary units that must be the same as the
units used by computeVerticalScrollExtent()
and
computeVerticalScrollOffset()
.
Returns | |
---|---|
int |
the total vertical range represented by the vertical scrollbar
The default range is the drawing height of this view. |
dispatchDraw
protected void dispatchDraw (Canvas canvas)
Called by draw to draw the child views. This may be overridden by derived classes to gain control just before its children are drawn (but after its own view has been drawn).
Parameters | |
---|---|
canvas |
Canvas : This value cannot be null . |
dispatchSetPressed
protected void dispatchSetPressed (boolean pressed)
Dispatch setPressed to all of this View's children.
Parameters | |
---|---|
pressed |
boolean : The new pressed state |
drawableStateChanged
protected void drawableStateChanged ()
This function is called whenever the state of the view changes in such a way that it impacts the state of drawables being shown.
If the View has a StateListAnimator, it will also be called to run necessary state change animations.
Be sure to call through to the superclass when overriding this function.
If you override this method you must call through to the
superclass implementation.
generateDefaultLayoutParams
protected ViewGroup.LayoutParams generateDefaultLayoutParams ()
Returns a set of default layout parameters. These parameters are requested
when the View passed to addView(android.view.View)
has no layout parameters
already set. If null is returned, an exception is thrown from addView.
Returns | |
---|---|
ViewGroup.LayoutParams |
a set of default layout parameters or null |
generateLayoutParams
protected ViewGroup.LayoutParams generateLayoutParams (ViewGroup.LayoutParams p)
Returns a safe set of layout parameters based on the supplied layout params.
When a ViewGroup is passed a View whose layout params do not pass the test of
checkLayoutParams(android.view.ViewGroup.LayoutParams)
, this method
is invoked. This method should return a new set of layout params suitable for
this ViewGroup, possibly by copying the appropriate attributes from the
specified set of layout params.
Parameters | |
---|---|
p |
ViewGroup.LayoutParams : The layout parameters to convert into a suitable set of layout parameters
for this ViewGroup. |
Returns | |
---|---|
ViewGroup.LayoutParams |
an instance of ViewGroup.LayoutParams or one
of its descendants |
getBottomFadingEdgeStrength
protected float getBottomFadingEdgeStrength ()
Returns the strength, or intensity, of the bottom faded edge. The strength is a value between 0.0 (no fade) and 1.0 (full fade). The default implementation returns 0.0 or 1.0 but no value in between. Subclasses should override this method to provide a smoother fade transition when scrolling occurs.
Returns | |
---|---|
float |
the intensity of the bottom fade as a float between 0.0f and 1.0f |
getBottomPaddingOffset
protected int getBottomPaddingOffset ()
Amount by which to extend the bottom fading region. Called only when
isPaddingOffsetRequired()
returns true.
Returns | |
---|---|
int |
The bottom padding offset in pixels. |
getContextMenuInfo
protected ContextMenu.ContextMenuInfo getContextMenuInfo ()
Views should implement this if they have extra information to associate
with the context menu. The return result is supplied as a parameter to
the OnCreateContextMenuListener.onCreateContextMenu(ContextMenu, View, ContextMenuInfo)
callback.
Returns | |
---|---|
ContextMenu.ContextMenuInfo |
Extra information about the item for which the context menu should be shown. This information will vary across different subclasses of View. |
getLeftPaddingOffset
protected int getLeftPaddingOffset ()
Amount by which to extend the left fading region. Called only when
isPaddingOffsetRequired()
returns true.
Returns | |
---|---|
int |
The left padding offset in pixels. |
getRightPaddingOffset
protected int getRightPaddingOffset ()
Amount by which to extend the right fading region. Called only when
isPaddingOffsetRequired()
returns true.
Returns | |
---|---|
int |
The right padding offset in pixels. |
getTopFadingEdgeStrength
protected float getTopFadingEdgeStrength ()
Returns the strength, or intensity, of the top faded edge. The strength is a value between 0.0 (no fade) and 1.0 (full fade). The default implementation returns 0.0 or 1.0 but no value in between. Subclasses should override this method to provide a smoother fade transition when scrolling occurs.
Returns | |
---|---|
float |
the intensity of the top fade as a float between 0.0f and 1.0f |
getTopPaddingOffset
protected int getTopPaddingOffset ()
Amount by which to extend the top fading region. Called only when
isPaddingOffsetRequired()
returns true.
Returns | |
---|---|
int |
The top padding offset in pixels. |
isPaddingOffsetRequired
protected boolean isPaddingOffsetRequired ()
If the View draws content inside its padding and enables fading edges, it needs to support padding offsets. Padding offsets are added to the fading edges to extend the length of the fade so that it covers pixels drawn inside the padding. Subclasses of this class should override this method if they need to draw content inside the padding.
Returns | |
---|---|
boolean |
True if padding offset must be applied, false otherwise. |
layoutChildren
protected void layoutChildren ()
Subclasses must override this method to layout their children.
onAttachedToWindow
protected void onAttachedToWindow ()
This is called when the view is attached to a window. At this point it
has a Surface and will start drawing. Note that this function is
guaranteed to be called before onDraw(android.graphics.Canvas)
,
however it may be called any time before the first onDraw -- including
before or after onMeasure(int, int)
.
If you override this method you must call through to the
superclass implementation.
onDetachedFromWindow
protected void onDetachedFromWindow ()
This is called when the view is detached from a window. At this point it
no longer has a surface for drawing.
If you override this method you must call through to the
superclass implementation.
onDisplayHint
protected void onDisplayHint (int hint)
Gives this view a hint about whether is displayed or not. For instance, when a View moves out of the screen, it might receives a display hint indicating the view is not displayed. Applications should not rely on this hint as there is no guarantee that they will receive one.
Parameters | |
---|---|
hint |
int : A hint about whether or not this view is displayed:
View.VISIBLE or View.INVISIBLE .
Value is View.VISIBLE , View.INVISIBLE , or View.GONE |
onFocusChanged
protected void onFocusChanged (boolean gainFocus, int direction, Rect previouslyFocusedRect)
Called by the view system when the focus state of this view changes.
When the focus change event is caused by directional navigation, direction
and previouslyFocusedRect provide insight into where the focus is coming from.
When overriding, be sure to call up through to the super class so that
the standard focus handling will occur.
If you override this method you must call through to the
superclass implementation.
Parameters | |
---|---|
gainFocus |
boolean : True if the View has focus; false otherwise. |
direction |
int : The direction focus has moved when requestFocus()
is called to give this view focus. Values are
View.FOCUS_UP , View.FOCUS_DOWN , View.FOCUS_LEFT ,
View.FOCUS_RIGHT , View.FOCUS_FORWARD , or View.FOCUS_BACKWARD .
It may not always apply, in which case use the default.
Value is View.FOCUS_BACKWARD , View.FOCUS_FORWARD , View.FOCUS_LEFT , View.FOCUS_UP , View.FOCUS_RIGHT , or View.FOCUS_DOWN |
previouslyFocusedRect |
Rect : The rectangle, in this view's coordinate
system, of the previously focused view. If applicable, this will be
passed in as finer grained information about where the focus is coming
from (in addition to direction). Will be null otherwise. |
onLayout
protected void onLayout (boolean changed, int l, int t, int r, int b)
Subclasses should NOT override this method but
layoutChildren()
instead.
Parameters | |
---|---|
changed |
boolean : This is a new size or position for this view |
l |
int : Left position, relative to parent |
t |
int : Top position, relative to parent |
r |
int : Right position, relative to parent |
b |
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 . |
onOverScrolled
protected void onOverScrolled (int scrollX, int scrollY, boolean clampedX, boolean clampedY)
Called by overScrollBy(int, int, int, int, int, int, int, int, boolean)
to
respond to the results of an over-scroll operation.
Parameters | |
---|---|
scrollX |
int : New X scroll value in pixels |
scrollY |
int : New Y scroll value in pixels |
clampedX |
boolean : True if scrollX was clamped to an over-scroll boundary |
clampedY |
boolean : True if scrollY was clamped to an over-scroll boundary |
onSizeChanged
protected void onSizeChanged (int w, int h, int oldw, int oldh)
This is called during layout when the size of this view has changed. If you were just added to the view hierarchy, you're called with the old values of 0.
Parameters | |
---|---|
w |
int : Current width of this view. |
h |
int : Current height of this view. |
oldw |
int : Old width of this view. |
oldh |
int : Old height of this view. |
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 2024-12-18 UTC.