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

Commit f4f05b8f authored by Scott Main's avatar Scott Main
Browse files

Update package descriptions with editorial revisions. 

Notably, this removes exessive info about resources
from the content package, because it's not a good location
and the info is avilable in the dev guide, but also
added some of the info to the Resources class description.

Change-Id: Ie78af26c9cec66314deb98e53078f48e16c08e70
parent 7b4ba9d8

core/java/android/app/admin/package.html

0 → 100644
+12 −0
Original line number Diff line number Diff line 
<HTML>

<BODY>

<p>Provides device administration features at the system level, allowing you to create

security-aware applications that are useful in enterprise settings, in which IT professionals

require rich control over employee devices.</p>



<p>For more information, see the <a

href="{@docRoot}guide/topics/admin/device-admin.html">Device Administration</a> developer guide.</p>

{@more}



</BODY>

</HTML>

core/java/android/app/backup/package.html

+3 −2
Original line number Diff line number Diff line
@@ -2,9 +2,10 @@ 
<BODY>

<p>Contains the backup and restore functionality available to

applications. If a user wipes the data on their device or upgrades to a new Android-powered

device, all applications that have enabled backup will restore the user's previous data.</p>

device, all applications that have enabled backup can restore the user's previous data when the

application is reinstalled.</p>



<p>For a detailed guide to using the backup APIs, see the <a

<p>For more information, see the <a

href="{@docRoot}guide/topics/data/backup.html">Data Backup</a> developer guide.</p>

{@more}

core/java/android/app/package.html

+35 −64
Original line number Diff line number Diff line 
<html>

<head>

<script type="text/javascript" src="http://www.corp.google.com/style/prettify.js"></script>

<script src="http://www.corp.google.com/eng/techpubs/include/navbar.js" type="text/javascript"></script>

</head>



<body>



<p>High-level classes encapsulating the overall Android application model.

The central class is {@link android.app.Activity}, with other top-level

application components being defined by {@link android.app.Service} and,

from the {@link android.content} package, {@link android.content.BroadcastReceiver}

and {@link android.content.ContentProvider}.  It also includes application

tools, such as dialogs and notifications.</p>

<p>Contains high-level classes encapsulating the overall Android application model.</p>



<p>An Android application is defined using one or more of Android's four core application

components. Two such application components are defined in this package: {@link

android.app.Activity} and {@link android.app.Service}. The other two components are from the {@link

android.content} package: {@link android.content.BroadcastReceiver} and {@link

android.content.ContentProvider}.</p>



<p>An {@link android.app.Activity} is an application component that provides a screen with which

users can interact in order to do something, such as dial the phone, take a photo, send an email, or

view a map. An activity can start other activities, including activities that live in separate

applications.</p>



<p>A {@link android.app.Service} is an application component that can perform

long-running operations in the background without a user interface. For example, a service

can handle network transactions, play music, or work with a content provider without the user being

aware of the work going on.</p>



<p>The {@link android.app.Fragment} class is also an important part of an application's

design&mdash;especially when designing for large screen devices, such as tablets. A fragment defines

a distinct part of an activity's behavior, including the associated UI. It has its own lifecycle

that is similar to that of the activity and can exist alongside other fragments that are embedded in

the activity. While an activity is running, you can add and remove fragments and include each

fragment in a back stack that's managed by the activity&mdash;allowing the user to navigate

backwards through the fragment states, without leaving the activity.</p>



<p>This package also defines application utilities, such as dialogs, notifications, and the

action bar.</p>



<p>For information about using some the classes in this package, see the following

documents: <a href="{@docRoot}guide/topics/fundamentals/index.html">Application

Fundamentals</a> (for activities, services, and fragments), <a

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

href="{@docRoot}guide/topics/ui/dialogs.html">Creating Dialogs</a>, and <a

href="{@docRoot}guide/topics/ui/notifiers/index.html">Notifying the User</a>.</p>



<p>This package builds on top of the lower-level Android packages

{@link android.widget}, {@link android.view}, {@link android.content},

{@link android.text}, {@link android.graphics}, {@link android.os}, and

{@link android.util}.</p>



<p>An {@link android.app.Activity Activity} is a specific operation the

user can perform, generally corresponding

to one screen in the user interface.

It is the basic building block of an Android application.

Examples of activities are "view the

list of people," "view the details of a person," "edit information about

a person," "view an image," etc.  Switching from one activity to another

generally implies adding a new entry on the navigation history; that is,

going "back" means moving to the previous activity you were doing.</p>



<p>A set of related activities can be grouped together as a "task".  Until

a new task is explicitly specified, all activites you start are considered

to be part of the current task.  While the only way to navigate between

individual activities is by going "back" in the history stack, the group

of activities in a task can be moved in relation to other tasks: for example

to the front or the back of the history stack.  This mechanism can be used

to present to the user a list of things they have been doing, moving

between them without disrupting previous work.

</p>



<p>A complete "application" is a set of activities that allow the user to do a

cohesive group of operations -- such as working with contacts, working with a

calendar, messaging, etc.  Though there can be a custom application object

associated with a set of activities, in many cases this is not needed --

each activity provides a particular path into one of the various kinds of

functionality inside of the application, serving as its on self-contained

"mini application".

</p>



<p>This approach allows an application to be broken into pieces, which

can be reused and replaced in a variety of ways.  Consider, for example,

a "camera application."  There are a number of things this application

must do, each of which is provided by a separate activity: take a picture

(creating a new image), browse through the existing images, display a

specific image, etc.  If the "contacts application" then wants to let the

user associate an image with a person, it can simply launch the existing

"take a picture" or "select an image" activity that is part of the camera

application and attach the picture it gets back.

</p>



<p>Note that there is no hard relationship between tasks the user sees and

applications the developer writes.  A task can be composed of activities from

multiple applications (such as the contact application using an activity in 

the camera application to get a picture for a person), and multiple active

tasks may be running for the same application (such as editing e-mail messages

to two different people).  The way tasks are organized is purely a UI policy

decided by the system; for example, typically a new task is started when the

user goes to the application launcher and selects an application.

</p>



</body>

</html>

core/java/android/appwidget/package.html

+23 −23
Original line number Diff line number Diff line 
<body>

<p>Android allows applications to publish views to be embedded in other applications.  These

views are called widgets, and are published by "AppWidget providers."  The component that can

contain widgets is called a "AppWidget host."

</p>

<p>Contains the components necessary to create "app widgets", which users can embed in other

applications (such as the home screen) to quickly access application data and services without

launching a new activity.</p>

<p>For more information, see the

<a href="{@docRoot}guide/topics/appwidgets/index.html">App Widgets</a>

documentation in the Dev Guide.</p>



developer guide.</p>



{@more}





<h2><a name="providers"></a>AppWidget Providers</h2>

<p>Any application can publish widgets.  All an application needs to do to publish a widget is

to have a {@link android.content.BroadcastReceiver} that receives the {@link

android.appwidget.AppWidgetManager#ACTION_APPWIDGET_UPDATE AppWidgetManager.ACTION_APPWIDGET_UPDATE} intent,

and provide some meta-data about the widget.  Android provides the

{@link android.appwidget.AppWidgetProvider} class, which extends BroadcastReceiver, as a convenience

class to aid in handling the broadcasts.





<h2>AppWidget Hosts</h3>

<p>Widget hosts are the containers in which widgets can be placed.  Most of the look and feel

<p>The behavior of an app widget is published by an "app widget provider."  An "app widget host" is

a component that can contain app widgets (such as the Home screen).</p>



<p>Any application can publish app widgets (as an app widget provider).  All an application needs to

do to publish an app widget is

provide a {@link android.content.BroadcastReceiver} that receives the {@link

android.appwidget.AppWidgetManager#ACTION_APPWIDGET_UPDATE} intent

and provide some metadata about the app widget.  Android provides the

{@link android.appwidget.AppWidgetProvider} class, which extends {@link

android.content.BroadcastReceiver}, as a convenience class to define the app widget behavrio and aid

in handling the broadcasts.</p>



<p>App widget hosts are the containers in which widgets can be placed.  Most of the look and feel

details are left up to the widget hosts.  For example, the home screen has one way of viewing

widgets, but the lock screen could also contain widgets, and it would have a different way of

adding, removing and otherwise managing widgets.</p>

<p>For more information on implementing your own widget host, see the

{@link android.appwidget.AppWidgetHost AppWidgetHost} class.</p>



<p>The <a href="{@docRoot}guide/topics/appwidgets/index.html">App Widgets</a>

developer guide shows you how to create an app widget provider. For information about implementing

an app widget host, see the {@link android.appwidget.AppWidgetHost} class.</p>



</body>

core/java/android/bluetooth/package.html

+2 −2
Original line number Diff line number Diff line
@@ -3,7 +3,7 @@ 
<p>Provides classes that manage Bluetooth functionality, such as scanning for

devices, connecting with devices, and managing data transfer between devices.</p>



<p>For a complete guide to using the Bluetooth APIs, see the <a

<p>For more information, see the <a

href="{@docRoot}guide/topics/wireless/bluetooth.html">Bluetooth</a> developer guide.</p>

{@more}
@@ -25,6 +25,6 @@ permission. 
</p>



<p class="note"><strong>Note:</strong>

Not all Android devices are guaranteed to have Bluetooth functionality.</p>

Not all Android-powered devices provide Bluetooth functionality.</p>

</BODY>

</HTML>