Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit f029a419 authored by Andrew Solovay's avatar Andrew Solovay Committed by Android Git Automerger
Browse files

am 8150734f: am 6b53fb62: Merge "docs: Updating support library pages for v.21." into lmp-dev 

* commit '8150734f':
  docs: Updating support library pages for v.21.
parents f1816c2b 8150734f

docs/html/tools/support-library/features.jd

+141 −32
Original line number Diff line number Diff line
@@ -8,15 +8,19 @@ page.title=Support Library Features 
    <h2>In this document</h2>

    <ol>

      <li><a href="#v4">v4 Support Library</a></li>

      <li><a href="#v7">v7 Libraries</a>

      <li><a href="#v7">v7 Support Libraries</a>

        <ol>

          <li><a href="#v7-appcompat">v7 appcompat library</a></li>

          <li><a href="#v7-cardview">v7 cardview library</a></li>

          <li><a href="#v7-gridlayout">v7 gridlayout library</a></li>

          <li><a href="#v7-mediarouter">v7 mediarouter library</a></li>

          <li><a href="#v7-palette">v7 palette library</a></li>

          <li><a href="#v7-recyclerview">v7 recyclerview library</a></li>

        </ol>

      </li>

      <li><a href="#v8">v8 Support Library</a></li>

      <li><a href="#v13">v13 Support Library</a></li>

      <li><a href="#v17-leanback">v17 Leanback Library</a></li>

    </ol>



    <h2>See also</h2>
@@ -59,14 +63,14 @@ page.title=Support Library Features 
  <li>App Components

    <ul>

      <li>{@link android.support.v4.app.Fragment}

        - Adds support encapsulation of user interface and functionality with Fragments, enabling

        applications provide layouts that adjust between small and large-screen devices.</li>

    </ul>

    <ul>

        - Adds support for encapsulation of user interface and functionality

        with Fragments, enabling

        applications to provide layouts that adjust between small and

        large-screen devices.

       </li>



      <li>{@link android.support.v4.app.NotificationCompat} - Adds support for rich notification

        features.</li>

    </ul>

    <ul>

      <li>{@link android.support.v4.content.LocalBroadcastManager} - Allows applications to easily

        register for and receive intents within a single application without broadcasting them

        globally.</li>
@@ -95,22 +99,15 @@ page.title=Support Library Features 
    <ul>

      <li>{@link android.support.v4.widget.ExploreByTouchHelper}

        - Adds a helper class for implementing accessibility support for custom views.</li>

    </ul>

    <ul>

      <li>{@link android.support.v4.view.accessibility.AccessibilityEventCompat} - Adds support for

      {@link android.view.accessibility.AccessibilityEvent}. For more information about implementing

      accessibility, see <a href="{@docRoot}guide/topics/ui/accessibility/index.html"

      >Accessibility</a>.</li>

    </ul>

    <ul>



      <li>{@link android.support.v4.view.accessibility.AccessibilityNodeInfoCompat} - Adds support

      for {@link android.view.accessibility.AccessibilityNodeInfo}.</li>

    </ul>

    <ul>

      <li>{@link android.support.v4.view.accessibility.AccessibilityNodeProviderCompat} - Adds

      support for {@link android.view.accessibility.AccessibilityNodeProvider}.</li>

    </ul>

    <ul>

      <li>{@link android.support.v4.view.AccessibilityDelegateCompat} - Adds support for

      {@link android.view.View.AccessibilityDelegate}.</li>

    </ul>
@@ -121,8 +118,6 @@ page.title=Support Library Features 
        The library also provides concrete implementations of this class, including

        {@link android.support.v4.content.CursorLoader} and

        {@link android.support.v4.content.AsyncTaskLoader}.</li>

    </ul>

    <ul>

      <li>{@link android.support.v4.content.FileProvider} - Adds support for sharing of private

        files between applications.</li>

    </ul>
@@ -136,9 +131,9 @@ page.title=Support Library Features 
</p>



<p>This library is located in the {@code &lt;sdk&gt;/extras/android/support/v4/} directory after

  you download the Android Support Libraries. This library does not contain user interface

  you download the Android Support Libraries. The library does not contain user interface

  resources. To include it in your application project, follow the instructions for

  <a href="{@docRoot}tools/support-library/setup.html#libs-without-res">adding libraries without

  <a href="{@docRoot}tools/support-library/setup.html#libs-without-res">Adding libraries without

  resources</a>.</p>



<p>The Gradle build script dependency identifier for this library is as follows:</p>
@@ -150,7 +145,7 @@ com.android.support:support-v4:18.0.+ 
<p>This dependency notation specifies the release version 18.0.0 or higher.</p>





<h2 id="v7">v7 Libraries</h2>

<h2 id="v7">v7 Support Libraries</h2>



<p>There are several libraries designed to be used with Android 2.1 (API level 7) and higher.

  These libraries provide specific feature sets and can be included in your application
@@ -159,8 +154,12 @@ com.android.support:support-v4:18.0.+ 


<h3 id="v7-appcompat">v7 appcompat library</h3>



<p>This library adds support for the <a href="{@docRoot}guide/topics/ui/actionbar.html">Action

  Bar</a> user interface <a href="{@docRoot}design/patterns/actionbar.html">design pattern</a>.

<p>This library adds support for the

  <a href="{@docRoot}guide/topics/ui/actionbar.html">Action Bar</a> user

  interface <a href="{@docRoot}design/patterns/actionbar.html">design

  pattern</a>. This library includes support for

  <a href="{@docRoot}design/material/">material design</a> user interface

  implementations.

</p>



<p class="note"><strong>Note:</strong>
@@ -187,18 +186,40 @@ com.android.support:support-v4:18.0.+ 
</ul>



<p>This library is located in the {@code &lt;sdk&gt;/extras/android/support/v7/appcompat/}

  directory after you download the Android Support Libraries. This library contains user

  directory after you download the Android Support Libraries. The library contains user

  interface resources. To include it in your application project, follow the instructions for

  <a href="{@docRoot}tools/support-library/setup.html#libs-with-res">adding libraries with

  <a href="{@docRoot}tools/support-library/setup.html#libs-with-res">Adding libraries with

  resources</a>.</p>



<p>The Gradle build script dependency identifier for this library is as follows:</p>



<pre>

com.android.support:appcompat-v7:18.0.+

com.android.support:appcompat-v7:21.0.+

</pre>



<p>This dependency notation specifies the release version 18.0.0 or higher.</p>

<p>This dependency notation specifies the release version 21.0.0 or higher.</p>



<h3 id="v7-cardview">v7 cardview library</h3>



<p>This library adds support for the {@link android.support.v7.widget.CardView}

widget, which lets you show information inside cards that have a consistent look

on any app. These cards are useful for material design

implementations, and are used extensively in layouts for TV apps.</p>



<p>This library is located in the

{@code &lt;sdk&gt;/extras/android/support/v7/cardview/} directory after you

download the Android Support Libraries. The library contains user interface

resources. To include it in your application project, follow the instructions

for <a href="{@docRoot}tools/support-library/setup.html#libs-with-res">Adding

libraries with resources</a>.</p>



<p>The Gradle build script dependency identifier for this library is as follows:</p>



<pre>

com.android.support:cardview-v7:21.0.+

</pre>



<p>This dependency notation specifies the release version 21.0.0 or higher.</p>



<h3 id="v7-gridlayout">v7 gridlayout library</h3>
@@ -208,9 +229,9 @@ com.android.support:appcompat-v7:18.0.+ 
  {@link android.support.v7.widget android.support.v7.widget} package in the API reference.</p>



<p>This library is located in the {@code &lt;sdk&gt;/extras/android/support/v7/gridlayout/}

  directory after you download the Android Support Libraries. This library contains user

  directory after you download the Android Support Libraries. The library contains user

  interface resources. To include it in your application project, follow the instructions for

  <a href="{@docRoot}tools/support-library/setup.html#libs-with-res">adding libraries with

  <a href="{@docRoot}tools/support-library/setup.html#libs-with-res">Adding libraries with

  resources</a>.</p>



<p>The Gradle build script dependency identifier for this library is as follows:</p>
@@ -221,6 +242,7 @@ com.android.support:gridlayout-v7:18.0.+ 


<p>This dependency notation specifies the release version 18.0.0 or higher.</p>





<h3 id="v7-mediarouter">v7 mediarouter library</h3>



<p>This library provides {@link android.support.v7.media.MediaRouter}, {@link
@@ -242,7 +264,7 @@ you download the Android Support Library. It's provided as a library project 
with a dependency on the v7 appcompat library, so you'll need to include both

libraries in your build path when setting up your project. For more information

on how to set up your project, follow the instructions in <a

href="{@docRoot}tools/support-library/setup.html#libs-with-res">adding libraries

href="{@docRoot}tools/support-library/setup.html#libs-with-res">Adding libraries

with resources</a>. If you are developing in Eclipse/ADT, make sure to include

both the <code>android-support-v7-mediarouter.jar</code> and

<code>android-support-v7-appcompat.jar</code> files.</p>
@@ -260,6 +282,52 @@ r18 are subject to change in later revisions of the Support Library. At this 
time, we recommend using the library only in connection with <a

href="https://developers.google.com/cast/docs/android_sender">Google Cast</a>. </p>



<h3 id="v7-palette">v7 palette library</h3>



<p>The v7 palette support library includes the

{@link android.support.v7.graphics.Palette} class, which lets you extract

prominent colors from an image. For example, a music app could use a

{@link android.support.v7.graphics.Palette} object to extract the major colors

from an album cover, and use those colors to build a color-coordinated song

title card.</p>



<p>This library is located in the

{@code &lt;sdk&gt;/extras/android/support/v7/palette/} directory after

  you download the Android Support Libraries. The library does not contain user interface

  resources. To include it in your application project, follow the instructions for

  <a href="{@docRoot}tools/support-library/setup.html#libs-without-res">Adding libraries without

  resources</a>.</p>



<p>The Gradle build script dependency identifier for this library is as follows:</p>



<pre>

com.android.support:palette-v7:21.0.+

</pre>



<p>This dependency notation specifies the release version 21.0.0 or higher.</p>



<h3 id="v7-recyclerview">v7 recyclerview library</h3>



<p>The recyclerview library adds the {@link android.support.v7.widget.RecyclerView}

class. This class provides support for the

<a href="{@docRoot}training/material/lists-cards.jd#RecyclerView">RecyclerView

widget</a>, a view for efficiently displaying large data sets by providing a

limited window of data items.</p>



<p>This library is located in the

{@code &lt;sdk&gt;/extras/android/support/v7/recyclerview/} directory after you

download the Android Support Libraries. The library contains user interface

resources. To include it in your application project, follow the instructions

for <a href="{@docRoot}tools/support-library/setup.html#libs-with-res">Adding

libraries with resources</a>.</p>



<p>The Gradle build script dependency identifier for this library is as follows:</p>



<pre>

com.android.support:recyclerview-v7:21.0.+

</pre>



<p>This dependency notation specifies the release version 21.0.0 or higher.</p>



<h2 id="v8">v8 Support Library</h2>
@@ -284,16 +352,16 @@ href="https://developers.google.com/cast/docs/android_sender">Google Cast</a>. < 
<p>This library is designed to be used for Android 3.2 (API level 13) and higher. It adds support

  for the <a href="{@docRoot}guide/components/fragments.html">Fragment</a> user interface pattern

  with the ({@link android.support.v13.app.FragmentCompat}) class and additional fragment support

  classes For more information about fragments, see the

  classes. For more information about fragments, see the

  <a href="{@docRoot}guide/components/fragments.html">Fragments</a> developer guide. For detailed

  information about the v13 Support Library APIs, see the {@link android.support.v13.app

  android.support.v13} package in the API reference.

</p>



<p>This library is located in the {@code &lt;sdk&gt;/extras/android/support/v13/} directory after

  you download the Android Support Libraries. This library does not contain user interface

  you download the Android Support Libraries. The library does not contain user interface

  resources. To include it in your application project, follow the instructions for

  <a href="{@docRoot}tools/support-library/setup.html#libs-without-res">adding libraries without

  <a href="{@docRoot}tools/support-library/setup.html#libs-without-res">Adding libraries without

  resources</a>.</p>



<p>The Gradle build script dependency identifier for this library is as follows:</p>
@@ -303,3 +371,44 @@ com.android.support:support-v13:18.0.+ 
</pre>



<p>This dependency notation specifies the release version 18.0.0 or higher.</p>



<h2 id="v17-leanback">v17 Leanback Library</h2>



<p>The {@link android.support.v17.leanback} package provides APIs to support

  building user interfaces

  on TV devices. It provides a number of important widgets for TV apps. Some of the notable classes include:</p>



<ul>

  <li>{@link android.support.v17.leanback.app.BrowseFragment} - A fragment for

    creating a primary layout for browsing categories and rows of media

    items.</li>

  <li>{@link android.support.v17.leanback.app.DetailsFragment} - A wrapper

    fragment for Leanback details screens.</li>

  <li>{@link android.support.v17.leanback.app.PlaybackOverlayFragment} - A

    subclass of {@link android.support.v17.leanback.app.DetailsFragment} for

    displaying playback controls and related content.</li>

  <li>{@link android.support.v17.leanback.app.SearchFragment} - A fragment to

    handle searches. The fragment receives the user's search request and passes

    it to the application-provided {@link

    android.support.v17.leanback.app.SearchFragment.SearchResultProvider

    SearchResultProvider}. The {@link

    android.support.v17.leanback.app.SearchFragment.SearchResultProvider

    SearchResultProvider} returns the search results to the

    {@link android.support.v17.leanback.app.SearchFragment}, which renders them

    into a {@link android.support.v17.leanback.app.RowsFragment}.</li>

</ul>



<p>This library is located in the

{@code &lt;sdk&gt;/extras/android/support/v17/leanback} directory after

you download the Android Support Libraries. For more information

on how to set up your project, follow the instructions in <a

href="{@docRoot}tools/support-library/setup.html#libs-with-res">Adding libraries

with resources</a>. </p>



<p>The Gradle build script dependency identifier for this library is as follows:</p>



<pre>

com.android.support:leanback-v17:21.0.+

</pre>



<p>This dependency notation specifies the release version 21.0.0 or higher.</p>

docs/html/tools/support-library/index.jd

+84 −1
Original line number Diff line number Diff line
@@ -59,8 +59,91 @@ page.title=Support Library 
<p>This section provides details about the Support Library package releases.</p>



<div class="toggle-content opened">

  <p><a href="#" onclick="return toggleContent(this)">

  <p id="rev21"><a href="#" onclick="return toggleContent(this)">

    <img src="{@docRoot}assets/images/triangle-opened.png" class="toggle-content-img" alt=""

/>Android Support Library, revision 21</a> <em>(October 2014)</em>

  </p>

  <div class="toggle-content-toggleme">

    <dl>

      <dt>Changes for <a href="features.html#v4">v4 support library:</a></dt>

      <dd>

        <ul>

          <li>Added support for {@link android.support.v4.app.Fragment}

              transitions for devices running Android 5.0 (API level 21).

              Be aware that transitions have no effect on devices running

              Android 4.4 and lower.

          </li>

          <li>Added {@link android.support.v4.provider.DocumentFile} to ease

              the transition from {@link java.io.File}

              while working with document trees. However, this class demands

              more processing overhead compared to the platform's

              {@link android.provider.DocumentsContract} API added in

              Android 4.4 (API level 19). So you should switch to using {@link

              android.provider.DocumentsContract} when running on Android 4.4

              and higher.</li>

        </ul>

      </dd>

      <dt>Changes for <a href="features.html#v7-appcompat">v7 appcompat

        library</a>:</dt>

      <dd>

        <ul>

          <li>Added support for <a href="{@docRoot}design/material/">material

              design</a> user interfaces.</li>

          <li>Added {@link android.support.v7.widget.Toolbar}, which generalizes

              the functionality of {@link android.support.v7.app.ActionBar} for

              use within app layouts.</li>

          <li>Updated {@link android.support.v7.app.ActionBarDrawerToggle},

              which contains the menu-to-arrow animation</li>

          <li>Updated common user interface widgets to allow tinting via theme

              attributes when running on pre-Android 5.0 devices</li>

          <li>Added {@link android.support.v7.widget.SwitchCompat}, a backport

              of the {@link android.widget.Switch} widget that was added in 

              Android 4.0 (API level 14).</li>

        </ul>

      </dd>

      <dt>New <a href="features.html#v7-cardview">v7 cardview library</a>:</dt>

      <dd>

        <ul>

          <li>Added the {@link android.support.v7.widget.CardView} widget, which

            provides a material design-compatible implementation for displaying

            data items.</li>

        </ul>

      </dd>

      <dt>New <a href="features.html#v7-recyclerview">v7 recyclerview

        library</a>:</dt>

      <dd>

        <ul>

          <li>Added the {@link android.support.v7.widget.RecyclerView} widget,

            which provides a flexible list view for providing a limited window

            into a large data set.</li>

        </ul>

      </dd>

      <dt>New <a href="features.html#v7-palette">v7 palette library</a>:</dt>

      <dd>

        <ul>

          <li>Added {@link android.support.v7.graphics.Palette} class,

          which lets you extract prominent colors from an image.</li>

        </ul>

      </dd>

      <dt>New <a href="features.html#v17-leanback">v17 leanback library</a>:</dt>

      <dd>

        <ul>

          <li>Added support for building TV user interfaces, including

            {@link android.support.v17.leanback.app.BrowseFragment},

            {@link android.support.v17.leanback.app.DetailsFragment}, and

            {@link android.support.v17.leanback.app.PlaybackOverlayFragment}.

            For more information about using these user interface widgets,

            see <a href="{@docRoot}training/tv/playback/index.html">Building TV

            Playback Apps</a>.</li>

        </ul>

      </dd>

    </dl>

  </div>

</div>



<div class="toggle-content closed">

  <p><a href="#" onclick="return toggleContent(this)">

    <img src="{@docRoot}assets/images/triangle-closed.png" class="toggle-content-img" alt=""

/>Android Support Library, revision 20</a> <em>(July 2014)</em>

  </p>

  <div class="toggle-content-toggleme">