The SDK includes a variety of tools for developing and debugging application code and designing an application UI. You can read about the tools in the
+Dev Guide and access them in the <sdk>/tools/ directory.
+
+
The tools package included in this SDK is the same as that included in the Android 1.0, Release 2 SDK.
+ +The Android system images listed below are included in this SDK. For more information about a system image — features, applications included, localizations, API changes, and so on — see its Version Notes.
+ +| Notes | Description | +||
|---|---|---|---|
| 3 | +Includes com.google.android.maps external library and a set of standard development applications. | + +
You can look at a variety of tutorials and samples in the Dev Guide and access the sample code itself
+in the <sdk>/samples/ directory of the SDK package.
The SDK package includes a full set of local documentation. To view it, open the <sdk>/documentation.html file in a web browser. If you are developing in an IDE such as Eclipse, you can also view the reference documentation directly in the IDE.
The most current documentation is always available on the Android Developers site:
+ + + + diff --git a/docs/html/sdk/1.5_r1/installing.jd b/docs/html/sdk/1.5_r1/installing.jd new file mode 100644 index 000000000000..df9ec3aee89b --- /dev/null +++ b/docs/html/sdk/1.5_r1/installing.jd @@ -0,0 +1,312 @@ +page.title=Installing the Android SDK +sdk.version=1.5_r1 + +@jd:body + + +This page describes how to install the Android SDK and set up your +development environment. If you haven't downloaded the SDK, you can +do so from the +Download page.
+ +If you encounter any problems during installation, see the +Installation Notes at the bottom of +this page.
+ +If you have already developed applications using an earlier version +of the SDK, please skip this page and read the +Upgrading the +SDK document instead. +
+ + +Before you get started with the Android SDK, take a moment to confirm +that your development machine meets the system requirements. +
+ +If you will be developing on Eclipse with the Android Development +Tools (ADT) Plugin — the recommended path if you are new to +Android — make sure that you have a suitable version of Eclipse +installed on your computer. If you need to install Eclipse, you can +download it from this location:
+ +http://www.eclipse.org/downloads/
+ +A Java or RCP version of Eclipse is recommended.
+ +After downloading the SDK, unpack the .zip archive to a suitable location on your machine. By default, the SDK files are unpacked into a directory named android_sdk_<platform>_<release>_<build>. The directory contains a link to a local copy of the documentation and the subdirectories tools/, samples/, and others.
Make a note of the name and location of the unpacked SDK directory on your system — you will need to refer to the SDK directory later, when setting up the Android plugin or using SDK tools.
+ +Optionally, you can add the path to the SDK tools directory to your path. As mentioned above, the tools/ directory is located in the SDK directory.
tools/ directory to it. If you don't
+ see a line setting the path, you can add one:export PATH=${PATH}:<your_sdk_dir>/toolstools/ directory to the path. Adding tools to your path lets you run Android Debug Bridge (adb) and the other command line tools without needing to supply the full path to the tools directory. Note that, if you update your SDK, you should remember to update your PATH settings to point to the new location, if different.
If you will be using the Eclipse IDE as your environment for developing Android applications, continue reading the next +section in order to install the Android Development Tools plugin and set up Eclipse. If you choose not to use Eclipse, you can +develop Android applications using other tools — read the guide to developing +in other IDEs.
+ + +Android offers a custom plugin for the Eclipse IDE, called Android +Development Tools (ADT), that is designed to give you a powerful, +integrated environment in which to build Android applications. It +extends the capabilites of Eclipse to let you quickly set up new Android +projects, create an application UI, add components based on the Android +Framework API, and debug using the Android SDK tools.
+ +If you are new to Android or want to develop using the Eclipse IDE, +the ADT plugin will be an essential part of your development +environment. In general, using Eclipse with ADT is a highly recommended +approach and is the fastest way to get started. This section describes +how to install ADT into your Eclipse environment. + +
If you prefer to work in a development environment other than Eclipse, +you do not need to install Eclipse or the ADT Plugin. Instead, you can +access the SDK tools directly to build and debug your application.
+ +Once you have Eclipse installed, as described in +Preparing for Installation, follow the steps below to +download the ADT plugin and install it in your respective Eclipse +environment.
+ +| Eclipse 3.3 (Europa) | Eclipse 3.4 (Ganymede) |
|---|---|
+
|
+
+
+
|
+
Now, you just need to modify your Eclipse preferences to point to the Android SDK directory:
+Done! If you haven't encountered any problems, then you're ready to +begin developing Android applications. See the After +Installation: Next Steps section for suggestions on how to start.
+ + ++If you are having trouble downloading the ADT plugin after following the steps above, here are some suggestions:
+ +http://dl-ssl.google.com/android/eclipse/
+If you are still unable to use Eclipse to download the ADT plugin as a remote update site, you can download the ADT files to your local machine using a browser and the install the files in Eclipse from there: +
++Note that to update your plugin, you will have to follow these steps again instead of the default update instructions.
+ +Note that the "Android Editors" feature of ADT requires several optional +Eclipse components (for example, WST). If you encounter an error when +installing ADT, your Eclipse installion might not include those components. +For information about how to quickly add the necessary components to your +Eclipse installation, see the troubleshooting topic +ADT Installation Error: "requires plug-in org.eclipse.wst.sse.ui".
+ +If you encounter this error when installing the ADT Plugin for Eclipse: +
+An error occurred during provisioning. +Cannot connect to keystore. +JKS+
+...then your development machine lacks a suitable Java VM. Installing Sun +Java 6 will resolve this issue and you can then reinstall the ADT +Plugin.
+ + +Once you have installed the SDK and the ADT Plugin, you are ready to +begin developing applications. Here are a few ways you can get started:
+ +Learn about Android
+Explore the SDK
+Explore some code
+<sdk>/samples, then compile and run it in
+your development environmentVisit the Android developer groups
+ia32-libs package using
+apt-get::
+ apt-get install ia32-libs
apt-get install sun-java6-bin
The sections below describe the system and software requirements for developing Android applications using the Android SDK tools included in Android 1.5 SDK, Release 1.
+ +Note: If JDK is already installed on your development computer, please take a moment to make sure that it meets the version requirements listed above. In +particular, note that some Linux distributions may include JDK 1.4 or Gnu Compiler for Java, both of which are not supported for Android development.
\ No newline at end of file diff --git a/docs/html/sdk/1.5_r1/upgrading.jd b/docs/html/sdk/1.5_r1/upgrading.jd new file mode 100644 index 000000000000..23cb82c29fa0 --- /dev/null +++ b/docs/html/sdk/1.5_r1/upgrading.jd @@ -0,0 +1,150 @@ +page.title=Upgrading the SDK +sdk.version=1.5_r1 +@jd:body + + + +This document describes how to move your development environment and existing +Android applications from an Android 1.0 SDK to the Android 1.5, Release 1 SDK. +If you are migrating applications from an earlier SDK, please read the upgrading +document available in the Android 1.0 SDK package. +
+ +To ensure that your applications are compliant with the Android 1.5 system available +on mobile devices, you need to install the Android 1.5 SDK and port your existing Android +applications to it. The sections below will guide you through the process.
+ +Download the SDK and unpack it into a safe location.
+ +After unpacking the new SDK and saving it an appropriate location, you should:
+ +Some data formats have changed since the last
+ SDK release, so any previously saved data in your emulator must be removed. Open a console/terminal
+ and navigate to the /tools directory of your new SDK. Launch the
+ emulator with the -wipe-data option.
+
Windows: emulator -wipe-data
+ Mac/Linux: ./emulator -wipe-data
If you had previously setup your
+ PATH variable to point to the SDK tools directory, then you'll need to update it to
+ point to the new SDK. For example, for a .bashrc or .bash_profile file:
+ export PATH=$PATH:<your_new_sdk_dir>/tools
Open the default.properties file associated with your build.xml
+ file (typically located in the same directory). In the default.properties
+ file, update the sdk-folder property with the full path to
+ the new SDK directory.
If you develop on Eclipse and are migrating from an Android 1.0 +SDK, no update of the ADT plugin is needed — skip to Update your Eclipse SDK Preferences.
+ +If you are migrating from an earlier version of the SDK, you will +need to update the ADT plugin.
You may also want to upgrade your +ADT plugin when a new version becomes available for your existing version +of the SDK.
+ +The steps below describe how to update the ADT plugin to the latest +version available.
+ +| Eclipse 3.3 (Europa) | Eclipse 3.4 (Ganymede) |
|---|---|
+
Alternatively, +
|
+
+
|
+
The last step is to update your Eclipse preferences to point to the new SDK directory:
+If (and only if) you have written apps in an SDK released previous to +the Android 1.0 SDK, you will need to migrate your applications. After +installing the new SDK and updating the ADT Plugin (if applicable), you +may encounter breakages in your application code, due to +framework and API changes. You'll need to update your code to match the +latest APIs.
+ +One way to start is to open your project in Eclipse and see where the ADT +identifies errors in your application. From there, you can lookup +specific API changes in the Android 1.0 APIs in the + +Overview of Changes and +API Diffs Report.
+ +If you have additional trouble updating your code, visit the +Android Developers Group +to seek help from other Android developers.
+ +If you have modified one of the ApiDemos applications and would like to migrate it +to the new SDK, note that you will need to uninstall the version of ApiDemos that comes +preinstalled in the emulator. For more information, or if you encounter an "reinstallation" +error when running or installing ApiDemos, see the troubleshooting topic +I can't install ApiDemos +apps in my IDE because of a signing error for information about how to solve the problem.
+ diff --git a/docs/html/sdk/android-1.5.jd b/docs/html/sdk/android-1.5.jd new file mode 100644 index 000000000000..55fc4ba6d3b0 --- /dev/null +++ b/docs/html/sdk/android-1.5.jd @@ -0,0 +1,248 @@ +page.title=Android 1.5 Version Notes +sdk.version=1.5_r1 +sys.date=April 2009 +@jd:body + +
+Date: April 2009
+API Level: 3
This document provides version notes for the Android 1.5 system image included in the SDK.
+ +The Android 1.5 system image delivered in the SDK is the development +counterpart to the Android 1.5 production system image, deployable to +Android-powered handsets starting in February 2009.
+ +The Android 1.5 system image delivers an updated version of the framework +API. As with previous versions, the Android 1.5 API +is assigned an integer identifier — 3 — that is +stored in the system itself. This identifier, called the "API Level", allows the +system to correctly determine whether an application is compatible with +the system, prior to installing the application.
+ +Applications can reference a specific API Level value in their
+manifest files, to indicate the minimum version of the Android system
+required to run the application. To reference a minimum API Level, applications
+can add a minSdkVersion attribute in their manifest files.
+The value of the attribute is an integer corresponding to an API Level
+identifier. Prior to installing an application, the system then checks the value of
+minSdkVersion and allows the install only
+if the referenced integer is less than or equal to the API Level integer stored
+in the system itself.
If you use the Android 1.5 system image to build an application
+compatible with Android-powered devices running the Android 1.5
+platform, please note that you must set the the
+android:minSdkVersion attribute in the application's
+manifest to "3", which is the API strictly associated with Android 1.5.
+
Specifically, you define the android:minSdkVersion
+attribute in a <uses-sdk> element as a child of
+<manifest> in the manifest file. When set, the
+attribute looks like this:
<manifest> + ... + <uses-sdk minSdkVersion="3" /> + ... +</manifest>+ +
By setting android:minSdkVersion in this way, you ensure
+that users will only be able to install your application if their
+devices are running the Android 1.5 platform. In turn, this ensures that
+your application will function properly on their devices, especially if
+it uses APIs introduced in Android 1.5.
If your application uses APIs introduced in Android 1.5 but does not
+declare <uses-sdk minSdkVersion="3" />, then it will
+run properly on Android 1.5 devices but not on Android 1.0
+devices. In the latter case, the application will crash at runtime when
+it tries to use the Android 1.5 APIs.
If your application does not use any new APIs introduced in Android
+1.5, you can indicate general Android 1.0 compatibility by removing
+minSdkVersion or setting the attribute to "1". However,
+before publishing your application, you must make sure to compile your
+application against the Android 1.0 system image (available in the
+Android SDK), to ensure that it builds and functions properly for
+Android 1.0 devices. You should test the application against system
+images corresponding to the API Levels that the application is designed
+to be compatible with.
If you are sure your application is not using Android 1.5 APIs and +has no need to use them, you might find it easier to keep working in the +Android 1.1 SDK, rather than migrating to the Android 1.5 SDK and having +to do additional testing.
+ + +The system image includes these external libraries, which you can +access from your application by adding a +<uses-library>.
+The Android 1.5 system image was tested for compatability with the +Android-powered devices listed below:
+The system image includes these built-in applications:
+The system image provides localized UI strings for the languages +listed below.
+Localized UI strings match the locales that are displayable in +the emulator, accessible through the device Settings application.
+ +| Module or Feature | Change Description | +
|---|---|
| Annotations for test systems | |
| Added {@link android.test.suitebuilder.annotation.LargeTest LargeTest} annotation. | |
| Added {@link android.test.suitebuilder.annotation.MediumTest MediumTest} annotation. | |
| Added {@link android.test.suitebuilder.annotation.SmallTest SmallTest} annotation. | |
| Allow a process to easily know its UID. | |
| Added public method {@link android.os.Process#myUid} to class {@link android.os.Process android.os.Process} | |
| Padding in views | |
| Added public method {@link android.view.View#getBottomPaddingOffset} to class {@link android.view.View android.view.View}. | |
| Added public method {@link android.view.View#getLeftPaddingOffset} to class {@link android.view.View android.view.View}. | |
| Added public method {@link android.view.View#getRightPaddingOffset} to class {@link android.view.View android.view.View}. | |
| Added public method {@link android.view.View#getTopPaddingOffset} to class {@link android.view.View android.view.View}. | |
| Added public method {@link android.view.View#isPaddingOffsetRequired} to class {@link android.view.View android.view.View}. | |
| Marquee support | |
| Added public method {@link android.widget.TextView#setMarqueeRepeatLimit} to class {@link android.widget.TextView} | |
| Added public field {@link android.R.attr#marqueeRepeatLimit android.R.attr.marqueeRepeatLimit} | |
| New permissions | |
| Added public field {@link android.Manifest.permission#BROADCAST_SMS android.Manifest.permission.BROADCAST_SMS} | |
| Added public field {@link android.Manifest.permission#BROADCAST_WAP_PUSH android.Manifest.permission.BROADCAST_WAP_PUSH} | |
| API cleanup | |
| Removed protected constructor java.net.ServerSocket.ServerSocket(java.net.SocketImpl). |