Added in API level 3

HorizontalScrollView


open class HorizontalScrollView : FrameLayout
kotlin.Any
   ↳ android.view.View
   ↳ android.view.ViewGroup
   ↳ android.widget.FrameLayout
   ↳ android.widget.HorizontalScrollView

Layout container for a view hierarchy that can be scrolled by the user, allowing it to be larger than the physical display. A HorizontalScrollView is a FrameLayout, meaning you should place one child in it containing the entire contents to scroll; this child may itself be a layout manager with a complex hierarchy of objects. A child that is often used is a LinearLayout in a horizontal orientation, presenting a horizontal array of top-level items that the user can scroll through.

The TextView class also takes care of its own scrolling, so does not require a HorizontalScrollView, but using the two together is possible to achieve the effect of a text view within a larger container.

HorizontalScrollView only supports horizontal scrolling. For vertical scrolling, use either ScrollView or ListView.

Summary

XML attributes
android:fillViewport Defines whether the scrollview should stretch its content to fill the viewport.
Inherited XML attributes
Inherited constants
Public constructors

HorizontalScrollView(context: Context!, attrs: AttributeSet!, defStyleAttr: Int)

HorizontalScrollView(context: Context!, attrs: AttributeSet!, defStyleAttr: Int, defStyleRes: Int)

Public methods
open Unit
addView(child: View!)

open Unit
addView(child: View!, index: Int)

open Unit
addView(child: View!, params: ViewGroup.LayoutParams!)

open Unit
addView(child: View!, index: Int, params: ViewGroup.LayoutParams!)

open Boolean
arrowScroll(direction: Int)

Handle scrolling in response to a left or right arrow click.

open Unit

open Boolean

open Unit
draw(canvas: Canvas)

open Boolean

You can call this function yourself to have the scroll view perform scrolling from a key event, just as if the event had been dispatched to it by the view hierarchy.

open Unit
fling(velocityX: Int)

Fling the scroll view

open Boolean
fullScroll(direction: Int)

Handles scrolling in response to a "home/end" shortcut press.

open CharSequence!

open Int

Returns the left edge effect color.

open Int

open Int

Returns the right edge effect color.

open Boolean

Indicates whether this HorizontalScrollView's content is stretched to fill the viewport.

open Boolean

open Boolean

open Boolean

open Boolean

open Boolean
pageScroll(direction: Int)

Handles scrolling in response to a "page up/down" shortcut press.

open Unit
requestChildFocus(child: View!, focused: View!)

open Boolean
requestChildRectangleOnScreen(child: View, rectangle: Rect!, immediate: Boolean)

open Unit

open Unit

open Unit
scrollTo(x: Int, y: Int)

Set the scrolled position of your view.

open Unit

Sets the edge effect color for both left and right edge effects.

open Unit
setFillViewport(fillViewport: Boolean)

Indicates this HorizontalScrollView whether it should stretch its content width to fill the viewport or not.

open Unit

Sets the left edge effect color.

open Unit

Sets the right edge effect color.

open Unit
setSmoothScrollingEnabled(smoothScrollingEnabled: Boolean)

Set whether arrow scrolling will animate its transition.

open Boolean

Unit
smoothScrollBy(dx: Int, dy: Int)

Like View#scrollBy, but scroll smoothly instead of immediately.

Unit

Like scrollTo, but scroll smoothly instead of immediately.

Protected methods
open Int

open Int

The scroll range of a scroll view is the overall width of all of its children.

open Int

Compute the amount to scroll in the X direction in order to get a rectangle completely on the screen (or, if taller than the screen, at least the first screen size chunk of it).

open Float

open Float

open Unit
measureChild(child: View!, parentWidthMeasureSpec: Int, parentHeightMeasureSpec: Int)

open Unit
measureChildWithMargins(child: View!, parentWidthMeasureSpec: Int, widthUsed: Int, parentHeightMeasureSpec: Int, heightUsed: Int)

open Unit
onLayout(changed: Boolean, l: Int, t: Int, r: Int, b: Int)

open Unit
onMeasure(widthMeasureSpec: Int, heightMeasureSpec: Int)

open Unit
onOverScrolled(scrollX: Int, scrollY: Int, clampedX: Boolean, clampedY: Boolean)

open Boolean
onRequestFocusInDescendants(direction: Int, previouslyFocusedRect: Rect!)

When looking for focus in children of a scroll view, need to be a little more careful not to give focus to something that is scrolled off screen.

open Unit

open Parcelable?

open Unit
onSizeChanged(w: Int, h: Int, oldw: Int, oldh: Int)

Inherited functions
Inherited properties

XML attributes

android:fillViewport

android:fillViewport
Defines whether the scrollview should stretch its content to fill the viewport.

May be a boolean value, such as "true" or "false".

Public constructors

HorizontalScrollView

Added in API level 3
HorizontalScrollView(context: Context!)

HorizontalScrollView

Added in API level 3
HorizontalScrollView(
    context: Context!,
    attrs: AttributeSet!)

HorizontalScrollView

Added in API level 3
HorizontalScrollView(
    context: Context!,
    attrs: AttributeSet!,
    defStyleAttr: Int)

HorizontalScrollView

Added in API level 21
HorizontalScrollView(
    context: Context!,
    attrs: AttributeSet!,
    defStyleAttr: Int,
    defStyleRes: Int)

Public methods

addView

Added in API level 3
open fun addView(child: View!): Unit
Parameters
child View!: the child view to add

addView

Added in API level 3
open fun addView(
    child: View!,
    index: Int
): Unit
Parameters
child View!: the child view to add
index Int: the position at which to add the child

addView

Added in API level 3
open fun addView(
    child: View!,
    params: ViewGroup.LayoutParams!
): Unit
Parameters
view The view to be added to this window.
params ViewGroup.LayoutParams!: the layout parameters to set on the child
child View!: the child view to add

addView

Added in API level 3
open fun addView(
    child: View!,
    index: Int,
    params: ViewGroup.LayoutParams!
): Unit
Parameters
child View!: the child view to add
index Int: the position at which to add the child or -1 to add last
params ViewGroup.LayoutParams!: the layout parameters to set on the child

arrowScroll

Added in API level 3
open fun arrowScroll(direction: Int): Boolean

Handle scrolling in response to a left or right arrow click.

Parameters
direction Int: The direction corresponding to the arrow key that was pressed
Return
Boolean True if we consumed the event, false otherwise

computeScroll

Added in API level 3
open fun computeScroll(): Unit

dispatchKeyEvent

Added in API level 3
open fun dispatchKeyEvent(event: KeyEvent!): Boolean
Parameters
event KeyEvent!: The key event to be dispatched.
Return
Boolean True if the event was handled, false otherwise.

draw

Added in API level 3
open fun draw(canvas: Canvas): Unit
Parameters
canvas Canvas: The Canvas to which the View is rendered. This value cannot be null.

executeKeyEvent

Added in API level 3
open fun executeKeyEvent(event: KeyEvent!): Boolean

You can call this function yourself to have the scroll view perform scrolling from a key event, just as if the event had been dispatched to it by the view hierarchy.

Parameters
event KeyEvent!: The key event to execute.
Return
Boolean Return true if the event was handled, else false.

fling

Added in API level 3
open fun fling(velocityX: Int): Unit

Fling the scroll view

Parameters
velocityX Int: The initial velocity in the X direction. Positive numbers mean that the finger/cursor is moving down the screen, which means we want to scroll towards the left.

fullScroll

Added in API level 3
open fun fullScroll(direction: Int): Boolean

Handles scrolling in response to a "home/end" shortcut press. This method will scroll the view to the left or right and give the focus to the leftmost/rightmost component in the new visible area. If no component is a good candidate for focus, this scrollview reclaims the focus.

Parameters
direction Int: the scroll direction: android.view.View#FOCUS_LEFT to go the left of the view or android.view.View#FOCUS_RIGHT to go the right
Return
Boolean true if the key event is consumed by this method, false otherwise

getAccessibilityClassName

Added in API level 23
open fun getAccessibilityClassName(): CharSequence!

getLeftEdgeEffectColor

Added in API level 29
open fun getLeftEdgeEffectColor(): Int

Returns the left edge effect color.

Return
Int The left edge effect color.

getMaxScrollAmount

Added in API level 3
open fun getMaxScrollAmount(): Int
Return
Int The maximum amount this scroll view will scroll in response to an arrow event.

getRightEdgeEffectColor

Added in API level 29
open fun getRightEdgeEffectColor(): Int

Returns the right edge effect color.

Return
Int The right edge effect color.

isFillViewport

Added in API level 3
open fun isFillViewport(): Boolean

Indicates whether this HorizontalScrollView's content is stretched to fill the viewport.

Return
Boolean True if the content fills the viewport, false otherwise.

isSmoothScrollingEnabled

Added in API level 3
open fun isSmoothScrollingEnabled(): Boolean
Return
Boolean Whether arrow scrolling will animate its transition.

onGenericMotionEvent

Added in API level 12
open fun onGenericMotionEvent(event: MotionEvent!): Boolean
Parameters
event MotionEvent!: The generic motion event being processed.
Return
Boolean True if the event was handled, false otherwise.

onInterceptTouchEvent

Added in API level 3
open fun onInterceptTouchEvent(ev: MotionEvent!): Boolean
Parameters
ev MotionEvent!: The motion event being dispatched down the hierarchy.
Return
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.

onTouchEvent

Added in API level 3
open fun onTouchEvent(ev: MotionEvent!): Boolean
Parameters
event The motion event.
Return
Boolean True if the event was handled, false otherwise.

pageScroll

Added in API level 3
open fun pageScroll(direction: Int): Boolean

Handles scrolling in response to a "page up/down" shortcut press. This method will scroll the view by one page left or right and give the focus to the leftmost/rightmost component in the new visible area. If no component is a good candidate for focus, this scrollview reclaims the focus.

Parameters
direction Int: the scroll direction: android.view.View#FOCUS_LEFT to go one page left or android.view.View#FOCUS_RIGHT to go one page right
Return
Boolean true if the key event is consumed by this method, false otherwise

requestChildFocus

Added in API level 3
open fun requestChildFocus(
    child: View!,
    focused: View!
): Unit
Parameters
child View!: The child of this ViewParent that wants focus. This view will contain the focused view. It is not necessarily the view that actually has focus.
focused View!: The view that is a descendant of child that actually has focus

requestChildRectangleOnScreen

Added in API level 3
open fun requestChildRectangleOnScreen(
    child: View,
    rectangle: Rect!,
    immediate: Boolean
): Boolean
Parameters
child View: The direct child making the request. This value cannot be null.
rectangle Rect!: The rectangle in the child's coordinates the child wishes to be on the screen.
immediate Boolean: True to forbid animated or delayed scrolling, false otherwise
Return
Boolean Whether the group scrolled to handle the operation

requestDisallowInterceptTouchEvent

Added in API level 3
open fun requestDisallowInterceptTouchEvent(disallowIntercept: Boolean): Unit
Parameters
disallowIntercept Boolean: True if the child does not want the parent to intercept touch events.

requestLayout

Added in API level 3
open fun requestLayout(): Unit

scrollTo

Added in API level 3
open fun scrollTo(
    x: Int,
    y: Int
): Unit

Set the scrolled position of your view. This will cause a call to onScrollChanged(int,int,int,int) and the view will be invalidated.

This version also clamps the scrolling to the bounds of our child.

Parameters
x Int: the x position to scroll to
y Int: the y position to scroll to

setEdgeEffectColor

Added in API level 29
open fun setEdgeEffectColor(color: Int): Unit

Sets the edge effect color for both left and right edge effects.

Parameters
color Int: The color for the edge effects.

setFillViewport

Added in API level 3
open fun setFillViewport(fillViewport: Boolean): Unit

Indicates this HorizontalScrollView whether it should stretch its content width to fill the viewport or not.

Parameters
fillViewport Boolean: True to stretch the content's width to the viewport's boundaries, false otherwise.

setLeftEdgeEffectColor

Added in API level 29
open fun setLeftEdgeEffectColor(color: Int): Unit

Sets the left edge effect color.

Parameters
color Int: The color for the left edge effect.

setRightEdgeEffectColor

Added in API level 29
open fun setRightEdgeEffectColor(color: Int): Unit

Sets the right edge effect color.

Parameters
color Int: The color for the right edge effect.

setSmoothScrollingEnabled

Added in API level 3
open fun setSmoothScrollingEnabled(smoothScrollingEnabled: Boolean): Unit

Set whether arrow scrolling will animate its transition.

Parameters
smoothScrollingEnabled Boolean: whether arrow scrolling will animate its transition

shouldDelayChildPressedState

Added in API level 14
open fun shouldDelayChildPressedState(): Boolean

smoothScrollBy

Added in API level 3
fun smoothScrollBy(
    dx: Int,
    dy: Int
): Unit

Like View#scrollBy, but scroll smoothly instead of immediately.

Parameters
dx Int: the number of pixels to scroll by on the X axis
dy Int: the number of pixels to scroll by on the Y axis

smoothScrollTo

Added in API level 3
fun smoothScrollTo(
    x: Int,
    y: Int
): Unit

Like scrollTo, but scroll smoothly instead of immediately.

Parameters
x Int: the position where to scroll on the X axis
y Int: the position where to scroll on the Y axis

Protected methods

computeHorizontalScrollOffset

Added in API level 3
protected open fun computeHorizontalScrollOffset(): Int
Return
Int the horizontal offset of the scrollbar's thumb

computeHorizontalScrollRange

Added in API level 3
protected open fun computeHorizontalScrollRange(): Int

The scroll range of a scroll view is the overall width of all of its children.

Return
Int the total horizontal range represented by the horizontal scrollbar

computeScrollDeltaToGetChildRectOnScreen

Added in API level 3
protected open fun computeScrollDeltaToGetChildRectOnScreen(rect: Rect!): Int

Compute the amount to scroll in the X direction in order to get a rectangle completely on the screen (or, if taller than the screen, at least the first screen size chunk of it).

Parameters
rect Rect!: The rect.
Return
Int The scroll delta.

getLeftFadingEdgeStrength

Added in API level 3
protected open fun getLeftFadingEdgeStrength(): Float
Return
Float the intensity of the left fade as a float between 0.0f and 1.0f

getRightFadingEdgeStrength

Added in API level 3
protected open fun getRightFadingEdgeStrength(): Float
Return
Float the intensity of the right fade as a float between 0.0f and 1.0f

measureChild

Added in API level 3
protected open fun measureChild(
    child: View!,
    parentWidthMeasureSpec: Int,
    parentHeightMeasureSpec: Int
): Unit
Parameters
child View!: The child to measure
parentWidthMeasureSpec Int: The width requirements for this view
parentHeightMeasureSpec Int: The height requirements for this view

measureChildWithMargins

Added in API level 3
protected open fun measureChildWithMargins(
    child: View!,
    parentWidthMeasureSpec: Int,
    widthUsed: Int,
    parentHeightMeasureSpec: Int,
    heightUsed: Int
): Unit
Parameters
child View!: The child to measure
parentWidthMeasureSpec Int: The width requirements for this view
widthUsed Int: Extra space that has been used up by the parent horizontally (possibly by other children of the parent)
parentHeightMeasureSpec Int: The height requirements for this view
heightUsed Int: Extra space that has been used up by the parent vertically (possibly by other children of the parent)

onLayout

Added in API level 3
protected open fun onLayout(
    changed: Boolean,
    l: Int,
    t: Int,
    r: Int,
    b: Int
): Unit
Parameters
changed Boolean: This is a new size or position for this view
left Left position, relative to parent
top Top position, relative to parent
right Right position, relative to parent
bottom Bottom position, relative to parent

onMeasure

Added in API level 3
protected open fun onMeasure(
    widthMeasureSpec: Int,
    heightMeasureSpec: Int
): Unit
Parameters
widthMeasureSpec Int: horizontal space requirements as imposed by the parent. The requirements are encoded with android.view.View.MeasureSpec.
heightMeasureSpec Int: vertical space requirements as imposed by the parent. The requirements are encoded with android.view.View.MeasureSpec.

onOverScrolled

Added in API level 9
protected open fun onOverScrolled(
    scrollX: Int,
    scrollY: Int,
    clampedX: Boolean,
    clampedY: Boolean
): Unit
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

onRequestFocusInDescendants

Added in API level 3
protected open fun onRequestFocusInDescendants(
    direction: Int,
    previouslyFocusedRect: Rect!
): Boolean

When looking for focus in children of a scroll view, need to be a little more careful not to give focus to something that is scrolled off screen. This is more expensive than the default android.view.ViewGroup implementation, otherwise this behavior might have been made the default.

Parameters
direction Int: One of FOCUS_UP, FOCUS_DOWN, FOCUS_LEFT, and FOCUS_RIGHT
previouslyFocusedRect Rect!: The rectangle (in this View's coordinate system) to give a finer grained hint about where focus is coming from. May be null if there is no hint.
Return
Boolean Whether focus was taken.

onRestoreInstanceState

Added in API level 3
protected open fun onRestoreInstanceState(state: Parcelable!): Unit
Parameters
state Parcelable!: The frozen state that had previously been returned by onSaveInstanceState.

onSaveInstanceState

Added in API level 3
protected open fun onSaveInstanceState(): Parcelable?
Return
Parcelable? Returns a Parcelable object containing the view's current dynamic state, or null if there is nothing interesting to save.

onSizeChanged

Added in API level 3
protected open fun onSizeChanged(
    w: Int,
    h: Int,
    oldw: Int,
    oldh: Int
): Unit
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.