blob: d263fdacdebc03b0d565716e27d2184e5f6f210c [file] [log] [blame]
Joe Malin4124e0a2010-06-07 16:26:25 -07001<h2>NotePad Documentation</h2>
2<p>
3 NotePad is a simple application for entering and saving character-only notes.
4 It demonstrates the following Android concepts:
5</p>
6<ul>
7 <li>ListView objects with Cursor-based adapters.</li>
8 <li>Data storage and access with a ContentProvider.</li>
9 <li>Intent filters that handle multiple actions.</li>
10 <li>Activity objects that handle more than one Intent.</li>
11 <li>Sending an Intent by selecting an item from a ListView.</li>
12 <li>Sending data in an Intent.</li>
13 <li>Dynamic construction of menus.</li>
14 <li>Context menus.</li>
15 <li>Providing other applications as alternative actions for a data item.</li>
16 <li>Creating <a href="../../../reference/android/provider/LiveFolders.html">
17 Live Folders</a></li>
18 <li>Setting up an application that does not use "save" or "exit". The application
19 saves the user's work whenever focus moves to another task. It remains available until
20 the system destroys it.</li>
The Android Open Source Project52d4c302009-03-03 19:29:09 -080021</ul>
Joe Malin4124e0a2010-06-07 16:26:25 -070022<h4>Functions</h4>
23<p>
24 By default, NotePad displays a list of existing notes,
25 and provides a menu that allows you to insert a new note. If you click an existing note, you
26 can edit it, or select the menu to delete it or edit its title. If you context-click an
27 existing note, you can also delete it. If you navigate away from a new note once you've entered
28 text, NotePad automatically saves what you've entered.
29</p>
30<h4>Limitations</h4>
31<p>
32 NotePad has limited functionality. It does not provide search/replace. It does not support
33 HTML or any other type of markup. However, it does have copy/paste if it is running on a
34 version of the Android platform that supports that functionality.
35</p>
36<h4>Provider</h4>
37<p>
38 Other applications can use NotePad's content provider to store notes. The "contract" for
39 the NotePad provider is documented in the Appendix.
40</p>
41<h4>Alternative actions</h4>
42<p>
43 Other applications can also register themselves to handle NotePad notes. To do this, they must
44 provide the necessary specifications in their manifest file. The specifications are listed in
45 the Appendix.
46</p>
47<h4>Test package</h4>
48<p>
49 This sample also contains a test package that demonstrates how to test a ContentProvider and
50 an Activity. To learn more about this test package, please read
51 <a href="tests/index.html">NotePadTest Documentation</a>
52</p>
53<p class="note">
54 Please notice that this is not the same code that's used for the
55 <a href="../../../guide/tutorials/notepad/index.html">Notepad Tutorial</a>. This code has been
56 updated more recently, and the tutorial is a more simple implementation. If you're new to
57 Android development, you should start with the tutorial, then return to this code.
58</p>
59<h4>Appendix A: Provider contract</h4>
60<h4>Appendix B: Registering an application</h4>
Scott Main50992e82009-08-29 13:08:18 -070061<img alt="" src="../images/sample_notepad.png" />
62<img alt="" src="../images/sample_note.png" />