Android/frameworks_base
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge "docs: Update ScrollView JavaDoc comments" into oc-dev

Browse Source 
am: 47ca22e361

Change-Id: I420d715eb686c1a27f888a394d764358cb227df6
This commit is contained in:
Joe Fernandez
2017-04-27 04:42:27 +00:00
committed by android-build-merger
parent 6e76d0dd0a 47ca22e361
commit 41043c27a7
1 changed files with 20 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

38
core/java/android/widget/ScrollView.java
View File

@@ -50,25 +50,27 @@ import com.android.internal.R;
import java.util.List;
/**
* Layout container for a view hierarchy that can be scrolled by the user,
* allowing it to be larger than the physical display. A ScrollView
* is a {@link 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 {@link LinearLayout} in a vertical orientation, presenting a vertical
* array of top-level items that the user can scroll through.
* <p>You should never use a ScrollView with a {@link ListView}, because
* ListView takes care of its own vertical scrolling. Most importantly, doing this
* defeats all of the important optimizations in ListView for dealing with
* large lists, since it effectively forces the ListView to display its entire
* list of items to fill up the infinite container supplied by ScrollView.
* <p>The {@link TextView} class also
* takes care of its own scrolling, so does not require a ScrollView, but
* using the two together is possible to achieve the effect of a text view
* within a larger container.
* A view group that allows the view hierarchy placed within it to be scrolled.
* Scroll view may have only one direct child placed within it.
* To add multiple views within the scroll view, make
* the direct child you add a view group, for example {@link LinearLayout}, and
* place additional views within that LinearLayout.
*
* <p>ScrollView only supports vertical scrolling. For horizontal scrolling,
* use {@link HorizontalScrollView}.
* <p>Scroll view supports vertical scrolling only. For horizontal scrolling,
* use {@link HorizontalScrollView} instead.</p>
*
* <p>Never add a {@link android.support.v7.widget.RecyclerView} or {@link ListView} to
* a scroll view. Doing so results in poor user interface performance and a poor user
* experience.</p>
*
* <p class="note">
* For vertical scrolling, consider {@link android.support.v4.widget.NestedScrollView}
* instead of scroll view which offers greater user interface flexibility and
* support for the material design scrolling patterns.</p>
*
* <p>To learn more about material design patterns for handling scrolling, see
* <a href="https://material.io/guidelines/patterns/scrolling-techniques.html#">
* Scrolling techniques</a>.</p>
*
* @attr ref android.R.styleable#ScrollView_fillViewport
*/