Você está na página 1de 626

A-Index

Overview Package Class Use Tree Deprecated Index Help


PREV LETTER NEXT LETTER FRAMES NO FRAMES All Classes
ABCDEFGHIKLMNOPQRSTUVWY

A
addEffect(int) - Method in class org.hermit.android.sound.Player
Add a sound effect to this player.
addEffect(int, float) - Method in class org.hermit.android.sound.Player
Add a sound effect to this player.
addGauge(Gauge) - Method in class org.hermit.android.instruments.InstrumentSurface
Add a gauge to this surface.
addHelpFromArrays(int, int) - Method in class org.hermit.android.core.HelpActivity
Add help to this help activity.
addInstrument(Instrument) - Method in class org.hermit.android.instruments.InstrumentSurface
Add an instrument to the system, associated with this surface.
addView(View) - Method in class org.hermit.android.widgets.HScrollView

addView(View, int) - Method in class org.hermit.android.widgets.HScrollView

addView(View, ViewGroup.LayoutParams) - Method in class org.hermit.android.widgets.HScrollView

addView(View, int, ViewGroup.LayoutParams) - Method in class


org.hermit.android.widgets.HScrollView

allRecords() - Method in class org.hermit.android.net.WebBasedData


Query for all records we have stored.
allRecordsSince(long) - Method in class org.hermit.android.net.WebBasedData
Query for all records we have stored timstamped AFTER a given date.
animStart() - Method in class org.hermit.android.core.SurfaceRunner
We are starting the animation loop.
animStart() - Method in class org.hermit.android.instruments.InstrumentSurface
We are starting the animation loop.
animStop() - Method in class org.hermit.android.core.SurfaceRunner
We are stopping the animation loop, for example to pause the app.
animStop() - Method in class org.hermit.android.instruments.InstrumentSurface
We are stopping the animation loop, for example to pause the app.
appDesc - Variable in class org.hermit.android.core.AppUtils.Version
Description either of the app or the version.
appName - Variable in class org.hermit.android.core.AppUtils.Version
Application's pretty name.
appSize(int, int, Bitmap.Config) - Method in class org.hermit.android.core.SurfaceRunner
Set the screen size.
appSize(int, int, Bitmap.Config) - Method in class org.hermit.android.instruments.InstrumentSurface
Set the screen size.
appStart() - Method in class org.hermit.android.core.SurfaceRunner
The application is starting.
appStart() - Method in class org.hermit.android.instruments.AudioAnalyser
The application is starting.
appStart() - Method in class org.hermit.android.instruments.Instrument
The application is starting.
appStart() - Method in class org.hermit.android.instruments.InstrumentSurface
The application is starting.
appStop() - Method in class org.hermit.android.core.SurfaceRunner

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index-files/index-1.html[2/19/2011 9:09:11 AM]


A-Index

The application is closing down.


appStop() - Method in class org.hermit.android.instruments.AudioAnalyser
The application is closing down.
appStop() - Method in class org.hermit.android.instruments.Instrument
The application is closing down.
appStop() - Method in class org.hermit.android.instruments.InstrumentSurface
The application is closing down.
AppUtils - Class in org.hermit.android.core
This class provides some simple application-related utilities.
AppUtils.Detail - Enum in org.hermit.android.core
Version info detail level.
AppUtils.Version - Class in org.hermit.android.core
Information on an application version.
AppUtils.Version() - Constructor for class org.hermit.android.core.AppUtils.Version

arrowScroll(int) - Method in class org.hermit.android.widgets.HScrollView


Handle scrolling in response to a left or right arrow click.
AudioAnalyser - Class in org.hermit.android.instruments
An Instrument which analyses an audio stream in various ways.
AudioAnalyser(SurfaceRunner) - Constructor for class org.hermit.android.instruments.AudioAnalyser
Create a WindMeter instance.
AudioReader - Class in org.hermit.android.io
A class which reads audio input from the mic in a background thread and passes it to the caller when
ready.
AudioReader() - Constructor for class org.hermit.android.io.AudioReader
Create an AudioReader instance.
AudioReader.Listener - Class in org.hermit.android.io
Listener for audio reads.
AudioReader.Listener() - Constructor for class org.hermit.android.io.AudioReader.Listener

Overview Package Class Use Tree Deprecated Index Help


PREV LETTER NEXT LETTER FRAMES NO FRAMES All Classes
ABCDEFGHIKLMNOPQRSTUVWY

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index-files/index-1.html[2/19/2011 9:09:11 AM]


Overview

Overview Package Class Use Tree Deprecated Index Help


PREV NEXT FRAMES NO FRAMES All Classes

HermitAndroid
HermitAndroid is a collection of useful classes for Android applications, in a library which can be linked
into Android projects.

See:
Description

Packages
org.hermit.android.core A library of foundation classes for Android applications.
org.hermit.android.instruments
org.hermit.android.io
org.hermit.android.net
org.hermit.android.notice
A library of classes to facilitate the creating of table-based content
org.hermit.android.provider
providers.
These classes provide functions to help apps manage their sound
org.hermit.android.sound
effects.
org.hermit.android.widgets

HermitAndroid is a collection of useful classes for Android applications, in a library which can be linked
into Android projects.

This library is structured as an Android library project, using the new Android libraries feature introduced in
Android SDK tools revision 6. This allows HermitAndroid to have its own resources, such as icons or
internationalized strings.

For information on getting the code, see the project home page on Google Code.

Overview Package Class Use Tree Deprecated Index Help


PREV NEXT FRAMES NO FRAMES All Classes

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/overview-summary.html[2/19/2011 9:09:14 AM]


Class Hierarchy

Overview Package Class Use Tree Deprecated Index Help


PREV NEXT FRAMES NO FRAMES All Classes

Hierarchy For All Packages


Package Hierarchies:
org.hermit.android.core, org.hermit.android.instruments, org.hermit.android.io, org.hermit.android.net,
org.hermit.android.notice, org.hermit.android.provider, org.hermit.android.sound,
org.hermit.android.widgets

Class Hierarchy
java.lang.Object
Activity
org.hermit.android.core.MainActivity
Activity
org.hermit.android.core.SplashActivity
Activity
org.hermit.android.core.HelpActivity
AlertDialog
org.hermit.android.notice.YesNoDialog
AlertDialog
org.hermit.android.notice.ErrorDialog
AlertDialog
org.hermit.android.notice.TextInputDialog
org.hermit.android.core.AppUtils
org.hermit.android.core.AppUtils.Version
org.hermit.android.io.AudioReader
org.hermit.android.io.AudioReader.Listener
org.hermit.android.net.CachedFile.Entry
ContentProvider
org.hermit.android.provider.TableProvider
org.hermit.android.provider.DbSchema
Dialog
org.hermit.android.notice.InfoBox
EditText
org.hermit.android.widgets.LinedEditText
org.hermit.android.sound.Effect
org.hermit.android.core.Errors
FrameLayout
org.hermit.android.widgets.HScrollView
org.hermit.android.instruments.Gauge
org.hermit.android.instruments.PowerGauge
org.hermit.android.instruments.SpectrumGauge
org.hermit.android.instruments.TextGauge
org.hermit.android.instruments.WaveformGauge
ImageButton
org.hermit.android.widgets.MultistateImageButton
org.hermit.android.instruments.Instrument
org.hermit.android.instruments.AudioAnalyser
ListActivity
org.hermit.android.widgets.TimeZoneActivity

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/overview-tree.html[2/19/2011 9:09:15 AM]


Class Hierarchy

org.hermit.android.core.MainActivity.ActivityListener
java.util.Observable
org.hermit.android.net.CachedFile (implements
org.hermit.android.net.WebFetcher.Listener)
org.hermit.android.net.WebBasedData (implements
org.hermit.android.net.WebFetcher.Listener)
org.hermit.android.core.OneTimeDialog
org.hermit.android.sound.Player
SQLiteOpenHelper
org.hermit.android.provider.DatabaseHelper
SurfaceView
org.hermit.android.core.SurfaceRunner
org.hermit.android.instruments.InstrumentSurface
org.hermit.android.provider.TableSchema
java.lang.Thread (implements java.lang.Runnable)
org.hermit.android.net.WebFetcher
org.hermit.android.net.FileFetcher
org.hermit.android.net.TableFetcher
java.lang.Throwable (implements java.io.Serializable)
java.lang.Exception
org.hermit.android.net.WebFetcher.FetchException

Interface Hierarchy
org.hermit.android.notice.TextInputDialog.OnOkListener
org.hermit.android.net.WebFetcher.Listener
org.hermit.android.notice.YesNoDialog.OnOkListener

Enum Hierarchy
java.lang.Object
java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable)
org.hermit.android.core.AppUtils.Detail

Overview Package Class Use Tree Deprecated Index Help


PREV NEXT FRAMES NO FRAMES All Classes

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/overview-tree.html[2/19/2011 9:09:15 AM]


Deprecated List

Overview Package Class Use Tree Deprecated Index Help


PREV NEXT FRAMES NO FRAMES All Classes

Deprecated API

Contents

Deprecated Methods

Deprecated Methods
org.hermit.android.core.MainActivity.createMessageBox(int)
The message box is now created automatically.
org.hermit.android.core.MainActivity.setHomeInfo(int, int)

org.hermit.android.core.MainActivity.setLicenseInfo(int, int)

Overview Package Class Use Tree Deprecated Index Help


PREV NEXT FRAMES NO FRAMES All Classes

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/deprecated-list.html[2/19/2011 9:09:16 AM]


API Help

Overview Package Class Use Tree Deprecated Index Help


PREV NEXT FRAMES NO FRAMES All Classes

How This API Document Is Organized


This API (Application Programming Interface) document has pages corresponding to the items in the
navigation bar, described as follows.

Overview
The Overview page is the front page of this API document and provides a list of all packages
with a summary for each. This page can also contain an overall description of the set of
packages.

Package
Each package has a page that contains a list of its classes and interfaces, with a summary for
each. This page can contain four categories:

Interfaces (italic)
Classes
Enums
Exceptions
Errors
Annotation Types

Class/Interface
Each class, interface, nested class and nested interface has its own separate page. Each of
these pages has three sections consisting of a class/interface description, summary tables, and
detailed member descriptions:

Class inheritance diagram


Direct Subclasses
All Known Subinterfaces
All Known Implementing Classes
Class/interface declaration
Class/interface description

Nested Class Summary


Field Summary
Constructor Summary
Method Summary

Field Detail
Constructor Detail
Method Detail

Each summary entry contains the first sentence from the detailed description for that item. The
summary entries are alphabetical, while the detailed descriptions are in the order they appear in
the source code. This preserves the logical groupings established by the programmer.

Annotation Type

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/help-doc.html[2/19/2011 9:09:17 AM]


API Help

Each annotation type has its own separate page with the following sections:

Annotation Type declaration


Annotation Type description
Required Element Summary
Optional Element Summary
Element Detail

Enum
Each enum has its own separate page with the following sections:

Enum declaration
Enum description
Enum Constant Summary
Enum Constant Detail

Use
Each documented package, class and interface has its own Use page. This page describes what
packages, classes, methods, constructors and fields use any part of the given class or package.
Given a class or interface A, its Use page includes subclasses of A, fields declared as A, methods
that return A, and methods and constructors with parameters of type A. You can access this
page by first going to the package, class or interface, then clicking on the "Use" link in the
navigation bar.

Tree (Class Hierarchy)


There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each
hierarchy page contains a list of classes and a list of interfaces. The classes are organized by
inheritance structure starting with java.lang.Object. The interfaces do not inherit from
java.lang.Object.

When viewing the Overview page, clicking on "Tree" displays the hierarchy for all
packages.
When viewing a particular package, class or interface page, clicking "Tree" displays the
hierarchy for only that package.

Deprecated API
The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not
recommended for use, generally due to improvements, and a replacement API is usually given.
Deprecated APIs may be removed in future implementations.

Index
The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.

Prev/Next
These links take you to the next or previous class, interface, package, or related page.

Frames/No Frames

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/help-doc.html[2/19/2011 9:09:17 AM]


API Help

These links show and hide the HTML frames. All pages are available with or without frames.

Serialized Form
Each serializable or externalizable class has a description of its serialization fields and methods. This
information is of interest to re-implementors, not to developers using the API. While there is no link in the
navigation bar, you can get to this information by going to any serialized class and clicking "Serialized
Form" in the "See also" section of the class description.

Constant Field Values


The Constant Field Values page lists the static final fields and their values.
This help file applies to API documentation generated using the standard doclet.

Overview Package Class Use Tree Deprecated Index Help


PREV NEXT FRAMES NO FRAMES All Classes

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/help-doc.html[2/19/2011 9:09:17 AM]


B-Index

Overview Package Class Use Tree Deprecated Index Help


PREV LETTER NEXT LETTER FRAMES NO FRAMES All Classes
ABCDEFGHIKLMNOPQRSTUVWY

B
BUTTON_1 - Static variable in class org.hermit.android.notice.InfoBox
Select configurable button 1 -- the middle button.
BUTTON_2 - Static variable in class org.hermit.android.notice.InfoBox
Select configurable button 2 -- the middle button.

Overview Package Class Use Tree Deprecated Index Help


PREV LETTER NEXT LETTER FRAMES NO FRAMES All Classes
ABCDEFGHIKLMNOPQRSTUVWY

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index-files/index-2.html[2/19/2011 9:09:19 AM]


Overview

All Classes Overview Package Class Use Tree Deprecated Index Help
PREV NEXT FRAMES NO FRAMES
Packages
org.hermit.android.core
org.hermit.android.instrum HermitAndroid
org.hermit.android.io
org.hermit.android.net HermitAndroid is a collection of useful classes for Android applications, in a library which
org.hermit.android.notice can be linked into Android projects.
org.hermit.android.provide
org.hermit.android.sound See:
org.hermit.android.widgets Description

Packages
org.hermit.android.core A library of foundation classes for Android
applications.
org.hermit.android.instruments
All Classes org.hermit.android.io
AppUtils org.hermit.android.net
AppUtils.Detail
org.hermit.android.notice
AudioAnalyser
AudioReader org.hermit.android.provider A library of classes to facilitate the creating of table-
AudioReader.Listener based content providers.
CachedFile These classes provide functions to help apps manage
CachedFile.Entry org.hermit.android.sound
their sound effects.
DatabaseHelper
DbSchema org.hermit.android.widgets
Effect
ErrorDialog
Errors
FileFetcher HermitAndroid is a collection of useful classes for Android applications, in a library which
Gauge can be linked into Android projects.
HelpActivity
HScrollView This library is structured as an Android library project, using the new Android libraries
InfoBox feature introduced in Android SDK tools revision 6. This allows HermitAndroid to have its
Instrument own resources, such as icons or internationalized strings.
InstrumentSurface
LinedEditText For information on getting the code, see the project home page on Google Code.
MainActivity
MainActivity.ActivityListen
MultistateImageButton Overview Package Class Use Tree Deprecated Index Help
OneTimeDialog PREV NEXT FRAMES NO FRAMES

Player
PowerGauge
SpectrumGauge
SplashActivity
SurfaceRunner
TableFetcher
TableProvider
TableSchema
TextGauge
TextInputDialog
TextInputDialog.OnOkList
TimeZoneActivity
WaveformGauge
WebBasedData
WebFetcher
WebFetcher.FetchExcepti
WebFetcher.Listener

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?index-filesindex-1.html[2/19/2011 9:09:21 AM]


Overview

YesNoDialog

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?index-filesindex-1.html[2/19/2011 9:09:21 AM]


All Classes

All Classes
AppUtils
AppUtils.Detail
AudioAnalyser
AudioReader
AudioReader.Listener
CachedFile
CachedFile.Entry
DatabaseHelper
DbSchema
Effect
ErrorDialog
Errors
FileFetcher
Gauge
HelpActivity
HScrollView
InfoBox
Instrument
InstrumentSurface
LinedEditText
MainActivity
MainActivity.ActivityListener
MultistateImageButton
OneTimeDialog
Player
PowerGauge
SpectrumGauge
SplashActivity
SurfaceRunner
TableFetcher
TableProvider
TableSchema
TextGauge
TextInputDialog
TextInputDialog.OnOkListener
TimeZoneActivity
WaveformGauge
WebBasedData
WebFetcher
WebFetcher.FetchException
WebFetcher.Listener
YesNoDialog
YesNoDialog.OnOkListener

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/allclasses-noframe.html[2/19/2011 9:09:23 AM]


C-Index

Overview Package Class Use Tree Deprecated Index Help


PREV LETTER NEXT LETTER FRAMES NO FRAMES All Classes
ABCDEFGHIKLMNOPQRSTUVWY

C
cacheBackground() - Method in class org.hermit.android.instruments.Gauge
Fetch and cache an image of the background now, then use that to draw the background on future
draw requests.
CachedFile - Class in org.hermit.android.net
This class manages a set of web-based files and caches them locally.
CachedFile(String, URL[]) - Constructor for class org.hermit.android.net.CachedFile
Create a cache of web-based files.
CachedFile.Entry - Class in org.hermit.android.net
Class describing an entry in the cache; i.e.
computeHorizontalScrollRange() - Method in class org.hermit.android.widgets.HScrollView
The scroll range of a scroll view is the overall height of all of its children.
computeScroll() - Method in class org.hermit.android.widgets.HScrollView

computeScrollDeltaToGetChildRectOnScreen(Rect) - Method in class


org.hermit.android.widgets.HScrollView
Compute the amount to scroll in the Y direction in order to get a rectangle completely on the screen
(or, if taller than the screen, at least the first screen size chunk of it).
createEulaBox(int, int, int) - Method in class org.hermit.android.core.MainActivity
Create a dialog for showing the EULA, or other warnings / disclaimers.
createMessageBox(int) - Method in class org.hermit.android.core.MainActivity
Deprecated. The message box is now created automatically.
createTable(SQLiteDatabase) - Method in class org.hermit.android.net.CachedFile
Create our table in the database.
createTable(SQLiteDatabase) - Method in class org.hermit.android.net.WebBasedData
Create our table in the database.

Overview Package Class Use Tree Deprecated Index Help


PREV LETTER NEXT LETTER FRAMES NO FRAMES All Classes
ABCDEFGHIKLMNOPQRSTUVWY

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index-files/index-3.html[2/19/2011 9:09:24 AM]


D-Index

Overview Package Class Use Tree Deprecated Index Help


PREV LETTER NEXT LETTER FRAMES NO FRAMES All Classes
ABCDEFGHIKLMNOPQRSTUVWY

D
DatabaseHelper - Class in org.hermit.android.provider
This class helps open, create, and upgrade the database file.
DatabaseHelper(Context, DbSchema) - Constructor for class
org.hermit.android.provider.DatabaseHelper
Creater a helper instance.
dataClient - Variable in class org.hermit.android.net.WebFetcher

dataUrls - Variable in class org.hermit.android.net.WebFetcher

date - Variable in class org.hermit.android.net.CachedFile.Entry


The last modified time of the file, as reported by the server, in ms UTC.
DbSchema - Class in org.hermit.android.provider
Class encapsulating the schema for a content provider.
DbSchema(String, int, String, TableSchema[]) - Constructor for class
org.hermit.android.provider.DbSchema
Create a database schema instance.
delete(Uri, String, String[]) - Method in class org.hermit.android.provider.TableProvider
A request to delete one or more rows.
dispatchKeyEvent(KeyEvent) - Method in class org.hermit.android.widgets.HScrollView

doDraw(Canvas, long) - Method in class org.hermit.android.core.SurfaceRunner


Draw the current frame of the application.
doDraw(Canvas, long) - Method in class org.hermit.android.instruments.InstrumentSurface
Draw the current frame of the application.
doUpdate(long) - Method in class org.hermit.android.core.SurfaceRunner
Update the state of the application for the current frame.
doUpdate(long) - Method in class org.hermit.android.instruments.AudioAnalyser
Update the state of the instrument for the current frame.
doUpdate(long) - Method in class org.hermit.android.instruments.Instrument
Update the state of the instrument for the current frame.
doUpdate(long) - Method in class org.hermit.android.instruments.InstrumentSurface
Update the state of the application for the current frame.
draw(Canvas, long, boolean) - Method in class org.hermit.android.instruments.Gauge
This method is called to ask the element to draw its dynamic content.
drawBackground(Canvas) - Method in class org.hermit.android.instruments.Gauge
This method is called to ask the element to draw its static content; i.e.
drawBackgroundBody(Canvas, Paint) - Method in class org.hermit.android.instruments.Gauge
Do the subclass-specific parts of drawing the background for this element.
drawBackgroundBody(Canvas, Paint) - Method in class org.hermit.android.instruments.PowerGauge
Do the subclass-specific parts of drawing the background for this element.
drawBody(Canvas, Paint, long) - Method in class org.hermit.android.instruments.Gauge
Do the subclass-specific parts of drawing for this element.
drawBody(Canvas, Paint, long) - Method in class org.hermit.android.instruments.PowerGauge
Do the subclass-specific parts of drawing for this element.
drawBody(Canvas, Paint, long) - Method in class org.hermit.android.instruments.SpectrumGauge
Do the subclass-specific parts of drawing for this element.
drawBody(Canvas, Paint, long) - Method in class org.hermit.android.instruments.TextGauge
This method is called to ask the element to draw itself.

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index-files/index-4.html[2/19/2011 9:09:27 AM]


D-Index

drawBody(Canvas, Paint, long) - Method in class org.hermit.android.instruments.WaveformGauge


Do the subclass-specific parts of drawing for this element.
drawFinish(Canvas, Paint, long) - Method in class org.hermit.android.instruments.Gauge
Wrap up drawing of this element.
drawStart(Canvas, Paint, long) - Method in class org.hermit.android.instruments.Gauge
Do initial parts of drawing for this element.

Overview Package Class Use Tree Deprecated Index Help


PREV LETTER NEXT LETTER FRAMES NO FRAMES All Classes
ABCDEFGHIKLMNOPQRSTUVWY

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index-files/index-4.html[2/19/2011 9:09:27 AM]


E-Index

Overview Package Class Use Tree Deprecated Index Help


PREV LETTER NEXT LETTER FRAMES NO FRAMES All Classes
ABCDEFGHIKLMNOPQRSTUVWY

E
Effect - Class in org.hermit.android.sound
Class representing a specific sound effect.
ERR_INIT_FAILED - Static variable in class org.hermit.android.io.AudioReader.Listener
Audio read error code: the audio reader failed to initialise.
ERR_OK - Static variable in class org.hermit.android.io.AudioReader.Listener
Audio read error code: no error.
ERR_READ_FAILED - Static variable in class org.hermit.android.io.AudioReader.Listener
Audio read error code: an audio read failed.
error(int) - Method in class org.hermit.android.instruments.Gauge
An error has occurred.
ErrorDialog - Class in org.hermit.android.notice
This class implements a popup error box (a subclass of AlertDialog) which can be used to display an
error message.
ErrorDialog(Context, int) - Constructor for class org.hermit.android.notice.ErrorDialog
Create an error dialog.
ErrorDialog(Context, CharSequence) - Constructor for class org.hermit.android.notice.ErrorDialog
Create an error dialog.
Errors - Class in org.hermit.android.core
Error handling and reporting utilities.
executeKeyEvent(KeyEvent) - Method in class org.hermit.android.widgets.HScrollView
You can call this function yourself to have the scroll view perform scrolling from a key event, just as if
the event had been dispatched to it by the view hierarchy.
EXTRAS_IMAGE_ID - Static variable in class org.hermit.android.core.SplashActivity
Extras key for the image resource ID.
EXTRAS_TIME_ID - Static variable in class org.hermit.android.core.SplashActivity
Extras key for the splash screen display time.

Overview Package Class Use Tree Deprecated Index Help


PREV LETTER NEXT LETTER FRAMES NO FRAMES All Classes
ABCDEFGHIKLMNOPQRSTUVWY

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index-files/index-5.html[2/19/2011 9:09:28 AM]


F-Index

Overview Package Class Use Tree Deprecated Index Help


PREV LETTER NEXT LETTER FRAMES NO FRAMES All Classes
ABCDEFGHIKLMNOPQRSTUVWY

F
fetch(URL, long) - Method in class org.hermit.android.net.WebFetcher
Fetch an object from the given URL.
FileFetcher - Class in org.hermit.android.net
Concrete instance of WebFetcher which gets a file and stores it locally.
FileFetcher(Context, URL, String, WebFetcher.Listener, long) - Constructor for class
org.hermit.android.net.FileFetcher
Fetch a file from the web.
FileFetcher(Context, URL, String, WebFetcher.Listener, long, long) - Constructor for class
org.hermit.android.net.FileFetcher
Fetch a file from the web.
fling(int) - Method in class org.hermit.android.widgets.HScrollView
Fling the scroll view

Overview Package Class Use Tree Deprecated Index Help


PREV LETTER NEXT LETTER FRAMES NO FRAMES All Classes
ABCDEFGHIKLMNOPQRSTUVWY

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index-files/index-6.html[2/19/2011 9:09:29 AM]


G-Index

Overview Package Class Use Tree Deprecated Index Help


PREV LETTER NEXT LETTER FRAMES NO FRAMES All Classes
ABCDEFGHIKLMNOPQRSTUVWY

G
Gauge - Class in org.hermit.android.instruments
A graphical display which shows some data in a region within a view.
Gauge(SurfaceRunner) - Constructor for class org.hermit.android.instruments.Gauge
Set up this view.
Gauge(SurfaceRunner, int) - Constructor for class org.hermit.android.instruments.Gauge
Set up this view.
Gauge(SurfaceRunner, int, int) - Constructor for class org.hermit.android.instruments.Gauge
Set up this view.
Gauge(SurfaceRunner, int, int, int) - Constructor for class org.hermit.android.instruments.Gauge
Set up this view.
getAppVersion() - Method in class org.hermit.android.core.AppUtils
Get the version info for the current app.
getBackgroundColor() - Method in class org.hermit.android.instruments.Gauge
Get the background colour of this element.
getBaseTextSize() - Static method in class org.hermit.android.instruments.Gauge
Get the base size for text.
getBitmap() - Method in class org.hermit.android.core.SurfaceRunner
Get a Bitmap which is the same size and format as the surface.
getBitmap(int, int) - Method in class org.hermit.android.core.SurfaceRunner
Get a Bitmap of a given size, in the same format as the surface.
getBounds() - Method in class org.hermit.android.instruments.Gauge
Get the bounding rect of this Element.
getBuffer() - Method in class org.hermit.android.instruments.TextGauge
Get the text buffers for the field values.
getContentUri() - Method in class org.hermit.android.provider.TableSchema
Get the table's content URI.
getDbName() - Method in class org.hermit.android.provider.DbSchema
Get the database name.
getDbVersion() - Method in class org.hermit.android.provider.DbSchema
Get the database version number.
getFile(URL) - Method in class org.hermit.android.net.CachedFile
Query for a given file in the cache.
getGridColor() - Method in class org.hermit.android.instruments.Gauge
Get the data scale / grid colour of this element.
getHeadTextSize() - Static method in class org.hermit.android.instruments.Gauge
Get the size for header text.
getHeight() - Method in class org.hermit.android.instruments.Gauge
Get the height of this element -- i.e.
getHelper() - Method in class org.hermit.android.provider.TableProvider
Get the database helper which this content provider will use.
getInnerGap() - Static method in class org.hermit.android.instruments.Gauge
Get the amount of padding within atoms within an element.
getInstance(Activity) - Static method in class org.hermit.android.core.AppUtils
Get the app utils instance for this Activity.
getInstance(Context) - Static method in class org.hermit.android.core.Errors
Get the single instance of this class for the given Activity, creating it if necessary.
getInterPadding() - Static method in class org.hermit.android.instruments.Gauge
Get the amount of padding between major elements in a view.

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index-files/index-7.html[2/19/2011 9:09:31 AM]


G-Index

getItemType() - Method in class org.hermit.android.provider.TableSchema


Get the MIME type for the items in the table.
getLabelSize() - Method in class org.hermit.android.instruments.PowerGauge
Get the size for the label text.
getLabelSize() - Method in class org.hermit.android.instruments.SpectrumGauge
Get the size for the label text.
getLeftFadingEdgeStrength() - Method in class org.hermit.android.widgets.HScrollView

getMaxScrollAmount() - Method in class org.hermit.android.widgets.HScrollView

getMiniTextSize() - Static method in class org.hermit.android.instruments.Gauge


Get the size for mini text.
getName() - Method in class org.hermit.android.net.WebBasedData
Get the name of this source.
getPaint() - Method in class org.hermit.android.instruments.Gauge
Get this element's Paint.
getPlotColor() - Method in class org.hermit.android.instruments.Gauge
Get the data plot colour of this element.
getPowerGauge(SurfaceRunner) - Method in class org.hermit.android.instruments.AudioAnalyser
Get a signal power gauge for this audio analyser.
getPreferredHeight() - Method in class org.hermit.android.instruments.Gauge
Get the minimum preferred height for this atom.
getPreferredHeight() - Method in class org.hermit.android.instruments.TextGauge
Get the minimum height needed to fit all the text.
getPreferredWidth() - Method in class org.hermit.android.instruments.Gauge
Get the minimum preferred width for this atom.
getPreferredWidth() - Method in class org.hermit.android.instruments.TextGauge
Get the minimum width needed to fit all the text.
getRes(int) - Method in class org.hermit.android.core.SurfaceRunner
Get the String value of a resource.
getRightFadingEdgeStrength() - Method in class org.hermit.android.widgets.HScrollView

getSchema() - Method in class org.hermit.android.provider.DatabaseHelper


Get the database schema.
getSchema() - Method in class org.hermit.android.provider.TableProvider
Get the database schema.
getSidebarWidth() - Static method in class org.hermit.android.instruments.Gauge
Get the sidebar width.
getSpectrumGauge(SurfaceRunner) - Method in class org.hermit.android.instruments.AudioAnalyser
Get a spectrum analyser gauge for this audio analyser.
getState() - Method in class org.hermit.android.widgets.MultistateImageButton
Get the current state of this button.
getSurface() - Method in class org.hermit.android.instruments.Gauge
Get the app context of this Element.
getSurface() - Method in class org.hermit.android.instruments.Instrument
Get the app context of this Element.
getTable(String) - Method in class org.hermit.android.provider.DbSchema
Get the schema for a specified table.
getTableName() - Method in class org.hermit.android.provider.TableSchema
Get the table name.
getTableSchema(String) - Method in class org.hermit.android.provider.TableProvider
Get the schema for a specified table.
getTableType() - Method in class org.hermit.android.provider.TableSchema
Get the MIME type for the table as a whole.
getTextColor() - Method in class org.hermit.android.instruments.TextGauge
Get the text colour of this element.
getTextScaleX() - Static method in class org.hermit.android.instruments.Gauge

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index-files/index-7.html[2/19/2011 9:09:31 AM]


G-Index

Get the base size for text based on this screen's size.
getTextSize() - Method in class org.hermit.android.instruments.TextGauge
Get the text size of this element.
getTextTypeface() - Static method in class org.hermit.android.instruments.Gauge
Get the default font for all text.
getTinyTextSize() - Static method in class org.hermit.android.instruments.Gauge
Get the size for tiny text based on this screen's size.
getType(Uri) - Method in class org.hermit.android.provider.TableProvider
Return the MIME type of the data at the given URI.
getVersionString() - Method in class org.hermit.android.core.AppUtils
Get a string containing the name and version info for the current app's package, in a simple format.
getVersionString(AppUtils.Detail) - Method in class org.hermit.android.core.AppUtils
Get a string containing the name and version info for the current app's package.
getWaveformGauge(SurfaceRunner) - Method in class org.hermit.android.instruments.AudioAnalyser
Get a waveform gauge for this audio analyser.
getWidth() - Method in class org.hermit.android.instruments.Gauge
Get the width of this element -- i.e.

Overview Package Class Use Tree Deprecated Index Help


PREV LETTER NEXT LETTER FRAMES NO FRAMES All Classes
ABCDEFGHIKLMNOPQRSTUVWY

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index-files/index-7.html[2/19/2011 9:09:31 AM]


H-Index

Overview Package Class Use Tree Deprecated Index Help


PREV LETTER NEXT LETTER FRAMES NO FRAMES All Classes
ABCDEFGHIKLMNOPQRSTUVWY

H
handle(URL, URLConnection, InputStream) - Method in class org.hermit.android.net.FileFetcher
Fetch a page of data from the given stream.
handle(URL, URLConnection, BufferedReader) - Method in class org.hermit.android.net.TableFetcher
Fetch a page of data from the given BufferedReader.
handle(URL, URLConnection, InputStream) - Method in class org.hermit.android.net.WebFetcher
Handle data from the given stream.
handle(URL, URLConnection, BufferedReader) - Method in class org.hermit.android.net.WebFetcher
Handle data from the given BufferedReader.
haveBounds() - Method in class org.hermit.android.instruments.Gauge
Determine whether we have the bounding rect of this Element.
HelpActivity - Class in org.hermit.android.core
An activity which displays an application's help, in a structured format.
HelpActivity() - Constructor for class org.hermit.android.core.HelpActivity

HScrollView - Class in org.hermit.android.widgets


Layout container for a view hierarchy that can be scrolled by the user, allowing it to be larger than
the physical display.
HScrollView(Context) - Constructor for class org.hermit.android.widgets.HScrollView

HScrollView(Context, AttributeSet) - Constructor for class org.hermit.android.widgets.HScrollView

Overview Package Class Use Tree Deprecated Index Help


PREV LETTER NEXT LETTER FRAMES NO FRAMES All Classes
ABCDEFGHIKLMNOPQRSTUVWY

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index-files/index-8.html[2/19/2011 9:09:33 AM]


I-Index

Overview Package Class Use Tree Deprecated Index Help


PREV LETTER NEXT LETTER FRAMES NO FRAMES All Classes
ABCDEFGHIKLMNOPQRSTUVWY

I
InfoBox - Class in org.hermit.android.notice
This class implements a popup info box (a subclass of Dialog) which can be used to display help text,
about info, license info, etc.
InfoBox(Activity) - Constructor for class org.hermit.android.notice.InfoBox
Create an info box with a "close" button.
InfoBox(Activity, int) - Constructor for class org.hermit.android.notice.InfoBox
Create an info box.
initializePaint(Paint) - Method in class org.hermit.android.instruments.Gauge
Set up the paint for this element.
initializePaint(Paint) - Method in class org.hermit.android.instruments.TextGauge
Set up the paint for this element.
insert(Uri, ContentValues) - Method in class org.hermit.android.provider.TableProvider
Implement this to insert a new row.
Instrument - Class in org.hermit.android.instruments
An instrument which measures some quantity, or accesses or produces some data, which can be
displayed on one or more Gauge objects.
Instrument(SurfaceRunner) - Constructor for class org.hermit.android.instruments.Instrument
Set up this view.
InstrumentSurface - Class in org.hermit.android.instruments
Common base for applications which display instruments.
InstrumentSurface(Activity) - Constructor for class org.hermit.android.instruments.InstrumentSurface
Create a SurfaceRunner instance.
InstrumentSurface(Activity, int) - Constructor for class
org.hermit.android.instruments.InstrumentSurface
Create a SurfaceRunner instance.
invalidate(URL) - Method in class org.hermit.android.net.CachedFile
Invalidate the given file in the cache (perhaps it was corrupted).
isAccepted() - Method in class org.hermit.android.core.OneTimeDialog
Query whether the dialog has been shown to the user and accepted.
isFillViewport() - Method in class org.hermit.android.widgets.HScrollView
Indicates whether this ScrollView's content is stretched to fill the viewport.
isPlaying() - Method in class org.hermit.android.sound.Effect
Determine whether this effect is playing.
isSmoothScrollingEnabled() - Method in class org.hermit.android.widgets.HScrollView

Overview Package Class Use Tree Deprecated Index Help


PREV LETTER NEXT LETTER FRAMES NO FRAMES All Classes
ABCDEFGHIKLMNOPQRSTUVWY

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index-files/index-9.html[2/19/2011 9:09:35 AM]


K-Index

Overview Package Class Use Tree Deprecated Index Help


PREV LETTER NEXT LETTER FRAMES NO FRAMES All Classes
ABCDEFGHIKLMNOPQRSTUVWY

K
kill() - Method in class org.hermit.android.net.WebFetcher
Kill this fetcher.
killAll() - Static method in class org.hermit.android.net.WebFetcher
Stop all fetch operations.
killed - Variable in class org.hermit.android.net.WebFetcher

Overview Package Class Use Tree Deprecated Index Help


PREV LETTER NEXT LETTER FRAMES NO FRAMES All Classes
ABCDEFGHIKLMNOPQRSTUVWY

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index-files/index-10.html[2/19/2011 9:09:38 AM]


L-Index

Overview Package Class Use Tree Deprecated Index Help


PREV LETTER NEXT LETTER FRAMES NO FRAMES All Classes
ABCDEFGHIKLMNOPQRSTUVWY

L
lastRecord() - Method in class org.hermit.android.net.WebBasedData
Query for the newest record we have stored.
launch(Context, int, long) - Static method in class org.hermit.android.core.SplashActivity
Launch a splash screen displaying the given drawable.
layout(int, int) - Method in class org.hermit.android.instruments.InstrumentSurface
Lay out the display for a given screen size.
LinedEditText - Class in org.hermit.android.widgets
A custom EditText that draws lines between each line of text that is displayed.
LinedEditText(Context, AttributeSet) - Constructor for class org.hermit.android.widgets.LinedEditText
Construct a widget from a given attribute set.
linkButtonPressed(int) - Method in class org.hermit.android.notice.InfoBox
Called when a link button is clicked.
loop() - Method in class org.hermit.android.sound.Effect
Start playing this sound effect in a continuous loop.
LOOPED_TICKER - Static variable in class org.hermit.android.core.SurfaceRunner
Surface runner option: use a Looper to drive animations.

Overview Package Class Use Tree Deprecated Index Help


PREV LETTER NEXT LETTER FRAMES NO FRAMES All Classes
ABCDEFGHIKLMNOPQRSTUVWY

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index-files/index-11.html[2/19/2011 9:09:39 AM]


M-Index

Overview Package Class Use Tree Deprecated Index Help


PREV LETTER NEXT LETTER FRAMES NO FRAMES All Classes
ABCDEFGHIKLMNOPQRSTUVWY

M
MainActivity - Class in org.hermit.android.core
An enhanced Activity class, for use as the main activity of an application.
MainActivity() - Constructor for class org.hermit.android.core.MainActivity

MainActivity.ActivityListener - Class in org.hermit.android.core


This interface defines a listener for sub-activity results.
MainActivity.ActivityListener() - Constructor for class
org.hermit.android.core.MainActivity.ActivityListener

makeProjection(String[][]) - Static method in class org.hermit.android.provider.TableSchema


This method creates a projection from a set of field definitions.
measureChild(View, int, int) - Method in class org.hermit.android.widgets.HScrollView

measureChildWithMargins(View, int, int, int, int) - Method in class


org.hermit.android.widgets.HScrollView

measureStart() - Method in class org.hermit.android.instruments.AudioAnalyser


We are starting the main run; start measurements.
measureStart() - Method in class org.hermit.android.instruments.Instrument
We are starting the main run; start measurements.
measureStop() - Method in class org.hermit.android.instruments.AudioAnalyser
We are stopping / pausing the run; stop measurements.
measureStop() - Method in class org.hermit.android.instruments.Instrument
We are stopping / pausing the run; stop measurements.
MultistateImageButton - Class in org.hermit.android.widgets
This class displays an image button which toggles or cycles through multiple states when clicked.
MultistateImageButton(Context, int[]) - Constructor for class
org.hermit.android.widgets.MultistateImageButton
Create a multistate image button with a specified set of image resource IDs.
MultistateImageButton(Context, AttributeSet, int[]) - Constructor for class
org.hermit.android.widgets.MultistateImageButton
Create a multistate image button with a specified set of image resource IDs.

Overview Package Class Use Tree Deprecated Index Help


PREV LETTER NEXT LETTER FRAMES NO FRAMES All Classes
ABCDEFGHIKLMNOPQRSTUVWY

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index-files/index-12.html[2/19/2011 9:09:41 AM]


N-Index

Overview Package Class Use Tree Deprecated Index Help


PREV LETTER NEXT LETTER FRAMES NO FRAMES All Classes
ABCDEFGHIKLMNOPQRSTUVWY

N
name - Variable in class org.hermit.android.net.CachedFile.Entry
The local name of the file.
newerThanDate - Variable in class org.hermit.android.net.WebFetcher

Overview Package Class Use Tree Deprecated Index Help


PREV LETTER NEXT LETTER FRAMES NO FRAMES All Classes
ABCDEFGHIKLMNOPQRSTUVWY

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index-files/index-13.html[2/19/2011 9:09:42 AM]


O-Index

Overview Package Class Use Tree Deprecated Index Help


PREV LETTER NEXT LETTER FRAMES NO FRAMES All Classes
ABCDEFGHIKLMNOPQRSTUVWY

O
okButtonPressed() - Method in class org.hermit.android.notice.InfoBox
Called when the OK button is clicked.
onActivityCanceled(Intent) - Method in class org.hermit.android.core.MainActivity.ActivityListener
Called when an activity you launched exits with a result code of RESULT_CANCELED.
onActivityFinished(int, Intent) - Method in class org.hermit.android.core.MainActivity.ActivityListener
Called when an activity you launched exits.
onActivityResult(int, Intent) - Method in class org.hermit.android.core.MainActivity.ActivityListener
Called when an activity you launched exits with a result code other than RESULT_CANCELED, giving
you the resultCode it returned, and any additional data from it.
onActivityResult(int, int, Intent) - Method in class org.hermit.android.core.MainActivity
Called when an activity you launched exits, giving you the requestCode you started it with, the
resultCode it returned, and any additional data from it.
onCreate(Bundle) - Method in class org.hermit.android.core.HelpActivity
Called when the activity is starting.
onCreate(Bundle) - Method in class org.hermit.android.core.MainActivity
Called when the activity is starting.
onCreate(Bundle) - Method in class org.hermit.android.core.SplashActivity
Called when the activity is starting.
onCreate(SQLiteDatabase) - Method in class org.hermit.android.provider.DatabaseHelper
Called when the database is created for the first time.
onCreate() - Method in class org.hermit.android.provider.TableProvider
Called when the provider is being started.
onCreate(Bundle) - Method in class org.hermit.android.widgets.TimeZoneActivity
Called when the activity is starting.
onDraw(Canvas) - Method in class org.hermit.android.widgets.LinedEditText
Overridden onDraw method.
OneTimeDialog - Class in org.hermit.android.core
A class which handles showing one-off notices.
OneTimeDialog(Activity, String, int, int, int) - Constructor for class
org.hermit.android.core.OneTimeDialog
Create a dialog for showing a notice, or other warnings / disclaimers, once only.
onInsert(Uri, TableSchema, ContentValues) - Method in class
org.hermit.android.provider.TableProvider
This method is called prior to processing an insert; it is called after
TableSchema.onInsert(ContentValues) .
onInsert(ContentValues) - Method in class org.hermit.android.provider.TableSchema
This method is called when a new row is added into this table.
onInterceptTouchEvent(MotionEvent) - Method in class org.hermit.android.widgets.HScrollView

onLayout(boolean, int, int, int, int) - Method in class org.hermit.android.widgets.HScrollView

onListItemClick(ListView, View, int, long) - Method in class


org.hermit.android.widgets.TimeZoneActivity
This method will be called when an item in the list is selected.
onMeasure(int, int) - Method in class org.hermit.android.widgets.HScrollView

onOk(CharSequence) - Method in interface org.hermit.android.notice.TextInputDialog.OnOkListener


The OK button has been clicked.

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index-files/index-14.html[2/19/2011 9:09:43 AM]


O-Index

onOk() - Method in interface org.hermit.android.notice.YesNoDialog.OnOkListener


The OK button has been clicked.
onPause() - Method in class org.hermit.android.core.SurfaceRunner
Pause the app.
onReadComplete(short[]) - Method in class org.hermit.android.io.AudioReader.Listener
An audio read has completed.
onReadError(int) - Method in class org.hermit.android.io.AudioReader.Listener
An error has occurred.
onRequestFocusInDescendants(int, Rect) - Method in class org.hermit.android.widgets.HScrollView
When looking for focus in children of a scroll view, need to be a little more careful not to give focus
to something that is scrolled off screen.
onRestoreInstanceState(Bundle) - Method in class org.hermit.android.core.HelpActivity
This method is called after onStart() when the activity is being re-initialized from a previously saved
state, given here in state.
onResume() - Method in class org.hermit.android.core.SurfaceRunner
We're resuming the app.
onSaveInstanceState(Bundle) - Method in class org.hermit.android.core.HelpActivity
Called to retrieve per-instance state from an activity before being killed so that the state can be
restored in onCreate(Bundle) or onRestoreInstanceState(Bundle) (the Bundle populated by this
method will be passed to both).
onSizeChanged(int, int, int, int) - Method in class org.hermit.android.widgets.HScrollView

onStart() - Method in class org.hermit.android.core.SurfaceRunner


The application is starting.
onStop() - Method in class org.hermit.android.core.SurfaceRunner
The application is closing down.
onSurfaceThread() - Method in class org.hermit.android.core.SurfaceRunner
Determine whether the caller is on the surface's animation thread.
onTouchEvent(MotionEvent) - Method in class org.hermit.android.widgets.HScrollView

onUpgrade(SQLiteDatabase, int, int) - Method in class org.hermit.android.provider.DatabaseHelper


Called when the database needs to be upgraded.
onWebData(URL, Object, long) - Method in class org.hermit.android.net.CachedFile
This method is invoked when a data item is retrieved from the URL we were invoked on.
onWebData(URL, Object, long) - Method in class org.hermit.android.net.WebBasedData
This method is invoked when a data record is retrieved from the URL we were invoked on.
onWebData(URL, Object, long) - Method in interface org.hermit.android.net.WebFetcher.Listener
This method is invoked when a data item is retrieved from one of the URLs we were invoked on.
onWebDone() - Method in class org.hermit.android.net.CachedFile
This method is invoked when the given URL has been fully fetched.
onWebDone() - Method in class org.hermit.android.net.WebBasedData
This method is invoked when the given URL has been fully fetched.
onWebDone() - Method in interface org.hermit.android.net.WebFetcher.Listener
This method is invoked when the URLs have been fully fetched.
onWebError(String) - Method in class org.hermit.android.net.CachedFile
Handle an error while fetching web data.
onWebError(String) - Method in class org.hermit.android.net.WebBasedData
Handle an error while fetching web data.
onWebError(String) - Method in interface org.hermit.android.net.WebFetcher.Listener
This method is invoked if an error occurs when fetching web data.
onWindowFocusChanged(boolean) - Method in class org.hermit.android.core.SurfaceRunner
Handle changes in focus.
optionSet(int) - Method in class org.hermit.android.core.SurfaceRunner
Check whether the given option flag is set on this surface.
optionSet(int) - Method in class org.hermit.android.instruments.Gauge
Check whether the given option flag is set on this surface.
org.hermit.android.core - package org.hermit.android.core

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index-files/index-14.html[2/19/2011 9:09:43 AM]


O-Index

A library of foundation classes for Android applications.


org.hermit.android.instruments - package org.hermit.android.instruments

org.hermit.android.io - package org.hermit.android.io

org.hermit.android.net - package org.hermit.android.net

org.hermit.android.notice - package org.hermit.android.notice

org.hermit.android.provider - package org.hermit.android.provider


A library of classes to facilitate the creating of table-based content providers.
org.hermit.android.sound - package org.hermit.android.sound
These classes provide functions to help apps manage their sound effects.
org.hermit.android.widgets - package org.hermit.android.widgets

Overview Package Class Use Tree Deprecated Index Help


PREV LETTER NEXT LETTER FRAMES NO FRAMES All Classes
ABCDEFGHIKLMNOPQRSTUVWY

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index-files/index-14.html[2/19/2011 9:09:43 AM]


P-Index

Overview Package Class Use Tree Deprecated Index Help


PREV LETTER NEXT LETTER FRAMES NO FRAMES All Classes
ABCDEFGHIKLMNOPQRSTUVWY

P
path - Variable in class org.hermit.android.net.CachedFile.Entry
The path of the local copy of the file.
play() - Method in class org.hermit.android.sound.Effect
Play this sound effect.
play(float) - Method in class org.hermit.android.sound.Effect
Play this sound effect.
play(Effect) - Method in class org.hermit.android.sound.Player
Play the given sound effect.
play(Effect, float, boolean) - Method in class org.hermit.android.sound.Player
Play the given sound effect.
Player - Class in org.hermit.android.sound
Main sound effects player class.
Player(Context) - Constructor for class org.hermit.android.sound.Player
Create a sound effect player that can handle 3 streams at once.
Player(Context, int) - Constructor for class org.hermit.android.sound.Player
Create a sound effect player.
postUpdate() - Method in class org.hermit.android.core.SurfaceRunner
Asynchronously schedule an update; i.e.
PowerGauge - Class in org.hermit.android.instruments
A graphical display which displays the signal power in dB from an AudioAnalyser instrument.
process(ContentValues) - Method in class org.hermit.android.net.WebBasedData
Optional processing step -- this is called for each record we read.

Overview Package Class Use Tree Deprecated Index Help


PREV LETTER NEXT LETTER FRAMES NO FRAMES All Classes
ABCDEFGHIKLMNOPQRSTUVWY

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index-files/index-15.html[2/19/2011 9:09:45 AM]


Q-Index

Overview Package Class Use Tree Deprecated Index Help


PREV LETTER NEXT LETTER FRAMES NO FRAMES All Classes
ABCDEFGHIKLMNOPQRSTUVWY

Q
query(Uri, String[], String, String[], String) - Method in class
org.hermit.android.provider.TableProvider
Receives a query request from a client in a local process, and returns a Cursor.
queryItem(TableSchema, String[], long) - Method in class org.hermit.android.provider.TableProvider
Query for a specified item within a table.
queryItem(TableSchema, String[], String) - Method in class org.hermit.android.provider.TableProvider
Query for a specified item within a table.
queryItems(TableSchema, String[], String, String[], String) - Method in class
org.hermit.android.provider.TableProvider
Query for items within a table.
queue(WebFetcher) - Static method in class org.hermit.android.net.WebFetcher
Queue a web fetch.

Overview Package Class Use Tree Deprecated Index Help


PREV LETTER NEXT LETTER FRAMES NO FRAMES All Classes
ABCDEFGHIKLMNOPQRSTUVWY

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index-files/index-16.html[2/19/2011 9:09:47 AM]


R-Index

Overview Package Class Use Tree Deprecated Index Help


PREV LETTER NEXT LETTER FRAMES NO FRAMES All Classes
ABCDEFGHIKLMNOPQRSTUVWY

R
reportException(Context, Exception) - Static method in class org.hermit.android.core.Errors
Report an unexpected exception to the user by popping up a dialog with some debug info.
reportException(Exception) - Method in class org.hermit.android.core.Errors
Report an unexpected exception to the user by popping up a dialog with some debug info.
reportException(Exception) - Method in class org.hermit.android.core.MainActivity
Report an unexpected exception to the user by popping up a dialog with some debug info.
requestChildFocus(View, View) - Method in class org.hermit.android.widgets.HScrollView

requestChildRectangleOnScreen(View, Rect, boolean) - Method in class


org.hermit.android.widgets.HScrollView

requestLayout() - Method in class org.hermit.android.widgets.HScrollView

restoreState(Bundle) - Method in class org.hermit.android.instruments.AudioAnalyser


Restore the game state from the given Bundle.
restoreState(Bundle) - Method in class org.hermit.android.instruments.Instrument
Restore the game state from the given Bundle.
run() - Method in class org.hermit.android.net.WebFetcher
Thread's main method.

Overview Package Class Use Tree Deprecated Index Help


PREV LETTER NEXT LETTER FRAMES NO FRAMES All Classes
ABCDEFGHIKLMNOPQRSTUVWY

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index-files/index-17.html[2/19/2011 9:09:48 AM]


S-Index

Overview Package Class Use Tree Deprecated Index Help


PREV LETTER NEXT LETTER FRAMES NO FRAMES All Classes
ABCDEFGHIKLMNOPQRSTUVWY

S
saveState(Bundle) - Method in class org.hermit.android.instruments.AudioAnalyser
Save the state of the game in the provided Bundle.
saveState(Bundle) - Method in class org.hermit.android.instruments.Instrument
Save the state of the game in the provided Bundle.
scrollTo(int, int) - Method in class org.hermit.android.widgets.HScrollView
setAboutInfo(int) - Method in class org.hermit.android.core.MainActivity
Set up the about info for dialogs.
setAverageLen(int) - Method in class org.hermit.android.instruments.AudioAnalyser
Set the histogram averaging window for this instrument.
setBackgroundColor(int) - Method in class org.hermit.android.instruments.Gauge
Set the background colour of this element.
setBarWidth(int) - Method in class org.hermit.android.instruments.PowerGauge
Set the overall thickness of the bar.
setBaseTextSize(float) - Static method in class org.hermit.android.instruments.Gauge
Set the base size for text.
setBlockSize(int) - Method in class org.hermit.android.instruments.AudioAnalyser
Set the input block size for this instrument.
setDatabase(SQLiteDatabase) - Method in class org.hermit.android.net.CachedFile
Set the database we use for storing our data.
setDatabase(SQLiteDatabase) - Method in class org.hermit.android.net.WebBasedData
Set the database we use for storing our data.
setDataColors(int, int) - Method in class org.hermit.android.instruments.Gauge
Set the plot colours of this element.
setDebugPerf(boolean) - Method in class org.hermit.android.core.SurfaceRunner
Turn display of performance info on or off.
setDebugPos(int, int) - Method in class org.hermit.android.core.SurfaceRunner
Set the screen position at which we display performance info.
setDecimation(int) - Method in class org.hermit.android.instruments.AudioAnalyser
Set the decimation rate for this instrument.
setDelay(long) - Method in class org.hermit.android.core.SurfaceRunner
Set the delay in ms in each iteration of the main loop.
setFillViewport(boolean) - Method in class org.hermit.android.widgets.HScrollView
Indicates this ScrollView whether it should stretch its content height to fill the viewport or not.
setGain(float) - Method in class org.hermit.android.sound.Player
Set the overall gain for sounds.
setGeometry(Rect) - Method in class org.hermit.android.instruments.Gauge
This is called during layout when the size of this element has changed.
setGeometry(Rect) - Method in class org.hermit.android.instruments.PowerGauge
This is called during layout when the size of this element has changed.
setGeometry(Rect) - Method in class org.hermit.android.instruments.SpectrumGauge
This is called during layout when the size of this element has changed.
setGeometry(Rect) - Method in class org.hermit.android.instruments.TextGauge
This is called during layout when the size of this element has changed.
setGeometry(Rect) - Method in class org.hermit.android.instruments.WaveformGauge
This is called during layout when the size of this element has changed.
setGridColor(int) - Method in class org.hermit.android.instruments.Gauge
Set the data scale / grid colour of this element.
setHeadTextSize(float) - Static method in class org.hermit.android.instruments.Gauge

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index-files/index-18.html[2/19/2011 9:09:50 AM]


S-Index

Set the size for header text.


setHomeInfo(int) - Method in class org.hermit.android.core.MainActivity
Set up the homepage info for dialogs.
setHomeInfo(int, int) - Method in class org.hermit.android.core.MainActivity
Deprecated.
setInnerGap(int) - Static method in class org.hermit.android.instruments.Gauge
Set the amount of padding within atoms within an element.
setInterPadding(int) - Static method in class org.hermit.android.instruments.Gauge
Set the amount of padding between major elements in a view.
setLabelSize(float) - Method in class org.hermit.android.instruments.PowerGauge
Set the size for the label text.
setLabelSize(float) - Method in class org.hermit.android.instruments.SpectrumGauge
Set the size for the label text.
setLicenseInfo(int) - Method in class org.hermit.android.core.MainActivity
Set up the license info for dialogs.
setLicenseInfo(int, int) - Method in class org.hermit.android.core.MainActivity
Deprecated.
setLinkButton(int, int, int) - Method in class org.hermit.android.notice.InfoBox
Set a link button on this dialog.
setMargins(int, int, int, int) - Method in class org.hermit.android.instruments.TextGauge
Set the margins around the displayed text.
setMiniTextSize(float) - Static method in class org.hermit.android.instruments.Gauge
Set the size for mini text.
setOnClickListener(OnClickListener) - Method in class
org.hermit.android.widgets.MultistateImageButton
Register a callback to be invoked when this view is clicked.
setOnOkListener(TextInputDialog.OnOkListener) - Method in class
org.hermit.android.notice.TextInputDialog
Set a listener for the dialog.
setOnOkListener(YesNoDialog.OnOkListener) - Method in class org.hermit.android.notice.YesNoDialog
Set a listener for the dialog.
setPlotColor(int) - Method in class org.hermit.android.instruments.Gauge
Set the data plot colour of this element.
setSampleRate(int) - Method in class org.hermit.android.instruments.AudioAnalyser
Set the sample rate for this instrument.
setSampleRate(int) - Method in class org.hermit.android.instruments.SpectrumGauge
Set the sample rate for this instrument.
setSidebarWidth(int) - Static method in class org.hermit.android.instruments.Gauge
Set the sidebar width.
setSmoothScrollingEnabled(boolean) - Method in class org.hermit.android.widgets.HScrollView
Set whether arrow scrolling will animate its transition.
setState(int) - Method in class org.hermit.android.widgets.MultistateImageButton
Set the current state of this button.
setSubtitle(int) - Method in class org.hermit.android.notice.InfoBox
Set the subtitle for the about box.
setSubtitle(String) - Method in class org.hermit.android.notice.InfoBox
Set the subtitle for the about box.
setTextColor(int) - Method in class org.hermit.android.instruments.TextGauge
Set the text colour of this element.
setTextFields(String[], int) - Method in class org.hermit.android.instruments.TextGauge
Set up the text fields to be displayed in this element.
setTextScaleX(float) - Static method in class org.hermit.android.instruments.Gauge
Set the horizontal scaling of the font; this can be used to produce a tall, thin font.
setTextSize(float) - Method in class org.hermit.android.instruments.TextGauge
Set the text size of this element.
setTextTypeface(Typeface) - Static method in class org.hermit.android.instruments.Gauge
Set the default font for all text.

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index-files/index-18.html[2/19/2011 9:09:50 AM]


S-Index

setTinyTextSize(float) - Static method in class org.hermit.android.instruments.Gauge


Set the size for tiny text.
setWindowFunc(Window.Function) - Method in class org.hermit.android.instruments.AudioAnalyser
Set the spectrum analyser windowing function for this instrument.
show() - Method in class org.hermit.android.core.OneTimeDialog
Show the dialog unconditionally.
show(String, String) - Method in class org.hermit.android.notice.ErrorDialog
Start the dialog and display it on screen.
show(String) - Method in class org.hermit.android.notice.ErrorDialog
Start the dialog and display it on screen.
show(int, int) - Method in class org.hermit.android.notice.InfoBox
Start the dialog and display it on screen.
show(int) - Method in class org.hermit.android.notice.InfoBox
Start the dialog and display it on screen.
show(String) - Method in class org.hermit.android.notice.InfoBox
Start the dialog and display it on screen.
show(int, int) - Method in class org.hermit.android.notice.TextInputDialog
Start the dialog and display it on screen.
show(int, int, String) - Method in class org.hermit.android.notice.TextInputDialog
Start the dialog and display it on screen.
show(String, String) - Method in class org.hermit.android.notice.TextInputDialog
Start the dialog and display it on screen.
show(String, String, String) - Method in class org.hermit.android.notice.TextInputDialog
Start the dialog and display it on screen.
show(int, int) - Method in class org.hermit.android.notice.YesNoDialog
Start the dialog and display it on screen.
show(CharSequence, CharSequence) - Method in class org.hermit.android.notice.YesNoDialog
Start the dialog and display it on screen.
showAbout() - Method in class org.hermit.android.core.MainActivity
Show an about dialog.
showEula() - Method in class org.hermit.android.core.MainActivity
Show the EULA dialog unconditionally.
showFirst() - Method in class org.hermit.android.core.OneTimeDialog
Show the dialog if this is the first program run.
showFirstEula() - Method in class org.hermit.android.core.MainActivity
Show the EULA dialog if this is the first program run.
smoothScrollBy(int, int) - Method in class org.hermit.android.widgets.HScrollView
Like View#scrollBy , but scroll smoothly instead of immediately.
smoothScrollTo(int, int) - Method in class org.hermit.android.widgets.HScrollView
Like HScrollView.scrollTo(int, int) , but scroll smoothly instead of immediately.
SpectrumGauge - Class in org.hermit.android.instruments
A graphical display which displays the audio spectrum from an AudioAnalyser instrument.
SplashActivity - Class in org.hermit.android.core
An activity which displays a splash screen and then returns to the calling activity.
SplashActivity() - Constructor for class org.hermit.android.core.SplashActivity

startActivityForResult(Intent, MainActivity.ActivityListener) - Method in class


org.hermit.android.core.MainActivity
Launch an activity for which you would like a result when it finished.
startReader(int, int, AudioReader.Listener) - Method in class org.hermit.android.io.AudioReader
Start this reader.
statsCount(int, int) - Method in class org.hermit.android.core.SurfaceRunner
Increment a performance counter.
statsCreate(String[]) - Method in class org.hermit.android.core.SurfaceRunner
Reserve space in the stats display for some application performance stats.
statsTime(int, long) - Method in class org.hermit.android.core.SurfaceRunner
Record a performance timer.

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index-files/index-18.html[2/19/2011 9:09:50 AM]


S-Index

stop() - Method in class org.hermit.android.sound.Effect


Stop this sound effect immediately.
stop(int) - Method in class org.hermit.android.sound.Player
Stop the given stream.
stopReader() - Method in class org.hermit.android.io.AudioReader
Start this reader.
SURFACE_CACHE_BG - Static variable in class org.hermit.android.instruments.InstrumentSurface
Instrument Surface runner option: cache a background bitmap.
SURFACE_DYNAMIC - Static variable in class org.hermit.android.core.SurfaceRunner
Surface runner option: handle configuration changes dynamically.
surfaceChanged(SurfaceHolder, int, int, int) - Method in class org.hermit.android.core.SurfaceRunner
This is called immediately after any structural changes (format or size) have been made to the
surface.
surfaceCreated(SurfaceHolder) - Method in class org.hermit.android.core.SurfaceRunner
This is called immediately after the surface is first created.
surfaceDestroyed(SurfaceHolder) - Method in class org.hermit.android.core.SurfaceRunner
This is called immediately before a surface is destroyed.
SurfaceRunner - Class in org.hermit.android.core
Common base for applications with an animated view.
SurfaceRunner(Context) - Constructor for class org.hermit.android.core.SurfaceRunner
Create a SurfaceRunner instance.
SurfaceRunner(Context, int) - Constructor for class org.hermit.android.core.SurfaceRunner
Create a SurfaceRunner instance.
SurfaceRunner(Context, AttributeSet) - Constructor for class org.hermit.android.core.SurfaceRunner
Create a SurfaceRunner instance.
surfaceStart() - Method in class org.hermit.android.core.SurfaceRunner
Start the surface running.
surfaceStop() - Method in class org.hermit.android.core.SurfaceRunner
Stop the surface running.

Overview Package Class Use Tree Deprecated Index Help


PREV LETTER NEXT LETTER FRAMES NO FRAMES All Classes
ABCDEFGHIKLMNOPQRSTUVWY

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index-files/index-18.html[2/19/2011 9:09:50 AM]


T-Index

Overview Package Class Use Tree Deprecated Index Help


PREV LETTER NEXT LETTER FRAMES NO FRAMES All Classes
ABCDEFGHIKLMNOPQRSTUVWY

T
TableFetcher - Class in org.hermit.android.net
Concrete instance of WebFetcher which fetches tabular data from the web.
TableProvider - Class in org.hermit.android.provider
This class is a base for content providers which provide access to table-organized data in an SQL
database.
TableProvider(DbSchema) - Constructor for class org.hermit.android.provider.TableProvider
Create an instance of this content provider.
TableSchema - Class in org.hermit.android.provider
Class encapsulating the schema for a table within a content provider.
TableSchema(String, String, Uri, String, String[][]) - Constructor for class
org.hermit.android.provider.TableSchema
Create a table schema instance.
TextGauge - Class in org.hermit.android.instruments
A Gauge which displays data in textual form, generally as a grid of numeric values.
TextGauge(SurfaceRunner) - Constructor for class org.hermit.android.instruments.TextGauge
Set up this view, and configure the text fields to be displayed in this element.
TextGauge(SurfaceRunner, String[], int) - Constructor for class
org.hermit.android.instruments.TextGauge
Set up this view, and configure the text fields to be displayed in this element.
TextInputDialog - Class in org.hermit.android.notice
This class implements a popup input box (a subclass of AlertDialog) which can be used to display a
prompt and read a text string from the user.
TextInputDialog(Context, int, int) - Constructor for class org.hermit.android.notice.TextInputDialog
Create an error dialog.
TextInputDialog(Context, CharSequence, CharSequence) - Constructor for class
org.hermit.android.notice.TextInputDialog
Create an error dialog.
TextInputDialog.OnOkListener - Interface in org.hermit.android.notice
Listener invoked when the user clicks the OK button.
timeout - Variable in class org.hermit.android.net.WebFetcher

TimeZoneActivity - Class in org.hermit.android.widgets


This class displays a picker which can be used to select a timezone.
TimeZoneActivity() - Constructor for class org.hermit.android.widgets.TimeZoneActivity

Overview Package Class Use Tree Deprecated Index Help


PREV LETTER NEXT LETTER FRAMES NO FRAMES All Classes
ABCDEFGHIKLMNOPQRSTUVWY

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index-files/index-19.html[2/19/2011 9:09:52 AM]


U-Index

Overview Package Class Use Tree Deprecated Index Help


PREV LETTER NEXT LETTER FRAMES NO FRAMES All Classes
ABCDEFGHIKLMNOPQRSTUVWY

U
update(Context, long) - Method in class org.hermit.android.net.CachedFile
Check to see whether we need to update our cached copies of the files.
update(long) - Method in class org.hermit.android.net.WebBasedData
Check to see whether we need to update our stored data.
update(Uri, ContentValues, String, String[]) - Method in class
org.hermit.android.provider.TableProvider
Update a content URI.
upgradeTable(SQLiteDatabase, int, int) - Method in class org.hermit.android.net.CachedFile
Upgrade or table in the database to a new version.
upgradeTable(SQLiteDatabase, int, int) - Method in class org.hermit.android.net.WebBasedData
Upgrade or table in the database to a new version.
url - Variable in class org.hermit.android.net.CachedFile.Entry
The URL of the file that was loaded.

Overview Package Class Use Tree Deprecated Index Help


PREV LETTER NEXT LETTER FRAMES NO FRAMES All Classes
ABCDEFGHIKLMNOPQRSTUVWY

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index-files/index-20.html[2/19/2011 9:09:53 AM]


V-Index

Overview Package Class Use Tree Deprecated Index Help


PREV LETTER NEXT LETTER FRAMES NO FRAMES All Classes
ABCDEFGHIKLMNOPQRSTUVWY

V
valueOf(String) - Static method in enum org.hermit.android.core.AppUtils.Detail
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.hermit.android.core.AppUtils.Detail
Returns an array containing the constants of this enum type, in the order they are declared.
versionCode - Variable in class org.hermit.android.core.AppUtils.Version
Version code of the app.
versionName - Variable in class org.hermit.android.core.AppUtils.Version
Version name of the app.

Overview Package Class Use Tree Deprecated Index Help


PREV LETTER NEXT LETTER FRAMES NO FRAMES All Classes
ABCDEFGHIKLMNOPQRSTUVWY

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index-files/index-21.html[2/19/2011 9:09:55 AM]


W-Index

Overview Package Class Use Tree Deprecated Index Help


PREV LETTER NEXT LETTER FRAMES NO FRAMES All Classes
ABCDEFGHIKLMNOPQRSTUVWY

W
WaveformGauge - Class in org.hermit.android.instruments
A graphical display which displays the audio waveform from an AudioAnalyser instrument.
WebBasedData - Class in org.hermit.android.net
This class implements a web-based source of data, which is cached in a local database.
WebBasedData(String, String, String, long, boolean, String[]) - Constructor for class
org.hermit.android.net.WebBasedData
Create a web-based data source.
WebFetcher - Class in org.hermit.android.net
This class fetches data from the web without blocking the main app.
WebFetcher(URL, WebFetcher.Listener, long) - Constructor for class
org.hermit.android.net.WebFetcher
Create a fetcher to get data from a given URL.
WebFetcher(URL, WebFetcher.Listener, long, long) - Constructor for class
org.hermit.android.net.WebFetcher
Create a fetcher to get data from a given URL.
WebFetcher(URL[], WebFetcher.Listener, long, long) - Constructor for class
org.hermit.android.net.WebFetcher
Create a fetcher to get data from a given list of URLs.
WebFetcher.FetchException - Exception in org.hermit.android.net
Web fetching exception.
WebFetcher.FetchException(String) - Constructor for exception
org.hermit.android.net.WebFetcher.FetchException
Create a FetchException with a message.
WebFetcher.FetchException(String, Exception) - Constructor for exception
org.hermit.android.net.WebFetcher.FetchException
Create a FetchException based on another exception.
WebFetcher.Listener - Interface in org.hermit.android.net
Listener for incoming web data.

Overview Package Class Use Tree Deprecated Index Help


PREV LETTER NEXT LETTER FRAMES NO FRAMES All Classes
ABCDEFGHIKLMNOPQRSTUVWY

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index-files/index-22.html[2/19/2011 9:09:56 AM]


Y-Index

Overview Package Class Use Tree Deprecated Index Help


PREV LETTER NEXT LETTER FRAMES NO FRAMES All Classes
ABCDEFGHIKLMNOPQRSTUVWY

Y
YesNoDialog - Class in org.hermit.android.notice
This class implements a popup dialog box (a subclass of AlertDialog) which can be used to display a
yes / no question.
YesNoDialog(Context, int, int) - Constructor for class org.hermit.android.notice.YesNoDialog
Create an error dialog.
YesNoDialog(Context, CharSequence, CharSequence) - Constructor for class
org.hermit.android.notice.YesNoDialog
Create an error dialog.
YesNoDialog.OnOkListener - Interface in org.hermit.android.notice
Listener invoked when the user clicks the OK button.

Overview Package Class Use Tree Deprecated Index Help


PREV LETTER NEXT LETTER FRAMES NO FRAMES All Classes
ABCDEFGHIKLMNOPQRSTUVWY

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index-files/index-23.html[2/19/2011 9:09:58 AM]


Player

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.hermit.android.sound

Class Player
java.lang.Object
org.hermit.android.sound.Player

public class Player


extends java.lang.Object

Main sound effects player class.

Constructor Summary
Player(Context context)
Create a sound effect player that can handle 3 streams at once.
Player(Context context, int streams)
Create a sound effect player.

Method Summary
Effect addEffect(int sound)
Add a sound effect to this player.
Effect addEffect(int sound, float vol)
Add a sound effect to this player.
int play(Effect effect)
Play the given sound effect.
int play(Effect effect, float rvol, boolean loop)
Play the given sound effect.
void setGain(float gain)
Set the overall gain for sounds.
void stop(int id)
Stop the given stream.

Methods inherited from class java.lang.Object


clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
Player
public Player(Context context)

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/sound/Player.html[2/19/2011 9:09:59 AM]


Player

Create a sound effect player that can handle 3 streams at once.

Parameters:
context - Application context we're running in.

Player
public Player(Context context,
int streams)

Create a sound effect player.

Parameters:
context - Application context we're running in.
streams - Maximum number of sound streams to play simultaneously.

Method Detail
addEffect
public Effect addEffect(int sound)

Add a sound effect to this player.

Parameters:
sound - Resource ID of the sound sample for this effect.
Returns:
An Effect object representing the new effect. Use this object to actually play the sound.

addEffect
public Effect addEffect(int sound,
float vol)

Add a sound effect to this player.

Parameters:
sound - Resource ID of the sound sample for this effect.
vol - Base volume for this effect.
Returns:
An Effect object representing the new effect. Use this object to actually play the sound.

setGain
public void setGain(float gain)

Set the overall gain for sounds.

Parameters:
gain - Desired gain. 1 = normal; 0 means don't play sounds.

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/sound/Player.html[2/19/2011 9:09:59 AM]


Player

play
public int play(Effect effect)

Play the given sound effect.

Parameters:
effect - Sound effect to play.
Returns:
The ID of the stream which is playing the sound. Zero if it's not playing.

play
public int play(Effect effect,
float rvol,
boolean loop)

Play the given sound effect. The sound won't be played if the volume would be zero or less.

Parameters:
effect - Sound effect to play.
rvol - Relative volume for this sound, 0 - 1.
loop - If true, loop the sound forever.
Returns:
The ID of the stream which is playing the sound. Zero if it's not playing; this includes if sounds
are disabled, or if the volume is zero.

stop
public void stop(int id)

Stop the given stream.

Parameters:
id - Stream ID to stop.

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/sound/Player.html[2/19/2011 9:09:59 AM]


InstrumentSurface

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.hermit.android.instruments

Class InstrumentSurface
java.lang.Object
SurfaceView
org.hermit.android.core.SurfaceRunner
org.hermit.android.instruments.InstrumentSurface

public abstract class InstrumentSurface


extends SurfaceRunner

Common base for applications which display instruments. This class is an extension of SurfaceRunner which
provides additional functions to manage the instruments embedded in it.

When using this class in an app, the app context must call these methods (usually from its corresponding
Activity methods):

SurfaceRunner.onStart()
SurfaceRunner.onResume()
SurfaceRunner.onPause()
SurfaceRunner.onStop()

The surface is enabled once it is created and sized, and SurfaceRunner.onStart() and
SurfaceRunner.onResume() have been called. You then start and stop it by calling
SurfaceRunner.surfaceStart() and SurfaceRunner.surfaceStop() .

Field Summary
static int SURFACE_CACHE_BG
Instrument Surface runner option: cache a background bitmap.

Fields inherited from class org.hermit.android.core.SurfaceRunner


LOOPED_TICKER, SURFACE_DYNAMIC

Constructor Summary
InstrumentSurface(Activity app)
Create a SurfaceRunner instance.
InstrumentSurface(Activity app, int options)
Create a SurfaceRunner instance.

Method Summary
void addGauge(Gauge i)
Add a gauge to this surface.
void addInstrument(Instrument i)

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/instruments/InstrumentSurface.html[2/19/2011 9:10:02 AM]


InstrumentSurface

Add an instrument to the system, associated with this surface.


protected animStart()
void
We are starting the animation loop.
protected animStop()
void
We are stopping the animation loop, for example to pause the app.
protected appSize(int width, int height, Bitmap.Config config)
void
Set the screen size.
protected appStart()
void
The application is starting.
protected appStop()
void
The application is closing down.
protected doDraw(Canvas canvas, long now)
void
Draw the current frame of the application.
protected doUpdate(long now)
void
Update the state of the application for the current frame.
protected layout(int width, int height)
abstract
void Lay out the display for a given screen size.

Methods inherited from class org.hermit.android.core.SurfaceRunner


getBitmap, getBitmap, getRes, onPause, onResume, onStart, onStop, onSurfaceThread,
onWindowFocusChanged, optionSet, postUpdate, setDebugPerf, setDebugPos, setDelay, statsCount,
statsCreate, statsTime, surfaceChanged, surfaceCreated, surfaceDestroyed, surfaceStart,
surfaceStop

Methods inherited from class java.lang.Object


clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail
SURFACE_CACHE_BG
public static final int SURFACE_CACHE_BG

Instrument Surface runner option: cache a background bitmap. If set, we will ask all the gauges to
draw their backgrounds into a full- screen bitmap; this bitmap will then be drawn prior to drawing the
gauge contents each frame.

See Also:
Constant Field Values

Constructor Detail
InstrumentSurface
public InstrumentSurface(Activity app)

Create a SurfaceRunner instance.

Parameters:

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/instruments/InstrumentSurface.html[2/19/2011 9:10:02 AM]


InstrumentSurface

app - The application context we're running in.

InstrumentSurface
public InstrumentSurface(Activity app,
int options)

Create a SurfaceRunner instance.

Parameters:
app - The application context we're running in.
options - Options for this SurfaceRunner. A bitwise OR of SURFACE_XXX constants.

Method Detail
addInstrument
public void addInstrument(Instrument i)

Add an instrument to the system, associated with this surface. Is is presumed that the app will create
one or more Gauge s for this instrument and add them to the surface with addGauge(Gauge) .

All instruments added here will be started and stopped when the application starts and stops, and will
have their measurement turned on when the app is visible and running. Their
Instrument.doUpdate(long) method will be called each time round the main animation loop.

All instruments must be added before the application starts running.

Parameters:
i - The instrument to add.

addGauge
public void addGauge(Gauge i)

Add a gauge to this surface. If this gauge has an associated Instrument , it should be attached to the
surface with addInstrument(Instrument) .

All gauges added here will have their Gauge.draw(Canvas, long, boolean) method called each time
round the main animation loop.

All gauges must be added before the application starts running.

Parameters:
i - The gauge to add.

layout
protected abstract void layout(int width,
int height)

Lay out the display for a given screen size. Subclasses must implement this, and should use it to lay
out the gauges.

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/instruments/InstrumentSurface.html[2/19/2011 9:10:02 AM]


InstrumentSurface

Parameters:
width - The new width of the surface.
height - The new height of the surface.

appStart
protected void appStart()

The application is starting. Perform any initial set-up prior to starting the application. We may not
have a screen size yet, so this is not a good place to allocate resources which depend on that.

If subclasses override this, they must call through to this method.

Specified by:
appStart in class SurfaceRunner

appSize
protected void appSize(int width,
int height,
Bitmap.Config config)

Set the screen size. This is guaranteed to be called before animStart(), but perhaps not before
appStart().

We call the layout() method here, so subclasses generally don't need to override this. If subclasses do
override this, they must call through to this method.

Specified by:
appSize in class SurfaceRunner

Parameters:
width - The new width of the surface.
height - The new height of the surface.
config - The pixel format of the surface.

animStart
protected void animStart()

We are starting the animation loop. The screen size is known.

doUpdate() and doDraw() may be called from this point on.

If subclasses override this, they must call through to this method.

Specified by:
animStart in class SurfaceRunner

animStop
protected void animStop()

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/instruments/InstrumentSurface.html[2/19/2011 9:10:02 AM]


InstrumentSurface

We are stopping the animation loop, for example to pause the app.

doUpdate() and doDraw() will not be called from this point on.

If subclasses override this, they must call through to this method.

Specified by:
animStop in class SurfaceRunner

appStop
protected void appStop()

The application is closing down. Clean up any resources.

Specified by:
appStop in class SurfaceRunner

doUpdate
protected void doUpdate(long now)

Update the state of the application for the current frame.

Applications must override this, and can use it to update for example the physics of a game. This may
be a no-op in some cases.

doDraw() will always be called after this method is called; however, the converse is not true, as we
sometimes need to draw just to update the screen. Hence this method is useful for updates which are
dependent on time rather than frames.

Specified by:
doUpdate in class SurfaceRunner

Parameters:
now - Nominal time of the current frame in ms.

doDraw
protected void doDraw(Canvas canvas,
long now)

Draw the current frame of the application.

Applications must override this, and are expected to draw the entire screen into the provided canvas.

This method will always be called after a call to doUpdate(), and also when the screen needs to be
re-drawn.

Specified by:
doDraw in class SurfaceRunner

Parameters:
canvas - The Canvas to draw into.

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/instruments/InstrumentSurface.html[2/19/2011 9:10:02 AM]


InstrumentSurface

now - Nominal time of the current frame in ms.

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/instruments/InstrumentSurface.html[2/19/2011 9:10:02 AM]


HelpActivity

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.hermit.android.core

Class HelpActivity
java.lang.Object
Activity
org.hermit.android.core.HelpActivity

public class HelpActivity


extends Activity

An activity which displays an application's help, in a structured format. Help is supplied via resources arrays;
one array contains the titles of the help sections, one contains the texts for each section. Sub-sections can
be added.

To use: subclass this activity, and have the subclass call addHelpFromArrays(int, int) . Then start this
activity when you need to display help.

It is recommended that you configure this activity to handle orientation and keyboardHidden configuration
changes in your app manifest.

Constructor Summary
HelpActivity()

Method Summary
protected addHelpFromArrays(int titlesId, int textsId)
void
Add help to this help activity.
void onCreate(Bundle icicle)
Called when the activity is starting.
protected onRestoreInstanceState(Bundle inState)
void
This method is called after onStart() when the activity is being re-initialized from a
previously saved state, given here in state.
void onSaveInstanceState(Bundle outState)
Called to retrieve per-instance state from an activity before being killed so that the state
can be restored in onCreate(Bundle) or onRestoreInstanceState(Bundle) (the Bundle populated
by this method will be passed to both).

Methods inherited from class java.lang.Object


clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/core/HelpActivity.html[2/19/2011 9:10:04 AM]


HelpActivity

HelpActivity
public HelpActivity()

Method Detail
onCreate
public void onCreate(Bundle icicle)

Called when the activity is starting. This is where most initialization should go: calling
setContentView(int) to inflate the activity's UI, etc.

Parameters:
icicle - Saved application state, if any.

onRestoreInstanceState
protected void onRestoreInstanceState(Bundle inState)

This method is called after onStart() when the activity is being re-initialized from a previously saved
state, given here in state. Most implementations will simply use onCreate(Bundle) to restore their
state, but it is sometimes convenient to do it here after all of the initialization has been done or to
allow subclasses to decide whether to use your default implementation. The default implementation of
this method performs a restore of any view state that had previously been frozen by
onSaveInstanceState(Bundle). This method is called between onStart() and onPostCreate(Bundle).

Parameters:
inState - The data most recently supplied in onSaveInstanceState(Bundle).

onSaveInstanceState
public void onSaveInstanceState(Bundle outState)

Called to retrieve per-instance state from an activity before being killed so that the state can be
restored in onCreate(Bundle) or onRestoreInstanceState(Bundle) (the Bundle populated by this
method will be passed to both). If called, this method will occur before onStop(). There are no
guarantees about whether it will occur before or after onPause().

Parameters:
outState - A Bundle in which to place any state information you wish to save.

addHelpFromArrays
protected void addHelpFromArrays(int titlesId,
int textsId)

Add help to this help activity.

The parameters are the resource IDs of two arrays; the first contains the titles of the help sections,
the second contains the bodies of the sections. The arrays must be the same length.

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/core/HelpActivity.html[2/19/2011 9:10:04 AM]


HelpActivity

A title and the corresponding content may both be resource IDs of further arrays. These arrays will be
added as sub-sections in the most recently-added section. There must be an enclosing outer section.

If this method is called more than once, help will be added to the top level. (This isn't really
recommended.)

Parameters:
titlesId - Resource ID of the titles array.
textsId - Resource ID of the contents array.

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/core/HelpActivity.html[2/19/2011 9:10:04 AM]


HScrollView

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.hermit.android.widgets

Class HScrollView
java.lang.Object
FrameLayout
org.hermit.android.widgets.HScrollView

public class HScrollView


extends FrameLayout

Layout container for a view hierarchy that can be scrolled by the user, allowing it to be larger than the
physical display. This class scrolls horizontally, as opposed to android.widget.ScrollView which only
supports vertical scrolling.

An HScrollView is a android.widget.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 android.widget.LinearLayout in a vertical orientation, presenting a vertical
array of top-level items that the user can scroll through.

HScrollView only supports horizontally scrolling.

Constructor Summary
HScrollView(Context context)

HScrollView(Context context, AttributeSet attrs)

Method Summary
void addView(View child)

void addView(View child, int index)

void addView(View child, int index, ViewGroup.LayoutParams params)

void addView(View child, ViewGroup.LayoutParams params)

boolean arrowScroll(int direction)


Handle scrolling in response to a left or right arrow click.
protected computeHorizontalScrollRange()
int
The scroll range of a scroll view is the overall height of all of its children.
void computeScroll()

protected

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/widgets/HScrollView.html[2/19/2011 9:10:06 AM]


HScrollView

int computeScrollDeltaToGetChildRectOnScreen(Rect rect)


Compute the amount to scroll in the Y direction in order to get a rectangle completely on
the screen (or, if taller than the screen, at least the first screen size chunk of it).
boolean dispatchKeyEvent(KeyEvent event)

boolean executeKeyEvent(KeyEvent event)


You can call this function yourself to have the scroll view perform scrolling from a key
event, just as if the event had been dispatched to it by the view hierarchy.
void fling(int velocityX)
Fling the scroll view
protected getLeftFadingEdgeStrength()
float

int getMaxScrollAmount()

protected getRightFadingEdgeStrength()
float

boolean isFillViewport()
Indicates whether this ScrollView's content is stretched to fill the viewport.
boolean isSmoothScrollingEnabled()

protected measureChild(View child, int parentWidthMeasureSpec, int parentHeightMeasureSpec)


void

protected measureChildWithMargins(View child, int parentWidthMeasureSpec, int widthUsed,


void
int parentHeightMeasureSpec, int heightUsed)

boolean onInterceptTouchEvent(MotionEvent ev)

protected onLayout(boolean changed, int l, int t, int r, int b)


void

protected onMeasure(int widthMeasureSpec, int heightMeasureSpec)


void

protected onRequestFocusInDescendants(int direction, Rect previouslyFocusedRect)


boolean
When looking for focus in children of a scroll view, need to be a little more careful not to
give focus to something that is scrolled off screen.
protected onSizeChanged(int w, int h, int oldw, int oldh)
void

boolean onTouchEvent(MotionEvent ev)

void requestChildFocus(View child, View focused)

boolean requestChildRectangleOnScreen(View child, Rect rectangle, boolean immediate)

void requestLayout()

void scrollTo(int x, int y)

void setFillViewport(boolean fillViewport)

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/widgets/HScrollView.html[2/19/2011 9:10:06 AM]


HScrollView

Indicates this ScrollView whether it should stretch its content height to fill the viewport
or not.
void setSmoothScrollingEnabled(boolean smoothScrollingEnabled)
Set whether arrow scrolling will animate its transition.
void smoothScrollBy(int dx, int dy)
Like View#scrollBy , but scroll smoothly instead of immediately.
void smoothScrollTo(int x, int y)
Like scrollTo(int, int) , but scroll smoothly instead of immediately.

Methods inherited from class java.lang.Object


clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
HScrollView
public HScrollView(Context context)

HScrollView
public HScrollView(Context context,
AttributeSet attrs)

Method Detail
getLeftFadingEdgeStrength
protected float getLeftFadingEdgeStrength()

getRightFadingEdgeStrength
protected float getRightFadingEdgeStrength()

getMaxScrollAmount
public int getMaxScrollAmount()

Returns:
The maximum amount this scroll view will scroll in response to an arrow event.

addView
public void addView(View child)

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/widgets/HScrollView.html[2/19/2011 9:10:06 AM]


HScrollView

addView
public void addView(View child,
int index)

addView
public void addView(View child,
ViewGroup.LayoutParams params)

addView
public void addView(View child,
int index,
ViewGroup.LayoutParams params)

isFillViewport
public boolean isFillViewport()

Indicates whether this ScrollView's content is stretched to fill the viewport.

Returns:
True if the content fills the viewport, false otherwise.

setFillViewport
public void setFillViewport(boolean fillViewport)

Indicates this ScrollView whether it should stretch its content height to fill the viewport or not.

Parameters:
fillViewport - True to stretch the content's height to the viewport's boundaries, false
otherwise.

isSmoothScrollingEnabled
public boolean isSmoothScrollingEnabled()

Returns:
Whether arrow scrolling will animate its transition.

setSmoothScrollingEnabled
public void setSmoothScrollingEnabled(boolean smoothScrollingEnabled)

Set whether arrow scrolling will animate its transition.

Parameters:
smoothScrollingEnabled - whether arrow scrolling will animate its transition

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/widgets/HScrollView.html[2/19/2011 9:10:06 AM]


HScrollView

onMeasure
protected void onMeasure(int widthMeasureSpec,
int heightMeasureSpec)

dispatchKeyEvent
public boolean dispatchKeyEvent(KeyEvent event)

executeKeyEvent
public boolean executeKeyEvent(KeyEvent event)

You can call this function yourself to have the scroll view perform scrolling from a key event, just as if
the event had been dispatched to it by the view hierarchy.

Parameters:
event - The key event to execute.
Returns:
Return true if the event was handled, else false.

onInterceptTouchEvent
public boolean onInterceptTouchEvent(MotionEvent ev)

onTouchEvent
public boolean onTouchEvent(MotionEvent ev)

arrowScroll
public boolean arrowScroll(int direction)

Handle scrolling in response to a left or right arrow click.

Parameters:
direction - The direction corresponding to the arrow key that was pressed
Returns:
True if we consumed the event, false otherwise

smoothScrollBy
public final void smoothScrollBy(int dx,
int dy)

Like View#scrollBy , but scroll smoothly instead of immediately.

Parameters:
dx

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/widgets/HScrollView.html[2/19/2011 9:10:06 AM]


HScrollView

- the number of pixels to scroll by on the X axis


dy - the number of pixels to scroll by on the Y axis

smoothScrollTo
public final void smoothScrollTo(int x,
int y)

Like scrollTo(int, int) , but scroll smoothly instead of immediately.

Parameters:
x - the position where to scroll on the X axis
y - the position where to scroll on the Y axis

computeHorizontalScrollRange
protected int computeHorizontalScrollRange()

The scroll range of a scroll view is the overall height of all of its children.

measureChild
protected void measureChild(View child,
int parentWidthMeasureSpec,
int parentHeightMeasureSpec)

measureChildWithMargins
protected void measureChildWithMargins(View child,
int parentWidthMeasureSpec,
int widthUsed,
int parentHeightMeasureSpec,
int heightUsed)

computeScroll
public void computeScroll()

computeScrollDeltaToGetChildRectOnScreen
protected int computeScrollDeltaToGetChildRectOnScreen(Rect rect)

Compute the amount to scroll in the Y direction in order to get a rectangle completely on the screen
(or, if taller than the screen, at least the first screen size chunk of it).

Parameters:
rect - The rect.
Returns:
The scroll delta.

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/widgets/HScrollView.html[2/19/2011 9:10:06 AM]


HScrollView

requestChildFocus
public void requestChildFocus(View child,
View focused)

onRequestFocusInDescendants
protected boolean onRequestFocusInDescendants(int direction,
Rect previouslyFocusedRect)

When looking for focus in children of a scroll view, need to be a little more careful not to give focus
to something that is scrolled off screen. This is more expensive than the default
android.view.ViewGroup implementation, otherwise this behavior might have been made the default.

requestChildRectangleOnScreen
public boolean requestChildRectangleOnScreen(View child,
Rect rectangle,
boolean immediate)

requestLayout
public void requestLayout()

onLayout
protected void onLayout(boolean changed,
int l,
int t,
int r,
int b)

onSizeChanged
protected void onSizeChanged(int w,
int h,
int oldw,
int oldh)

fling
public void fling(int velocityX)

Fling the scroll view

Parameters:
velocityX- The initial velocity in the Y direction. Positive numbers mean that the finger/curor is
moving down the screen, which means we want to scroll towards the top.

scrollTo

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/widgets/HScrollView.html[2/19/2011 9:10:06 AM]


HScrollView

public void scrollTo(int x,


int y)

This version also clamps the scrolling to the bounds of our child.

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/widgets/HScrollView.html[2/19/2011 9:10:06 AM]


WebBasedData

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.hermit.android.net

Class WebBasedData
java.lang.Object
java.util.Observable
org.hermit.android.net.WebBasedData

All Implemented Interfaces:


WebFetcher.Listener

public class WebBasedData


extends java.util.Observable
implements WebFetcher.Listener

This class implements a web-based source of data, which is cached in a local database. The data is
assumed to be timestamped records.

Constructor Summary
WebBasedData(java.lang.String name, java.lang.String base, java.lang.String suff, long interval,
boolean ldate, java.lang.String[] fields)
Create a web-based data source.

Method Summary
Cursor allRecords()
Query for all records we have stored.
Cursor allRecordsSince(long date)
Query for all records we have stored timstamped AFTER a given date.
void createTable(SQLiteDatabase db)
Create our table in the database.
java.lang.String getName()
Get the name of this source.
ContentValues lastRecord()
Query for the newest record we have stored.
void onWebData(java.net.URL url, java.lang.Object obj, long fileDate)
This method is invoked when a data record is retrieved from the URL we were
invoked on.
void onWebDone()
This method is invoked when the given URL has been fully fetched.
void onWebError(java.lang.String msg)
Handle an error while fetching web data.
protected void process(ContentValues rec)
Optional processing step -- this is called for each record we read.

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/net/WebBasedData.html[2/19/2011 9:10:09 AM]


WebBasedData

void setDatabase(SQLiteDatabase db)


Set the database we use for storing our data.
void update(long now)
Check to see whether we need to update our stored data.
void upgradeTable(SQLiteDatabase db, int oldV, int newV)
Upgrade or table in the database to a new version.

Methods inherited from class java.util.Observable


addObserver, clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged,
notifyObservers, notifyObservers, setChanged

Methods inherited from class java.lang.Object


clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
WebBasedData
public WebBasedData(java.lang.String name,
java.lang.String base,
java.lang.String suff,
long interval,
boolean ldate,
java.lang.String[] fields)

Create a web-based data source.

Parameters:
name - The name of this source, and its database table.
base - The base URL for this source; this is the whole URL if urlSuff is null.
suff - The URL suffix. If not null, the URL is urlBase + date + urlSuff, where date is in the
format "20091231".
interval - Interval in ms between records in the source.
ldate - If true, the source uses long-format dates.
fields - Names for the fields in the source.

Method Detail
createTable
public void createTable(SQLiteDatabase db)

Create our table in the database.

Parameters:
db - The database.

upgradeTable
public void upgradeTable(SQLiteDatabase db,
int oldV,
int newV)

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/net/WebBasedData.html[2/19/2011 9:10:09 AM]


WebBasedData

Upgrade or table in the database to a new version.

Parameters:
db - The database.
oldV - Version we're upgrading from.
newV - Version we're upgrading to.

setDatabase
public void setDatabase(SQLiteDatabase db)

Set the database we use for storing our data.

Parameters:
db - The database. Will be null if the database is being closed.

getName
public java.lang.String getName()

Get the name of this source.

Returns:
The name of this source.

allRecords
public Cursor allRecords()

Query for all records we have stored. It is the caller's responsibility to call close() on the cursor when
done.

Returns:
A Cursor over all the records, sorted in ascending date order. The Cursor is positioned before the
first record.

allRecordsSince
public Cursor allRecordsSince(long date)

Query for all records we have stored timstamped AFTER a given date. It is the caller's responsibility to
call close() on the cursor when done.

Parameters:
date - Cut-off date -- only return records newer than this date (not equal).
Returns:
A Cursor over all the records, sorted in ascending date order. The Cursor is positioned before the
first record.

lastRecord

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/net/WebBasedData.html[2/19/2011 9:10:09 AM]


WebBasedData

public ContentValues lastRecord()

Query for the newest record we have stored.

Returns:
The contents of the last record we have. Returns null if there are no records.

update
public void update(long now)

Check to see whether we need to update our stored data. If so, kick off a web fetch. The observers
will be notified for any new data that we load.

Parameters:
now - The current time in millis.

process
protected void process(ContentValues rec)

Optional processing step -- this is called for each record we read. It can be used to add synthesized
values.

Parameters:
rec - The record to process.

onWebData
public void onWebData(java.net.URL url,
java.lang.Object obj,
long fileDate)

This method is invoked when a data record is retrieved from the URL we were invoked on.

Specified by:
onWebData in interface WebFetcher.Listener

Parameters:
url - The URL of the source being loaded.
obj - The object that was loaded; the type depends on the fetcher class used.
fileDate - The last modified time of the source file, as reported by the server, in ms UTC.

onWebDone
public void onWebDone()

This method is invoked when the given URL has been fully fetched.

Specified by:
onWebDone in interface WebFetcher.Listener

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/net/WebBasedData.html[2/19/2011 9:10:09 AM]


WebBasedData

onWebError
public void onWebError(java.lang.String msg)

Handle an error while fetching web data.

Specified by:
onWebError in interface WebFetcher.Listener

Parameters:
msg - The error message.

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/net/WebBasedData.html[2/19/2011 9:10:09 AM]


SurfaceRunner

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.hermit.android.core

Class SurfaceRunner
java.lang.Object
SurfaceView
org.hermit.android.core.SurfaceRunner

Direct Known Subclasses:


InstrumentSurface

public abstract class SurfaceRunner


extends SurfaceView

Common base for applications with an animated view. This class can be used in games etc. It handles all
the setup states of a SurfaceView, and provides a Thread which the app can use to manage the animation.

When using this class in an app, the app context must call these methods (usually from its corresponding
Activity methods):

onStart()
onResume()
onPause()
onStop()

The surface is enabled once it is created and sized, and onStart() and onResume() have been called. You
then start and stop it by calling surfaceStart() and surfaceStop() .

Field Summary
static int LOOPED_TICKER
Surface runner option: use a Looper to drive animations.
static int SURFACE_DYNAMIC
Surface runner option: handle configuration changes dynamically.

Constructor Summary
SurfaceRunner(Context app)
Create a SurfaceRunner instance.
SurfaceRunner(Context app, AttributeSet attrs)
Create a SurfaceRunner instance.
SurfaceRunner(Context app, int options)
Create a SurfaceRunner instance.

Method Summary
protected
abstract void animStart()

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/core/SurfaceRunner.html[2/19/2011 9:10:11 AM]


SurfaceRunner

We are starting the animation loop.


protected
abstract void animStop()
We are stopping the animation loop, for example to pause the app.
protected
abstract void appSize(int width, int height, Bitmap.Config config)
Set the screen size.
protected
abstract void appStart()
The application is starting.
protected
abstract void appStop()
The application is closing down.
protected
abstract void doDraw(Canvas canvas, long now)
Draw the current frame of the application.
protected
abstract void doUpdate(long now)
Update the state of the application for the current frame.
Bitmap getBitmap()
Get a Bitmap which is the same size and format as the surface.
Bitmap getBitmap(int w, int h)
Get a Bitmap of a given size, in the same format as the surface.
java.lang.String getRes(int resid)
Get the String value of a resource.
void onPause()
Pause the app.
void onResume()
We're resuming the app.
void onStart()
The application is starting.
void onStop()
The application is closing down.
boolean onSurfaceThread()
Determine whether the caller is on the surface's animation thread.
void onWindowFocusChanged(boolean hasWindowFocus)
Handle changes in focus.
boolean optionSet(int option)
Check whether the given option flag is set on this surface.
void postUpdate()
Asynchronously schedule an update; i.e.
void setDebugPerf(boolean enable)
Turn display of performance info on or off.
void setDebugPos(int x, int y)
Set the screen position at which we display performance info.
void setDelay(long delay)
Set the delay in ms in each iteration of the main loop.
void statsCount(int index, int val)
Increment a performance counter.
protected void statsCreate(java.lang.String[] labels)
Reserve space in the stats display for some application performance stats.
void statsTime(int index, long val)

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/core/SurfaceRunner.html[2/19/2011 9:10:11 AM]


SurfaceRunner

Record a performance timer.


void surfaceChanged(SurfaceHolder holder, int format, int width, int height)
This is called immediately after any structural changes (format or size) have
been made to the surface.
void surfaceCreated(SurfaceHolder holder)
This is called immediately after the surface is first created.
void surfaceDestroyed(SurfaceHolder holder)
This is called immediately before a surface is destroyed.
void surfaceStart()
Start the surface running.
void surfaceStop()
Stop the surface running.

Methods inherited from class java.lang.Object


clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail
SURFACE_DYNAMIC
public static final int SURFACE_DYNAMIC

Surface runner option: handle configuration changes dynamically. If set, configuration changes such
as screen orientation changes will be passed up to the app; otherwise, it is assumed that we will re-
start for these.

See Also:
Constant Field Values

LOOPED_TICKER
public static final int LOOPED_TICKER

Surface runner option: use a Looper to drive animations. This allows asynchronous updates to be
posted by the app.

See Also:
Constant Field Values

Constructor Detail
SurfaceRunner
public SurfaceRunner(Context app)

Create a SurfaceRunner instance.

Parameters:
app - The application context we're running in.

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/core/SurfaceRunner.html[2/19/2011 9:10:11 AM]


SurfaceRunner

SurfaceRunner
public SurfaceRunner(Context app,
int options)

Create a SurfaceRunner instance.

Parameters:
app - The application context we're running in.
options - Options for this SurfaceRunner. A bitwise OR of SURFACE_XXX constants.

SurfaceRunner
public SurfaceRunner(Context app,
AttributeSet attrs)

Create a SurfaceRunner instance.

Parameters:
app - The application context we're running in.
attrs - Layout attributes for this SurfaceRunner.

Method Detail
optionSet
public boolean optionSet(int option)

Check whether the given option flag is set on this surface.

Parameters:
option - The option flag to test; one of SURFACE_XXX.
Returns:
true iff the option is set.

setDelay
public void setDelay(long delay)

Set the delay in ms in each iteration of the main loop.

Parameters:
delay - The time in ms to sleep each time round the main animation loop. If zero, we will not
sleep, but will run continuously.

If you want to do all your animation under direct app control using postUpdate(), just set a
large delay. You may want to consider using 1000 -- i.e. one second -- to make sure you get a
refresh at a decent interval.

surfaceCreated

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/core/SurfaceRunner.html[2/19/2011 9:10:11 AM]


SurfaceRunner

public void surfaceCreated(SurfaceHolder holder)

This is called immediately after the surface is first created. Implementations of this should start up
whatever rendering code they desire. Note that only one thread can ever draw into a Surface, so you
should not draw into the Surface here if your normal rendering will be in another thread.

Parameters:
holder - The SurfaceHolder whose surface is being created.

surfaceChanged
public void surfaceChanged(SurfaceHolder holder,
int format,
int width,
int height)

This is called immediately after any structural changes (format or size) have been made to the
surface. This method is always called at least once, after surfaceCreated(SurfaceHolder).

Parameters:
holder - The SurfaceHolder whose surface has changed.
format - The new PixelFormat of the surface.
width - The new width of the surface.
height - The new height of the surface.

surfaceDestroyed
public void surfaceDestroyed(SurfaceHolder holder)

This is called immediately before a surface is destroyed. After returning from this call, you should no
longer try to access this surface. If you have a rendering thread that directly accesses the surface,
you must ensure that thread is no longer touching the Surface before returning from this function.

Parameters:
holder - The SurfaceHolder whose surface is being destroyed.

onStart
public void onStart()

The application is starting. Applications must call this from their Activity.onStart() method.

onResume
public void onResume()

We're resuming the app. Applications must call this from their Activity.onResume() method.

surfaceStart
public void surfaceStart()

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/core/SurfaceRunner.html[2/19/2011 9:10:11 AM]


SurfaceRunner

Start the surface running. Applications must call this to set the surface going. They may use this to
implement their own level of start/stop control, for example to implement a "pause" button.

surfaceStop
public void surfaceStop()

Stop the surface running. Applications may call this to stop the surface running. They may use this to
implement their own level of start/stop control, for example to implement a "pause" button.

onPause
public void onPause()

Pause the app. Applications must call this from their Activity.onPause() method.

onStop
public void onStop()

The application is closing down. Applications must call this from their Activity.onStop() method.

onWindowFocusChanged
public void onWindowFocusChanged(boolean hasWindowFocus)

Handle changes in focus. When we lose focus, pause the game so a popup (like the menu) doesn't
cause havoc.

Parameters:
hasWindowFocus - True iff we have focus.

postUpdate
public void postUpdate()

Asynchronously schedule an update; i.e. a frame of animation. This can only be called if the
SurfaceRunner was created with the option LOOPED_TICKER.

appStart
protected abstract void appStart()

The application is starting. Perform any initial set-up prior to starting the application. We may not
have a screen size yet, so this is not a good place to allocate resources which depend on that.

appSize

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/core/SurfaceRunner.html[2/19/2011 9:10:11 AM]


SurfaceRunner

protected abstract void appSize(int width,


int height,
Bitmap.Config config)

Set the screen size. This is guaranteed to be called before animStart(), but perhaps not before
appStart().

Parameters:
width - The new width of the surface.
height - The new height of the surface.
config - The pixel format of the surface.

animStart
protected abstract void animStart()

We are starting the animation loop. The screen size is known.

doUpdate() and doDraw() may be called from this point on.

animStop
protected abstract void animStop()

We are stopping the animation loop, for example to pause the app.

doUpdate() and doDraw() will not be called from this point on.

appStop
protected abstract void appStop()

The application is closing down. Clean up any resources.

doUpdate
protected abstract void doUpdate(long now)

Update the state of the application for the current frame.

Applications must override this, and can use it to update for example the physics of a game. This may
be a no-op in some cases.

doDraw() will always be called after this method is called; however, the converse is not true, as we
sometimes need to draw just to update the screen. Hence this method is useful for updates which are
dependent on time rather than frames.

Parameters:
now - Current time in ms.

doDraw

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/core/SurfaceRunner.html[2/19/2011 9:10:11 AM]


SurfaceRunner

protected abstract void doDraw(Canvas canvas,


long now)

Draw the current frame of the application.

Applications must override this, and are expected to draw the entire screen into the provided canvas.

This method will always be called after a call to doUpdate(), and also when the screen needs to be
re-drawn.

Parameters:
canvas - The Canvas to draw into.
now - Current time in ms. Will be the same as that passed to doUpdate(), if there was a
preceeding call to doUpdate().

getRes
public java.lang.String getRes(int resid)

Get the String value of a resource.

Parameters:
resid - The ID of the resource we want.
Returns:
The resource value.

getBitmap
public Bitmap getBitmap()

Get a Bitmap which is the same size and format as the surface. This can be used to get an off-screen
rendering buffer, for example.

Returns:
A Bitmap which is the same size and pixel format as the screen.

getBitmap
public Bitmap getBitmap(int w,
int h)

Get a Bitmap of a given size, in the same format as the surface. This can be used to get an off-screen
rendering buffer, for example.

Parameters:
w - Desired width in pixels.
h - Desired height in pixels.
Returns:
A Bitmap which is the same size and pixel format as the screen.

onSurfaceThread
public boolean onSurfaceThread()

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/core/SurfaceRunner.html[2/19/2011 9:10:11 AM]


SurfaceRunner

Determine whether the caller is on the surface's animation thread.

Returns:
The resource value.

setDebugPerf
public void setDebugPerf(boolean enable)

Turn display of performance info on or off.

Parameters:
enable - True to enable performance display.

setDebugPos
public void setDebugPos(int x,
int y)

Set the screen position at which we display performance info.

Parameters:
x - Screen X position.
y - Screen Y position.

statsCreate
protected void statsCreate(java.lang.String[] labels)

Reserve space in the stats display for some application performance stats. The given labels will
become stats which will be displayed if setDebugPerf(boolean enable) is passed true. Each stat is
subsequently referred to by its index in this labels array.

This method must be called before appStart() in order for the app's stats to be displayed. After
appStart() is called, the stats content is frozen until the next appStop() / appStart(). Typically the app
should invoke this method from its constructor. However this method is, of course, optional.

Parameters:
labels - Labels for the app's stats, one label per stat. Labels need to be 7 chars or less.

statsCount
public void statsCount(int index,
int val)

Increment a performance counter. This method is used for counts of specific quantities, which will be
displayed as counts per second; for example frames per second.

Parameters:
index - Index of the stat to bump (its index in the "labels" argument to statsCreate(String[]
labels) ).
val - Amount to add to the counter.

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/core/SurfaceRunner.html[2/19/2011 9:10:11 AM]


SurfaceRunner

statsTime
public void statsTime(int index,
long val)

Record a performance timer. This method is used for timings of specific activities; the average of the
recorded values will be displayed.

Parameters:
index - Index of the stat to record (its index in the "labels" argument to statsCreate(String[]
labels) ).
val - The time value for this iteration.

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/core/SurfaceRunner.html[2/19/2011 9:10:11 AM]


AppUtils.Version

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.hermit.android.core

Class AppUtils.Version
java.lang.Object
org.hermit.android.core.AppUtils.Version

Enclosing class:
AppUtils

public class AppUtils.Version


extends java.lang.Object

Information on an application version.

Field Summary
java.lang.CharSequence appDesc
Description either of the app or the version.
java.lang.CharSequence appName
Application's pretty name.
int versionCode
Version code of the app.
java.lang.CharSequence versionName
Version name of the app.

Constructor Summary
AppUtils.Version()

Method Summary
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail
appName
public java.lang.CharSequence appName

Application's pretty name. null if unknown.

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/core/AppUtils.Version.html[2/19/2011 9:10:14 AM]


AppUtils.Version

versionCode
public int versionCode

Version code of the app. -1 if unknown.

versionName
public java.lang.CharSequence versionName

Version name of the app. null if unknown.

appDesc
public java.lang.CharSequence appDesc

Description either of the app or the version. null if unknown.

Constructor Detail
AppUtils.Version
public AppUtils.Version()

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/core/AppUtils.Version.html[2/19/2011 9:10:14 AM]


AudioAnalyser

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.hermit.android.instruments

Class AudioAnalyser
java.lang.Object
org.hermit.android.instruments.Instrument
org.hermit.android.instruments.AudioAnalyser

public class AudioAnalyser


extends Instrument

An Instrument which analyses an audio stream in various ways.

To use this class, your application must have permission RECORD_AUDIO.

Constructor Summary
AudioAnalyser(SurfaceRunner parent)
Create a WindMeter instance.

Method Summary
void appStart()
The application is starting.
void appStop()
The application is closing down.
void doUpdate(long now)
Update the state of the instrument for the current frame.
PowerGauge getPowerGauge(SurfaceRunner surface)
Get a signal power gauge for this audio analyser.
SpectrumGauge getSpectrumGauge(SurfaceRunner surface)
Get a spectrum analyser gauge for this audio analyser.
WaveformGauge getWaveformGauge(SurfaceRunner surface)
Get a waveform gauge for this audio analyser.
void measureStart()
We are starting the main run; start measurements.
void measureStop()
We are stopping / pausing the run; stop measurements.
protected restoreState(Bundle icicle)
void
Restore the game state from the given Bundle.
protected saveState(Bundle icicle)
void
Save the state of the game in the provided Bundle.
void setAverageLen(int len)
Set the histogram averaging window for this instrument.

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/instruments/AudioAnalyser.html[2/19/2011 9:10:15 AM]


AudioAnalyser

void setBlockSize(int size)


Set the input block size for this instrument.
void setDecimation(int rate)
Set the decimation rate for this instrument.
void setSampleRate(int rate)
Set the sample rate for this instrument.
void setWindowFunc(org.hermit.dsp.Window.Function func)
Set the spectrum analyser windowing function for this instrument.

Methods inherited from class org.hermit.android.instruments.Instrument


getSurface

Methods inherited from class java.lang.Object


clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
AudioAnalyser
public AudioAnalyser(SurfaceRunner parent)

Create a WindMeter instance.

Parameters:
parent - Parent surface.

Method Detail
setSampleRate
public void setSampleRate(int rate)

Set the sample rate for this instrument.

Parameters:
rate - The desired rate, in samples/sec.

setBlockSize
public void setBlockSize(int size)

Set the input block size for this instrument.

Parameters:
size - The desired block size, in samples. Typical values would be 256, 512, or 1024. Larger
block sizes will mean more work to analyse the spectrum.

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/instruments/AudioAnalyser.html[2/19/2011 9:10:15 AM]


AudioAnalyser

setWindowFunc
public void setWindowFunc(org.hermit.dsp.Window.Function func)

Set the spectrum analyser windowing function for this instrument.

Parameters:
func - The desired windowing function. Window.Function.BLACKMAN_HARRIS is a good option.
Window.Function.RECTANGULAR turns off windowing.

setDecimation
public void setDecimation(int rate)

Set the decimation rate for this instrument.

Parameters:
rate - The desired decimation. Only 1 in rate blocks will actually be processed.

setAverageLen
public void setAverageLen(int len)

Set the histogram averaging window for this instrument.

Parameters:
len - The averaging interval. 1 means no averaging.

appStart
public void appStart()

The application is starting. Perform any initial set-up prior to starting the application. We may not
have a screen size yet, so this is not a good place to allocate resources which depend on that.

Overrides:
appStart in class Instrument

measureStart
public void measureStart()

We are starting the main run; start measurements.

Overrides:
measureStart in class Instrument

measureStop
public void measureStop()

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/instruments/AudioAnalyser.html[2/19/2011 9:10:15 AM]


AudioAnalyser

We are stopping / pausing the run; stop measurements.

Overrides:
measureStop in class Instrument

appStop
public void appStop()

The application is closing down. Clean up any resources.

Overrides:
appStop in class Instrument

getWaveformGauge
public WaveformGauge getWaveformGauge(SurfaceRunner surface)

Get a waveform gauge for this audio analyser.

Parameters:
surface - The surface in which the gauge will be displayed.
Returns:
A gauge which will display the audio waveform.

getSpectrumGauge
public SpectrumGauge getSpectrumGauge(SurfaceRunner surface)

Get a spectrum analyser gauge for this audio analyser.

Parameters:
surface - The surface in which the gauge will be displayed.
Returns:
A gauge which will display the audio waveform.

getPowerGauge
public PowerGauge getPowerGauge(SurfaceRunner surface)

Get a signal power gauge for this audio analyser.

Parameters:
surface - The surface in which the gauge will be displayed.
Returns:
A gauge which will display the signal power in a dB meter.

doUpdate
public final void doUpdate(long now)

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/instruments/AudioAnalyser.html[2/19/2011 9:10:15 AM]


AudioAnalyser

Update the state of the instrument for the current frame. This method must be invoked from the
doUpdate() method of the application's SurfaceRunner .

Since this is called frequently, we first check whether new audio data has actually arrived.

Overrides:
doUpdate in class Instrument

Parameters:
now - Nominal time of the current frame in ms.

saveState
protected void saveState(Bundle icicle)

Save the state of the game in the provided Bundle.

Overrides:
saveState in class Instrument

Parameters:
icicle - The Bundle in which we should save our state.

restoreState
protected void restoreState(Bundle icicle)

Restore the game state from the given Bundle.

Overrides:
restoreState in class Instrument

Parameters:
icicle - The Bundle containing the saved state.

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/instruments/AudioAnalyser.html[2/19/2011 9:10:15 AM]


Instrument

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.hermit.android.instruments

Class Instrument
java.lang.Object
org.hermit.android.instruments.Instrument

Direct Known Subclasses:


AudioAnalyser

public class Instrument


extends java.lang.Object

An instrument which measures some quantity, or accesses or produces some data, which can be displayed
on one or more Gauge objects.

Constructor Summary
Instrument(SurfaceRunner parent)
Set up this view.

Method Summary
void appStart()
The application is starting.
void appStop()
The application is closing down.
protected doUpdate(long now)
void
Update the state of the instrument for the current frame.
protected
SurfaceRunner getSurface()
Get the app context of this Element.
void measureStart()
We are starting the main run; start measurements.
void measureStop()
We are stopping / pausing the run; stop measurements.
protected restoreState(Bundle icicle)
void
Restore the game state from the given Bundle.
protected saveState(Bundle icicle)
void
Save the state of the game in the provided Bundle.

Methods inherited from class java.lang.Object


clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/instruments/Instrument.html[2/19/2011 9:10:17 AM]


Instrument

Constructor Detail
Instrument
public Instrument(SurfaceRunner parent)

Set up this view.

Parameters:
parent - Parent surface.

Method Detail
appStart
public void appStart()

The application is starting. Perform any initial set-up prior to starting the application.

measureStart
public void measureStart()

We are starting the main run; start measurements.

measureStop
public void measureStop()

We are stopping / pausing the run; stop measurements.

appStop
public void appStop()

The application is closing down. Clean up any resources.

doUpdate
protected void doUpdate(long now)

Update the state of the instrument for the current frame.

Instruments may override this, and can use it to read the current input state. This method is invoked
in the main animation loop -- i.e. frequently.

Parameters:
now - Nominal time of the current frame in ms.

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/instruments/Instrument.html[2/19/2011 9:10:17 AM]


Instrument

getSurface
protected SurfaceRunner getSurface()

Get the app context of this Element.

Returns:
The app context we're running in.

saveState
protected void saveState(Bundle icicle)

Save the state of the game in the provided Bundle.

Parameters:
icicle - The Bundle in which we should save our state.

restoreState
protected void restoreState(Bundle icicle)

Restore the game state from the given Bundle.

Parameters:
icicle - The Bundle containing the saved state.

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/instruments/Instrument.html[2/19/2011 9:10:17 AM]


AppUtils

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.hermit.android.core

Class AppUtils
java.lang.Object
org.hermit.android.core.AppUtils

public class AppUtils


extends java.lang.Object

This class provides some simple application-related utilities.

Nested Class Summary


static class AppUtils.Detail
Version info detail level.
class AppUtils.Version
Information on an application version.

Method Summary
AppUtils.Version getAppVersion()
Get the version info for the current app.
static AppUtils getInstance(Activity parent)
Get the app utils instance for this Activity.
java.lang.String getVersionString()
Get a string containing the name and version info for the current app's package,
in a simple format.
java.lang.String getVersionString(AppUtils.Detail detail)
Get a string containing the name and version info for the current app's package.

Methods inherited from class java.lang.Object


clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail
getInstance
public static AppUtils getInstance(Activity parent)

Get the app utils instance for this Activity.

Parameters:
parent - Activity for which we want information.

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/core/AppUtils.html[2/19/2011 9:10:19 AM]


AppUtils

Returns:
The application utilities instance for this app.

getAppVersion
public AppUtils.Version getAppVersion()

Get the version info for the current app.

Returns:
App version info. null if the info could not be found.

getVersionString
public java.lang.String getVersionString()

Get a string containing the name and version info for the current app's package, in a simple format.

Returns:
Descriptive name / version string.

getVersionString
public java.lang.String getVersionString(AppUtils.Detail detail)

Get a string containing the name and version info for the current app's package.

Parameters:
detail - How much detail we want.
Returns:
Descriptive name / version string.

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/core/AppUtils.html[2/19/2011 9:10:19 AM]


org.hermit.android.core

Overview Package Class Use Tree Deprecated Index Help


PREV PACKAGE NEXT PACKAGE FRAMES NO FRAMES All Classes

Package org.hermit.android.core
A library of foundation classes for Android applications.

See:
Description

Class Summary
AppUtils This class provides some simple application-related utilities.
Errors Error handling and reporting utilities.
HelpActivity An activity which displays an application's help, in a structured format.
MainActivity An enhanced Activity class, for use as the main activity of an application.
MainActivity.ActivityListener This interface defines a listener for sub-activity results.
OneTimeDialog A class which handles showing one-off notices.
An activity which displays a splash screen and then returns to the calling
SplashActivity
activity.
SurfaceRunner Common base for applications with an animated view.

Enum Summary
AppUtils.Detail Version info detail level.

Package org.hermit.android.core Description


A library of foundation classes for Android applications.

Overview Package Class Use Tree Deprecated Index Help


PREV PACKAGE NEXT PACKAGE FRAMES NO FRAMES All Classes

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/core/package-summary.html[2/19/2011 9:10:21 AM]


AppUtils.Detail

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES All Classes
SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD DETAIL: ENUM CONSTANTS | FIELD | METHOD

org.hermit.android.core

Enum AppUtils.Detail
java.lang.Object
java.lang.Enum<AppUtils.Detail>
org.hermit.android.core.AppUtils.Detail

All Implemented Interfaces:


java.io.Serializable, java.lang.Comparable<AppUtils.Detail>

Enclosing class:
AppUtils

public static enum AppUtils.Detail


extends java.lang.Enum<AppUtils.Detail>

Version info detail level.

Enum Constant Summary


DEBUG
Show debug-level detail.
NONE
Do not display.
SIMPLE
Show basic name and version.

Method Summary
static AppUtils.Detail valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.
static AppUtils.Detail[] values()
Returns an array containing the constants of this enum type, in the order
they are declared.

Methods inherited from class java.lang.Enum


clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString,
valueOf

Methods inherited from class java.lang.Object


getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/core/AppUtils.Detail.html[2/19/2011 9:10:23 AM]


AppUtils.Detail

NONE
public static final AppUtils.Detail NONE

Do not display.

SIMPLE
public static final AppUtils.Detail SIMPLE

Show basic name and version.

DEBUG
public static final AppUtils.Detail DEBUG

Show debug-level detail.

Method Detail
values
public static AppUtils.Detail[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This
method may be used to iterate over the constants as follows:
for (AppUtils.Detail c : AppUtils.Detail.values())
System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf
public static AppUtils.Detail valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an
identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not
permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified
name
java.lang.NullPointerException - if the argument is null

Overview Package Class Use Tree Deprecated Index Help

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/core/AppUtils.Detail.html[2/19/2011 9:10:23 AM]


AppUtils.Detail

PREV CLASS NEXT CLASS FRAMES NO FRAMES All Classes


SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD DETAIL: ENUM CONSTANTS | FIELD | METHOD

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/core/AppUtils.Detail.html[2/19/2011 9:10:23 AM]


org.hermit.android.instruments

Overview Package Class Use Tree Deprecated Index Help


PREV PACKAGE NEXT PACKAGE FRAMES NO FRAMES All Classes

Package org.hermit.android.instruments

Class Summary
AudioAnalyser An Instrument which analyses an audio stream in various ways.
Gauge A graphical display which shows some data in a region within a view.
An instrument which measures some quantity, or accesses or produces some data,
Instrument
which can be displayed on one or more Gauge objects.
InstrumentSurface Common base for applications which display instruments.
A graphical display which displays the signal power in dB from an AudioAnalyser
PowerGauge
instrument.
A graphical display which displays the audio spectrum from an AudioAnalyser
SpectrumGauge
instrument.
TextGauge A Gauge which displays data in textual form, generally as a grid of numeric values.
A graphical display which displays the audio waveform from an AudioAnalyser
WaveformGauge
instrument.

Overview Package Class Use Tree Deprecated Index Help


PREV PACKAGE NEXT PACKAGE FRAMES NO FRAMES All Classes

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/instruments/package-summary.html[2/19/2011 9:10:24 AM]


AudioReader

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.hermit.android.io

Class AudioReader
java.lang.Object
org.hermit.android.io.AudioReader

public class AudioReader


extends java.lang.Object

A class which reads audio input from the mic in a background thread and passes it to the caller when
ready.

To use this class, your application must have permission RECORD_AUDIO.

Nested Class Summary


static class AudioReader.Listener
Listener for audio reads.

Constructor Summary
AudioReader()
Create an AudioReader instance.

Method Summary
void startReader(int rate, int block, AudioReader.Listener listener)
Start this reader.
void stopReader()
Start this reader.

Methods inherited from class java.lang.Object


clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
AudioReader
public AudioReader()

Create an AudioReader instance.

Method Detail
http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/io/AudioReader.html[2/19/2011 9:10:26 AM]
AudioReader

startReader
public void startReader(int rate,
int block,
AudioReader.Listener listener)

Start this reader.

Parameters:
rate - The audio sampling rate, in samples / sec.
block - Number of samples of input to read at a time. This is different from the system audio
buffer size.
listener - Listener to be notified on each completed read.

stopReader
public void stopReader()

Start this reader.

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/io/AudioReader.html[2/19/2011 9:10:26 AM]


org.hermit.android.io

Overview Package Class Use Tree Deprecated Index Help


PREV PACKAGE NEXT PACKAGE FRAMES NO FRAMES All Classes

Package org.hermit.android.io

Class Summary
A class which reads audio input from the mic in a background thread and passes
AudioReader
it to the caller when ready.
AudioReader.Listener Listener for audio reads.

Overview Package Class Use Tree Deprecated Index Help


PREV PACKAGE NEXT PACKAGE FRAMES NO FRAMES All Classes

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/io/package-summary.html[2/19/2011 9:10:28 AM]


AudioReader.Listener

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.hermit.android.io

Class AudioReader.Listener
java.lang.Object
org.hermit.android.io.AudioReader.Listener

Enclosing class:
AudioReader

public abstract static class AudioReader.Listener


extends java.lang.Object

Listener for audio reads.

Field Summary
static int ERR_INIT_FAILED
Audio read error code: the audio reader failed to initialise.
static int ERR_OK
Audio read error code: no error.
static int ERR_READ_FAILED
Audio read error code: an audio read failed.

Constructor Summary
AudioReader.Listener()

Method Summary
abstract onReadComplete(short[] buffer)
void
An audio read has completed.
abstract onReadError(int error)
void
An error has occurred.

Methods inherited from class java.lang.Object


clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail
ERR_OK

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/io/AudioReader.Listener.html[2/19/2011 9:10:30 AM]


AudioReader.Listener

public static final int ERR_OK

Audio read error code: no error.

See Also:
Constant Field Values

ERR_INIT_FAILED
public static final int ERR_INIT_FAILED

Audio read error code: the audio reader failed to initialise.

See Also:
Constant Field Values

ERR_READ_FAILED
public static final int ERR_READ_FAILED

Audio read error code: an audio read failed.

See Also:
Constant Field Values

Constructor Detail
AudioReader.Listener
public AudioReader.Listener()

Method Detail
onReadComplete
public abstract void onReadComplete(short[] buffer)

An audio read has completed.

Parameters:
buffer - Buffer containing the data.

onReadError
public abstract void onReadError(int error)

An error has occurred. The reader has been terminated.

Parameters:
error - ERR_XXX code describing the error.

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/io/AudioReader.Listener.html[2/19/2011 9:10:30 AM]


AudioReader.Listener

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/io/AudioReader.Listener.html[2/19/2011 9:10:30 AM]


Overview

All Classes Overview Package Class Use Tree Deprecated Index Help
PREV NEXT FRAMES NO FRAMES
Packages
org.hermit.android.core
org.hermit.android.instru HermitAndroid
org.hermit.android.io
org.hermit.android.net HermitAndroid is a collection of useful classes for Android applications, in a library
org.hermit.android.notic which can be linked into Android projects.
org.hermit.android.prov
org.hermit.android.soun See:
org.hermit.android.widg Description

Packages
A library of foundation classes for Android
org.hermit.android.core
applications.
org.hermit.android.instruments
All Classes org.hermit.android.io
AppUtils
AppUtils.Detail org.hermit.android.net
AudioAnalyser org.hermit.android.notice
AudioReader
A library of classes to facilitate the creating of
AudioReader.Listener org.hermit.android.provider
CachedFile table-based content providers.
CachedFile.Entry These classes provide functions to help apps
org.hermit.android.sound
DatabaseHelper manage their sound effects.
DbSchema
Effect org.hermit.android.widgets
ErrorDialog
Errors
FileFetcher
Gauge HermitAndroid is a collection of useful classes for Android applications, in a library
HelpActivity which can be linked into Android projects.
HScrollView
InfoBox This library is structured as an Android library project, using the new Android
Instrument libraries feature introduced in Android SDK tools revision 6. This allows
InstrumentSurface HermitAndroid to have its own resources, such as icons or internationalized strings.
LinedEditText
MainActivity For information on getting the code, see the project home page on Google Code.
MainActivity.ActivityList
MultistateImageButton
Overview Package Class Use Tree Deprecated Index Help
OneTimeDialog
PREV NEXT FRAMES NO FRAMES
Player
PowerGauge
SpectrumGauge
SplashActivity
SurfaceRunner
TableFetcher
TableProvider
TableSchema
TextGauge
TextInputDialog
TextInputDialog.OnOkL
TimeZoneActivity

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?overview-summary.html[2/19/2011 9:10:32 AM]


Overview

WaveformGauge
WebBasedData
WebFetcher
WebFetcher.FetchException
WebFetcher.Listener

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?overview-summary.html[2/19/2011 9:10:32 AM]


org.hermit.android.net

Overview Package Class Use Tree Deprecated Index Help


PREV PACKAGE NEXT PACKAGE FRAMES NO FRAMES All Classes

Package org.hermit.android.net

Interface Summary
WebFetcher.Listener Listener for incoming web data.

Class Summary
CachedFile This class manages a set of web-based files and caches them locally.
CachedFile.Entry Class describing an entry in the cache; i.e.
FileFetcher Concrete instance of WebFetcher which gets a file and stores it locally.
TableFetcher Concrete instance of WebFetcher which fetches tabular data from the web.
This class implements a web-based source of data, which is cached in a local
WebBasedData
database.
WebFetcher This class fetches data from the web without blocking the main app.

Exception Summary
WebFetcher.FetchException Web fetching exception.

Overview Package Class Use Tree Deprecated Index Help


PREV PACKAGE NEXT PACKAGE FRAMES NO FRAMES All Classes

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/net/package-summary.html[2/19/2011 9:10:34 AM]


org.hermit.android.notice

Overview Package Class Use Tree Deprecated Index Help


PREV PACKAGE NEXT PACKAGE FRAMES NO FRAMES All Classes

Package org.hermit.android.notice

Interface Summary
TextInputDialog.OnOkListener Listener invoked when the user clicks the OK button.
YesNoDialog.OnOkListener Listener invoked when the user clicks the OK button.

Class Summary
This class implements a popup error box (a subclass of AlertDialog) which can be used
ErrorDialog
to display an error message.
This class implements a popup info box (a subclass of Dialog) which can be used to
InfoBox
display help text, about info, license info, etc.

TextInputDialog This class implements a popup input box (a subclass of AlertDialog) which can be used
to display a prompt and read a text string from the user.
This class implements a popup dialog box (a subclass of AlertDialog) which can be
YesNoDialog
used to display a yes / no question.

Overview Package Class Use Tree Deprecated Index Help


PREV PACKAGE NEXT PACKAGE FRAMES NO FRAMES All Classes

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/notice/package-summary.html[2/19/2011 9:10:37 AM]


org.hermit.android.provider

Overview Package Class Use Tree Deprecated Index Help


PREV PACKAGE NEXT PACKAGE FRAMES NO FRAMES All Classes

Package org.hermit.android.provider
A library of classes to facilitate the creating of table-based content providers.

See:
Description

Class Summary
DatabaseHelper This class helps open, create, and upgrade the database file.
DbSchema Class encapsulating the schema for a content provider.
This class is a base for content providers which provide access to table-organized data
TableProvider
in an SQL database.
TableSchema Class encapsulating the schema for a table within a content provider.

Package org.hermit.android.provider Description


A library of classes to facilitate the creating of table-based content providers. Applications may use these
classes to create a content provider with the minimum amount of code, while still retaining reasonable
flexibility to implement custom behaviour.

Simple Usage
The basic usage model is this:

Create a subclass of DbSchema to define the schema of your content provider's database. Use inner
classes which are subclasses of TableSchema to define the tables.
Create a subclass of TableProvider to implement the content provider. In many cases this class will
consist only of a constructor which passes the schema to the TableProvider constructor.
Declare the provider in your manifest.

For a simple provider, it's really that easy. All of the code for managing the database, and doing inserts,
queries, etc., is provided for you.

Handling Database Upgrade


The default implementation handles database upgrade by simply deleting the existing database, and
creating a fresh one. This is something that many applications will wish to improve on, and you can do this
by providing a custom subclass of DatabaseHelper .

To do this, first create your helper subclass. Override DatabaseHelper.onUpgrade(SQLiteDatabase, int,


int) and any other methods you need. Then, in your TableProvider subclass, override
TableProvider.getHelper() to return an instance of your database helper.

Example

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/provider/package-summary.html[2/19/2011 9:10:38 AM]


org.hermit.android.provider

The following example illustrates a very simple provider, which is the basis for an app logging broadcast
events.

First, the schema definition:


package org.hermit.broadtest.provider;
import org.hermit.android.provider.DbSchema;
import org.hermit.android.provider.TableSchema;
import android.net.Uri;
/**
* Class encapsulating the schema for the broadcast content provider.
*/
public class BroadcastSchema
extends DbSchema
{
private static final String DATABASE_NAME = "broadcasts";
// Current schema version.
private static final int SCHEMA_VERSION = 2;
// Provider authority name.
private static final String AUTHORITY = "com.bn.provider.Broadcast";
public static final class BroadcastTable
extends TableSchema
{
// Name of the broadcasts table.
private static final String TABLE_NAME = "broadcasts";
// Base MIME type for the broadcasts table.
private static final String TABLE_TYPE = "vnd.bn.broadcast";
/**
* The content:// style URL for the broadcasts table.
*/
public static final Uri CONTENT_URI =
Uri.parse("content://" + AUTHORITY + "/broadcasts");
/**
* The default sort order for the broadcasts table.
*/
public static final String SORT_ORDER = "time DESC";
/**
* Broadcast table field: the title of the broadcast.
*/
public static final String TITLE = "title";
/**
* Broadcast table field: any extras that came with the broadcast.
*/
public static final String EXTRAS = "extras";
/**
* Broadcast table field: the timestamp for when the broadcast was
* received.
*/
public static final String TIME = "time";
// Definitions of the fields.
private static final String[][] FIELDS = {
{ TITLE, "TEXT" },
{ EXTRAS, "TEXT" },
{ TIME, "INTEGER" },
};
/**
* A default projection which gets all the fields of the broadcast
* table.
*/
public static final String[] PROJECTION = makeProjection(FIELDS);
/**
* Create a broadcasts table schema instance.

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/provider/package-summary.html[2/19/2011 9:10:38 AM]


org.hermit.android.provider

*/
protected BroadcastTable() {
super(TABLE_NAME, TABLE_TYPE, CONTENT_URI, SORT_ORDER, FIELDS);
}
}
/**
* Create a broadcast database schema instance.
*/
protected BroadcastSchema() {
super(DATABASE_NAME, SCHEMA_VERSION, AUTHORITY, TABLE_SCHEMAS);
}
// Our table schemas.
private static final TableSchema[] TABLE_SCHEMAS = {
new BroadcastTable(),
};
}

With that, the provider itself is trivial:


package org.hermit.broadtest.provider;
import org.hermit.android.provider.TableProvider;
/**
* Content provider for stored broadcast events.
*/
public class BroadcastProvider
extends TableProvider
{
/**
* Create an instance of this content provider.
*/
public BroadcastProvider() {
super(new BroadcastSchema());
}
}

And finally, the manifest:


<provider android:name=".provider.BroadcastProvider"
android:authorities="com.bn.provider.Broadcast" />

Overview Package Class Use Tree Deprecated Index Help


PREV PACKAGE NEXT PACKAGE FRAMES NO FRAMES All Classes

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/provider/package-summary.html[2/19/2011 9:10:38 AM]


org.hermit.android.sound

Overview Package Class Use Tree Deprecated Index Help


PREV PACKAGE NEXT PACKAGE FRAMES NO FRAMES All Classes

Package org.hermit.android.sound
These classes provide functions to help apps manage their sound effects.

See:
Description

Class Summary
Effect Class representing a specific sound effect.
Player Main sound effects player class.

Package org.hermit.android.sound Description


These classes provide functions to help apps manage their sound effects.

Overview Package Class Use Tree Deprecated Index Help


PREV PACKAGE NEXT PACKAGE FRAMES NO FRAMES All Classes

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/sound/package-summary.html[2/19/2011 9:10:40 AM]


org.hermit.android.widgets

Overview Package Class Use Tree Deprecated Index Help


PREV PACKAGE NEXT PACKAGE FRAMES NO FRAMES All Classes

Package org.hermit.android.widgets

Class Summary
Layout container for a view hierarchy that can be scrolled by the user, allowing
HScrollView
it to be larger than the physical display.
LinedEditText A custom EditText that draws lines between each line of text that is displayed.

MultistateImageButton This class displays an image button which toggles or cycles through multiple
states when clicked.
TimeZoneActivity This class displays a picker which can be used to select a timezone.

Overview Package Class Use Tree Deprecated Index Help


PREV PACKAGE NEXT PACKAGE FRAMES NO FRAMES All Classes

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/widgets/package-summary.html[2/19/2011 9:10:41 AM]


Class Hierarchy

All Classes Overview Package Class Use Tree Deprecated Index Help
PREV NEXT FRAMES NO FRAMES
Packages
org.hermit.android.core
org.hermit.android.instru
org.hermit.android.io
Hierarchy For All Packages
org.hermit.android.net
org.hermit.android.notic Package Hierarchies:
org.hermit.android.core, org.hermit.android.instruments, org.hermit.android.io,
org.hermit.android.prov
org.hermit.android.net, org.hermit.android.notice, org.hermit.android.provider,
org.hermit.android.soun
org.hermit.android.sound, org.hermit.android.widgets
org.hermit.android.widg

Class Hierarchy
java.lang.Object
Activity
org.hermit.android.core.MainActivity
Activity
org.hermit.android.core.SplashActivity
Activity
org.hermit.android.core.HelpActivity
AlertDialog
org.hermit.android.notice.YesNoDialog
AlertDialog
org.hermit.android.notice.ErrorDialog
AlertDialog
org.hermit.android.notice.TextInputDialog
org.hermit.android.core.AppUtils
All Classes org.hermit.android.core.AppUtils.Version
AppUtils org.hermit.android.io.AudioReader
AppUtils.Detail org.hermit.android.io.AudioReader.Listener
AudioAnalyser org.hermit.android.net.CachedFile.Entry
AudioReader ContentProvider
AudioReader.Listener org.hermit.android.provider.TableProvider
CachedFile org.hermit.android.provider.DbSchema
CachedFile.Entry Dialog
DatabaseHelper org.hermit.android.notice.InfoBox
DbSchema EditText
Effect org.hermit.android.widgets.LinedEditText
ErrorDialog org.hermit.android.sound.Effect
Errors org.hermit.android.core.Errors
FileFetcher FrameLayout
Gauge org.hermit.android.widgets.HScrollView
HelpActivity org.hermit.android.instruments.Gauge
HScrollView org.hermit.android.instruments.PowerGauge
InfoBox org.hermit.android.instruments.SpectrumGauge
Instrument org.hermit.android.instruments.TextGauge
InstrumentSurface org.hermit.android.instruments.WaveformGauge
LinedEditText ImageButton
MainActivity org.hermit.android.widgets.MultistateImageButton
MainActivity.ActivityList org.hermit.android.instruments.Instrument
MultistateImageButton org.hermit.android.instruments.AudioAnalyser
OneTimeDialog ListActivity
Player org.hermit.android.widgets.TimeZoneActivity

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?overview-tree.html[2/19/2011 9:10:43 AM]


Class Hierarchy

PowerGauge org.hermit.android.core.MainActivity.ActivityListener
SpectrumGauge java.util.Observable
SplashActivity org.hermit.android.net.CachedFile (implements
SurfaceRunner org.hermit.android.net.WebFetcher.Listener)
TableFetcher org.hermit.android.net.WebBasedData (implements
TableProvider org.hermit.android.net.WebFetcher.Listener)
TableSchema org.hermit.android.core.OneTimeDialog
TextGauge org.hermit.android.sound.Player
TextInputDialog SQLiteOpenHelper
TextInputDialog.OnOkL org.hermit.android.provider.DatabaseHelper
TimeZoneActivity SurfaceView
WaveformGauge org.hermit.android.core.SurfaceRunner
WebBasedData org.hermit.android.instruments.InstrumentSurface
WebFetcher org.hermit.android.provider.TableSchema
WebFetcher.FetchExce java.lang.Thread (implements java.lang.Runnable)
WebFetcher.Listener org.hermit.android.net.WebFetcher
YesNoDialog org.hermit.android.net.FileFetcher
YesNoDialog.OnOkListe org.hermit.android.net.TableFetcher
java.lang.Throwable (implements java.io.Serializable)
java.lang.Exception
org.hermit.android.net.WebFetcher.FetchException

Interface Hierarchy
org.hermit.android.notice.TextInputDialog.OnOkListener
org.hermit.android.net.WebFetcher.Listener
org.hermit.android.notice.YesNoDialog.OnOkListener

Enum Hierarchy
java.lang.Object
java.lang.Enum<E> (implements java.lang.Comparable<T>,
java.io.Serializable)
org.hermit.android.core.AppUtils.Detail

Overview Package Class Use Tree Deprecated Index Help


PREV NEXT FRAMES NO FRAMES

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?overview-tree.html[2/19/2011 9:10:43 AM]


org.hermit.android.core Class Hierarchy

Overview Package Class Use Tree Deprecated Index Help


PREV NEXT FRAMES NO FRAMES All Classes

Hierarchy For Package org.hermit.android.core


Package Hierarchies:
All Packages

Class Hierarchy
java.lang.Object
Activity
org.hermit.android.core.MainActivity
Activity
org.hermit.android.core.SplashActivity
Activity
org.hermit.android.core.HelpActivity
org.hermit.android.core.AppUtils
org.hermit.android.core.AppUtils.Version
org.hermit.android.core.Errors
org.hermit.android.core.MainActivity.ActivityListener
org.hermit.android.core.OneTimeDialog
SurfaceView
org.hermit.android.core.SurfaceRunner

Enum Hierarchy
java.lang.Object
java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable)
org.hermit.android.core.AppUtils.Detail

Overview Package Class Use Tree Deprecated Index Help


PREV NEXT FRAMES NO FRAMES All Classes

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/core/package-tree.html[2/19/2011 9:10:46 AM]


org.hermit.android.instruments Class Hierarchy

Overview Package Class Use Tree Deprecated Index Help


PREV NEXT FRAMES NO FRAMES All Classes

Hierarchy For Package org.hermit.android.instruments


Package Hierarchies:
All Packages

Class Hierarchy
java.lang.Object
org.hermit.android.instruments.Gauge
org.hermit.android.instruments.PowerGauge
org.hermit.android.instruments.SpectrumGauge
org.hermit.android.instruments.TextGauge
org.hermit.android.instruments.WaveformGauge
org.hermit.android.instruments.Instrument
org.hermit.android.instruments.AudioAnalyser
SurfaceView
org.hermit.android.core.SurfaceRunner
org.hermit.android.instruments.InstrumentSurface

Overview Package Class Use Tree Deprecated Index Help


PREV NEXT FRAMES NO FRAMES All Classes

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/instruments/package-tree.html[2/19/2011 9:10:47 AM]


org.hermit.android.io Class Hierarchy

Overview Package Class Use Tree Deprecated Index Help


PREV NEXT FRAMES NO FRAMES All Classes

Hierarchy For Package org.hermit.android.io


Package Hierarchies:
All Packages

Class Hierarchy
java.lang.Object
org.hermit.android.io.AudioReader
org.hermit.android.io.AudioReader.Listener

Overview Package Class Use Tree Deprecated Index Help


PREV NEXT FRAMES NO FRAMES All Classes

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/io/package-tree.html[2/19/2011 9:10:48 AM]


org.hermit.android.net Class Hierarchy

Overview Package Class Use Tree Deprecated Index Help


PREV NEXT FRAMES NO FRAMES All Classes

Hierarchy For Package org.hermit.android.net


Package Hierarchies:
All Packages

Class Hierarchy
java.lang.Object
org.hermit.android.net.CachedFile.Entry
java.util.Observable
org.hermit.android.net.CachedFile (implements
org.hermit.android.net.WebFetcher.Listener)
org.hermit.android.net.WebBasedData (implements
org.hermit.android.net.WebFetcher.Listener)
java.lang.Thread (implements java.lang.Runnable)
org.hermit.android.net.WebFetcher
org.hermit.android.net.FileFetcher
org.hermit.android.net.TableFetcher
java.lang.Throwable (implements java.io.Serializable)
java.lang.Exception
org.hermit.android.net.WebFetcher.FetchException

Interface Hierarchy
org.hermit.android.net.WebFetcher.Listener

Overview Package Class Use Tree Deprecated Index Help


PREV NEXT FRAMES NO FRAMES All Classes

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/net/package-tree.html[2/19/2011 9:10:50 AM]


org.hermit.android.notice Class Hierarchy

Overview Package Class Use Tree Deprecated Index Help


PREV NEXT FRAMES NO FRAMES All Classes

Hierarchy For Package org.hermit.android.notice


Package Hierarchies:
All Packages

Class Hierarchy
java.lang.Object
AlertDialog
org.hermit.android.notice.YesNoDialog
AlertDialog
org.hermit.android.notice.ErrorDialog
AlertDialog
org.hermit.android.notice.TextInputDialog
Dialog
org.hermit.android.notice.InfoBox

Interface Hierarchy
org.hermit.android.notice.TextInputDialog.OnOkListener
org.hermit.android.notice.YesNoDialog.OnOkListener

Overview Package Class Use Tree Deprecated Index Help


PREV NEXT FRAMES NO FRAMES All Classes

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/notice/package-tree.html[2/19/2011 9:10:52 AM]


org.hermit.android.provider Class Hierarchy

Overview Package Class Use Tree Deprecated Index Help


PREV NEXT FRAMES NO FRAMES All Classes

Hierarchy For Package org.hermit.android.provider


Package Hierarchies:
All Packages

Class Hierarchy
java.lang.Object
ContentProvider
org.hermit.android.provider.TableProvider
org.hermit.android.provider.DbSchema
SQLiteOpenHelper
org.hermit.android.provider.DatabaseHelper
org.hermit.android.provider.TableSchema

Overview Package Class Use Tree Deprecated Index Help


PREV NEXT FRAMES NO FRAMES All Classes

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/provider/package-tree.html[2/19/2011 9:10:59 AM]


org.hermit.android.sound Class Hierarchy

Overview Package Class Use Tree Deprecated Index Help


PREV NEXT FRAMES NO FRAMES All Classes

Hierarchy For Package org.hermit.android.sound


Package Hierarchies:
All Packages

Class Hierarchy
java.lang.Object
org.hermit.android.sound.Effect
org.hermit.android.sound.Player

Overview Package Class Use Tree Deprecated Index Help


PREV NEXT FRAMES NO FRAMES All Classes

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/sound/package-tree.html[2/19/2011 9:11:00 AM]


org.hermit.android.widgets Class Hierarchy

Overview Package Class Use Tree Deprecated Index Help


PREV NEXT FRAMES NO FRAMES All Classes

Hierarchy For Package org.hermit.android.widgets


Package Hierarchies:
All Packages

Class Hierarchy
java.lang.Object
EditText
org.hermit.android.widgets.LinedEditText
FrameLayout
org.hermit.android.widgets.HScrollView
ImageButton
org.hermit.android.widgets.MultistateImageButton
ListActivity
org.hermit.android.widgets.TimeZoneActivity

Overview Package Class Use Tree Deprecated Index Help


PREV NEXT FRAMES NO FRAMES All Classes

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/widgets/package-tree.html[2/19/2011 9:11:01 AM]


MainActivity

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.hermit.android.core

Class MainActivity
java.lang.Object
Activity
org.hermit.android.core.MainActivity

public class MainActivity


extends Activity

An enhanced Activity class, for use as the main activity of an application. The main thing this class provides
is a nice callback-based mechanism for starting sub-activities. This makes it easier for different parts of an
app to kick off sub-activities and get the results.

Note: it is best that sub-classes do not implement onActivityResult(int, int, Intent). If they do, then for
safety use small request codes, and call super.onActivityResult(int, int, Intent) when you get an unknown
code.

Author:
Ian Cameron Smith

Nested Class Summary


static class MainActivity.ActivityListener
This interface defines a listener for sub-activity results.

Constructor Summary
MainActivity()

Method Summary
void createEulaBox(int title, int text, int close)
Create a dialog for showing the EULA, or other warnings / disclaimers.
void createMessageBox(int close)
Deprecated. The message box is now created automatically.
protected onActivityResult(int requestCode, int resultCode, Intent data)
void
Called when an activity you launched exits, giving you the requestCode you started it
with, the resultCode it returned, and any additional data from it.
protected onCreate(Bundle icicle)
void
Called when the activity is starting.
void reportException(java.lang.Exception e)
Report an unexpected exception to the user by popping up a dialog with some debug
info.

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/core/MainActivity.html[2/19/2011 9:11:02 AM]


MainActivity

void setAboutInfo(int about)


Set up the about info for dialogs.
void setHomeInfo(int link)
Set up the homepage info for dialogs.
void setHomeInfo(int button, int link)
Deprecated.
void setLicenseInfo(int link)
Set up the license info for dialogs.
void setLicenseInfo(int button, int link)
Deprecated.
void showAbout()
Show an about dialog.
void showEula()
Show the EULA dialog unconditionally.
void showFirstEula()
Show the EULA dialog if this is the first program run.
void startActivityForResult(Intent intent, MainActivity.ActivityListener listener)
Launch an activity for which you would like a result when it finished.

Methods inherited from class java.lang.Object


clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
MainActivity
public MainActivity()

Method Detail
onCreate
protected void onCreate(Bundle icicle)

Called when the activity is starting. This is where most initialisation should go: calling
setContentView(int) to inflate the activity's UI, etc. You can call finish() from within this function, in
which case onDestroy() will be immediately called without any of the rest of the activity lifecycle
executing. Derived classes must call through to the super class's implementation of this method. If
they do not, an exception will be thrown.

Parameters:
icicle - If the activity is being re-initialised after previously being shut down then this Bundle
contains the data it most recently supplied in onSaveInstanceState(Bundle). Note: Otherwise it is
null.

createEulaBox

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/core/MainActivity.html[2/19/2011 9:11:02 AM]


MainActivity

public void createEulaBox(int title,


int text,
int close)

Create a dialog for showing the EULA, or other warnings / disclaimers. When your app starts, call
showFirstEula() to display the dialog the first time your app runs. To display it on demand, call
showEula() .

Parameters:
title - Resource ID of the dialog title.
text - Resource ID of the EULA / warning text.
close - Resource ID of the close button.

showFirstEula
public void showFirstEula()

Show the EULA dialog if this is the first program run. You need to have created the dialog by calling
createEulaBox(int, int, int) .

showEula
public void showEula()

Show the EULA dialog unconditionally. You need to have created the dialog by calling
createEulaBox(int, int, int) .

createMessageBox
@Deprecated
public void createMessageBox(int close)

Deprecated. The message box is now created automatically.

Create a dialog for help / about boxes etc. If you want to display one of those, set up the info in it by
calling setHomeInfo(int, int) , setAboutInfo(int) and setLicenseInfo(int, int) ; then pop up a
dialog by calling showAbout().

Parameters:
close - Resource ID of the close button.

setAboutInfo
public void setAboutInfo(int about)

Set up the about info for dialogs. See showAbout().

Parameters:
about - Resource ID of the about text.

setHomeInfo

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/core/MainActivity.html[2/19/2011 9:11:02 AM]


MainActivity

public void setHomeInfo(int link)

Set up the homepage info for dialogs. See showAbout().

Parameters:
link - Resource ID of the URL the button links to.

setHomeInfo
@Deprecated
public void setHomeInfo(int button,
int link)

Deprecated.

Set up the homepage info for dialogs. See showAbout().

Parameters:
button - Resource ID of the button text.
link - Resource ID of the URL the button links to.

setLicenseInfo
public void setLicenseInfo(int link)

Set up the license info for dialogs. See showAbout().

Parameters:
link - Resource ID of the URL the button links to.

setLicenseInfo
@Deprecated
public void setLicenseInfo(int button,
int link)

Deprecated.

Set up the license info for dialogs. See showAbout().

Parameters:
button - Resource ID of the button text.
link - Resource ID of the URL the button links to.

showAbout
public void showAbout()

Show an about dialog. You need to have configured it by calling setAboutInfo(int), setHomeInfo(int,
int) and setLicenseInfo(int, int) .

reportException

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/core/MainActivity.html[2/19/2011 9:11:02 AM]


MainActivity

public void reportException(java.lang.Exception e)

Report an unexpected exception to the user by popping up a dialog with some debug info. Don't
report the same exception more than twice, and if we get floods of exceptions, just bomb out.

This method may be called from any thread. The reporting will be deferred to the UI thread.

Parameters:
e - The exception.

startActivityForResult
public void startActivityForResult(Intent intent,
MainActivity.ActivityListener listener)

Launch an activity for which you would like a result when it finished. When this activity exits, the
given ActivityListener will be invoked.

Note that this method should only be used with Intent protocols that are defined to return a result. In
other protocols (such as ACTION_MAIN or ACTION_VIEW), you may not get the result when you
expect. As a special case, if you call startActivityForResult() during the initial onCreate() / onResume()
of your activity, then your window will not be displayed until a result is returned back from the started
activity. This method throws ActivityNotFoundException if there was no Activity found to run the given
Intent.

Parameters:
intent - The intent to start.
listener - Listener to invoke when the activity returns.

onActivityResult
protected void onActivityResult(int requestCode,
int resultCode,
Intent data)

Called when an activity you launched exits, giving you the requestCode you started it with, the
resultCode it returned, and any additional data from it. The resultCode will be RESULT_CANCELED if
the activity explicitly returned that, didn't return any result, or crashed during its operation.

Parameters:
requestCode - The integer request code originally supplied to startActivityForResult(), allowing
you to identify who this result came from.
resultCode - The integer result code returned by the child activity through its setResult().
data - Additional data to return to the caller.

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/core/MainActivity.html[2/19/2011 9:11:02 AM]


SplashActivity

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.hermit.android.core

Class SplashActivity
java.lang.Object
Activity
org.hermit.android.core.SplashActivity

public class SplashActivity


extends Activity

An activity which displays a splash screen and then returns to the calling activity.

Field Summary
static java.lang.String EXTRAS_IMAGE_ID
Extras key for the image resource ID.
static java.lang.String EXTRAS_TIME_ID
Extras key for the splash screen display time.

Constructor Summary
SplashActivity()

Method Summary
static void launch(Context context, int image, long time)
Launch a splash screen displaying the given drawable.
void onCreate(Bundle icicle)
Called when the activity is starting.

Methods inherited from class java.lang.Object


clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail
EXTRAS_IMAGE_ID
public static final java.lang.String EXTRAS_IMAGE_ID

Extras key for the image resource ID. The extras data named by this key is an int which specifies the
image to display.

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/core/SplashActivity.html[2/19/2011 9:11:05 AM]


SplashActivity

See Also:
Constant Field Values

EXTRAS_TIME_ID
public static final java.lang.String EXTRAS_TIME_ID

Extras key for the splash screen display time. The extras data named by this key is the time in ms for
which the splash screen should be displayed.

See Also:
Constant Field Values

Constructor Detail
SplashActivity
public SplashActivity()

Method Detail
onCreate
public void onCreate(Bundle icicle)

Called when the activity is starting. This is where most initialization should go: calling
setContentView(int) to inflate the activity's UI, etc.

Parameters:
icicle - Saved application state, if any.

launch
public static void launch(Context context,
int image,
long time)

Launch a splash screen displaying the given drawable.

Parameters:
context - Application context we're running in.
image - Resource ID of the image to display.
time - Time in ms for which the splash screen should be visible.

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/core/SplashActivity.html[2/19/2011 9:11:05 AM]


YesNoDialog

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.hermit.android.notice

Class YesNoDialog
java.lang.Object
AlertDialog
org.hermit.android.notice.YesNoDialog

public class YesNoDialog


extends AlertDialog

This class implements a popup dialog box (a subclass of AlertDialog) which can be used to display a yes /
no question.

Nested Class Summary


static interface YesNoDialog.OnOkListener
Listener invoked when the user clicks the OK button.

Constructor Summary
YesNoDialog(Context parent, java.lang.CharSequence okBut, java.lang.CharSequence cancelBut)
Create an error dialog.
YesNoDialog(Context parent, int okBut, int cancelBut)
Create an error dialog.

Method Summary
void setOnOkListener(YesNoDialog.OnOkListener listener)
Set a listener for the dialog.
void show(java.lang.CharSequence title, java.lang.CharSequence text)
Start the dialog and display it on screen.
void show(int title, int text)
Start the dialog and display it on screen.

Methods inherited from class java.lang.Object


clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
YesNoDialog
public YesNoDialog(Context parent,
int okBut,

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/notice/YesNoDialog.html[2/19/2011 9:11:07 AM]


YesNoDialog

int cancelBut)

Create an error dialog.

Parameters:
parent - Parent application context.
okBut - The resource ID of the text for the OK button.
cancelBut - The resource ID of the text for the cancel button.

YesNoDialog
public YesNoDialog(Context parent,
java.lang.CharSequence okBut,
java.lang.CharSequence cancelBut)

Create an error dialog.

Parameters:
parent - Parent application context.
okBut - The text for the OK button.
cancelBut - The text for the cancel button.

Method Detail
setOnOkListener
public void setOnOkListener(YesNoDialog.OnOkListener listener)

Set a listener for the dialog.

Parameters:
listener - The listener to set.

show
public void show(int title,
int text)

Start the dialog and display it on screen. The window is placed in the application layer and opaque.

Parameters:
title - Title for the dialog.
text - Input prompt to display in the dialog.

show
public void show(java.lang.CharSequence title,
java.lang.CharSequence text)

Start the dialog and display it on screen. The window is placed in the application layer and opaque.

Parameters:
title - Title for the dialog.
text - Input prompt to display in the dialog.

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/notice/YesNoDialog.html[2/19/2011 9:11:07 AM]


YesNoDialog

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/notice/YesNoDialog.html[2/19/2011 9:11:07 AM]


ErrorDialog

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.hermit.android.notice

Class ErrorDialog
java.lang.Object
AlertDialog
org.hermit.android.notice.ErrorDialog

public class ErrorDialog


extends AlertDialog

This class implements a popup error box (a subclass of AlertDialog) which can be used to display an error
message.

Constructor Summary
ErrorDialog(Context parent, java.lang.CharSequence button)
Create an error dialog.
ErrorDialog(Context parent, int button)
Create an error dialog.

Method Summary
void show(java.lang.String text)
Start the dialog and display it on screen.
void show(java.lang.String title, java.lang.String text)
Start the dialog and display it on screen.

Methods inherited from class java.lang.Object


clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
ErrorDialog
public ErrorDialog(Context parent,
int button)

Create an error dialog.

Parameters:
parent - Parent application context.
button - The resource ID of the text for the OK button.

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/notice/ErrorDialog.html[2/19/2011 9:11:09 AM]


ErrorDialog

ErrorDialog
public ErrorDialog(Context parent,
java.lang.CharSequence button)

Create an error dialog.

Parameters:
parent - Parent application context.
button - The text for the OK button.

Method Detail
show
public void show(java.lang.String title,
java.lang.String text)

Start the dialog and display it on screen. The window is placed in the application layer and opaque.

Parameters:
title - Title for the dialog.
text - Text to display in the dialog.

show
public void show(java.lang.String text)

Start the dialog and display it on screen. The window is placed in the application layer and opaque.

Parameters:
text - Text to display in the dialog.

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/notice/ErrorDialog.html[2/19/2011 9:11:09 AM]


TextInputDialog

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.hermit.android.notice

Class TextInputDialog
java.lang.Object
AlertDialog
org.hermit.android.notice.TextInputDialog

public class TextInputDialog


extends AlertDialog

This class implements a popup input box (a subclass of AlertDialog) which can be used to display a prompt
and read a text string from the user.

Nested Class Summary


static interface TextInputDialog.OnOkListener
Listener invoked when the user clicks the OK button.

Constructor Summary
TextInputDialog(Context parent, java.lang.CharSequence okBut, java.lang.CharSequence cancelBut)
Create an error dialog.
TextInputDialog(Context parent, int okBut, int cancelBut)
Create an error dialog.

Method Summary
void setOnOkListener(TextInputDialog.OnOkListener listener)
Set a listener for the dialog.
void show(int title, int text)
Start the dialog and display it on screen.
void show(int title, int text, java.lang.String dflt)
Start the dialog and display it on screen.
void show(java.lang.String title, java.lang.String text)
Start the dialog and display it on screen.
void show(java.lang.String title, java.lang.String text, java.lang.String dflt)
Start the dialog and display it on screen.

Methods inherited from class java.lang.Object


clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/notice/TextInputDialog.html[2/19/2011 9:11:10 AM]


TextInputDialog

TextInputDialog
public TextInputDialog(Context parent,
int okBut,
int cancelBut)

Create an error dialog.

Parameters:
parent - Parent application context.
okBut - The resource ID of the text for the OK button.
cancelBut - The resource ID of the text for the cancel button.

TextInputDialog
public TextInputDialog(Context parent,
java.lang.CharSequence okBut,
java.lang.CharSequence cancelBut)

Create an error dialog.

Parameters:
parent - Parent application context.
okBut - The text for the OK button.
cancelBut - The text for the cancel button.

Method Detail
setOnOkListener
public void setOnOkListener(TextInputDialog.OnOkListener listener)

Set a listener for the dialog.

Parameters:
listener - The listener to set.

show
public void show(int title,
int text)

Start the dialog and display it on screen. The window is placed in the application layer and opaque.

Parameters:
title - Title for the dialog.
text - Input prompt to display in the dialog.

show
public void show(int title,
int text,
java.lang.String dflt)

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/notice/TextInputDialog.html[2/19/2011 9:11:10 AM]


TextInputDialog

Start the dialog and display it on screen. The window is placed in the application layer and opaque.

Parameters:
title - Title for the dialog.
text - Input prompt to display in the dialog.
dflt - Default text to display in the input field.

show
public void show(java.lang.String title,
java.lang.String text)

Start the dialog and display it on screen. The window is placed in the application layer and opaque.

Parameters:
title - Title for the dialog.
text - Input prompt to display in the dialog.

show
public void show(java.lang.String title,
java.lang.String text,
java.lang.String dflt)

Start the dialog and display it on screen. The window is placed in the application layer and opaque.

Parameters:
title - Title for the dialog.
text - Input prompt to display in the dialog.
dflt - Default text to display in the input field.

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/notice/TextInputDialog.html[2/19/2011 9:11:10 AM]


CachedFile.Entry

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.hermit.android.net

Class CachedFile.Entry
java.lang.Object
org.hermit.android.net.CachedFile.Entry

Enclosing class:
CachedFile

public static final class CachedFile.Entry


extends java.lang.Object

Class describing an entry in the cache; i.e. a cached file.

Field Summary
long date
The last modified time of the file, as reported by the server, in ms UTC.
java.lang.String name
The local name of the file.
java.io.File path
The path of the local copy of the file.
java.net.URL url
The URL of the file that was loaded.

Method Summary
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail
url
public final java.net.URL url

The URL of the file that was loaded.

name
public java.lang.String name

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/net/CachedFile.Entry.html[2/19/2011 9:11:11 AM]


CachedFile.Entry

The local name of the file.

path
public java.io.File path

The path of the local copy of the file.

date
public long date

The last modified time of the file, as reported by the server, in ms UTC.

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/net/CachedFile.Entry.html[2/19/2011 9:11:11 AM]


TableProvider

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.hermit.android.provider

Class TableProvider
java.lang.Object
ContentProvider
org.hermit.android.provider.TableProvider

public class TableProvider


extends ContentProvider

This class is a base for content providers which provide access to table-organized data in an SQL database.

Typically, this is used by creating a subclass which is empty other than providing an appropriate schema to
this class's constructor. The bulk of the work in creating a content provider is in creating the schema, a
subclass of DbSchema .

Constructor Summary
TableProvider(DbSchema schema)
Create an instance of this content provider.

Method Summary
int delete(Uri uri, java.lang.String where, java.lang.String[] whereArgs)
A request to delete one or more rows.
protected
DatabaseHelper getHelper()
Get the database helper which this content provider will use.
protected getSchema()
DbSchema
Get the database schema.
protected
TableSchema getTableSchema(java.lang.String name)
Get the schema for a specified table.
java.lang.String getType(Uri uri)
Return the MIME type of the data at the given URI.
Uri insert(Uri uri, ContentValues initValues)
Implement this to insert a new row.
boolean onCreate()
Called when the provider is being started.
protected void onInsert(Uri uri, TableSchema table, ContentValues initValues)
This method is called prior to processing an insert; it is called after
TableSchema.onInsert(ContentValues) .
Cursor query(Uri uri, java.lang.String[] projection, java.lang.String where,
java.lang.String[] whereArgs, java.lang.String sortOrder)
Receives a query request from a client in a local process, and returns a Cursor.
protected Cursor queryItem(TableSchema t, java.lang.String[] projection, long id)

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/provider/TableProvider.html[2/19/2011 9:11:14 AM]


TableProvider

Query for a specified item within a table.


protected Cursor queryItem(TableSchema t, java.lang.String[] projection, java.lang.String id)
Query for a specified item within a table.
protected Cursor queryItems(TableSchema t, java.lang.String[] projection, java.lang.String where,
java.lang.String[] whereArgs, java.lang.String sortOrder)
Query for items within a table.
int update(Uri uri, ContentValues values, java.lang.String where,
java.lang.String[] whereArgs)
Update a content URI.

Methods inherited from class java.lang.Object


clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
TableProvider
public TableProvider(DbSchema schema)

Create an instance of this content provider.

Parameters:
schema - Structure defining the database schema.

Method Detail
onCreate
public boolean onCreate()

Called when the provider is being started.

Returns:
true if the provider was successfully loaded, false otherwise.

getSchema
protected DbSchema getSchema()

Get the database schema.

Returns:
The schema for this database.

getTableSchema
protected TableSchema getTableSchema(java.lang.String name)
throws java.lang.IllegalArgumentException

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/provider/TableProvider.html[2/19/2011 9:11:14 AM]


TableProvider

Get the schema for a specified table.

Parameters:
name - The name of the table we want.
Returns:
The schema for the given table.
Throws:
java.lang.IllegalArgumentException - No such table.

getHelper
protected DatabaseHelper getHelper()

Get the database helper which this content provider will use.

Subclasses may override this to provide a smarter database helper; for example, to implement a
smarter database upgrade process. See DatabaseHelper .

Returns:
A database helper for this content provider.

getType
public java.lang.String getType(Uri uri)

Return the MIME type of the data at the given URI. This should start with vnd.android.cursor.item/ for
a single record, or vnd.android.cursor.dir/ for multiple items.

Parameters:
uri - The URI to query.
Returns:
MIME type string for the given URI, or null if there is no type.

query
public Cursor query(Uri uri,
java.lang.String[] projection,
java.lang.String where,
java.lang.String[] whereArgs,
java.lang.String sortOrder)

Receives a query request from a client in a local process, and returns a Cursor. This is called internally
by the ContentResolver.

Parameters:
uri - The URI to query. This will be the full URI sent by the client; if the client is requesting a
specific record, the URI will end in a record number that the implementation should parse and
add to a WHERE or HAVING clause, specifying that _id value.
projection - The list of columns to put into the cursor. If null all columns are included.
where - A selection criteria to apply when filtering rows. If null then all rows are included.
whereArgs - You may include ?s in selection, which will be replaced by the values from
selectionArgs, in order that they appear in the selection. The values will be bound as Strings.
sortOrder - How the rows in the cursor should be sorted. If null then the provider is free to
define the sort order.

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/provider/TableProvider.html[2/19/2011 9:11:14 AM]


TableProvider

Returns:
A Cursor or null.

queryItem
protected Cursor queryItem(TableSchema t,
java.lang.String[] projection,
long id)

Query for a specified item within a table.

Parameters:
t - The schema for the table to query.
projection - The list of columns to put into the cursor. If null all columns are included.
id - The ID of the item we want.
Returns:
A Cursor or null.

queryItem
protected Cursor queryItem(TableSchema t,
java.lang.String[] projection,
java.lang.String id)

Query for a specified item within a table.

Parameters:
t - The schema for the table to query.
projection - The list of columns to put into the cursor. If null all columns are included.
id - The ID of the item we want, as a String.
Returns:
A Cursor or null.

queryItems
protected Cursor queryItems(TableSchema t,
java.lang.String[] projection,
java.lang.String where,
java.lang.String[] whereArgs,
java.lang.String sortOrder)

Query for items within a table.

Parameters:
t - The schema for the table to query.
projection - The list of columns to put into the cursor. If null all columns are included.
where - A selection criteria to apply when filtering rows. If null then all rows are included.
whereArgs - You may include ?s in selection, which will be replaced by the values from
selectionArgs, in order that they appear in the selection. The values will be bound as Strings.
sortOrder - How the rows in the cursor should be sorted. If null then the provider is free to
define the sort order.
Returns:
A Cursor or null.

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/provider/TableProvider.html[2/19/2011 9:11:14 AM]


TableProvider

onInsert
protected void onInsert(Uri uri,
TableSchema table,
ContentValues initValues)

This method is called prior to processing an insert; it is called after


TableSchema.onInsert(ContentValues) . Subclasses can use this to carry out additional processing.

Parameters:
uri - The content:// URI of the insertion request.
table - The schema of the table we're inserting into.
initValues - A set of column_name/value pairs to add to the database.

insert
public Uri insert(Uri uri,
ContentValues initValues)

Implement this to insert a new row. As a courtesy, call notifyChange() after inserting.

Parameters:
uri - The content:// URI of the insertion request.
initValues - A set of column_name/value pairs to add to the database.
Returns:
The URI for the newly inserted item.

delete
public int delete(Uri uri,
java.lang.String where,
java.lang.String[] whereArgs)

A request to delete one or more rows. The selection clause is applied when performing the deletion,
allowing the operation to affect multiple rows in a directory. As a courtesy, call notifyDelete() after
deleting. The implementation is responsible for parsing out a row ID at the end of the URI, if a
specific row is being deleted. That is, the client would pass in content://contacts/people/22 and the
implementation is responsible for parsing the record number (22) when creating an SQL statement.

Parameters:
uri - The full URI to delete, including a row ID (if a specific record is to be deleted).
where - An optional restriction to apply to rows when deleting.
whereArgs - You may include ?s in where, which will be replaced by the values from whereArgs.
Returns:
The number of rows affected.
Throws:
SQLException - Database error.

update
public int update(Uri uri,
ContentValues values,
java.lang.String where,
java.lang.String[] whereArgs)

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/provider/TableProvider.html[2/19/2011 9:11:14 AM]


TableProvider

Update a content URI. All rows matching the optionally provided selection will have their columns
listed as the keys in the values map with the values of those keys. As a courtesy, call notifyChange()
after updating.

Parameters:
uri - The URI to update. This can potentially have a record ID if this is an update request for a
specific record.
values - A Bundle mapping from column names to new column values (NULL is a valid value).
where - An optional restriction to apply to rows when updating.
whereArgs - You may include ?s in where, which will be replaced by the values from whereArgs.
Returns:
The number of rows affected.

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/provider/TableProvider.html[2/19/2011 9:11:14 AM]


DbSchema

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.hermit.android.provider

Class DbSchema
java.lang.Object
org.hermit.android.provider.DbSchema

public abstract class DbSchema


extends java.lang.Object

Class encapsulating the schema for a content provider. Applications must subclass this, and provide the
necessary information in the call to this base class's constructor.

An application's subclass will typically provide the following:

Inner classes which are subclasses of TableSchema, defining the schemas of the individual tables.
A constructor which calls this class's constructor, passing the required information.

Constructor Summary
protected DbSchema(java.lang.String name, int version, java.lang.String auth,
TableSchema[] tables)
Create a database schema instance.

Method Summary
java.lang.String getDbName()
Get the database name.
int getDbVersion()
Get the database version number.
protected
TableSchema getTable(java.lang.String name)
Get the schema for a specified table.

Methods inherited from class java.lang.Object


clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
DbSchema
protected DbSchema(java.lang.String name,
int version,
java.lang.String auth,
TableSchema[] tables)

Create a database schema instance.

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/provider/DbSchema.html[2/19/2011 9:11:16 AM]


DbSchema

Parameters:
name - Name for the database; e.g. "passages".
version - Version number of the database. The upgrade process will be run when this
increments.
auth - Authority name for this content provider; e.g. "org.hermit.provider.PassageData".
tables - List of table schemas.

Method Detail
getDbName
public java.lang.String getDbName()

Get the database name.

Returns:
The name of the database.

getDbVersion
public int getDbVersion()

Get the database version number.

Returns:
The database version number.

getTable
protected TableSchema getTable(java.lang.String name)
throws java.lang.IllegalArgumentException

Get the schema for a specified table.

Parameters:
name - The name of the table we want.
Returns:
The schema for the given table.
Throws:
java.lang.IllegalArgumentException - No such table.

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/provider/DbSchema.html[2/19/2011 9:11:16 AM]


InfoBox

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.hermit.android.notice

Class InfoBox
java.lang.Object
Dialog
org.hermit.android.notice.InfoBox

public class InfoBox


extends Dialog

This class implements a popup info box (a subclass of Dialog) which can be used to display help text, about
info, license info, etc.

Field Summary
static int BUTTON_1
Select configurable button 1 -- the middle button.
static int BUTTON_2
Select configurable button 2 -- the middle button.

Constructor Summary
InfoBox(Activity parent)
Create an info box with a "close" button.
InfoBox(Activity parent, int button)
Create an info box.

Method Summary
protected linkButtonPressed(int which)
void
Called when a link button is clicked.
protected okButtonPressed()
void
Called when the OK button is clicked.
void setLinkButton(int which, int label, int link)
Set a link button on this dialog.
void setSubtitle(int textId)
Set the subtitle for the about box.
void setSubtitle(java.lang.String text)
Set the subtitle for the about box.
void show(int text)
Start the dialog and display it on screen.
void show(int title, int text)
Start the dialog and display it on screen.

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/notice/InfoBox.html[2/19/2011 9:11:18 AM]


InfoBox

void show(java.lang.String text)


Start the dialog and display it on screen.

Methods inherited from class java.lang.Object


clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail
BUTTON_1
public static final int BUTTON_1

Select configurable button 1 -- the middle button.

See Also:
Constant Field Values

BUTTON_2
public static final int BUTTON_2

Select configurable button 2 -- the middle button.

See Also:
Constant Field Values

Constructor Detail
InfoBox
public InfoBox(Activity parent)

Create an info box with a "close" button.

Parameters:
parent - Parent application context.

InfoBox
public InfoBox(Activity parent,
int button)

Create an info box.

Parameters:
parent - Parent application context.
button - Resource ID of the text for the OK button.

Method Detail

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/notice/InfoBox.html[2/19/2011 9:11:18 AM]


InfoBox

setLinkButton
public void setLinkButton(int which,
int label,
int link)

Set a link button on this dialog. These are buttons that the user can click to open a URL, e.g. the
project page, license, etc.

Parameters:
which - Which button to set: BUTTON_1 or BUTTON_2.
label - The button label as a resource ID.
link - Resource ID of the URL for the button.

setSubtitle
public void setSubtitle(int textId)

Set the subtitle for the about box.

Parameters:
textId - ID of the subtitle to display; if 0, don't show one.

setSubtitle
public void setSubtitle(java.lang.String text)

Set the subtitle for the about box.

Parameters:
text - Subtitle to display; if null, don't show one.

show
public void show(int title,
int text)

Start the dialog and display it on screen. The window is placed in the application layer and opaque.

Parameters:
title - Title for the dialog.
text - Text to display in the dialog.

show
public void show(int text)

Start the dialog and display it on screen. The window is placed in the application layer and opaque.

Parameters:
text - Text to display in the dialog.

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/notice/InfoBox.html[2/19/2011 9:11:18 AM]


InfoBox

show
public void show(java.lang.String text)

Start the dialog and display it on screen. The window is placed in the application layer and opaque.

Parameters:
text - Text to display in the dialog.

okButtonPressed
protected void okButtonPressed()

Called when the OK button is clicked.

linkButtonPressed
protected void linkButtonPressed(int which)

Called when a link button is clicked.

Parameters:
which - The ID of the link button which has been clicked, as passed to setLinkButton(int, int,
int) .

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/notice/InfoBox.html[2/19/2011 9:11:18 AM]


LinedEditText

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.hermit.android.widgets

Class LinedEditText
java.lang.Object
EditText
org.hermit.android.widgets.LinedEditText

public class LinedEditText


extends EditText

A custom EditText that draws lines between each line of text that is displayed.

Constructor Summary
LinedEditText(Context context, AttributeSet attrs)
Construct a widget from a given attribute set.

Method Summary
protected onDraw(Canvas canvas)
void
Overridden onDraw method.

Methods inherited from class java.lang.Object


clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
LinedEditText
public LinedEditText(Context context,
AttributeSet attrs)

Construct a widget from a given attribute set. This is required to allow this widget to be used from
XML layouts.

Parameters:
context - Context we're running in.
attrs - Attributes for this widget.

Method Detail
onDraw

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/widgets/LinedEditText.html[2/19/2011 9:11:19 AM]


LinedEditText

protected void onDraw(Canvas canvas)

Overridden onDraw method. Draw the text, with lines.

Parameters:
canvas - Canvas to draw into.

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/widgets/LinedEditText.html[2/19/2011 9:11:19 AM]


Effect

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.hermit.android.sound

Class Effect
java.lang.Object
org.hermit.android.sound.Effect

public class Effect


extends java.lang.Object

Class representing a specific sound effect.

Method Summary
boolean isPlaying()
Determine whether this effect is playing.
void loop()
Start playing this sound effect in a continuous loop.
void play()
Play this sound effect.
void play(float rvol)
Play this sound effect.
void stop()
Stop this sound effect immediately.

Methods inherited from class java.lang.Object


clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail
play
public void play()

Play this sound effect.

play
public void play(float rvol)

Play this sound effect.

Parameters:

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/sound/Effect.html[2/19/2011 9:11:21 AM]


Effect

rvol - Relative volume for this sound, 0 - 1.

loop
public void loop()

Start playing this sound effect in a continuous loop.

stop
public void stop()

Stop this sound effect immediately.

isPlaying
public final boolean isPlaying()

Determine whether this effect is playing.

Returns:
True if this sound effect is playing.

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/sound/Effect.html[2/19/2011 9:11:21 AM]


Errors

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.hermit.android.core

Class Errors
java.lang.Object
org.hermit.android.core.Errors

public class Errors


extends java.lang.Object

Error handling and reporting utilities.

Author:
Ian Cameron Smith

Method Summary
static Errors getInstance(Context context)
Get the single instance of this class for the given Activity, creating it if necessary.
static void reportException(Context context, java.lang.Exception e)
Report an unexpected exception to the user by popping up a dialog with some debug
info.
void reportException(java.lang.Exception e)
Report an unexpected exception to the user by popping up a dialog with some debug
info.

Methods inherited from class java.lang.Object


clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail
getInstance
public static Errors getInstance(Context context)

Get the single instance of this class for the given Activity, creating it if necessary.

Parameters:
context - The Activity for which we want an error reporter.
Returns:
The single instance of this class.

reportException

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/core/Errors.html[2/19/2011 9:11:23 AM]


Errors

public static void reportException(Context context,


java.lang.Exception e)

Report an unexpected exception to the user by popping up a dialog with some debug info. Don't
report the same exception more than twice, and if we get floods of exceptions, just bomb out.

This method may be called from any thread. The reporting will be deferred to the UI thread.

Parameters:
context - The Activity for which we want an error reporter.
e - The exception.

reportException
public void reportException(java.lang.Exception e)

Report an unexpected exception to the user by popping up a dialog with some debug info. Don't
report the same exception more than twice, and if we get floods of exceptions, just bomb out.

This method may be called from any thread. The reporting will be deferred to the UI thread.

Parameters:
e - The exception.

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/core/Errors.html[2/19/2011 9:11:23 AM]


Gauge

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.hermit.android.instruments

Class Gauge
java.lang.Object
org.hermit.android.instruments.Gauge

Direct Known Subclasses:


PowerGauge, SpectrumGauge, TextGauge, WaveformGauge

public class Gauge


extends java.lang.Object

A graphical display which shows some data in a region within a view. The data may come from an
Instrument or some other source.

Configuration
Your gauge will be notified of its geometry by a call to setGeometry(Rect). This is where you should note
your position and size and perform any internal layout you need to do.

Note that if you are running in an app which handles screen configuration changes, setGeometry(Rect) will
be called any time the screen changes size or shape (e.g. on an orientation change). You should be
prepared to handle these subsequent calls by re-creating data structures, re-doing layout, etc., as required.

Data Updating
It is assumed that your gauge has some kind of data source, but how this works is up to you.

Drawing Sequence -- User


A gauge may have a background which is rendered separately from its content, for performance reasons.
Hence, a Gauge user must request the background to be drawn, and then the gauge content to be drawn.
If the caller is going to cache the background, the background need be requested only when the geometry
changes.

There are two options. In the non-caching case, the caller may simply call draw(Canvas, long, boolean) ,
passing true as the last argument. This asks the Gauge to draw its background and its content.

In the caching case, the caller should call drawBackground(Canvas) to ask the gauge to draw its background
into the given canvas. Since the gauge will use the same co-ordinates that it uses to draw to the screen,
the canvas will need to be the size of the screen (or you can translate the co-ordinates). Then, to draw the
gauge, the caller should render the stored background and then call draw(Canvas, long, boolean) .

Drawing Sequence -- Implementor


From the Gauge implementor's point of view, there are two routines to implement:
drawBackgroundBody(Canvas, Paint) drawBody(Canvas, Paint, long)

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/instruments/Gauge.html[2/19/2011 9:11:25 AM]


Gauge

(optional), and .

If your implementation of drawBody(Canvas, Paint, long) draws a complete, opaque rendition of the
gauge, that's all you need; there's no need to provide an implementation of drawBackgroundBody(). But if
your gauge has a separate, persistent background appearance, you may reap a performance benefit by
separating out its drawing. Do this by implementing drawBackgroundBody(Canvas, Paint). This routine
should draw the gauge background at the gauge's configured position in the specified Canvas.

A facility is provided for caching background images. To use this, call cacheBackground() once your layout is
set up -- for example at the end of setGeometry(Rect). At that point, your background will be fetched (by
calling your implementation of drawBackgroundBody()) and stored; then when someone asks us to draw
our background, the request will be satisfied using the stored bitmap, without calling your
drawBackgroundBody() again.

Constructor Summary
Gauge(SurfaceRunner parent)
Set up this view.
Gauge(SurfaceRunner parent, int options)
Set up this view.
Gauge(SurfaceRunner parent, int grid, int plot)
Set up this view.
Gauge(SurfaceRunner parent, int options, int grid, int plot)
Set up this view.

Method Summary
protected void cacheBackground()
Fetch and cache an image of the background now, then use that to draw the
background on future draw requests.
void draw(Canvas canvas, long now, boolean bg)
This method is called to ask the element to draw its dynamic content.
void drawBackground(Canvas canvas)
This method is called to ask the element to draw its static content; i.e.
protected void drawBackgroundBody(Canvas canvas, Paint paint)
Do the subclass-specific parts of drawing the background for this element.
protected void drawBody(Canvas canvas, Paint paint, long now)
Do the subclass-specific parts of drawing for this element.
protected void drawFinish(Canvas canvas, Paint paint, long now)
Wrap up drawing of this element.
protected void drawStart(Canvas canvas, Paint paint, long now)
Do initial parts of drawing for this element.
void error(int error)
An error has occurred.
int getBackgroundColor()
Get the background colour of this element.
static float getBaseTextSize()
Get the base size for text.
Rect getBounds()

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/instruments/Gauge.html[2/19/2011 9:11:25 AM]


Gauge

Get the bounding rect of this Element.


int getGridColor()
Get the data scale / grid colour of this element.
static float getHeadTextSize()
Get the size for header text.
int getHeight()
Get the height of this element -- i.e.
static int getInnerGap()
Get the amount of padding within atoms within an element.
static int getInterPadding()
Get the amount of padding between major elements in a view.
static float getMiniTextSize()
Get the size for mini text.
protected getPaint()
Paint
Get this element's Paint.
int getPlotColor()
Get the data plot colour of this element.
int getPreferredHeight()
Get the minimum preferred height for this atom.
int getPreferredWidth()
Get the minimum preferred width for this atom.
static int getSidebarWidth()
Get the sidebar width.
protected
SurfaceRunner getSurface()
Get the app context of this Element.
static float getTextScaleX()
Get the base size for text based on this screen's size.
static Typeface getTextTypeface()
Get the default font for all text.
static float getTinyTextSize()
Get the size for tiny text based on this screen's size.
int getWidth()
Get the width of this element -- i.e.
boolean haveBounds()
Determine whether we have the bounding rect of this Element.
protected void initializePaint(Paint paint)
Set up the paint for this element.
boolean optionSet(int option)
Check whether the given option flag is set on this surface.
void setBackgroundColor(int col)
Set the background colour of this element.
static void setBaseTextSize(float size)
Set the base size for text.
void setDataColors(int grid, int plot)
Set the plot colours of this element.
void setGeometry(Rect bounds)

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/instruments/Gauge.html[2/19/2011 9:11:25 AM]


Gauge

This is called during layout when the size of this element has changed.
void setGridColor(int grid)
Set the data scale / grid colour of this element.
static void setHeadTextSize(float size)
Set the size for header text.
static void setInnerGap(int gap)
Set the amount of padding within atoms within an element.
static void setInterPadding(int pad)
Set the amount of padding between major elements in a view.
static void setMiniTextSize(float size)
Set the size for mini text.
void setPlotColor(int plot)
Set the data plot colour of this element.
static void setSidebarWidth(int width)
Set the sidebar width.
static void setTextScaleX(float scale)
Set the horizontal scaling of the font; this can be used to produce a tall, thin font.
static void setTextTypeface(Typeface face)
Set the default font for all text.
static void setTinyTextSize(float size)
Set the size for tiny text.

Methods inherited from class java.lang.Object


clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
Gauge
public Gauge(SurfaceRunner parent)

Set up this view.

Parameters:
parent - Parent surface.

Gauge
public Gauge(SurfaceRunner parent,
int options)

Set up this view.

Parameters:
parent - Parent surface.
options - Options for this SurfaceRunner. A bitwise OR of GAUGE_XXX constants.

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/instruments/Gauge.html[2/19/2011 9:11:25 AM]


Gauge

Gauge
public Gauge(SurfaceRunner parent,
int grid,
int plot)

Set up this view.

Parameters:
parent - Parent surface.
grid - Colour for drawing a data scale / grid.
plot - Colour for drawing data plots.

Gauge
public Gauge(SurfaceRunner parent,
int options,
int grid,
int plot)

Set up this view.

Parameters:
parent - Parent surface.
options - Options for this SurfaceRunner. A bitwise OR of GAUGE_XXX constants.
grid - Colour for drawing a data scale / grid.
plot - Colour for drawing data plots.

Method Detail
initializePaint
protected void initializePaint(Paint paint)

Set up the paint for this element. This is called during initialization. Subclasses can override this to do
class-specific one-time initialization.

Parameters:
paint - The paint to initialize.

optionSet
public boolean optionSet(int option)

Check whether the given option flag is set on this surface.

Parameters:
option - The option flag to test; one of GAUGE_XXX.
Returns:
true iff the option is set.

setTextTypeface

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/instruments/Gauge.html[2/19/2011 9:11:25 AM]


Gauge

public static void setTextTypeface(Typeface face)

Set the default font for all text.

Parameters:
face - The default font for all text.

getTextTypeface
public static Typeface getTextTypeface()

Get the default font for all text.

Returns:
The default font for all text.

setBaseTextSize
public static void setBaseTextSize(float size)

Set the base size for text.

Parameters:
size - Base text size for the app.

getBaseTextSize
public static float getBaseTextSize()

Get the base size for text.

Returns:
Base text size for the app.

setHeadTextSize
public static void setHeadTextSize(float size)

Set the size for header text.

Parameters:
size - Header text size for the app.

getHeadTextSize
public static float getHeadTextSize()

Get the size for header text.

Returns:
Header text size for the app.

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/instruments/Gauge.html[2/19/2011 9:11:25 AM]


Gauge

setMiniTextSize
public static void setMiniTextSize(float size)

Set the size for mini text.

Parameters:
size - Mini text size for the app.

getMiniTextSize
public static float getMiniTextSize()

Get the size for mini text.

Returns:
Mini text size for the app.

setTinyTextSize
public static void setTinyTextSize(float size)

Set the size for tiny text.

Parameters:
size - Tiny text size for the app.

getTinyTextSize
public static float getTinyTextSize()

Get the size for tiny text based on this screen's size.

Returns:
Tiny text size for the app.

setTextScaleX
public static void setTextScaleX(float scale)

Set the horizontal scaling of the font; this can be used to produce a tall, thin font.

Parameters:
scale - Horizontal scaling of the font.

getTextScaleX
public static float getTextScaleX()

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/instruments/Gauge.html[2/19/2011 9:11:25 AM]


Gauge

Get the base size for text based on this screen's size.

Returns:
Horizontal scaling of the font.

setSidebarWidth
public static void setSidebarWidth(int width)

Set the sidebar width.

Parameters:
width - The sidebar width.

getSidebarWidth
public static int getSidebarWidth()

Get the sidebar width.

Returns:
The sidebar width.

setInterPadding
public static void setInterPadding(int pad)

Set the amount of padding between major elements in a view.

Parameters:
pad - The amount of padding between major elements in a view.

getInterPadding
public static int getInterPadding()

Get the amount of padding between major elements in a view.

Returns:
The amount of padding between major elements in a view.

setInnerGap
public static void setInnerGap(int gap)

Set the amount of padding within atoms within an element. Specifically the small gaps in side bars.

Parameters:
gap - The amount of padding within atoms within an element

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/instruments/Gauge.html[2/19/2011 9:11:25 AM]


Gauge

getInnerGap
public static int getInnerGap()

Get the amount of padding within atoms within an element. Specifically the small gaps in side bars.

Returns:
The amount of padding within atoms within an element

setGeometry
public void setGeometry(Rect bounds)

This is called during layout when the size of this element has changed. This is where we first discover
our size, so set our geometry to match.

Parameters:
bounds - The bounding rect of this element within its parent View.

cacheBackground
protected void cacheBackground()

Fetch and cache an image of the background now, then use that to draw the background on future
draw requests. The cached image is invalidated the next time the geometry changes.

Implementations should call this method once their layout is set -- for example at the end of
setGeometry(Rect) -- if they have a significant static background that they wish to have cached.

getPreferredWidth
public int getPreferredWidth()

Get the minimum preferred width for this atom.

Returns:
The minimum preferred width for this atom. Returns zero if we don't know yet.

getPreferredHeight
public int getPreferredHeight()

Get the minimum preferred height for this atom.

Returns:
The minimum preferred height for this atom. Returns zero if we don't know yet.

haveBounds
public final boolean haveBounds()

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/instruments/Gauge.html[2/19/2011 9:11:25 AM]


Gauge

Determine whether we have the bounding rect of this Element.

Returns:
True if our geometry has been set up.

getBounds
public final Rect getBounds()

Get the bounding rect of this Element.

Returns:
The bounding rect of this element within its parent View. This will be 0, 0, 0, 0 if setGeometry()
has not been called yet.

getWidth
public final int getWidth()

Get the width of this element -- i.e. the current configured width.

Returns:
The width of this element within its parent View. This will be 0 if setGeometry() has not been
called yet.

getHeight
public final int getHeight()

Get the height of this element -- i.e. the current configured height.

Returns:
The height of this element within its parent View. This will be 0 if setGeometry() has not been
called yet.

setBackgroundColor
public void setBackgroundColor(int col)

Set the background colour of this element.

Parameters:
col - The new background colour, in ARGB format.

getBackgroundColor
public int getBackgroundColor()

Get the background colour of this element.

Returns:

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/instruments/Gauge.html[2/19/2011 9:11:25 AM]


Gauge

The background colour, in ARGB format.

setDataColors
public void setDataColors(int grid,
int plot)

Set the plot colours of this element.

Parameters:
grid - Colour for drawing a data scale / grid.
plot - Colour for drawing data plots.

setGridColor
public void setGridColor(int grid)

Set the data scale / grid colour of this element.

Parameters:
grid - Colour for drawing a data scale / grid.

setPlotColor
public void setPlotColor(int plot)

Set the data plot colour of this element.

Parameters:
plot - Colour for drawing a data plot.

getGridColor
public int getGridColor()

Get the data scale / grid colour of this element.

Returns:
Colour for drawing a data scale / grid.

getPlotColor
public int getPlotColor()

Get the data plot colour of this element.

Returns:
Colour for drawing data plots.

error

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/instruments/Gauge.html[2/19/2011 9:11:25 AM]


Gauge

public void error(int error)

An error has occurred. Notify the user somehow.

Subclasses can override this to do something neat.

Parameters:
error - ERR_XXX code describing the error.

getPaint
protected Paint getPaint()

Get this element's Paint.

Returns:
The Paint which was set up in initializePaint().

drawBackground
public void drawBackground(Canvas canvas)

This method is called to ask the element to draw its static content; i.e. the background / chrome.

Parameters:
canvas - Canvas to draw into.

drawBackgroundBody
protected void drawBackgroundBody(Canvas canvas,
Paint paint)

Do the subclass-specific parts of drawing the background for this element. Subclasses should override
this if they have significant background content which they would like to draw once only. Whatever is
drawn here will be saved in a bitmap, which will be rendered to the screen before the dynamic
content is drawn.

Obviously, if implementing this method, don't clear the screen when drawing the dynamic part.

Parameters:
canvas - Canvas to draw into.
paint - The Paint which was set up in initializePaint().

draw
public void draw(Canvas canvas,
long now,
boolean bg)

This method is called to ask the element to draw its dynamic content.

Parameters:
canvas

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/instruments/Gauge.html[2/19/2011 9:11:25 AM]


Gauge

- Canvas to draw into.


now - Nominal system time in ms. of this update.
bg - Iff true, tell the gauge to draw its background first. This is cheaper than calling
drawBackground(Canvas) before this method.

drawStart
protected void drawStart(Canvas canvas,
Paint paint,
long now)

Do initial parts of drawing for this element.

Parameters:
canvas - Canvas to draw into.
paint - The Paint which was set up in initializePaint().
now - Nominal system time in ms. of this update.

drawBody
protected void drawBody(Canvas canvas,
Paint paint,
long now)

Do the subclass-specific parts of drawing for this element. Subclasses should override this to do their
drawing.

Parameters:
canvas - Canvas to draw into.
paint - The Paint which was set up in initializePaint().
now - Nominal system time in ms. of this update.

drawFinish
protected void drawFinish(Canvas canvas,
Paint paint,
long now)

Wrap up drawing of this element.

Parameters:
canvas - Canvas to draw into.
paint - The Paint which was set up in initializePaint().
now - Nominal system time in ms. of this update.

getSurface
protected SurfaceRunner getSurface()

Get the app context of this Element.

Returns:
The app context we're running in.

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/instruments/Gauge.html[2/19/2011 9:11:25 AM]


Gauge

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/instruments/Gauge.html[2/19/2011 9:11:25 AM]


PowerGauge

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.hermit.android.instruments

Class PowerGauge
java.lang.Object
org.hermit.android.instruments.Gauge
org.hermit.android.instruments.PowerGauge

public class PowerGauge


extends Gauge

A graphical display which displays the signal power in dB from an AudioAnalyser instrument. This class
cannot be instantiated directly; get an instance by calling AudioAnalyser.getPowerGauge(SurfaceRunner).

Method Summary
protected drawBackgroundBody(Canvas canvas, Paint paint)
void
Do the subclass-specific parts of drawing the background for this element.
protected drawBody(Canvas canvas, Paint paint, long now)
void
Do the subclass-specific parts of drawing for this element.
float getLabelSize()
Get the size for the label text.
void setBarWidth(int width)
Set the overall thickness of the bar.
void setGeometry(Rect bounds)
This is called during layout when the size of this element has changed.
void setLabelSize(float size)
Set the size for the label text.

Methods inherited from class org.hermit.android.instruments.Gauge


cacheBackground, draw, drawBackground, drawFinish, drawStart, error, getBackgroundColor,
getBaseTextSize, getBounds, getGridColor, getHeadTextSize, getHeight, getInnerGap,
getInterPadding, getMiniTextSize, getPaint, getPlotColor, getPreferredHeight, getPreferredWidth,
getSidebarWidth, getSurface, getTextScaleX, getTextTypeface, getTinyTextSize, getWidth,
haveBounds, initializePaint, optionSet, setBackgroundColor, setBaseTextSize, setDataColors,
setGridColor, setHeadTextSize, setInnerGap, setInterPadding, setMiniTextSize, setPlotColor,
setSidebarWidth, setTextScaleX, setTextTypeface, setTinyTextSize

Methods inherited from class java.lang.Object


clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail
setBarWidth

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/instruments/PowerGauge.html[2/19/2011 9:11:28 AM]


PowerGauge

public void setBarWidth(int width)

Set the overall thickness of the bar.

Parameters:
width - Overall width in pixels of the bar.

setLabelSize
public void setLabelSize(float size)

Set the size for the label text.

Parameters:
size - Label text size for the gauge.

getLabelSize
public float getLabelSize()

Get the size for the label text.

Returns:
Label text size for the gauge.

setGeometry
public void setGeometry(Rect bounds)

This is called during layout when the size of this element has changed. This is where we first discover
our size, so set our geometry to match.

Overrides:
setGeometry in class Gauge

Parameters:
bounds - The bounding rect of this element within its parent View.

drawBackgroundBody
protected void drawBackgroundBody(Canvas canvas,
Paint paint)

Do the subclass-specific parts of drawing the background for this element. Subclasses should override
this if they have significant background content which they would like to draw once only. Whatever is
drawn here will be saved in a bitmap, which will be rendered to the screen before the dynamic
content is drawn.

Obviously, if implementing this method, don't clear the screen when drawing the dynamic part.

Overrides:
drawBackgroundBody in class Gauge

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/instruments/PowerGauge.html[2/19/2011 9:11:28 AM]


PowerGauge

Parameters:
canvas - Canvas to draw into.
paint - The Paint which was set up in initializePaint().

drawBody
protected final void drawBody(Canvas canvas,
Paint paint,
long now)

Do the subclass-specific parts of drawing for this element. This method is called on the thread of the
containing SuraceView.

Subclasses should override this to do their drawing.

Overrides:
drawBody in class Gauge

Parameters:
canvas - Canvas to draw into.
paint - The Paint which was set up in initializePaint().
now - Nominal system time in ms. of this update.

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/instruments/PowerGauge.html[2/19/2011 9:11:28 AM]


SpectrumGauge

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.hermit.android.instruments

Class SpectrumGauge
java.lang.Object
org.hermit.android.instruments.Gauge
org.hermit.android.instruments.SpectrumGauge

public class SpectrumGauge


extends Gauge

A graphical display which displays the audio spectrum from an AudioAnalyser instrument. This class cannot
be instantiated directly; get an instance by calling AudioAnalyser.getSpectrumGauge(SurfaceRunner) .

Method Summary
protected drawBody(Canvas canvas, Paint paint, long now)
void
Do the subclass-specific parts of drawing for this element.
float getLabelSize()
Get the size for the label text.
void setGeometry(Rect bounds)
This is called during layout when the size of this element has changed.
void setLabelSize(float size)
Set the size for the label text.
void setSampleRate(int rate)
Set the sample rate for this instrument.

Methods inherited from class org.hermit.android.instruments.Gauge


cacheBackground, draw, drawBackground, drawBackgroundBody, drawFinish, drawStart, error,
getBackgroundColor, getBaseTextSize, getBounds, getGridColor, getHeadTextSize, getHeight,
getInnerGap, getInterPadding, getMiniTextSize, getPaint, getPlotColor, getPreferredHeight,
getPreferredWidth, getSidebarWidth, getSurface, getTextScaleX, getTextTypeface, getTinyTextSize,
getWidth, haveBounds, initializePaint, optionSet, setBackgroundColor, setBaseTextSize,
setDataColors, setGridColor, setHeadTextSize, setInnerGap, setInterPadding, setMiniTextSize,
setPlotColor, setSidebarWidth, setTextScaleX, setTextTypeface, setTinyTextSize

Methods inherited from class java.lang.Object


clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail
setSampleRate
public void setSampleRate(int rate)

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/instruments/SpectrumGauge.html[2/19/2011 9:11:29 AM]


SpectrumGauge

Set the sample rate for this instrument.

Parameters:
rate - The desired rate, in samples/sec.

setLabelSize
public void setLabelSize(float size)

Set the size for the label text.

Parameters:
size - Label text size for the gauge.

getLabelSize
public float getLabelSize()

Get the size for the label text.

Returns:
Label text size for the gauge.

setGeometry
public void setGeometry(Rect bounds)

This is called during layout when the size of this element has changed. This is where we first discover
our size, so set our geometry to match.

Overrides:
setGeometry in class Gauge

Parameters:
bounds - The bounding rect of this element within its parent View.

drawBody
protected final void drawBody(Canvas canvas,
Paint paint,
long now)

Do the subclass-specific parts of drawing for this element. This method is called on the thread of the
containing SuraceView.

Subclasses should override this to do their drawing.

Overrides:
drawBody in class Gauge

Parameters:
canvas - Canvas to draw into.
paint - The Paint which was set up in initializePaint().

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/instruments/SpectrumGauge.html[2/19/2011 9:11:29 AM]


SpectrumGauge

now - Nominal system time in ms. of this update.

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/instruments/SpectrumGauge.html[2/19/2011 9:11:29 AM]


TextGauge

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.hermit.android.instruments

Class TextGauge
java.lang.Object
org.hermit.android.instruments.Gauge
org.hermit.android.instruments.TextGauge

public class TextGauge


extends Gauge

A Gauge which displays data in textual form, generally as a grid of numeric values.

Constructor Summary
TextGauge(SurfaceRunner parent)
Set up this view, and configure the text fields to be displayed in this element.
TextGauge(SurfaceRunner parent, java.lang.String[] template, int rows)
Set up this view, and configure the text fields to be displayed in this element.

Method Summary
protected drawBody(Canvas canvas, Paint paint, long now)
void
This method is called to ask the element to draw itself.
char[][][] getBuffer()
Get the text buffers for the field values.
int getPreferredHeight()
Get the minimum height needed to fit all the text.
int getPreferredWidth()
Get the minimum width needed to fit all the text.
int getTextColor()
Get the text colour of this element.
float getTextSize()
Get the text size of this element.
protected initializePaint(Paint paint)
void
Set up the paint for this element.
void setGeometry(Rect bounds)
This is called during layout when the size of this element has changed.
void setMargins(int left, int top, int right, int bottom)
Set the margins around the displayed text.
void setTextColor(int col)
Set the text colour of this element.
void setTextFields(java.lang.String[] template, int rows)
Set up the text fields to be displayed in this element.

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/instruments/TextGauge.html[2/19/2011 9:11:31 AM]


TextGauge

void setTextSize(float size)


Set the text size of this element.

Methods inherited from class org.hermit.android.instruments.Gauge


cacheBackground, draw, drawBackground, drawBackgroundBody, drawFinish, drawStart, error,
getBackgroundColor, getBaseTextSize, getBounds, getGridColor, getHeadTextSize, getHeight,
getInnerGap, getInterPadding, getMiniTextSize, getPaint, getPlotColor, getSidebarWidth,
getSurface, getTextScaleX, getTextTypeface, getTinyTextSize, getWidth, haveBounds, optionSet,
setBackgroundColor, setBaseTextSize, setDataColors, setGridColor, setHeadTextSize, setInnerGap,
setInterPadding, setMiniTextSize, setPlotColor, setSidebarWidth, setTextScaleX, setTextTypeface,
setTinyTextSize

Methods inherited from class java.lang.Object


clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
TextGauge
public TextGauge(SurfaceRunner parent)

Set up this view, and configure the text fields to be displayed in this element. This is equivalent to
calling setTextFields() after the basic constructor. We support display of a single field, or a rectangular
table of fields. The caller must call setTextFields(String[] template, int rows) to set the table
format.

Parameters:
parent - Parent surface.

TextGauge
public TextGauge(SurfaceRunner parent,
java.lang.String[] template,
int rows)

Set up this view, and configure the text fields to be displayed in this element. This is equivalent to
calling setTextFields() after the basic constructor. We support display of a single field, or a rectangular
table of fields. The fields are specified by passing in sample text values to be measured; we then
allocate the space automatically.

Parameters:
parent - Parent surface.
template - Strings representing the columns to display. Each one should be a sample piece of
text which will be measured to determine the required space for each column. Must be provided.
rows - Number of rows of text to display.

Method Detail
initializePaint
protected void initializePaint(Paint paint)

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/instruments/TextGauge.html[2/19/2011 9:11:31 AM]


TextGauge

Set up the paint for this element. This is called during initialisation. Subclasses can override this to do
class-specific one-time initialisation.

Overrides:
initializePaint in class Gauge

Parameters:
paint - The paint to initialise.

setGeometry
public void setGeometry(Rect bounds)

This is called during layout when the size of this element has changed. This is where we first discover
our size, so set our geometry to match.

Overrides:
setGeometry in class Gauge

Parameters:
bounds - The bounding rect of this element within its parent View.

setMargins
public void setMargins(int left,
int top,
int right,
int bottom)

Set the margins around the displayed text. This the total space between the edges of the element and
the outside bounds of the text.

Parameters:
left - The left margin.
top - The top margin.
right - The right margin.
bottom - The bottom margin.

setTextFields
public void setTextFields(java.lang.String[] template,
int rows)

Set up the text fields to be displayed in this element. If this is never called, there will be no text. We
support display of a single field, or a rectangular table of fields. The fields are specified by passing in
sample text values to be measured; we then allocate the space automatically. This must be called
before setText() can be called.

Parameters:
template - Strings representing the columns to display. Each one should be a sample piece of
text which will be measured to determine the required space for each column.
rows - Number of rows of text to display.

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/instruments/TextGauge.html[2/19/2011 9:11:31 AM]


TextGauge

getBuffer
public char[][][] getBuffer()

Get the text buffers for the field values. The caller can change a field's content by writing to the
appropriate member of the array, as in "buffer[row][col][0] = 'X';".

Returns:
Text buffers for the field values.

getPreferredWidth
public int getPreferredWidth()

Get the minimum width needed to fit all the text.

Overrides:
getPreferredWidth in class Gauge

Returns:
The minimum width needed to fit all the text. Returns zero if setTextFields() hasn't been called.

getPreferredHeight
public int getPreferredHeight()

Get the minimum height needed to fit all the text.

Overrides:
getPreferredHeight in class Gauge

Returns:
The minimum height needed to fit all the text. Returns zero if setTextFields() hasn't been called.

setTextColor
public void setTextColor(int col)

Set the text colour of this element.

Parameters:
col - The new text colour, in ARGB format.

getTextColor
public int getTextColor()

Get the text colour of this element.

Returns:
The text colour, in ARGB format.

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/instruments/TextGauge.html[2/19/2011 9:11:31 AM]


TextGauge

setTextSize
public void setTextSize(float size)

Set the text size of this element.

Parameters:
size - The new text size.

getTextSize
public float getTextSize()

Get the text size of this element.

Returns:
The text size.

drawBody
protected void drawBody(Canvas canvas,
Paint paint,
long now)

This method is called to ask the element to draw itself.

Overrides:
drawBody in class Gauge

Parameters:
canvas - Canvas to draw into.
paint - The Paint which was set up in initializePaint().
now - Nominal system time in ms. of this update.

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/instruments/TextGauge.html[2/19/2011 9:11:31 AM]


WaveformGauge

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.hermit.android.instruments

Class WaveformGauge
java.lang.Object
org.hermit.android.instruments.Gauge
org.hermit.android.instruments.WaveformGauge

public class WaveformGauge


extends Gauge

A graphical display which displays the audio waveform from an AudioAnalyser instrument. This class cannot
be instantiated directly; get an instance by calling AudioAnalyser.getWaveformGauge(SurfaceRunner) .

Method Summary
protected drawBody(Canvas canvas, Paint paint, long now)
void
Do the subclass-specific parts of drawing for this element.
void setGeometry(Rect bounds)
This is called during layout when the size of this element has changed.

Methods inherited from class org.hermit.android.instruments.Gauge


cacheBackground, draw, drawBackground, drawBackgroundBody, drawFinish, drawStart, error,
getBackgroundColor, getBaseTextSize, getBounds, getGridColor, getHeadTextSize, getHeight,
getInnerGap, getInterPadding, getMiniTextSize, getPaint, getPlotColor, getPreferredHeight,
getPreferredWidth, getSidebarWidth, getSurface, getTextScaleX, getTextTypeface, getTinyTextSize,
getWidth, haveBounds, initializePaint, optionSet, setBackgroundColor, setBaseTextSize,
setDataColors, setGridColor, setHeadTextSize, setInnerGap, setInterPadding, setMiniTextSize,
setPlotColor, setSidebarWidth, setTextScaleX, setTextTypeface, setTinyTextSize

Methods inherited from class java.lang.Object


clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail
setGeometry
public void setGeometry(Rect bounds)

This is called during layout when the size of this element has changed. This is where we first discover
our size, so set our geometry to match.

Overrides:
setGeometry in class Gauge

Parameters:
bounds - The bounding rect of this element within its parent View.

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/instruments/WaveformGauge.html[2/19/2011 9:11:33 AM]


WaveformGauge

drawBody
protected final void drawBody(Canvas canvas,
Paint paint,
long now)

Do the subclass-specific parts of drawing for this element. This method is called on the thread of the
containing SuraceView.

Subclasses should override this to do their drawing.

Overrides:
drawBody in class Gauge

Parameters:
canvas - Canvas to draw into.
paint - The Paint which was set up in initializePaint().
now - Nominal system time in ms. of this update.

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/instruments/WaveformGauge.html[2/19/2011 9:11:33 AM]


MultistateImageButton

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.hermit.android.widgets

Class MultistateImageButton
java.lang.Object
ImageButton
org.hermit.android.widgets.MultistateImageButton

public class MultistateImageButton


extends ImageButton

This class displays an image button which toggles or cycles through multiple states when clicked.

Constructor Summary
MultistateImageButton(Context context, AttributeSet attrs, int[] images)
Create a multistate image button with a specified set of image resource IDs.
MultistateImageButton(Context context, int[] images)
Create a multistate image button with a specified set of image resource IDs.

Method Summary
int getState()
Get the current state of this button.
void setOnClickListener(OnClickListener l)
Register a callback to be invoked when this view is clicked.
void setState(int s)
Set the current state of this button.

Methods inherited from class java.lang.Object


clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
MultistateImageButton
public MultistateImageButton(Context context,
int[] images)

Create a multistate image button with a specified set of image resource IDs.

Parameters:
context - Parent application.
images - Resource IDs of the images to use for each state.

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/widgets/MultistateImageButton.html[2/19/2011 9:11:35 AM]


MultistateImageButton

MultistateImageButton
public MultistateImageButton(Context context,
AttributeSet attrs,
int[] images)

Create a multistate image button with a specified set of image resource IDs.

Parameters:
context - Parent application.
attrs - Layout attributes.
images - Resource IDs of the images to use for each state.

Method Detail
setOnClickListener
public void setOnClickListener(OnClickListener l)

Register a callback to be invoked when this view is clicked. If this view is not clickable, it becomes
clickable. We override this here because we are using the parent class's listener slot for our own
purposes.

Parameters:
l - The callback that will run.

getState
public int getState()

Get the current state of this button.

Returns:
The current state, as an index into the list of images.

setState
public void setState(int s)

Set the current state of this button.

Parameters:
s - State to set, as an index into the list of images.

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/widgets/MultistateImageButton.html[2/19/2011 9:11:35 AM]


TimeZoneActivity

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.hermit.android.widgets

Class TimeZoneActivity
java.lang.Object
ListActivity
org.hermit.android.widgets.TimeZoneActivity

public class TimeZoneActivity


extends ListActivity

This class displays a picker which can be used to select a timezone. Options are provided to add app-
specific zones, such as "local", "nautical", etc.

Constructor Summary
TimeZoneActivity()

Method Summary
protected onCreate(Bundle icicle)
void
Called when the activity is starting.
void onListItemClick(ListView l, View v, int position, long id)
This method will be called when an item in the list is selected.

Methods inherited from class java.lang.Object


clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
TimeZoneActivity
public TimeZoneActivity()

Method Detail
onCreate
protected void onCreate(Bundle icicle)

Called when the activity is starting. This is where most initialization should go: calling
setContentView(int) to inflate the activity's UI, etc.

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/widgets/TimeZoneActivity.html[2/19/2011 9:11:36 AM]


TimeZoneActivity

Parameters:
icicle - If the activity is being re-initialized after previously being shut down then this Bundle
contains the data it most recently supplied in onSaveInstanceState(Bundle). Note: Otherwise it is
null.

onListItemClick
public void onListItemClick(ListView l,
View v,
int position,
long id)

This method will be called when an item in the list is selected. Subclasses can call
getListView().getItemAtPosition(position) if they need to access the data associated with the selected
item.

Parameters:
l - The ListView where the click happened.
v - The view that was clicked within the ListView.
position - The position of the view in the list.
id - The row id of the item that was clicked.

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/widgets/TimeZoneActivity.html[2/19/2011 9:11:36 AM]


MainActivity.ActivityListener

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.hermit.android.core

Class MainActivity.ActivityListener
java.lang.Object
org.hermit.android.core.MainActivity.ActivityListener

Enclosing class:
MainActivity

public abstract static class MainActivity.ActivityListener


extends java.lang.Object

This interface defines a listener for sub-activity results.

Constructor Summary
MainActivity.ActivityListener()

Method Summary
void onActivityCanceled(Intent data)
Called when an activity you launched exits with a result code of RESULT_CANCELED.
void onActivityFinished(int resultCode, Intent data)
Called when an activity you launched exits.
void onActivityResult(int resultCode, Intent data)
Called when an activity you launched exits with a result code other than RESULT_CANCELED,
giving you the resultCode it returned, and any additional data from it.

Methods inherited from class java.lang.Object


clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
MainActivity.ActivityListener
public MainActivity.ActivityListener()

Method Detail
onActivityFinished

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/core/MainActivity.ActivityListener.html[2/19/2011 9:11:37 AM]


MainActivity.ActivityListener

public void onActivityFinished(int resultCode,


Intent data)

Called when an activity you launched exits.

Applications can override this to be informed when an activity finishes, either by an error, the user
pressing "back", or normally, or whatever. The default implementation calls either
onActivityCanceled(), if resultCode == RESULT_CANCELED, or else onActivityResult().

Parameters:
resultCode - The integer result code returned by the child activity through its setResult().
data - Additional data returned by the activity.

onActivityCanceled
public void onActivityCanceled(Intent data)

Called when an activity you launched exits with a result code of RESULT_CANCELED. This will happen
if the user presses "back", or if the activity returned that code explicitly, didn't return any result, or
crashed during its operation.

Applications can override this if they want to be separately notified of a RESULT_CANCELED. It


doesn't make sense to override both onActivityFinished() and this method.

Parameters:
data - Additional data returned by the activity.

onActivityResult
public void onActivityResult(int resultCode,
Intent data)

Called when an activity you launched exits with a result code other than RESULT_CANCELED, giving
you the resultCode it returned, and any additional data from it.

Applications can override this if they want to be separately notified of a normal exit. It doesn't make
sense to override both onActivityFinished() and this method.

Parameters:
resultCode - The integer result code returned by the child activity through its setResult().
data - Additional data returned by the activity.

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/core/MainActivity.ActivityListener.html[2/19/2011 9:11:37 AM]


CachedFile

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.hermit.android.net

Class CachedFile
java.lang.Object
java.util.Observable
org.hermit.android.net.CachedFile

All Implemented Interfaces:


WebFetcher.Listener

public class CachedFile


extends java.util.Observable
implements WebFetcher.Listener

This class manages a set of web-based files and caches them locally. Data about the files is held in a local
database.

Nested Class Summary


static class CachedFile.Entry
Class describing an entry in the cache; i.e.

Constructor Summary
CachedFile(java.lang.String name, java.net.URL[] urls)
Create a cache of web-based files.

Method Summary
void createTable(SQLiteDatabase db)
Create our table in the database.
CachedFile.Entry getFile(java.net.URL url)
Query for a given file in the cache.
void invalidate(java.net.URL url)
Invalidate the given file in the cache (perhaps it was corrupted).
void onWebData(java.net.URL url, java.lang.Object obj, long date)
This method is invoked when a data item is retrieved from the URL we were
invoked on.
void onWebDone()
This method is invoked when the given URL has been fully fetched.
void onWebError(java.lang.String msg)
Handle an error while fetching web data.
void setDatabase(SQLiteDatabase db)
Set the database we use for storing our data.

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/net/CachedFile.html[2/19/2011 9:11:39 AM]


CachedFile

void update(Context context, long now)


Check to see whether we need to update our cached copies of the files.
void upgradeTable(SQLiteDatabase db, int oldV, int newV)
Upgrade or table in the database to a new version.

Methods inherited from class java.util.Observable


addObserver, clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged,
notifyObservers, notifyObservers, setChanged

Methods inherited from class java.lang.Object


clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
CachedFile
public CachedFile(java.lang.String name,
java.net.URL[] urls)

Create a cache of web-based files. This is private, as only one instance exists.

Parameters:
name - The name of this source, and its database table.
urls - The list of URLs to cache.

Method Detail
createTable
public void createTable(SQLiteDatabase db)

Create our table in the database.

Parameters:
db - The database.

upgradeTable
public void upgradeTable(SQLiteDatabase db,
int oldV,
int newV)

Upgrade or table in the database to a new version.

Parameters:
db - The database.
oldV - Version we're upgrading from.
newV - Version we're upgrading to.

setDatabase

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/net/CachedFile.html[2/19/2011 9:11:39 AM]


CachedFile

public void setDatabase(SQLiteDatabase db)

Set the database we use for storing our data.

Parameters:
db - The database. Will be null if the database is being closed.

getFile
public CachedFile.Entry getFile(java.net.URL url)

Query for a given file in the cache.

Parameters:
url - The URL of the file we want.
Returns:
null if the URL is not being cached at all. Otherwise, an Entry containing info on the file; path
will be non-null if the file has been loaded, and date will be its reported last mod time.

invalidate
public void invalidate(java.net.URL url)

Invalidate the given file in the cache (perhaps it was corrupted).

Parameters:
url - The URL of the file to invalidate.

update
public void update(Context context,
long now)

Check to see whether we need to update our cached copies of the files. If so, kick off a web fetch.
The observers will be notified for each file that we load.

Parameters:
context - The application context. Used for determining where the local files are kept.
now - The current time in millis.

onWebData
public void onWebData(java.net.URL url,
java.lang.Object obj,
long date)

This method is invoked when a data item is retrieved from the URL we were invoked on.

Specified by:
onWebData in interface WebFetcher.Listener

Parameters:

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/net/CachedFile.html[2/19/2011 9:11:39 AM]


CachedFile

url - The URL of the source being loaded.


obj - The object that was loaded; the type depends on the fetcher class used.
date - The last modified time of the source file, as reported by the server, in ms UTC.

onWebDone
public void onWebDone()

This method is invoked when the given URL has been fully fetched.

Specified by:
onWebDone in interface WebFetcher.Listener

onWebError
public void onWebError(java.lang.String msg)

Handle an error while fetching web data.

Specified by:
onWebError in interface WebFetcher.Listener

Parameters:
msg - The error message.

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/net/CachedFile.html[2/19/2011 9:11:39 AM]


WebFetcher.Listener

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.hermit.android.net

Interface WebFetcher.Listener
All Known Implementing Classes:
CachedFile, WebBasedData

Enclosing class:
WebFetcher

public static interface WebFetcher.Listener

Listener for incoming web data.

Method Summary
void onWebData(java.net.URL url, java.lang.Object obj, long date)
This method is invoked when a data item is retrieved from one of the URLs we were invoked
on.
void onWebDone()
This method is invoked when the URLs have been fully fetched.
void onWebError(java.lang.String msg)
This method is invoked if an error occurs when fetching web data.

Method Detail
onWebData
void onWebData(java.net.URL url,
java.lang.Object obj,
long date)

This method is invoked when a data item is retrieved from one of the URLs we were invoked on.

Parameters:
url - The URL that this record came from.
obj - The object that was loaded; the type depends on the fetcher class used.
date - The last modified time of the source file, as reported by the server, in ms UTC.

onWebDone
void onWebDone()

This method is invoked when the URLs have been fully fetched.

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/net/WebFetcher.Listener.html[2/19/2011 9:11:41 AM]


WebFetcher.Listener

onWebError
void onWebError(java.lang.String msg)

This method is invoked if an error occurs when fetching web data.

Parameters:
msg - The error message.

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/net/WebFetcher.Listener.html[2/19/2011 9:11:41 AM]


OneTimeDialog

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.hermit.android.core

Class OneTimeDialog
java.lang.Object
org.hermit.android.core.OneTimeDialog

public class OneTimeDialog


extends java.lang.Object

A class which handles showing one-off notices. This can be used for a EULA, or for "new feature" notices
which show once per app version.

A benefit of this class is that it doesn't create the notice object unless it needs to be shown; most times it
doesn't.

Author:
Ian Cameron Smith

Constructor Summary
OneTimeDialog(Activity parent, java.lang.String name, int title, int text, int close)
Create a dialog for showing a notice, or other warnings / disclaimers, once only.

Method Summary
protected isAccepted()
boolean
Query whether the dialog has been shown to the user and accepted.
void show()
Show the dialog unconditionally.
void showFirst()
Show the dialog if this is the first program run.

Methods inherited from class java.lang.Object


clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
OneTimeDialog
public OneTimeDialog(Activity parent,
java.lang.String name,
int title,
int text,
int close)

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/core/OneTimeDialog.html[2/19/2011 9:11:42 AM]


OneTimeDialog

Create a dialog for showing a notice, or other warnings / disclaimers, once only.

When your app starts, call showFirst() to display the dialog the first time your app runs. This will
actually show it if it hasn't been seen for the current version of the app.

To display the notice on demand, call show().

Parameters:
parent - Our parent activity.
name - Name for this notice. This should be an internal identifier; it will be used to name the
preference we use.
title - Resource ID of the dialog title.
text - Resource ID of the notice / warning text.
close - Resource ID of the close button.

Method Detail
showFirst
public void showFirst()

Show the dialog if this is the first program run.

show
public void show()

Show the dialog unconditionally.

isAccepted
protected boolean isAccepted()

Query whether the dialog has been shown to the user and accepted.

Returns:
True iff the user has seen the dialog and clicked "OK".

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/core/OneTimeDialog.html[2/19/2011 9:11:42 AM]


DatabaseHelper

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.hermit.android.provider

Class DatabaseHelper
java.lang.Object
SQLiteOpenHelper
org.hermit.android.provider.DatabaseHelper

public class DatabaseHelper


extends SQLiteOpenHelper

This class helps open, create, and upgrade the database file.

Applications may use this class as is, or override it, for example to provide a database upgrade handler. If
you don't wish to override it, nothing need be done. If you wish to subclass it, then create your subclass
and override TableProvider.getHelper() to return it.

Constructor Summary
DatabaseHelper(Context context, DbSchema schema)
Creater a helper instance.

Method Summary
protected getSchema()
DbSchema
Get the database schema.
void onCreate(SQLiteDatabase db)
Called when the database is created for the first time.
void onUpgrade(SQLiteDatabase db, int oldVersion, int newVersion)
Called when the database needs to be upgraded.

Methods inherited from class java.lang.Object


clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
DatabaseHelper
public DatabaseHelper(Context context,
DbSchema schema)

Creater a helper instance.

Parameters:
context - Application context.

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/provider/DatabaseHelper.html[2/19/2011 9:11:43 AM]


DatabaseHelper

schema - Schema for this database.

Method Detail
onCreate
public void onCreate(SQLiteDatabase db)

Called when the database is created for the first time. This is where the creation of tables and the
initial population of the tables should happen.

The default implementation creates all the fields specified in all of the table schemas. Subclasses may
override this, for example to add special fields.

Parameters:
db - The new database.

onUpgrade
public void onUpgrade(SQLiteDatabase db,
int oldVersion,
int newVersion)

Called when the database needs to be upgraded. The implementation should use this method to drop
tables, add tables, or do anything else it needs to upgrade to the new schema version.

The default implementation simply deletes all tables and calls #onOpen(SQLiteDatabase) . Subclasses
may override this method to do a more intelligent upgrade.

If you add new columns you can use ALTER TABLE to insert them into a live table. If you rename or
remove columns you can use ALTER TABLE to rename the old table, then create the new table and
then populate the new table with the contents of the old table.

Parameters:
db - The new database.
oldVersion - The old database version.
newVersion - The new database version.

getSchema
protected DbSchema getSchema()

Get the database schema.

Returns:
The schema for this database.

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/provider/DatabaseHelper.html[2/19/2011 9:11:43 AM]


TableSchema

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.hermit.android.provider

Class TableSchema
java.lang.Object
org.hermit.android.provider.TableSchema

public abstract class TableSchema


extends java.lang.Object

Class encapsulating the schema for a table within a content provider. Applications must subclass this, and
provide the necessary information in the call to this base class's constructor.

An application's subclass will typically provide the following:

A public static final Uri CONTENT_URI field, defining the content URI for the table.
A public static final String SORT_ORDER field, defining the default sort clause for the table.
For each column in the table, a public static final String field defining the column's database
name.
A public static final String[] PROJECTION field, defining the default projection for the table.
A constructor which calls this class's constructor, passing the required information.

Constructor Summary
protected TableSchema(java.lang.String name, java.lang.String type, Uri uri,
java.lang.String sort, java.lang.String[][] fields)
Create a table schema instance.

Method Summary
Uri getContentUri()
Get the table's content URI.
java.lang.String getItemType()
Get the MIME type for the items in the table.
java.lang.String getTableName()
Get the table name.
java.lang.String getTableType()
Get the MIME type for the table as a whole.
protected
static java.lang.String[] makeProjection(java.lang.String[][] fields)
This method creates a projection from a set of field definitions.
void onInsert(ContentValues values)
This method is called when a new row is added into this table.

Methods inherited from class java.lang.Object


clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/provider/TableSchema.html[2/19/2011 9:11:45 AM]


TableSchema

Constructor Detail
TableSchema
protected TableSchema(java.lang.String name,
java.lang.String type,
Uri uri,
java.lang.String sort,
java.lang.String[][] fields)

Create a table schema instance.

Parameters:
name - Name for the table; e.g. "points".
type - Base MIME type identifying the content of this table; e.g. "vnd.hermit.org.passage.point".
uri - Content URI for this table.
sort - Default sort order for this table; e.g. "time ASC".
fields - List of field definitions. Each one is two strings, being the field name and type. E.g. { {
"name", "TEXT" }, { "time", "INTEGER" }}. The standard ID field "_id" will be prepended
automatically.

Method Detail
makeProjection
protected static java.lang.String[] makeProjection(java.lang.String[][] fields)

This method creates a projection from a set of field definitions. It can be used by subclasses to set up
a default projection. The returned projection includes all fields, including the implicit "_id" field, which
should not be in the supplied field list.

Parameters:
fields - List of field definitions. Each one is two strings, being the field name and type. E.g. { {
"name", "TEXT" }, { "time", "INTEGER" }}. The standard ID field "_id" will be prepended
automatically.
Returns:
An all-fields projection for the given fields list.

getTableName
public java.lang.String getTableName()

Get the table name.

Returns:
The table's name in the database.

getContentUri
public Uri getContentUri()

Get the table's content URI.

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/provider/TableSchema.html[2/19/2011 9:11:45 AM]


TableSchema

Returns:
The "content://" content URI for this table.

getTableType
public java.lang.String getTableType()

Get the MIME type for the table as a whole.

Returns:
The "vnd.android.cursor.dir/" MIME type for the table.

getItemType
public java.lang.String getItemType()

Get the MIME type for the items in the table.

Returns:
The "vnd.android.cursor.item/" MIME type for the items.

onInsert
public void onInsert(ContentValues values)

This method is called when a new row is added into this table. Subclasses can override this to fill in
any missing values.

Parameters:
values - The fields being added.

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/provider/TableSchema.html[2/19/2011 9:11:45 AM]


WebFetcher

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.hermit.android.net

Class WebFetcher
java.lang.Object
java.lang.Thread
org.hermit.android.net.WebFetcher

All Implemented Interfaces:


java.lang.Runnable

Direct Known Subclasses:


FileFetcher, TableFetcher

public abstract class WebFetcher


extends java.lang.Thread

This class fetches data from the web without blocking the main app.

Nested Class Summary


static class WebFetcher.FetchException
Web fetching exception.
static interface WebFetcher.Listener
Listener for incoming web data.

Nested classes/interfaces inherited from class java.lang.Thread


java.lang.Thread.State, java.lang.Thread.UncaughtExceptionHandler

Field Summary
protected
WebFetcher.Listener dataClient

protected
java.net.URL[] dataUrls

protected boolean killed

protected long newerThanDate

protected long timeout

Fields inherited from class java.lang.Thread


MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/net/WebFetcher.html[2/19/2011 9:11:46 AM]


WebFetcher

Constructor Summary
WebFetcher(java.net.URL[] urls, WebFetcher.Listener client, long timeout, long newer)
Create a fetcher to get data from a given list of URLs.
WebFetcher(java.net.URL url, WebFetcher.Listener client, long timeout)
Create a fetcher to get data from a given URL.
WebFetcher(java.net.URL url, WebFetcher.Listener client, long timeout, long newer)
Create a fetcher to get data from a given URL.

Method Summary
protected fetch(java.net.URL url, long newer)
void
Fetch an object from the given URL.
protected handle(java.net.URL url, java.net.URLConnection conn, java.io.BufferedReader stream)
void
Handle data from the given BufferedReader.
protected handle(java.net.URL url, java.net.URLConnection conn, java.io.InputStream stream)
void
Handle data from the given stream.
void kill()
Kill this fetcher.
static void killAll()
Stop all fetch operations.
static void queue(WebFetcher fetcher)
Queue a web fetch.
void run()
Thread's main method.

Methods inherited from class java.lang.Thread


activeCount, checkAccess, countStackFrames, currentThread, destroy, dumpStack, enumerate,
getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName,
getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock,
interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume,
setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority,
setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield

Methods inherited from class java.lang.Object


clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail
timeout
protected final long timeout

killed
protected boolean killed

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/net/WebFetcher.html[2/19/2011 9:11:46 AM]


WebFetcher

dataUrls
protected final java.net.URL[] dataUrls

newerThanDate
protected final long newerThanDate

dataClient
protected final WebFetcher.Listener dataClient

Constructor Detail
WebFetcher
public WebFetcher(java.net.URL url,
WebFetcher.Listener client,
long timeout)

Create a fetcher to get data from a given URL. Data will be fetched asynchronously from the URL, and
passed as it arrives to the given client. You can start the fetch when you want by calling start(); or
you can pass it to queue() to be executed when other fetches are done.

Parameters:
url - The URL to fetch data from.
client - Client to pass the data to.
timeout - Maximum time in ms for which the job will be allowed to run.

WebFetcher
public WebFetcher(java.net.URL url,
WebFetcher.Listener client,
long timeout,
long newer)

Create a fetcher to get data from a given URL. Data will be fetched asynchronously from the URL, and
passed as it arrives to the given client. You can start the fetch when you want by calling start(); or
you can pass it to queue() to be executed when other fetches are done.

Parameters:
url - The URL to fetch data from.
client - Client to pass the data to.
timeout - Maximum time in ms for which the job will be allowed to run.
newer - If-modified-since time in ms UTC. The fetch will only be carried out if the remote
resource has been modified since this time. If zero, fetch without this condition.

WebFetcher
public WebFetcher(java.net.URL[] urls,
WebFetcher.Listener client,
long timeout,
long newer)

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/net/WebFetcher.html[2/19/2011 9:11:46 AM]


WebFetcher

Create a fetcher to get data from a given list of URLs. Data will be fetched asynchronously from each
URL in sequence, and passed as it arrives to the given client. If any URL fails, the whole fetch will be
aborted. If all URLs succeed, onWebDone() will be called in the listener. You can start the fetch when
you want by calling start(); or you can pass it to queue() to be executed when other fetches are
done.

Parameters:
urls - The URLs to fetch data from.
client - Client to pass the data to.
timeout - Maximum time in ms for which the job will be allowed to run.
newer - If-modified-since time in ms UTC. The fetch will only be carried out if the remote
resource has been modified since this time. If zero, fetch without this condition.

Method Detail
queue
public static void queue(WebFetcher fetcher)

Queue a web fetch. It will be executed when the current fetches are done.

Parameters:
fetcher - The web fetcher to queue.

killAll
public static void killAll()

Stop all fetch operations.

kill
public void kill()

Kill this fetcher. Don't start it, don't do any more callbacks.

run
public void run()

Thread's main method. Just fetch the URLs in sequence. If one fails, stop there.

Specified by:
run in interface java.lang.Runnable
Overrides:
run in class java.lang.Thread

fetch
protected void fetch(java.net.URL url,

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/net/WebFetcher.html[2/19/2011 9:11:46 AM]


WebFetcher

long newer)
throws WebFetcher.FetchException,
java.io.IOException

Fetch an object from the given URL.

Parameters:
url - The URL to fetch.
newer - If-modified-since time in ms UTC. The fetch will only be carried out if the remote
resource has been modified since this time. If zero, fetch without this condition.
Throws:
WebFetcher.FetchException - Some problem was detected, such as a timeout.
java.io.IOException - An I/O error occurred.

handle
protected void handle(java.net.URL url,
java.net.URLConnection conn,
java.io.InputStream stream)
throws WebFetcher.FetchException,
java.io.IOException

Handle data from the given stream.

Parameters:
url - The URL we're reading.
conn - The current connection to the URL.
stream - The InputStream to read from.
Throws:
WebFetcher.FetchException - Some problem was detected, such as a timeout.
java.io.IOException - An I/O error occurred.

handle
protected void handle(java.net.URL url,
java.net.URLConnection conn,
java.io.BufferedReader stream)
throws WebFetcher.FetchException,
java.io.IOException

Handle data from the given BufferedReader.

Parameters:
url - The URL we're reading.
conn - The current connection to the URL.
stream - The BufferedReader to read from.
Throws:
WebFetcher.FetchException - Some problem was detected, such as a timeout.
java.io.IOException - An I/O error occurred.

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/net/WebFetcher.html[2/19/2011 9:11:46 AM]


FileFetcher

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.hermit.android.net

Class FileFetcher
java.lang.Object
java.lang.Thread
org.hermit.android.net.WebFetcher
org.hermit.android.net.FileFetcher

All Implemented Interfaces:


java.lang.Runnable

public class FileFetcher


extends WebFetcher

Concrete instance of WebFetcher which gets a file and stores it locally. The value passed back to the
listener is the local file name as a File.

Nested Class Summary


Nested classes/interfaces inherited from class org.hermit.android.net.WebFetcher
WebFetcher.FetchException, WebFetcher.Listener

Nested classes/interfaces inherited from class java.lang.Thread


java.lang.Thread.State, java.lang.Thread.UncaughtExceptionHandler

Field Summary
Fields inherited from class org.hermit.android.net.WebFetcher
dataClient, dataUrls, killed, newerThanDate, timeout

Fields inherited from class java.lang.Thread


MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary
FileFetcher(Context context, java.net.URL url, java.lang.String name, WebFetcher.Listener client,
long timeout)
Fetch a file from the web.
FileFetcher(Context context, java.net.URL url, java.lang.String name, WebFetcher.Listener client,
long timeout, long newer)
Fetch a file from the web.

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/net/FileFetcher.html[2/19/2011 9:11:49 AM]


FileFetcher

Method Summary
protected handle(java.net.URL url, java.net.URLConnection conn, java.io.InputStream stream)
void
Fetch a page of data from the given stream.

Methods inherited from class org.hermit.android.net.WebFetcher


fetch, handle, kill, killAll, queue, run

Methods inherited from class java.lang.Thread


activeCount, checkAccess, countStackFrames, currentThread, destroy, dumpStack, enumerate,
getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName,
getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock,
interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume,
setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority,
setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield

Methods inherited from class java.lang.Object


clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail
FileFetcher
public FileFetcher(Context context,
java.net.URL url,
java.lang.String name,
WebFetcher.Listener client,
long timeout)

Fetch a file from the web.

Parameters:
context - Application context.
url - The URL to fetch data from.
name - Local name to save the file as.
client - Client to pass the data to. It will be given the local file name as a File object.
timeout - Maximum time in ms for which the job will be allowed to run.

FileFetcher
public FileFetcher(Context context,
java.net.URL url,
java.lang.String name,
WebFetcher.Listener client,
long timeout,
long newer)

Fetch a file from the web.

Parameters:
context - Application context.
url - The URL to fetch data from.
name - Local name to save the file as.
client - Client to pass the data to. It will be given the local file name as a File object.
timeout - Maximum time in ms for which the job will be allowed to run.

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/net/FileFetcher.html[2/19/2011 9:11:49 AM]


FileFetcher

newer - If-modified-since time in ms UTC. The fetch will only be carried out if the remote
resource has been modified since this time. If zero, fetch without this condition.

Method Detail
handle
protected void handle(java.net.URL url,
java.net.URLConnection conn,
java.io.InputStream stream)
throws WebFetcher.FetchException,
java.io.IOException

Fetch a page of data from the given stream.

Overrides:
handle in class WebFetcher

Parameters:
url - The URL we're reading.
conn - The current connection to the URL.
stream - The InputStream to read from.
Throws:
FetchException - Some problem was detected.
java.io.IOException - An I/O error occurred.
WebFetcher.FetchException

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/net/FileFetcher.html[2/19/2011 9:11:49 AM]


TableFetcher

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.hermit.android.net

Class TableFetcher
java.lang.Object
java.lang.Thread
org.hermit.android.net.WebFetcher
org.hermit.android.net.TableFetcher

All Implemented Interfaces:


java.lang.Runnable

public class TableFetcher


extends WebFetcher

Concrete instance of WebFetcher which fetches tabular data from the web. Lines in the file are parsed into
fields and passed to the caller in a ContentValues object.

Nested Class Summary


Nested classes/interfaces inherited from class org.hermit.android.net.WebFetcher
WebFetcher.FetchException, WebFetcher.Listener

Nested classes/interfaces inherited from class java.lang.Thread


java.lang.Thread.UncaughtExceptionHandler

Field Summary
Fields inherited from class org.hermit.android.net.WebFetcher
dataClient, dataUrls, killed, newerThanDate, timeout

Fields inherited from class java.lang.Thread


MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Method Summary
protected handle(java.net.URL url, java.net.URLConnection conn, java.io.BufferedReader readc)
void
Fetch a page of data from the given BufferedReader.

Methods inherited from class org.hermit.android.net.WebFetcher


fetch, handle, kill, killAll, queue, run

Methods inherited from class java.lang.Thread

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/net/TableFetcher.html[2/19/2011 9:11:50 AM]


TableFetcher

activeCount, checkAccess, countStackFrames, currentThread, destroy, dumpStack, enumerate,


getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName,
getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock,
interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume,
setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority,
setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield

Methods inherited from class java.lang.Object


clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail
handle
protected void handle(java.net.URL url,
java.net.URLConnection conn,
java.io.BufferedReader readc)
throws WebFetcher.FetchException,
java.io.IOException

Fetch a page of data from the given BufferedReader.

Overrides:
handle in class WebFetcher

Parameters:
url - The URL we're reading.
conn - The current connection to the URL.
readc - The BufferedReader to read from.
Throws:
FetchException - Some problem was detected.
java.io.IOException - An I/O error occurred.
WebFetcher.FetchException

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/net/TableFetcher.html[2/19/2011 9:11:50 AM]


WebFetcher.FetchException

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.hermit.android.net

Class WebFetcher.FetchException
java.lang.Object
java.lang.Throwable
java.lang.Exception
org.hermit.android.net.WebFetcher.FetchException

All Implemented Interfaces:


java.io.Serializable

Enclosing class:
WebFetcher

public static class WebFetcher.FetchException


extends java.lang.Exception

Web fetching exception. Used to signal a problem while fetching data.

See Also:
Serialized Form

Constructor Summary
WebFetcher.FetchException(java.lang.String s)
Create a FetchException with a message.
WebFetcher.FetchException(java.lang.String s, java.lang.Exception e)
Create a FetchException based on another exception.

Method Summary
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause,
printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object


clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail
WebFetcher.FetchException
public WebFetcher.FetchException(java.lang.String s)

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/net/WebFetcher.FetchException.html[2/19/2011 9:11:52 AM]


WebFetcher.FetchException

Create a FetchException with a message.

Parameters:
s - The exception message.

WebFetcher.FetchException
public WebFetcher.FetchException(java.lang.String s,
java.lang.Exception e)

Create a FetchException based on another exception.

Parameters:
s - The exception message.
e - The root exception.

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/net/WebFetcher.FetchException.html[2/19/2011 9:11:52 AM]


TextInputDialog.OnOkListener

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.hermit.android.notice

Interface TextInputDialog.OnOkListener
Enclosing class:
TextInputDialog

public static interface TextInputDialog.OnOkListener

Listener invoked when the user clicks the OK button.

Method Summary
void onOk(java.lang.CharSequence input)
The OK button has been clicked.

Method Detail
onOk
void onOk(java.lang.CharSequence input)

The OK button has been clicked.

Parameters:
input - The input text.

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/notice/TextInputDialog.OnOkListener.html[2/19/2011 9:11:53 AM]


YesNoDialog.OnOkListener

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.hermit.android.notice

Interface YesNoDialog.OnOkListener
Enclosing class:
YesNoDialog

public static interface YesNoDialog.OnOkListener

Listener invoked when the user clicks the OK button.

Method Summary
void onOk()
The OK button has been clicked.

Method Detail
onOk
void onOk()

The OK button has been clicked.

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/notice/YesNoDialog.OnOkListener.html[2/19/2011 9:11:54 AM]


Deprecated List

All Classes Overview Package Class Use Tree Deprecated Index Help
PREV NEXT FRAMES NO FRAMES
Packages
org.hermit.android.core
org.hermit.android.instru
org.hermit.android.io
Deprecated API
org.hermit.android.net
org.hermit.android.notic Contents
org.hermit.android.prov
org.hermit.android.soun Deprecated Methods
org.hermit.android.widg

Deprecated Methods
org.hermit.android.core.MainActivity.createMessageBox(int)
The message box is now created automatically.
org.hermit.android.core.MainActivity.setHomeInfo(int, int)

All Classes
org.hermit.android.core.MainActivity.setLicenseInfo(int, int)
AppUtils
AppUtils.Detail
AudioAnalyser
AudioReader
AudioReader.Listener
Overview Package Class Use Tree Deprecated Index Help
CachedFile
PREV NEXT FRAMES NO FRAMES
CachedFile.Entry
DatabaseHelper
DbSchema
Effect
ErrorDialog
Errors
FileFetcher
Gauge
HelpActivity
HScrollView
InfoBox
Instrument
InstrumentSurface
LinedEditText
MainActivity
MainActivity.ActivityList
MultistateImageButton
OneTimeDialog
Player
PowerGauge
SpectrumGauge
SplashActivity
SurfaceRunner
TableFetcher
TableProvider
TableSchema
TextGauge
TextInputDialog
TextInputDialog.OnOkL
TimeZoneActivity

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?deprecated-list.html[2/19/2011 9:11:57 AM]


Deprecated List

WaveformGauge
WebBasedData
WebFetcher
WebFetcher.FetchException
WebFetcher.Listener

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?deprecated-list.html[2/19/2011 9:11:57 AM]


API Help

All Classes Overview Package Class Use Tree Deprecated Index Help
PREV NEXT FRAMES NO FRAMES
Packages
org.hermit.android.core
org.hermit.android.instru How This API Document Is Organized
org.hermit.android.io
org.hermit.android.net This API (Application Programming Interface) document has pages corresponding to
org.hermit.android.notic the items in the navigation bar, described as follows.
org.hermit.android.prov
org.hermit.android.soun Overview
org.hermit.android.widg
The Overview page is the front page of this API document and provides a
list of all packages with a summary for each. This page can also contain
an overall description of the set of packages.

Package
Each package has a page that contains a list of its classes and interfaces,
with a summary for each. This page can contain four categories:

Interfaces (italic)
Classes
Enums
Exceptions
Errors
Annotation Types

Class/Interface
Each class, interface, nested class and nested interface has its own
separate page. Each of these pages has three sections consisting of a
class/interface description, summary tables, and detailed member
descriptions:

Class inheritance diagram


Direct Subclasses
All Known Subinterfaces
All Known Implementing Classes
Class/interface declaration
Class/interface description

Nested Class Summary


Field Summary
Constructor Summary
All Classes Method Summary
AppUtils
AppUtils.Detail Field Detail
AudioAnalyser Constructor Detail
AudioReader Method Detail
AudioReader.Listener
CachedFile Each summary entry contains the first sentence from the detailed
CachedFile.Entry description for that item. The summary entries are alphabetical, while the
DatabaseHelper detailed descriptions are in the order they appear in the source code. This
DbSchema preserves the logical groupings established by the programmer.

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?help-doc.html[2/19/2011 9:11:59 AM]


API Help

Effect
ErrorDialog Annotation Type
Errors
FileFetcher
Each annotation type has its own separate page with the following
Gauge
sections:
HelpActivity
HScrollView
Annotation Type declaration
InfoBox
Annotation Type description
Instrument
Required Element Summary
InstrumentSurface
Optional Element Summary
LinedEditText
Element Detail
MainActivity
MainActivity.ActivityList
MultistateImageButton Enum
OneTimeDialog
Player Each enum has its own separate page with the following sections:
PowerGauge
SpectrumGauge Enum declaration
SplashActivity Enum description
SurfaceRunner Enum Constant Summary
TableFetcher Enum Constant Detail
TableProvider
TableSchema Use
TextGauge
TextInputDialog Each documented package, class and interface has its own Use page.
TextInputDialog.OnOkL This page describes what packages, classes, methods, constructors and
TimeZoneActivity fields use any part of the given class or package. Given a class or
WaveformGauge interface A, its Use page includes subclasses of A, fields declared as A,
WebBasedData methods that return A, and methods and constructors with parameters of
WebFetcher type A. You can access this page by first going to the package, class or
WebFetcher.FetchExce interface, then clicking on the "Use" link in the navigation bar.
WebFetcher.Listener
YesNoDialog
YesNoDialog.OnOkListe Tree (Class Hierarchy)
There is a Class Hierarchy page for all packages, plus a hierarchy for each
package. Each hierarchy page contains a list of classes and a list of
interfaces. The classes are organized by inheritance structure starting with
java.lang.Object. The interfaces do not inherit from java.lang.Object.

When viewing the Overview page, clicking on "Tree" displays the


hierarchy for all packages.
When viewing a particular package, class or interface page, clicking
"Tree" displays the hierarchy for only that package.

Deprecated API
The Deprecated API page lists all of the API that have been deprecated. A
deprecated API is not recommended for use, generally due to
improvements, and a replacement API is usually given. Deprecated APIs
may be removed in future implementations.

Index
The Index contains an alphabetic list of all classes, interfaces,
constructors, methods, and fields.

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?help-doc.html[2/19/2011 9:11:59 AM]


API Help

Prev/Next
These links take you to the next or previous class, interface, package, or related
page.

Frames/No Frames
These links show and hide the HTML frames. All pages are available with or without
frames.

Serialized Form
Each serializable or externalizable class has a description of its serialization fields and
methods. This information is of interest to re-implementors, not to developers using
the API. While there is no link in the navigation bar, you can get to this information
by going to any serialized class and clicking "Serialized Form" in the "See also"
section of the class description.

Constant Field Values


The Constant Field Values page lists the static final fields and their values.
This help file applies to API documentation generated using the standard doclet.

Overview Package Class Use Tree Deprecated Index Help


PREV NEXT FRAMES NO FRAMES

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?help-doc.html[2/19/2011 9:11:59 AM]


Constant Field Values

Overview Package Class Use Tree Deprecated Index Help


PREV NEXT FRAMES NO FRAMES All Classes

Constant Field Values

Contents

org.hermit.*

org.hermit.*
org.hermit.android.core.SplashActivity
public static final java.lang.String EXTRAS_IMAGE_ID "image_id"
public static final java.lang.String EXTRAS_TIME_ID "splash_time"

org.hermit.android.core.SurfaceRunner
public static final int LOOPED_TICKER 2
public static final int SURFACE_DYNAMIC 1

org.hermit.android.instruments.InstrumentSurface
public static final int SURFACE_CACHE_BG 256

org.hermit.android.io.AudioReader.Listener
public static final int ERR_INIT_FAILED 1
public static final int ERR_OK 0
public static final int ERR_READ_FAILED 2

org.hermit.android.notice.InfoBox
public static final int BUTTON_1 1
public static final int BUTTON_2 2

Overview Package Class Use Tree Deprecated Index Help


PREV NEXT FRAMES NO FRAMES All Classes

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/constant-values.html[2/19/2011 9:12:01 AM]


Overview

All Classes Overview Package Class Use Tree Deprecated Index Help
PREV NEXT FRAMES NO FRAMES
Packages
org.hermit.android.core
org.hermit.android.instru HermitAndroid
org.hermit.android.io
org.hermit.android.net HermitAndroid is a collection of useful classes for Android applications, in a library
org.hermit.android.notic which can be linked into Android projects.
org.hermit.android.prov
org.hermit.android.soun See:
org.hermit.android.widg Description

Packages
A library of foundation classes for Android
org.hermit.android.core
applications.
org.hermit.android.instruments
All Classes org.hermit.android.io
AppUtils
AppUtils.Detail org.hermit.android.net
AudioAnalyser org.hermit.android.notice
AudioReader
A library of classes to facilitate the creating of
AudioReader.Listener org.hermit.android.provider
CachedFile table-based content providers.
CachedFile.Entry These classes provide functions to help apps
org.hermit.android.sound
DatabaseHelper manage their sound effects.
DbSchema
Effect org.hermit.android.widgets
ErrorDialog
Errors
FileFetcher
Gauge HermitAndroid is a collection of useful classes for Android applications, in a library
HelpActivity which can be linked into Android projects.
HScrollView
InfoBox This library is structured as an Android library project, using the new Android
Instrument libraries feature introduced in Android SDK tools revision 6. This allows
InstrumentSurface HermitAndroid to have its own resources, such as icons or internationalized strings.
LinedEditText
MainActivity For information on getting the code, see the project home page on Google Code.
MainActivity.ActivityList
MultistateImageButton
Overview Package Class Use Tree Deprecated Index Help
OneTimeDialog
PREV NEXT FRAMES NO FRAMES
Player
PowerGauge
SpectrumGauge
SplashActivity
SurfaceRunner
TableFetcher
TableProvider
TableSchema
TextGauge
TextInputDialog
TextInputDialog.OnOkL
TimeZoneActivity

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?index-filesindex-2.html[2/19/2011 9:12:04 AM]


Overview

WaveformGauge
WebBasedData
WebFetcher
WebFetcher.FetchException
WebFetcher.Listener

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?index-filesindex-2.html[2/19/2011 9:12:04 AM]


All Classes

All Classes
AppUtils
AppUtils.Detail
AudioAnalyser
AudioReader
AudioReader.Listener
CachedFile
CachedFile.Entry
DatabaseHelper
DbSchema
Effect
ErrorDialog
Errors
FileFetcher
Gauge
HelpActivity
HScrollView
InfoBox
Instrument
InstrumentSurface
LinedEditText
MainActivity
MainActivity.ActivityListener
MultistateImageButton
OneTimeDialog
Player
PowerGauge
SpectrumGauge
SplashActivity
SurfaceRunner
TableFetcher
TableProvider
TableSchema
TextGauge
TextInputDialog
TextInputDialog.OnOkListener
TimeZoneActivity
WaveformGauge
WebBasedData
WebFetcher
WebFetcher.FetchException
WebFetcher.Listener
YesNoDialog
YesNoDialog.OnOkListener

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/allclasses-frame.html[2/19/2011 9:12:06 AM]


org.hermit.android.core

org.hermit.android.core
Classes
AppUtils
Errors
HelpActivity
MainActivity
MainActivity.ActivityListener
OneTimeDialog
SplashActivity
SurfaceRunner
Enums
AppUtils.Detail

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/core/package-frame.html[2/19/2011 9:12:07 AM]


org.hermit.android.instruments

org.hermit.android.instruments
Classes
AudioAnalyser
Gauge
Instrument
InstrumentSurface
PowerGauge
SpectrumGauge
TextGauge
WaveformGauge

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/instruments/package-frame.html[2/19/2011 9:12:09 AM]


org.hermit.android.io

org.hermit.android.io
Classes
AudioReader
AudioReader.Listener

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/io/package-frame.html[2/19/2011 9:12:10 AM]


org.hermit.android.net

org.hermit.android.net
Interfaces
WebFetcher.Listener
Classes
CachedFile
CachedFile.Entry
FileFetcher
TableFetcher
WebBasedData
WebFetcher
Exceptions
WebFetcher.FetchException

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/net/package-frame.html[2/19/2011 9:12:12 AM]


org.hermit.android.notice

org.hermit.android.notice
Interfaces
TextInputDialog.OnOkListener
YesNoDialog.OnOkListener
Classes
ErrorDialog
InfoBox
TextInputDialog
YesNoDialog

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/notice/package-frame.html[2/19/2011 9:12:13 AM]


org.hermit.android.provider

org.hermit.android.provider
Classes
DatabaseHelper
DbSchema
TableProvider
TableSchema

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/provider/package-frame.html[2/19/2011 9:12:14 AM]


org.hermit.android.sound

org.hermit.android.sound
Classes
Effect
Player

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/sound/package-frame.html[2/19/2011 9:12:15 AM]


org.hermit.android.widgets

org.hermit.android.widgets
Classes
HScrollView
LinedEditText
MultistateImageButton
TimeZoneActivity

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/widgets/package-frame.html[2/19/2011 9:12:16 AM]


Overview

All Classes Overview Package Class Use Tree Deprecated Index Help
PREV NEXT FRAMES NO FRAMES
Packages
org.hermit.android.core
org.hermit.android.instru HermitAndroid
org.hermit.android.io
org.hermit.android.net HermitAndroid is a collection of useful classes for Android applications, in a library
org.hermit.android.notic which can be linked into Android projects.
org.hermit.android.prov
org.hermit.android.soun See:
org.hermit.android.widg Description

Packages
A library of foundation classes for Android
org.hermit.android.core
applications.
org.hermit.android.instruments
All Classes org.hermit.android.io
AppUtils
AppUtils.Detail org.hermit.android.net
AudioAnalyser org.hermit.android.notice
AudioReader
A library of classes to facilitate the creating of
AudioReader.Listener org.hermit.android.provider
CachedFile table-based content providers.
CachedFile.Entry These classes provide functions to help apps
org.hermit.android.sound
DatabaseHelper manage their sound effects.
DbSchema
Effect org.hermit.android.widgets
ErrorDialog
Errors
FileFetcher
Gauge HermitAndroid is a collection of useful classes for Android applications, in a library
HelpActivity which can be linked into Android projects.
HScrollView
InfoBox This library is structured as an Android library project, using the new Android
Instrument libraries feature introduced in Android SDK tools revision 6. This allows
InstrumentSurface HermitAndroid to have its own resources, such as icons or internationalized strings.
LinedEditText
MainActivity For information on getting the code, see the project home page on Google Code.
MainActivity.ActivityList
MultistateImageButton
Overview Package Class Use Tree Deprecated Index Help
OneTimeDialog
PREV NEXT FRAMES NO FRAMES
Player
PowerGauge
SpectrumGauge
SplashActivity
SurfaceRunner
TableFetcher
TableProvider
TableSchema
TextGauge
TextInputDialog
TextInputDialog.OnOkL
TimeZoneActivity

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?index-filesindex-3.html[2/19/2011 9:12:18 AM]


Overview

WaveformGauge
WebBasedData
WebFetcher
WebFetcher.FetchException
WebFetcher.Listener

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?index-filesindex-3.html[2/19/2011 9:12:18 AM]


Overview

All Classes Overview Package Class Use Tree Deprecated Index Help
PREV NEXT FRAMES NO FRAMES
Packages
org.hermit.android.core
org.hermit.android.instrum HermitAndroid
org.hermit.android.io
org.hermit.android.net HermitAndroid is a collection of useful classes for Android applications, in a library which
org.hermit.android.notice can be linked into Android projects.
org.hermit.android.provide
org.hermit.android.sound See:
org.hermit.android.widgets Description

Packages
org.hermit.android.core A library of foundation classes for Android
applications.
org.hermit.android.instruments
All Classes org.hermit.android.io
AppUtils org.hermit.android.net
AppUtils.Detail
org.hermit.android.notice
AudioAnalyser
AudioReader org.hermit.android.provider A library of classes to facilitate the creating of table-
AudioReader.Listener based content providers.
CachedFile These classes provide functions to help apps manage
CachedFile.Entry org.hermit.android.sound
their sound effects.
DatabaseHelper
DbSchema org.hermit.android.widgets
Effect
ErrorDialog
Errors
FileFetcher HermitAndroid is a collection of useful classes for Android applications, in a library which
Gauge can be linked into Android projects.
HelpActivity
HScrollView This library is structured as an Android library project, using the new Android libraries
InfoBox feature introduced in Android SDK tools revision 6. This allows HermitAndroid to have its
Instrument own resources, such as icons or internationalized strings.
InstrumentSurface
LinedEditText For information on getting the code, see the project home page on Google Code.
MainActivity
MainActivity.ActivityListen
MultistateImageButton Overview Package Class Use Tree Deprecated Index Help
OneTimeDialog PREV NEXT FRAMES NO FRAMES

Player
PowerGauge
SpectrumGauge
SplashActivity
SurfaceRunner
TableFetcher
TableProvider
TableSchema
TextGauge
TextInputDialog
TextInputDialog.OnOkList
TimeZoneActivity
WaveformGauge
WebBasedData
WebFetcher
WebFetcher.FetchExcepti
WebFetcher.Listener

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?index-filesindex-4.html[2/19/2011 9:12:22 AM]


Overview

YesNoDialog

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?index-filesindex-4.html[2/19/2011 9:12:22 AM]


Overview

All Classes Overview Package Class Use Tree Deprecated Index Help
PREV NEXT FRAMES NO FRAMES
Packages
org.hermit.android.core
org.hermit.android.instru HermitAndroid
org.hermit.android.io
org.hermit.android.net HermitAndroid is a collection of useful classes for Android applications, in a library
org.hermit.android.notic which can be linked into Android projects.
org.hermit.android.prov
org.hermit.android.soun See:
org.hermit.android.widg Description

Packages
A library of foundation classes for Android
org.hermit.android.core
applications.
org.hermit.android.instruments
All Classes org.hermit.android.io
AppUtils
AppUtils.Detail org.hermit.android.net
AudioAnalyser org.hermit.android.notice
AudioReader
A library of classes to facilitate the creating of
AudioReader.Listener org.hermit.android.provider
CachedFile table-based content providers.
CachedFile.Entry These classes provide functions to help apps
org.hermit.android.sound
DatabaseHelper manage their sound effects.
DbSchema
Effect org.hermit.android.widgets
ErrorDialog
Errors
FileFetcher
Gauge HermitAndroid is a collection of useful classes for Android applications, in a library
HelpActivity which can be linked into Android projects.
HScrollView
InfoBox This library is structured as an Android library project, using the new Android
Instrument libraries feature introduced in Android SDK tools revision 6. This allows
InstrumentSurface HermitAndroid to have its own resources, such as icons or internationalized strings.
LinedEditText
MainActivity For information on getting the code, see the project home page on Google Code.
MainActivity.ActivityList
MultistateImageButton
Overview Package Class Use Tree Deprecated Index Help
OneTimeDialog
PREV NEXT FRAMES NO FRAMES
Player
PowerGauge
SpectrumGauge
SplashActivity
SurfaceRunner
TableFetcher
TableProvider
TableSchema
TextGauge
TextInputDialog
TextInputDialog.OnOkL
TimeZoneActivity

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?index-filesindex-5.html[2/19/2011 9:12:24 AM]


Overview

WaveformGauge
WebBasedData
WebFetcher
WebFetcher.FetchException
WebFetcher.Listener

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?index-filesindex-5.html[2/19/2011 9:12:24 AM]


Overview

All Classes Overview Package Class Use Tree Deprecated Index Help
PREV NEXT FRAMES NO FRAMES
Packages
org.hermit.android.core
org.hermit.android.instru HermitAndroid
org.hermit.android.io
org.hermit.android.net HermitAndroid is a collection of useful classes for Android applications, in a library
org.hermit.android.notic which can be linked into Android projects.
org.hermit.android.prov
org.hermit.android.soun See:
org.hermit.android.widg Description

Packages
A library of foundation classes for Android
org.hermit.android.core
applications.
org.hermit.android.instruments
All Classes org.hermit.android.io
AppUtils
AppUtils.Detail org.hermit.android.net
AudioAnalyser org.hermit.android.notice
AudioReader
A library of classes to facilitate the creating of
AudioReader.Listener org.hermit.android.provider
CachedFile table-based content providers.
CachedFile.Entry These classes provide functions to help apps
org.hermit.android.sound
DatabaseHelper manage their sound effects.
DbSchema
Effect org.hermit.android.widgets
ErrorDialog
Errors
FileFetcher
Gauge HermitAndroid is a collection of useful classes for Android applications, in a library
HelpActivity which can be linked into Android projects.
HScrollView
InfoBox This library is structured as an Android library project, using the new Android
Instrument libraries feature introduced in Android SDK tools revision 6. This allows
InstrumentSurface HermitAndroid to have its own resources, such as icons or internationalized strings.
LinedEditText
MainActivity For information on getting the code, see the project home page on Google Code.
MainActivity.ActivityList
MultistateImageButton
Overview Package Class Use Tree Deprecated Index Help
OneTimeDialog
PREV NEXT FRAMES NO FRAMES
Player
PowerGauge
SpectrumGauge
SplashActivity
SurfaceRunner
TableFetcher
TableProvider
TableSchema
TextGauge
TextInputDialog
TextInputDialog.OnOkL
TimeZoneActivity

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?index-filesindex-6.html[2/19/2011 9:12:27 AM]


Overview

WaveformGauge
WebBasedData
WebFetcher
WebFetcher.FetchException
WebFetcher.Listener

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?index-filesindex-6.html[2/19/2011 9:12:27 AM]


Overview

All Classes Overview Package Class Use Tree Deprecated Index Help
PREV NEXT FRAMES NO FRAMES
Packages
org.hermit.android.core
org.hermit.android.instru HermitAndroid
org.hermit.android.io
org.hermit.android.net HermitAndroid is a collection of useful classes for Android applications, in a library
org.hermit.android.notic which can be linked into Android projects.
org.hermit.android.prov
org.hermit.android.soun See:
org.hermit.android.widg Description

Packages
A library of foundation classes for Android
org.hermit.android.core
applications.
org.hermit.android.instruments
All Classes org.hermit.android.io
AppUtils
AppUtils.Detail org.hermit.android.net
AudioAnalyser org.hermit.android.notice
AudioReader
A library of classes to facilitate the creating of
AudioReader.Listener org.hermit.android.provider
CachedFile table-based content providers.
CachedFile.Entry These classes provide functions to help apps
org.hermit.android.sound
DatabaseHelper manage their sound effects.
DbSchema
Effect org.hermit.android.widgets
ErrorDialog
Errors
FileFetcher
Gauge HermitAndroid is a collection of useful classes for Android applications, in a library
HelpActivity which can be linked into Android projects.
HScrollView
InfoBox This library is structured as an Android library project, using the new Android
Instrument libraries feature introduced in Android SDK tools revision 6. This allows
InstrumentSurface HermitAndroid to have its own resources, such as icons or internationalized strings.
LinedEditText
MainActivity For information on getting the code, see the project home page on Google Code.
MainActivity.ActivityList
MultistateImageButton
Overview Package Class Use Tree Deprecated Index Help
OneTimeDialog
PREV NEXT FRAMES NO FRAMES
Player
PowerGauge
SpectrumGauge
SplashActivity
SurfaceRunner
TableFetcher
TableProvider
TableSchema
TextGauge
TextInputDialog
TextInputDialog.OnOkL
TimeZoneActivity

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?index-filesindex-7.html[2/19/2011 9:12:29 AM]


Overview

WaveformGauge
WebBasedData
WebFetcher
WebFetcher.FetchException
WebFetcher.Listener

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?index-filesindex-7.html[2/19/2011 9:12:29 AM]


Overview

All Classes Overview Package Class Use Tree Deprecated Index Help
PREV NEXT FRAMES NO FRAMES
Packages
org.hermit.android.core
org.hermit.android.instru HermitAndroid
org.hermit.android.io
org.hermit.android.net HermitAndroid is a collection of useful classes for Android applications, in a library
org.hermit.android.notic which can be linked into Android projects.
org.hermit.android.prov
org.hermit.android.soun See:
org.hermit.android.widg Description

Packages
A library of foundation classes for Android
org.hermit.android.core
applications.
org.hermit.android.instruments
All Classes org.hermit.android.io
AppUtils
AppUtils.Detail org.hermit.android.net
AudioAnalyser org.hermit.android.notice
AudioReader
A library of classes to facilitate the creating of
AudioReader.Listener org.hermit.android.provider
CachedFile table-based content providers.
CachedFile.Entry These classes provide functions to help apps
org.hermit.android.sound
DatabaseHelper manage their sound effects.
DbSchema
Effect org.hermit.android.widgets
ErrorDialog
Errors
FileFetcher
Gauge HermitAndroid is a collection of useful classes for Android applications, in a library
HelpActivity which can be linked into Android projects.
HScrollView
InfoBox This library is structured as an Android library project, using the new Android
Instrument libraries feature introduced in Android SDK tools revision 6. This allows
InstrumentSurface HermitAndroid to have its own resources, such as icons or internationalized strings.
LinedEditText
MainActivity For information on getting the code, see the project home page on Google Code.
MainActivity.ActivityList
MultistateImageButton
Overview Package Class Use Tree Deprecated Index Help
OneTimeDialog
PREV NEXT FRAMES NO FRAMES
Player
PowerGauge
SpectrumGauge
SplashActivity
SurfaceRunner
TableFetcher
TableProvider
TableSchema
TextGauge
TextInputDialog
TextInputDialog.OnOkL
TimeZoneActivity

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?index-filesindex-8.html[2/19/2011 9:12:32 AM]


Overview

WaveformGauge
WebBasedData
WebFetcher
WebFetcher.FetchException
WebFetcher.Listener

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?index-filesindex-8.html[2/19/2011 9:12:32 AM]


Overview

All Classes Overview Package Class Use Tree Deprecated Index Help
PREV NEXT FRAMES NO FRAMES
Packages
org.hermit.android.core
org.hermit.android.instru HermitAndroid
org.hermit.android.io
org.hermit.android.net HermitAndroid is a collection of useful classes for Android applications, in a library
org.hermit.android.notic which can be linked into Android projects.
org.hermit.android.prov
org.hermit.android.soun See:
org.hermit.android.widg Description

Packages
A library of foundation classes for Android
org.hermit.android.core
applications.
org.hermit.android.instruments
All Classes org.hermit.android.io
AppUtils
AppUtils.Detail org.hermit.android.net
AudioAnalyser org.hermit.android.notice
AudioReader
A library of classes to facilitate the creating of
AudioReader.Listener org.hermit.android.provider
CachedFile table-based content providers.
CachedFile.Entry These classes provide functions to help apps
org.hermit.android.sound
DatabaseHelper manage their sound effects.
DbSchema
Effect org.hermit.android.widgets
ErrorDialog
Errors
FileFetcher
Gauge HermitAndroid is a collection of useful classes for Android applications, in a library
HelpActivity which can be linked into Android projects.
HScrollView
InfoBox This library is structured as an Android library project, using the new Android
Instrument libraries feature introduced in Android SDK tools revision 6. This allows
InstrumentSurface HermitAndroid to have its own resources, such as icons or internationalized strings.
LinedEditText
MainActivity For information on getting the code, see the project home page on Google Code.
MainActivity.ActivityList
MultistateImageButton
Overview Package Class Use Tree Deprecated Index Help
OneTimeDialog
PREV NEXT FRAMES NO FRAMES
Player
PowerGauge
SpectrumGauge
SplashActivity
SurfaceRunner
TableFetcher
TableProvider
TableSchema
TextGauge
TextInputDialog
TextInputDialog.OnOkL
TimeZoneActivity

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?index-filesindex-9.html[2/19/2011 9:12:35 AM]


Overview

WaveformGauge
WebBasedData
WebFetcher
WebFetcher.FetchException
WebFetcher.Listener

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?index-filesindex-9.html[2/19/2011 9:12:35 AM]


Overview

All Classes Overview Package Class Use Tree Deprecated Index Help
PREV NEXT FRAMES NO FRAMES
Packages
org.hermit.android.core
org.hermit.android.instrum HermitAndroid
org.hermit.android.io
org.hermit.android.net HermitAndroid is a collection of useful classes for Android applications, in a library which
org.hermit.android.notice can be linked into Android projects.
org.hermit.android.provide
org.hermit.android.sound See:
org.hermit.android.widgets Description

Packages
org.hermit.android.core A library of foundation classes for Android
applications.
org.hermit.android.instruments
All Classes org.hermit.android.io
AppUtils org.hermit.android.net
AppUtils.Detail
org.hermit.android.notice
AudioAnalyser
AudioReader org.hermit.android.provider A library of classes to facilitate the creating of table-
AudioReader.Listener based content providers.
CachedFile These classes provide functions to help apps manage
CachedFile.Entry org.hermit.android.sound
their sound effects.
DatabaseHelper
DbSchema org.hermit.android.widgets
Effect
ErrorDialog
Errors
FileFetcher HermitAndroid is a collection of useful classes for Android applications, in a library which
Gauge can be linked into Android projects.
HelpActivity
HScrollView This library is structured as an Android library project, using the new Android libraries
InfoBox feature introduced in Android SDK tools revision 6. This allows HermitAndroid to have its
Instrument own resources, such as icons or internationalized strings.
InstrumentSurface
LinedEditText For information on getting the code, see the project home page on Google Code.
MainActivity
MainActivity.ActivityListen
MultistateImageButton Overview Package Class Use Tree Deprecated Index Help
OneTimeDialog PREV NEXT FRAMES NO FRAMES

Player
PowerGauge
SpectrumGauge
SplashActivity
SurfaceRunner
TableFetcher
TableProvider
TableSchema
TextGauge
TextInputDialog
TextInputDialog.OnOkList
TimeZoneActivity
WaveformGauge
WebBasedData
WebFetcher
WebFetcher.FetchExcepti
WebFetcher.Listener

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?index-filesindex-10.html[2/19/2011 9:12:38 AM]


Overview

YesNoDialog

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?index-filesindex-10.html[2/19/2011 9:12:38 AM]


Overview

All Classes Overview Package Class Use Tree Deprecated Index Help
PREV NEXT FRAMES NO FRAMES
Packages
org.hermit.android.core
org.hermit.android.instru HermitAndroid
org.hermit.android.io
org.hermit.android.net HermitAndroid is a collection of useful classes for Android applications, in a library
org.hermit.android.notic which can be linked into Android projects.
org.hermit.android.prov
org.hermit.android.soun See:
org.hermit.android.widg Description

Packages
A library of foundation classes for Android
org.hermit.android.core
applications.
org.hermit.android.instruments
All Classes org.hermit.android.io
AppUtils
AppUtils.Detail org.hermit.android.net
AudioAnalyser org.hermit.android.notice
AudioReader
A library of classes to facilitate the creating of
AudioReader.Listener org.hermit.android.provider
CachedFile table-based content providers.
CachedFile.Entry These classes provide functions to help apps
org.hermit.android.sound
DatabaseHelper manage their sound effects.
DbSchema
Effect org.hermit.android.widgets
ErrorDialog
Errors
FileFetcher
Gauge HermitAndroid is a collection of useful classes for Android applications, in a library
HelpActivity which can be linked into Android projects.
HScrollView
InfoBox This library is structured as an Android library project, using the new Android
Instrument libraries feature introduced in Android SDK tools revision 6. This allows
InstrumentSurface HermitAndroid to have its own resources, such as icons or internationalized strings.
LinedEditText
MainActivity For information on getting the code, see the project home page on Google Code.
MainActivity.ActivityList
MultistateImageButton
Overview Package Class Use Tree Deprecated Index Help
OneTimeDialog
PREV NEXT FRAMES NO FRAMES
Player
PowerGauge
SpectrumGauge
SplashActivity
SurfaceRunner
TableFetcher
TableProvider
TableSchema
TextGauge
TextInputDialog
TextInputDialog.OnOkL
TimeZoneActivity

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?index-filesindex-11.html[2/19/2011 9:12:41 AM]


Overview

WaveformGauge
WebBasedData
WebFetcher
WebFetcher.FetchException
WebFetcher.Listener

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?index-filesindex-11.html[2/19/2011 9:12:41 AM]


Overview

All Classes Overview Package Class Use Tree Deprecated Index Help
PREV NEXT FRAMES NO FRAMES
Packages
org.hermit.android.core
org.hermit.android.instru HermitAndroid
org.hermit.android.io
org.hermit.android.net HermitAndroid is a collection of useful classes for Android applications, in a library
org.hermit.android.notic which can be linked into Android projects.
org.hermit.android.prov
org.hermit.android.soun See:
org.hermit.android.widg Description

Packages
A library of foundation classes for Android
org.hermit.android.core
applications.
org.hermit.android.instruments
All Classes org.hermit.android.io
AppUtils
AppUtils.Detail org.hermit.android.net
AudioAnalyser org.hermit.android.notice
AudioReader
A library of classes to facilitate the creating of
AudioReader.Listener org.hermit.android.provider
CachedFile table-based content providers.
CachedFile.Entry These classes provide functions to help apps
org.hermit.android.sound
DatabaseHelper manage their sound effects.
DbSchema
Effect org.hermit.android.widgets
ErrorDialog
Errors
FileFetcher
Gauge HermitAndroid is a collection of useful classes for Android applications, in a library
HelpActivity which can be linked into Android projects.
HScrollView
InfoBox This library is structured as an Android library project, using the new Android
Instrument libraries feature introduced in Android SDK tools revision 6. This allows
InstrumentSurface HermitAndroid to have its own resources, such as icons or internationalized strings.
LinedEditText
MainActivity For information on getting the code, see the project home page on Google Code.
MainActivity.ActivityList
MultistateImageButton
Overview Package Class Use Tree Deprecated Index Help
OneTimeDialog
PREV NEXT FRAMES NO FRAMES
Player
PowerGauge
SpectrumGauge
SplashActivity
SurfaceRunner
TableFetcher
TableProvider
TableSchema
TextGauge
TextInputDialog
TextInputDialog.OnOkL
TimeZoneActivity

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?index-filesindex-12.html[2/19/2011 9:12:45 AM]


Overview

WaveformGauge
WebBasedData
WebFetcher
WebFetcher.FetchException
WebFetcher.Listener

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?index-filesindex-12.html[2/19/2011 9:12:45 AM]


Overview

All Classes Overview Package Class Use Tree Deprecated Index Help
PREV NEXT FRAMES NO FRAMES
Packages
org.hermit.android.core
org.hermit.android.instru HermitAndroid
org.hermit.android.io
org.hermit.android.net HermitAndroid is a collection of useful classes for Android applications, in a library
org.hermit.android.notic which can be linked into Android projects.
org.hermit.android.prov
org.hermit.android.soun See:
org.hermit.android.widg Description

Packages
A library of foundation classes for Android
org.hermit.android.core
applications.
org.hermit.android.instruments
All Classes org.hermit.android.io
AppUtils
AppUtils.Detail org.hermit.android.net
AudioAnalyser org.hermit.android.notice
AudioReader
A library of classes to facilitate the creating of
AudioReader.Listener org.hermit.android.provider
CachedFile table-based content providers.
CachedFile.Entry These classes provide functions to help apps
org.hermit.android.sound
DatabaseHelper manage their sound effects.
DbSchema
Effect org.hermit.android.widgets
ErrorDialog
Errors
FileFetcher
Gauge HermitAndroid is a collection of useful classes for Android applications, in a library
HelpActivity which can be linked into Android projects.
HScrollView
InfoBox This library is structured as an Android library project, using the new Android
Instrument libraries feature introduced in Android SDK tools revision 6. This allows
InstrumentSurface HermitAndroid to have its own resources, such as icons or internationalized strings.
LinedEditText
MainActivity For information on getting the code, see the project home page on Google Code.
MainActivity.ActivityList
MultistateImageButton
Overview Package Class Use Tree Deprecated Index Help
OneTimeDialog
PREV NEXT FRAMES NO FRAMES
Player
PowerGauge
SpectrumGauge
SplashActivity
SurfaceRunner
TableFetcher
TableProvider
TableSchema
TextGauge
TextInputDialog
TextInputDialog.OnOkL
TimeZoneActivity

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?index-filesindex-13.html[2/19/2011 9:12:47 AM]


Overview

WaveformGauge
WebBasedData
WebFetcher
WebFetcher.FetchException
WebFetcher.Listener

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?index-filesindex-13.html[2/19/2011 9:12:47 AM]


Overview

All Classes Overview Package Class Use Tree Deprecated Index Help
PREV NEXT FRAMES NO FRAMES
Packages
org.hermit.android.core
org.hermit.android.instru HermitAndroid
org.hermit.android.io
org.hermit.android.net HermitAndroid is a collection of useful classes for Android applications, in a library
org.hermit.android.notic which can be linked into Android projects.
org.hermit.android.prov
org.hermit.android.soun See:
org.hermit.android.widg Description

Packages
A library of foundation classes for Android
org.hermit.android.core
applications.
org.hermit.android.instruments
All Classes org.hermit.android.io
AppUtils
AppUtils.Detail org.hermit.android.net
AudioAnalyser org.hermit.android.notice
AudioReader
A library of classes to facilitate the creating of
AudioReader.Listener org.hermit.android.provider
CachedFile table-based content providers.
CachedFile.Entry These classes provide functions to help apps
org.hermit.android.sound
DatabaseHelper manage their sound effects.
DbSchema
Effect org.hermit.android.widgets
ErrorDialog
Errors
FileFetcher
Gauge HermitAndroid is a collection of useful classes for Android applications, in a library
HelpActivity which can be linked into Android projects.
HScrollView
InfoBox This library is structured as an Android library project, using the new Android
Instrument libraries feature introduced in Android SDK tools revision 6. This allows
InstrumentSurface HermitAndroid to have its own resources, such as icons or internationalized strings.
LinedEditText
MainActivity For information on getting the code, see the project home page on Google Code.
MainActivity.ActivityList
MultistateImageButton
Overview Package Class Use Tree Deprecated Index Help
OneTimeDialog
PREV NEXT FRAMES NO FRAMES
Player
PowerGauge
SpectrumGauge
SplashActivity
SurfaceRunner
TableFetcher
TableProvider
TableSchema
TextGauge
TextInputDialog
TextInputDialog.OnOkL
TimeZoneActivity

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?index-filesindex-14.html[2/19/2011 9:12:50 AM]


Overview

WaveformGauge
WebBasedData
WebFetcher
WebFetcher.FetchException
WebFetcher.Listener

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?index-filesindex-14.html[2/19/2011 9:12:50 AM]


Overview

All Classes Overview Package Class Use Tree Deprecated Index Help
PREV NEXT FRAMES NO FRAMES
Packages
org.hermit.android.core
org.hermit.android.instru HermitAndroid
org.hermit.android.io
org.hermit.android.net HermitAndroid is a collection of useful classes for Android applications, in a library
org.hermit.android.notic which can be linked into Android projects.
org.hermit.android.prov
org.hermit.android.soun See:
org.hermit.android.widg Description

Packages
A library of foundation classes for Android
org.hermit.android.core
applications.
org.hermit.android.instruments
All Classes org.hermit.android.io
AppUtils
AppUtils.Detail org.hermit.android.net
AudioAnalyser org.hermit.android.notice
AudioReader
A library of classes to facilitate the creating of
AudioReader.Listener org.hermit.android.provider
CachedFile table-based content providers.
CachedFile.Entry These classes provide functions to help apps
org.hermit.android.sound
DatabaseHelper manage their sound effects.
DbSchema
Effect org.hermit.android.widgets
ErrorDialog
Errors
FileFetcher
Gauge HermitAndroid is a collection of useful classes for Android applications, in a library
HelpActivity which can be linked into Android projects.
HScrollView
InfoBox This library is structured as an Android library project, using the new Android
Instrument libraries feature introduced in Android SDK tools revision 6. This allows
InstrumentSurface HermitAndroid to have its own resources, such as icons or internationalized strings.
LinedEditText
MainActivity For information on getting the code, see the project home page on Google Code.
MainActivity.ActivityList
MultistateImageButton
Overview Package Class Use Tree Deprecated Index Help
OneTimeDialog
PREV NEXT FRAMES NO FRAMES
Player
PowerGauge
SpectrumGauge
SplashActivity
SurfaceRunner
TableFetcher
TableProvider
TableSchema
TextGauge
TextInputDialog
TextInputDialog.OnOkL
TimeZoneActivity

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?index-filesindex-15.html[2/19/2011 9:12:52 AM]


Overview

WaveformGauge
WebBasedData
WebFetcher
WebFetcher.FetchException
WebFetcher.Listener

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?index-filesindex-15.html[2/19/2011 9:12:52 AM]


Overview

All Classes Overview Package Class Use Tree Deprecated Index Help
PREV NEXT FRAMES NO FRAMES
Packages
org.hermit.android.core
org.hermit.android.instru HermitAndroid
org.hermit.android.io
org.hermit.android.net HermitAndroid is a collection of useful classes for Android applications, in a library
org.hermit.android.notic which can be linked into Android projects.
org.hermit.android.prov
org.hermit.android.soun See:
org.hermit.android.widg Description

Packages
A library of foundation classes for Android
org.hermit.android.core
applications.
org.hermit.android.instruments
All Classes org.hermit.android.io
AppUtils
AppUtils.Detail org.hermit.android.net
AudioAnalyser org.hermit.android.notice
AudioReader
A library of classes to facilitate the creating of
AudioReader.Listener org.hermit.android.provider
CachedFile table-based content providers.
CachedFile.Entry These classes provide functions to help apps
org.hermit.android.sound
DatabaseHelper manage their sound effects.
DbSchema
Effect org.hermit.android.widgets
ErrorDialog
Errors
FileFetcher
Gauge HermitAndroid is a collection of useful classes for Android applications, in a library
HelpActivity which can be linked into Android projects.
HScrollView
InfoBox This library is structured as an Android library project, using the new Android
Instrument libraries feature introduced in Android SDK tools revision 6. This allows
InstrumentSurface HermitAndroid to have its own resources, such as icons or internationalized strings.
LinedEditText
MainActivity For information on getting the code, see the project home page on Google Code.
MainActivity.ActivityList
MultistateImageButton
Overview Package Class Use Tree Deprecated Index Help
OneTimeDialog
PREV NEXT FRAMES NO FRAMES
Player
PowerGauge
SpectrumGauge
SplashActivity
SurfaceRunner
TableFetcher
TableProvider
TableSchema
TextGauge
TextInputDialog
TextInputDialog.OnOkL
TimeZoneActivity

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?index-filesindex-16.html[2/19/2011 9:12:55 AM]


Overview

WaveformGauge
WebBasedData
WebFetcher
WebFetcher.FetchException
WebFetcher.Listener

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?index-filesindex-16.html[2/19/2011 9:12:55 AM]


Overview

All Classes Overview Package Class Use Tree Deprecated Index Help
PREV NEXT FRAMES NO FRAMES
Packages
org.hermit.android.core
org.hermit.android.instru HermitAndroid
org.hermit.android.io
org.hermit.android.net HermitAndroid is a collection of useful classes for Android applications, in a library
org.hermit.android.notic which can be linked into Android projects.
org.hermit.android.prov
org.hermit.android.soun See:
org.hermit.android.widg Description

Packages
A library of foundation classes for Android
org.hermit.android.core
applications.
org.hermit.android.instruments
All Classes org.hermit.android.io
AppUtils
AppUtils.Detail org.hermit.android.net
AudioAnalyser org.hermit.android.notice
AudioReader
A library of classes to facilitate the creating of
AudioReader.Listener org.hermit.android.provider
CachedFile table-based content providers.
CachedFile.Entry These classes provide functions to help apps
org.hermit.android.sound
DatabaseHelper manage their sound effects.
DbSchema
Effect org.hermit.android.widgets
ErrorDialog
Errors
FileFetcher
Gauge HermitAndroid is a collection of useful classes for Android applications, in a library
HelpActivity which can be linked into Android projects.
HScrollView
InfoBox This library is structured as an Android library project, using the new Android
Instrument libraries feature introduced in Android SDK tools revision 6. This allows
InstrumentSurface HermitAndroid to have its own resources, such as icons or internationalized strings.
LinedEditText
MainActivity For information on getting the code, see the project home page on Google Code.
MainActivity.ActivityList
MultistateImageButton
Overview Package Class Use Tree Deprecated Index Help
OneTimeDialog
PREV NEXT FRAMES NO FRAMES
Player
PowerGauge
SpectrumGauge
SplashActivity
SurfaceRunner
TableFetcher
TableProvider
TableSchema
TextGauge
TextInputDialog
TextInputDialog.OnOkL
TimeZoneActivity

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?index-filesindex-17.html[2/19/2011 9:12:57 AM]


Overview

WaveformGauge
WebBasedData
WebFetcher
WebFetcher.FetchException
WebFetcher.Listener

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?index-filesindex-17.html[2/19/2011 9:12:57 AM]


Overview

All Classes Overview Package Class Use Tree Deprecated Index Help
PREV NEXT FRAMES NO FRAMES
Packages
org.hermit.android.core
org.hermit.android.instru HermitAndroid
org.hermit.android.io
org.hermit.android.net HermitAndroid is a collection of useful classes for Android applications, in a library
org.hermit.android.notic which can be linked into Android projects.
org.hermit.android.prov
org.hermit.android.soun See:
org.hermit.android.widg Description

Packages
A library of foundation classes for Android
org.hermit.android.core
applications.
org.hermit.android.instruments
All Classes org.hermit.android.io
AppUtils
AppUtils.Detail org.hermit.android.net
AudioAnalyser org.hermit.android.notice
AudioReader
A library of classes to facilitate the creating of
AudioReader.Listener org.hermit.android.provider
CachedFile table-based content providers.
CachedFile.Entry These classes provide functions to help apps
org.hermit.android.sound
DatabaseHelper manage their sound effects.
DbSchema
Effect org.hermit.android.widgets
ErrorDialog
Errors
FileFetcher
Gauge HermitAndroid is a collection of useful classes for Android applications, in a library
HelpActivity which can be linked into Android projects.
HScrollView
InfoBox This library is structured as an Android library project, using the new Android
Instrument libraries feature introduced in Android SDK tools revision 6. This allows
InstrumentSurface HermitAndroid to have its own resources, such as icons or internationalized strings.
LinedEditText
MainActivity For information on getting the code, see the project home page on Google Code.
MainActivity.ActivityList
MultistateImageButton
Overview Package Class Use Tree Deprecated Index Help
OneTimeDialog
PREV NEXT FRAMES NO FRAMES
Player
PowerGauge
SpectrumGauge
SplashActivity
SurfaceRunner
TableFetcher
TableProvider
TableSchema
TextGauge
TextInputDialog
TextInputDialog.OnOkL
TimeZoneActivity

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?index-filesindex-18.html[2/19/2011 9:13:00 AM]


Overview

WaveformGauge
WebBasedData
WebFetcher
WebFetcher.FetchException
WebFetcher.Listener

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?index-filesindex-18.html[2/19/2011 9:13:00 AM]


Overview

All Classes Overview Package Class Use Tree Deprecated Index Help
PREV NEXT FRAMES NO FRAMES
Packages
org.hermit.android.core
org.hermit.android.instru HermitAndroid
org.hermit.android.io
org.hermit.android.net HermitAndroid is a collection of useful classes for Android applications, in a library
org.hermit.android.notic which can be linked into Android projects.
org.hermit.android.prov
org.hermit.android.soun See:
org.hermit.android.widg Description

Packages
A library of foundation classes for Android
org.hermit.android.core
applications.
org.hermit.android.instruments
All Classes org.hermit.android.io
AppUtils
AppUtils.Detail org.hermit.android.net
AudioAnalyser org.hermit.android.notice
AudioReader
A library of classes to facilitate the creating of
AudioReader.Listener org.hermit.android.provider
CachedFile table-based content providers.
CachedFile.Entry These classes provide functions to help apps
org.hermit.android.sound
DatabaseHelper manage their sound effects.
DbSchema
Effect org.hermit.android.widgets
ErrorDialog
Errors
FileFetcher
Gauge HermitAndroid is a collection of useful classes for Android applications, in a library
HelpActivity which can be linked into Android projects.
HScrollView
InfoBox This library is structured as an Android library project, using the new Android
Instrument libraries feature introduced in Android SDK tools revision 6. This allows
InstrumentSurface HermitAndroid to have its own resources, such as icons or internationalized strings.
LinedEditText
MainActivity For information on getting the code, see the project home page on Google Code.
MainActivity.ActivityList
MultistateImageButton
Overview Package Class Use Tree Deprecated Index Help
OneTimeDialog
PREV NEXT FRAMES NO FRAMES
Player
PowerGauge
SpectrumGauge
SplashActivity
SurfaceRunner
TableFetcher
TableProvider
TableSchema
TextGauge
TextInputDialog
TextInputDialog.OnOkL
TimeZoneActivity

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?index-filesindex-19.html[2/19/2011 9:13:02 AM]


Overview

WaveformGauge
WebBasedData
WebFetcher
WebFetcher.FetchException
WebFetcher.Listener

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?index-filesindex-19.html[2/19/2011 9:13:02 AM]


Overview

All Classes Overview Package Class Use Tree Deprecated Index Help
PREV NEXT FRAMES NO FRAMES
Packages
org.hermit.android.core
org.hermit.android.instru HermitAndroid
org.hermit.android.io
org.hermit.android.net HermitAndroid is a collection of useful classes for Android applications, in a library
org.hermit.android.notic which can be linked into Android projects.
org.hermit.android.prov
org.hermit.android.soun See:
org.hermit.android.widg Description

Packages
A library of foundation classes for Android
org.hermit.android.core
applications.
org.hermit.android.instruments
All Classes org.hermit.android.io
AppUtils
AppUtils.Detail org.hermit.android.net
AudioAnalyser org.hermit.android.notice
AudioReader
A library of classes to facilitate the creating of
AudioReader.Listener org.hermit.android.provider
CachedFile table-based content providers.
CachedFile.Entry These classes provide functions to help apps
org.hermit.android.sound
DatabaseHelper manage their sound effects.
DbSchema
Effect org.hermit.android.widgets
ErrorDialog
Errors
FileFetcher
Gauge HermitAndroid is a collection of useful classes for Android applications, in a library
HelpActivity which can be linked into Android projects.
HScrollView
InfoBox This library is structured as an Android library project, using the new Android
Instrument libraries feature introduced in Android SDK tools revision 6. This allows
InstrumentSurface HermitAndroid to have its own resources, such as icons or internationalized strings.
LinedEditText
MainActivity For information on getting the code, see the project home page on Google Code.
MainActivity.ActivityList
MultistateImageButton
Overview Package Class Use Tree Deprecated Index Help
OneTimeDialog
PREV NEXT FRAMES NO FRAMES
Player
PowerGauge
SpectrumGauge
SplashActivity
SurfaceRunner
TableFetcher
TableProvider
TableSchema
TextGauge
TextInputDialog
TextInputDialog.OnOkL
TimeZoneActivity

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?index-filesindex-20.html[2/19/2011 9:13:05 AM]


Overview

WaveformGauge
WebBasedData
WebFetcher
WebFetcher.FetchException
WebFetcher.Listener

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?index-filesindex-20.html[2/19/2011 9:13:05 AM]


Overview

All Classes Overview Package Class Use Tree Deprecated Index Help
PREV NEXT FRAMES NO FRAMES
Packages
org.hermit.android.core
org.hermit.android.instru HermitAndroid
org.hermit.android.io
org.hermit.android.net HermitAndroid is a collection of useful classes for Android applications, in a library
org.hermit.android.notic which can be linked into Android projects.
org.hermit.android.prov
org.hermit.android.soun See:
org.hermit.android.widg Description

Packages
A library of foundation classes for Android
org.hermit.android.core
applications.
org.hermit.android.instruments
All Classes org.hermit.android.io
AppUtils
AppUtils.Detail org.hermit.android.net
AudioAnalyser org.hermit.android.notice
AudioReader
A library of classes to facilitate the creating of
AudioReader.Listener org.hermit.android.provider
CachedFile table-based content providers.
CachedFile.Entry These classes provide functions to help apps
org.hermit.android.sound
DatabaseHelper manage their sound effects.
DbSchema
Effect org.hermit.android.widgets
ErrorDialog
Errors
FileFetcher
Gauge HermitAndroid is a collection of useful classes for Android applications, in a library
HelpActivity which can be linked into Android projects.
HScrollView
InfoBox This library is structured as an Android library project, using the new Android
Instrument libraries feature introduced in Android SDK tools revision 6. This allows
InstrumentSurface HermitAndroid to have its own resources, such as icons or internationalized strings.
LinedEditText
MainActivity For information on getting the code, see the project home page on Google Code.
MainActivity.ActivityList
MultistateImageButton
Overview Package Class Use Tree Deprecated Index Help
OneTimeDialog
PREV NEXT FRAMES NO FRAMES
Player
PowerGauge
SpectrumGauge
SplashActivity
SurfaceRunner
TableFetcher
TableProvider
TableSchema
TextGauge
TextInputDialog
TextInputDialog.OnOkL
TimeZoneActivity

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?index-filesindex-21.html[2/19/2011 9:13:07 AM]


Overview

WaveformGauge
WebBasedData
WebFetcher
WebFetcher.FetchException
WebFetcher.Listener

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?index-filesindex-21.html[2/19/2011 9:13:07 AM]


Overview

All Classes Overview Package Class Use Tree Deprecated Index Help
PREV NEXT FRAMES NO FRAMES
Packages
org.hermit.android.core
org.hermit.android.instru HermitAndroid
org.hermit.android.io
org.hermit.android.net HermitAndroid is a collection of useful classes for Android applications, in a library
org.hermit.android.notic which can be linked into Android projects.
org.hermit.android.prov
org.hermit.android.soun See:
org.hermit.android.widg Description

Packages
A library of foundation classes for Android
org.hermit.android.core
applications.
org.hermit.android.instruments
All Classes org.hermit.android.io
AppUtils
AppUtils.Detail org.hermit.android.net
AudioAnalyser org.hermit.android.notice
AudioReader
A library of classes to facilitate the creating of
AudioReader.Listener org.hermit.android.provider
CachedFile table-based content providers.
CachedFile.Entry These classes provide functions to help apps
org.hermit.android.sound
DatabaseHelper manage their sound effects.
DbSchema
Effect org.hermit.android.widgets
ErrorDialog
Errors
FileFetcher
Gauge HermitAndroid is a collection of useful classes for Android applications, in a library
HelpActivity which can be linked into Android projects.
HScrollView
InfoBox This library is structured as an Android library project, using the new Android
Instrument libraries feature introduced in Android SDK tools revision 6. This allows
InstrumentSurface HermitAndroid to have its own resources, such as icons or internationalized strings.
LinedEditText
MainActivity For information on getting the code, see the project home page on Google Code.
MainActivity.ActivityList
MultistateImageButton
Overview Package Class Use Tree Deprecated Index Help
OneTimeDialog
PREV NEXT FRAMES NO FRAMES
Player
PowerGauge
SpectrumGauge
SplashActivity
SurfaceRunner
TableFetcher
TableProvider
TableSchema
TextGauge
TextInputDialog
TextInputDialog.OnOkL
TimeZoneActivity

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?index-filesindex-22.html[2/19/2011 9:13:09 AM]


Overview

WaveformGauge
WebBasedData
WebFetcher
WebFetcher.FetchException
WebFetcher.Listener

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?index-filesindex-22.html[2/19/2011 9:13:09 AM]


Overview

All Classes Overview Package Class Use Tree Deprecated Index Help
PREV NEXT FRAMES NO FRAMES
Packages
org.hermit.android.core
org.hermit.android.instru HermitAndroid
org.hermit.android.io
org.hermit.android.net HermitAndroid is a collection of useful classes for Android applications, in a library
org.hermit.android.notic which can be linked into Android projects.
org.hermit.android.prov
org.hermit.android.soun See:
org.hermit.android.widg Description

Packages
A library of foundation classes for Android
org.hermit.android.core
applications.
org.hermit.android.instruments
All Classes org.hermit.android.io
AppUtils
AppUtils.Detail org.hermit.android.net
AudioAnalyser org.hermit.android.notice
AudioReader
A library of classes to facilitate the creating of
AudioReader.Listener org.hermit.android.provider
CachedFile table-based content providers.
CachedFile.Entry These classes provide functions to help apps
org.hermit.android.sound
DatabaseHelper manage their sound effects.
DbSchema
Effect org.hermit.android.widgets
ErrorDialog
Errors
FileFetcher
Gauge HermitAndroid is a collection of useful classes for Android applications, in a library
HelpActivity which can be linked into Android projects.
HScrollView
InfoBox This library is structured as an Android library project, using the new Android
Instrument libraries feature introduced in Android SDK tools revision 6. This allows
InstrumentSurface HermitAndroid to have its own resources, such as icons or internationalized strings.
LinedEditText
MainActivity For information on getting the code, see the project home page on Google Code.
MainActivity.ActivityList
MultistateImageButton
Overview Package Class Use Tree Deprecated Index Help
OneTimeDialog
PREV NEXT FRAMES NO FRAMES
Player
PowerGauge
SpectrumGauge
SplashActivity
SurfaceRunner
TableFetcher
TableProvider
TableSchema
TextGauge
TextInputDialog
TextInputDialog.OnOkL
TimeZoneActivity

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?index-filesindex-23.html[2/19/2011 9:13:12 AM]


Overview

WaveformGauge
WebBasedData
WebFetcher
WebFetcher.FetchException
WebFetcher.Listener

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?index-filesindex-23.html[2/19/2011 9:13:12 AM]


Uses of Class org.hermit.android.sound.Player

Overview Package Class Use Tree Deprecated Index Help


PREV NEXT FRAMES NO FRAMES All Classes

Uses of Class
org.hermit.android.sound.Player
No usage of org.hermit.android.sound.Player

Overview Package Class Use Tree Deprecated Index Help


PREV NEXT FRAMES NO FRAMES All Classes

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/sound/class-use/Player.html[2/19/2011 9:13:13 AM]


Player

All Classes Overview Package Class Use Tree Deprecated Index Help
PREV CLASS NEXT CLASS FRAMES NO FRAMES
Packages SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
org.hermit.android.core
org.hermit.android.instru
org.hermit.android.io org.hermit.android.sound
org.hermit.android.net
org.hermit.android.notic Class Player
org.hermit.android.prov
java.lang.Object
org.hermit.android.soun
org.hermit.android.sound.Player
org.hermit.android.widg

public class Player


extends java.lang.Object

Main sound effects player class.

Constructor Summary
Player(Context context)
Create a sound effect player that can handle 3 streams at once.
Player(Context context, int streams)
Create a sound effect player.

Method Summary
Effect addEffect(int sound)
Add a sound effect to this player.
Effect addEffect(int sound, float vol)
Add a sound effect to this player.
int play(Effect effect)
Play the given sound effect.
int play(Effect effect, float rvol, boolean loop)
Play the given sound effect.
void setGain(float gain)
Set the overall gain for sounds.
void stop(int id)
Stop the given stream.

Methods inherited from class java.lang.Object


clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString,
wait, wait, wait

All Classes
AppUtils
AppUtils.Detail Constructor Detail
AudioAnalyser
AudioReader Player
AudioReader.Listener
CachedFile public Player(Context context)

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/sound/Player.html[2/19/2011 9:13:16 AM]


Player

CachedFile.Entry
DatabaseHelper Create a sound effect player that can handle 3 streams at once.
DbSchema
Effect Parameters:
ErrorDialog context - Application context we're running in.
Errors
FileFetcher
Player
Gauge
HelpActivity
HScrollView
public Player(Context context,
InfoBox int streams)
Instrument
InstrumentSurface Create a sound effect player.
LinedEditText
MainActivity Parameters:
MainActivity.ActivityList context - Application context we're running in.
MultistateImageButton streams - Maximum number of sound streams to play simultaneously.
OneTimeDialog

Method Detail
Player
PowerGauge
SpectrumGauge
SplashActivity
SurfaceRunner
addEffect
TableFetcher
public Effect addEffect(int sound)
TableProvider
TableSchema Add a sound effect to this player.
TextGauge
TextInputDialog Parameters:
TextInputDialog.OnOkL sound - Resource ID of the sound sample for this effect.
TimeZoneActivity Returns:
WaveformGauge An Effect object representing the new effect. Use this object to actually
WebBasedData play the sound.
WebFetcher
WebFetcher.FetchExce
WebFetcher.Listener
YesNoDialog addEffect
YesNoDialog.OnOkListe
public Effect addEffect(int sound,
float vol)

Add a sound effect to this player.

Parameters:
sound - Resource ID of the sound sample for this effect.
vol - Base volume for this effect.
Returns:
An Effect object representing the new effect. Use this object to actually
play the sound.

setGain
public void setGain(float gain)

Set the overall gain for sounds.

Parameters:

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/sound/Player.html[2/19/2011 9:13:16 AM]


Player

gain - Desired gain. 1 = normal; 0 means don't play sounds.

play
public int play(Effect effect)

Play the given sound effect.

Parameters:
effect - Sound effect to play.
Returns:
The ID of the stream which is playing the sound. Zero if it's not playing.

play
public int play(Effect effect,
float rvol,
boolean loop)

Play the given sound effect. The sound won't be played if the volume would be
zero or less.

Parameters:
effect - Sound effect to play.
rvol - Relative volume for this sound, 0 - 1.
loop - If true, loop the sound forever.
Returns:
The ID of the stream which is playing the sound. Zero if it's not playing;
this includes if sounds are disabled, or if the volume is zero.

stop
public void stop(int id)

Stop the given stream.

Parameters:
id - Stream ID to stop.

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/sound/Player.html[2/19/2011 9:13:16 AM]


Uses of Class org.hermit.android.instruments.InstrumentSurface

Overview Package Class Use Tree Deprecated Index Help


PREV NEXT FRAMES NO FRAMES All Classes

Uses of Class
org.hermit.android.instruments.InstrumentSurface
No usage of org.hermit.android.instruments.InstrumentSurface

Overview Package Class Use Tree Deprecated Index Help


PREV NEXT FRAMES NO FRAMES All Classes

http://moonblink.googlecode.com/...unk/HermitAndroid/doc/org/hermit/android/instruments/class-use/InstrumentSurface.html[2/19/2011 9:13:18 AM]


InstrumentSurface

All Classes Overview Package Class Use Tree Deprecated Index Help
PREV CLASS NEXT CLASS FRAMES NO FRAMES
Packages SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
org.hermit.android.core
org.hermit.android.instru
org.hermit.android.io org.hermit.android.instruments
org.hermit.android.net
org.hermit.android.notic Class InstrumentSurface
org.hermit.android.prov
java.lang.Object
org.hermit.android.soun
SurfaceView
org.hermit.android.widg org.hermit.android.core.SurfaceRunner
org.hermit.android.instruments.InstrumentSurface

public abstract class InstrumentSurface


extends SurfaceRunner

Common base for applications which display instruments. This class is an extension
of SurfaceRunner which provides additional functions to manage the instruments
embedded in it.

When using this class in an app, the app context must call these methods (usually
from its corresponding Activity methods):

SurfaceRunner.onStart()
SurfaceRunner.onResume()
SurfaceRunner.onPause()
SurfaceRunner.onStop()

The surface is enabled once it is created and sized, and SurfaceRunner.onStart()


and SurfaceRunner.onResume() have been called. You then start and stop it by
calling SurfaceRunner.surfaceStart() and SurfaceRunner.surfaceStop().

Field Summary
static int SURFACE_CACHE_BG
Instrument Surface runner option: cache a background bitmap.

Fields inherited from class org.hermit.android.core.SurfaceRunner


LOOPED_TICKER, SURFACE_DYNAMIC

Constructor Summary
InstrumentSurface(Activity app)
Create a SurfaceRunner instance.
InstrumentSurface(Activity app, int options)
Create a SurfaceRunner instance.

Method Summary
void addGauge(Gauge i)
Add a gauge to this surface.

http://moonblink.googlecode.com/...k/HermitAndroid/doc/index.html?org/hermit/android/instruments/InstrumentSurface.html[2/19/2011 9:13:21 AM]


InstrumentSurface

void addInstrument(Instrument i)
Add an instrument to the system, associated with this surface.
protected animStart()
void
We are starting the animation loop.
protected animStop()
void
We are stopping the animation loop, for example to pause the
app.
protected appSize(int width, int height, Bitmap.Config config)
void
Set the screen size.
protected appStart()
void
The application is starting.
protected appStop()
void
The application is closing down.
protected doDraw(Canvas canvas, long now)
void
Draw the current frame of the application.
protected doUpdate(long now)
void
Update the state of the application for the current frame.
protected layout(int width, int height)
abstract
void Lay out the display for a given screen size.

Methods inherited from class org.hermit.android.core.SurfaceRunner


getBitmap, getBitmap, getRes, onPause, onResume, onStart, onStop,
onSurfaceThread, onWindowFocusChanged, optionSet, postUpdate, setDebugPerf,
setDebugPos, setDelay, statsCount, statsCreate, statsTime, surfaceChanged,
surfaceCreated, surfaceDestroyed, surfaceStart, surfaceStop

Methods inherited from class java.lang.Object


clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString,
wait, wait, wait

Field Detail
All Classes
AppUtils
AppUtils.Detail SURFACE_CACHE_BG
AudioAnalyser
AudioReader public static final int SURFACE_CACHE_BG
AudioReader.Listener
CachedFile Instrument Surface runner option: cache a background bitmap. If set, we will
CachedFile.Entry ask all the gauges to draw their backgrounds into a full- screen bitmap; this
DatabaseHelper bitmap will then be drawn prior to drawing the gauge contents each frame.
DbSchema
Effect See Also:
ErrorDialog Constant Field Values
Errors
FileFetcher Constructor Detail
Gauge
HelpActivity
HScrollView InstrumentSurface
InfoBox
Instrument public InstrumentSurface(Activity app)
InstrumentSurface

http://moonblink.googlecode.com/...k/HermitAndroid/doc/index.html?org/hermit/android/instruments/InstrumentSurface.html[2/19/2011 9:13:21 AM]


InstrumentSurface

LinedEditText Create a SurfaceRunner instance.


MainActivity
MainActivity.ActivityList Parameters:
MultistateImageButton app - The application context we're running in.
OneTimeDialog
Player
PowerGauge InstrumentSurface
SpectrumGauge
SplashActivity public InstrumentSurface(Activity app,
SurfaceRunner int options)
TableFetcher
TableProvider Create a SurfaceRunner instance.
TableSchema
TextGauge Parameters:
TextInputDialog app - The application context we're running in.
TextInputDialog.OnOkL options - Options for this SurfaceRunner. A bitwise OR of SURFACE_XXX
TimeZoneActivity constants.
WaveformGauge
WebBasedData
WebFetcher
Method Detail
WebFetcher.FetchExce
WebFetcher.Listener addInstrument
YesNoDialog
YesNoDialog.OnOkListe public void addInstrument(Instrument i)

Add an instrument to the system, associated with this surface. Is is presumed


that the app will create one or more Gauge s for this instrument and add them
to the surface with addGauge(Gauge) .

All instruments added here will be started and stopped when the application
starts and stops, and will have their measurement turned on when the app is
visible and running. Their Instrument.doUpdate(long) method will be called
each time round the main animation loop.

All instruments must be added before the application starts running.

Parameters:
i - The instrument to add.

addGauge
public void addGauge(Gauge i)

Add a gauge to this surface. If this gauge has an associated Instrument , it


should be attached to the surface with addInstrument(Instrument) .

All gauges added here will have their Gauge.draw(Canvas, long, boolean)
method called each time round the main animation loop.

All gauges must be added before the application starts running.

Parameters:
i - The gauge to add.

http://moonblink.googlecode.com/...k/HermitAndroid/doc/index.html?org/hermit/android/instruments/InstrumentSurface.html[2/19/2011 9:13:21 AM]


InstrumentSurface

layout
protected abstract void layout(int width,
int height)

Lay out the display for a given screen size. Subclasses must implement this,
and should use it to lay out the gauges.

Parameters:
width - The new width of the surface.
height - The new height of the surface.

appStart
protected void appStart()

The application is starting. Perform any initial set-up prior to starting the
application. We may not have a screen size yet, so this is not a good place to
allocate resources which depend on that.

If subclasses override this, they must call through to this method.

Specified by:
appStart in class SurfaceRunner

appSize
protected void appSize(int width,
int height,
Bitmap.Config config)

Set the screen size. This is guaranteed to be called before animStart(), but
perhaps not before appStart().

We call the layout() method here, so subclasses generally don't need to


override this. If subclasses do override this, they must call through to this
method.

Specified by:
appSize in class SurfaceRunner

Parameters:
width - The new width of the surface.
height - The new height of the surface.
config - The pixel format of the surface.

animStart
protected void animStart()

We are starting the animation loop. The screen size is known.

doUpdate() and doDraw() may be called from this point on.

http://moonblink.googlecode.com/...k/HermitAndroid/doc/index.html?org/hermit/android/instruments/InstrumentSurface.html[2/19/2011 9:13:21 AM]


InstrumentSurface

If subclasses override this, they must call through to this method.

Specified by:
animStart in class SurfaceRunner

animStop
protected void animStop()

We are stopping the animation loop, for example to pause the app.

doUpdate() and doDraw() will not be called from this point on.

If subclasses override this, they must call through to this method.

Specified by:
animStop in class SurfaceRunner

appStop
protected void appStop()

The application is closing down. Clean up any resources.

Specified by:
appStop in class SurfaceRunner

doUpdate
protected void doUpdate(long now)

Update the state of the application for the current frame.

Applications must override this, and can use it to update for example the
physics of a game. This may be a no-op in some cases.

doDraw() will always be called after this method is called; however, the
converse is not true, as we sometimes need to draw just to update the screen.
Hence this method is useful for updates which are dependent on time rather
than frames.

Specified by:
doUpdate in class SurfaceRunner

Parameters:
now - Nominal time of the current frame in ms.

doDraw
protected void doDraw(Canvas canvas,
long now)

Draw the current frame of the application.

http://moonblink.googlecode.com/...k/HermitAndroid/doc/index.html?org/hermit/android/instruments/InstrumentSurface.html[2/19/2011 9:13:21 AM]


InstrumentSurface

Applications must override this, and are expected to draw the entire screen into
the provided canvas.

This method will always be called after a call to doUpdate(), and also when the
screen needs to be re-drawn.

Specified by:
doDraw in class SurfaceRunner

Parameters:
canvas - The Canvas to draw into.
now - Nominal time of the current frame in ms.

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

http://moonblink.googlecode.com/...k/HermitAndroid/doc/index.html?org/hermit/android/instruments/InstrumentSurface.html[2/19/2011 9:13:21 AM]


Uses of Class org.hermit.android.core.HelpActivity

Overview Package Class Use Tree Deprecated Index Help


PREV NEXT FRAMES NO FRAMES All Classes

Uses of Class
org.hermit.android.core.HelpActivity
No usage of org.hermit.android.core.HelpActivity

Overview Package Class Use Tree Deprecated Index Help


PREV NEXT FRAMES NO FRAMES All Classes

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/core/class-use/HelpActivity.html[2/19/2011 9:13:23 AM]


HelpActivity

All Classes Overview Package Class Use Tree Deprecated Index Help
PREV CLASS NEXT CLASS FRAMES NO FRAMES
Packages SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
org.hermit.android.core
org.hermit.android.instru
org.hermit.android.io org.hermit.android.core
org.hermit.android.net
org.hermit.android.notic Class HelpActivity
org.hermit.android.prov
java.lang.Object
org.hermit.android.soun
Activity
org.hermit.android.widg org.hermit.android.core.HelpActivity

public class HelpActivity


extends Activity

An activity which displays an application's help, in a structured format. Help is


supplied via resources arrays; one array contains the titles of the help sections, one
contains the texts for each section. Sub-sections can be added.

To use: subclass this activity, and have the subclass call addHelpFromArrays(int,
int) . Then start this activity when you need to display help.

It is recommended that you configure this activity to handle orientation and


keyboardHidden configuration changes in your app manifest.

Constructor Summary
HelpActivity()

Method Summary
protected addHelpFromArrays(int titlesId, int textsId)
void
Add help to this help activity.
void onCreate(Bundle icicle)
Called when the activity is starting.
protected onRestoreInstanceState(Bundle inState)
void
This method is called after onStart() when the activity is being re-
initialized from a previously saved state, given here in state.
All Classes
void onSaveInstanceState(Bundle outState)
AppUtils
AppUtils.Detail Called to retrieve per-instance state from an activity before being
AudioAnalyser killed so that the state can be restored in onCreate(Bundle) or
AudioReader onRestoreInstanceState(Bundle) (the Bundle populated by this method
AudioReader.Listener will be passed to both).
CachedFile
CachedFile.Entry Methods inherited from class java.lang.Object
DatabaseHelper
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString,
DbSchema wait, wait, wait
Effect
ErrorDialog
Errors

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/core/HelpActivity.html[2/19/2011 9:13:25 AM]


HelpActivity

FileFetcher Constructor Detail


Gauge
HelpActivity
HScrollView HelpActivity
InfoBox
Instrument public HelpActivity()
InstrumentSurface
LinedEditText
MainActivity
Method Detail
MainActivity.ActivityList
MultistateImageButton onCreate
OneTimeDialog
Player public void onCreate(Bundle icicle)
PowerGauge
SpectrumGauge Called when the activity is starting. This is where most initialization should go:
SplashActivity calling setContentView(int) to inflate the activity's UI, etc.
SurfaceRunner
TableFetcher Parameters:
TableProvider icicle - Saved application state, if any.
TableSchema
TextGauge
TextInputDialog onRestoreInstanceState
TextInputDialog.OnOkL
TimeZoneActivity protected void onRestoreInstanceState(Bundle inState)
WaveformGauge
WebBasedData This method is called after onStart() when the activity is being re-initialized
WebFetcher from a previously saved state, given here in state. Most implementations will
WebFetcher.FetchExce simply use onCreate(Bundle) to restore their state, but it is sometimes
WebFetcher.Listener convenient to do it here after all of the initialization has been done or to allow
YesNoDialog subclasses to decide whether to use your default implementation. The default
YesNoDialog.OnOkListe implementation of this method performs a restore of any view state that had
previously been frozen by onSaveInstanceState(Bundle). This method is called
between onStart() and onPostCreate(Bundle).

Parameters:
inState - The data most recently supplied in
onSaveInstanceState(Bundle).

onSaveInstanceState
public void onSaveInstanceState(Bundle outState)

Called to retrieve per-instance state from an activity before being killed so that
the state can be restored in onCreate(Bundle) or
onRestoreInstanceState(Bundle) (the Bundle populated by this method will be
passed to both). If called, this method will occur before onStop(). There are no
guarantees about whether it will occur before or after onPause().

Parameters:
outState - A Bundle in which to place any state information you wish to
save.

addHelpFromArrays

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/core/HelpActivity.html[2/19/2011 9:13:25 AM]


HelpActivity

protected void addHelpFromArrays(int titlesId,


int textsId)

Add help to this help activity.

The parameters are the resource IDs of two arrays; the first contains the titles
of the help sections, the second contains the bodies of the sections. The arrays
must be the same length.

A title and the corresponding content may both be resource IDs of further
arrays. These arrays will be added as sub-sections in the most recently-added
section. There must be an enclosing outer section.

If this method is called more than once, help will be added to the top level.
(This isn't really recommended.)

Parameters:
titlesId - Resource ID of the titles array.
textsId - Resource ID of the contents array.

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/core/HelpActivity.html[2/19/2011 9:13:25 AM]


Uses of Class org.hermit.android.widgets.HScrollView

Overview Package Class Use Tree Deprecated Index Help


PREV NEXT FRAMES NO FRAMES All Classes

Uses of Class
org.hermit.android.widgets.HScrollView
No usage of org.hermit.android.widgets.HScrollView

Overview Package Class Use Tree Deprecated Index Help


PREV NEXT FRAMES NO FRAMES All Classes

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/widgets/class-use/HScrollView.html[2/19/2011 9:13:27 AM]


HScrollView

All Classes Overview Package Class Use Tree Deprecated Index Help
PREV CLASS NEXT CLASS FRAMES NO FRAMES
Packages SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
org.hermit.android.core
org.hermit.android.instru
org.hermit.android.io org.hermit.android.widgets
org.hermit.android.net
org.hermit.android.notic Class HScrollView
org.hermit.android.prov
java.lang.Object
org.hermit.android.soun
FrameLayout
org.hermit.android.widg org.hermit.android.widgets.HScrollView

public class HScrollView


extends FrameLayout

Layout container for a view hierarchy that can be scrolled by the user, allowing it to
be larger than the physical display. This class scrolls horizontally, as opposed to
android.widget.ScrollView which only supports vertical scrolling.

An HScrollView is a android.widget.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
android.widget.LinearLayout in a vertical orientation, presenting a vertical array of
top-level items that the user can scroll through.

HScrollView only supports horizontally scrolling.

Constructor Summary
HScrollView(Context context)

HScrollView(Context context, AttributeSet attrs)

Method Summary
void addView(View child)

void addView(View child, int index)

void addView(View child, int index, ViewGroup.LayoutParams params)

void addView(View child, ViewGroup.LayoutParams params)

boolean arrowScroll(int direction)


Handle scrolling in response to a left or right arrow click.
protected computeHorizontalScrollRange()
int
The scroll range of a scroll view is the overall height of all of its
children.
void computeScroll()

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/widgets/HScrollView.html[2/19/2011 9:13:30 AM]


HScrollView

protected computeScrollDeltaToGetChildRectOnScreen(Rect rect)


int
Compute the amount to scroll in the Y direction in order to get a
rectangle completely on the screen (or, if taller than the screen, at least
the first screen size chunk of it).
boolean dispatchKeyEvent(KeyEvent event)

boolean executeKeyEvent(KeyEvent event)


You can call this function yourself to have the scroll view perform
scrolling from a key event, just as if the event had been dispatched to it
by the view hierarchy.
void fling(int velocityX)
Fling the scroll view
protected getLeftFadingEdgeStrength()
float

int getMaxScrollAmount()

protected getRightFadingEdgeStrength()
float

boolean isFillViewport()
Indicates whether this ScrollView's content is stretched to fill the
viewport.
boolean isSmoothScrollingEnabled()

protected measureChild(View child, int parentWidthMeasureSpec,


void
int parentHeightMeasureSpec)

protected measureChildWithMargins(View child, int parentWidthMeasureSpec,


void
int widthUsed, int parentHeightMeasureSpec, int heightUsed)

boolean onInterceptTouchEvent(MotionEvent ev)

protected onLayout(boolean changed, int l, int t, int r, int b)


void

protected onMeasure(int widthMeasureSpec, int heightMeasureSpec)


void

protected onRequestFocusInDescendants(int direction,


boolean
Rect previouslyFocusedRect)
When looking for focus in children of a scroll view, need to be a
little more careful not to give focus to something that is scrolled off
screen.
protected onSizeChanged(int w, int h, int oldw, int oldh)
void

boolean onTouchEvent(MotionEvent ev)

void requestChildFocus(View child, View focused)

boolean requestChildRectangleOnScreen(View child, Rect rectangle,


boolean immediate)

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/widgets/HScrollView.html[2/19/2011 9:13:30 AM]


HScrollView

void requestLayout()

void scrollTo(int x, int y)

void setFillViewport(boolean fillViewport)


Indicates this ScrollView whether it should stretch its content
height to fill the viewport or not.
void setSmoothScrollingEnabled(boolean smoothScrollingEnabled)
Set whether arrow scrolling will animate its transition.
void smoothScrollBy(int dx, int dy)
Like View#scrollBy , but scroll smoothly instead of immediately.
void smoothScrollTo(int x, int y)

All Classes
Like scrollTo(int, int) , but scroll smoothly instead of
immediately.
AppUtils
AppUtils.Detail
AudioAnalyser Methods inherited from class java.lang.Object
AudioReader clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString,
AudioReader.Listener wait, wait, wait
CachedFile
CachedFile.Entry

Constructor Detail
DatabaseHelper
DbSchema
Effect
HScrollView
ErrorDialog
Errors
FileFetcher
public HScrollView(Context context)
Gauge
HelpActivity
HScrollView
InfoBox HScrollView
Instrument
InstrumentSurface public HScrollView(Context context,
AttributeSet attrs)
LinedEditText
MainActivity
MainActivity.ActivityList Method Detail
MultistateImageButton
OneTimeDialog
Player getLeftFadingEdgeStrength
PowerGauge
SpectrumGauge protected float getLeftFadingEdgeStrength()
SplashActivity
SurfaceRunner
TableFetcher getRightFadingEdgeStrength
TableProvider
TableSchema protected float getRightFadingEdgeStrength()
TextGauge
TextInputDialog
TextInputDialog.OnOkL
TimeZoneActivity
getMaxScrollAmount
WaveformGauge
public int getMaxScrollAmount()
WebBasedData
WebFetcher Returns:

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/widgets/HScrollView.html[2/19/2011 9:13:30 AM]


HScrollView

WebFetcher.FetchExce The maximum amount this scroll view will scroll in response to an arrow
WebFetcher.Listener event.
YesNoDialog
YesNoDialog.OnOkListe

addView
public void addView(View child)

addView
public void addView(View child,
int index)

addView
public void addView(View child,
ViewGroup.LayoutParams params)

addView
public void addView(View child,
int index,
ViewGroup.LayoutParams params)

isFillViewport
public boolean isFillViewport()

Indicates whether this ScrollView's content is stretched to fill the viewport.

Returns:
True if the content fills the viewport, false otherwise.

setFillViewport
public void setFillViewport(boolean fillViewport)

Indicates this ScrollView whether it should stretch its content height to fill the
viewport or not.

Parameters:
fillViewport - True to stretch the content's height to the viewport's
boundaries, false otherwise.

isSmoothScrollingEnabled
public boolean isSmoothScrollingEnabled()

Returns:
Whether arrow scrolling will animate its transition.

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/widgets/HScrollView.html[2/19/2011 9:13:30 AM]


HScrollView

setSmoothScrollingEnabled
public void setSmoothScrollingEnabled(boolean smoothScrollingEnabled)

Set whether arrow scrolling will animate its transition.

Parameters:
smoothScrollingEnabled - whether arrow scrolling will animate its
transition

onMeasure
protected void onMeasure(int widthMeasureSpec,
int heightMeasureSpec)

dispatchKeyEvent
public boolean dispatchKeyEvent(KeyEvent event)

executeKeyEvent
public boolean executeKeyEvent(KeyEvent event)

You can call this function yourself to have the scroll view perform scrolling from
a key event, just as if the event had been dispatched to it by the view
hierarchy.

Parameters:
event - The key event to execute.
Returns:
Return true if the event was handled, else false.

onInterceptTouchEvent
public boolean onInterceptTouchEvent(MotionEvent ev)

onTouchEvent
public boolean onTouchEvent(MotionEvent ev)

arrowScroll
public boolean arrowScroll(int direction)

Handle scrolling in response to a left or right arrow click.

Parameters:
direction - The direction corresponding to the arrow key that was

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/widgets/HScrollView.html[2/19/2011 9:13:30 AM]


HScrollView

pressed
Returns:
True if we consumed the event, false otherwise

smoothScrollBy
public final void smoothScrollBy(int dx,
int dy)

Like View#scrollBy , but scroll smoothly instead of immediately.

Parameters:
dx - the number of pixels to scroll by on the X axis
dy - the number of pixels to scroll by on the Y axis

smoothScrollTo
public final void smoothScrollTo(int x,
int y)

Like scrollTo(int, int) , but scroll smoothly instead of immediately.

Parameters:
x - the position where to scroll on the X axis
y - the position where to scroll on the Y axis

computeHorizontalScrollRange
protected int computeHorizontalScrollRange()

The scroll range of a scroll view is the overall height of all of its children.

measureChild
protected void measureChild(View child,
int parentWidthMeasureSpec,
int parentHeightMeasureSpec)

measureChildWithMargins
protected void measureChildWithMargins(View child,
int parentWidthMeasureSpec,
int widthUsed,
int parentHeightMeasureSpec,
int heightUsed)

computeScroll
public void computeScroll()

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/widgets/HScrollView.html[2/19/2011 9:13:30 AM]


HScrollView

computeScrollDeltaToGetChildRectOnScreen
protected int computeScrollDeltaToGetChildRectOnScreen(Rect rect)

Compute the amount to scroll in the Y direction in order to get a rectangle


completely on the screen (or, if taller than the screen, at least the first screen
size chunk of it).

Parameters:
rect - The rect.
Returns:
The scroll delta.

requestChildFocus
public void requestChildFocus(View child,
View focused)

onRequestFocusInDescendants
protected boolean onRequestFocusInDescendants(int direction,
Rect previouslyFocusedRect)

When looking for focus in children of a scroll view, need to be a little more
careful not to give focus to something that is scrolled off screen. This is more
expensive than the default android.view.ViewGroup implementation, otherwise
this behavior might have been made the default.

requestChildRectangleOnScreen
public boolean requestChildRectangleOnScreen(View child,
Rect rectangle,
boolean immediate)

requestLayout
public void requestLayout()

onLayout
protected void onLayout(boolean changed,
int l,
int t,
int r,
int b)

onSizeChanged
protected void onSizeChanged(int w,
int h,
int oldw,
int oldh)

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/widgets/HScrollView.html[2/19/2011 9:13:30 AM]


HScrollView

fling
public void fling(int velocityX)

Fling the scroll view

Parameters:
velocityX - The initial velocity in the Y direction. Positive numbers mean
that the finger/curor is moving down the screen, which means we want to
scroll towards the top.

scrollTo
public void scrollTo(int x,
int y)

This version also clamps the scrolling to the bounds of our child.

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/widgets/HScrollView.html[2/19/2011 9:13:30 AM]


Uses of Class org.hermit.android.net.WebBasedData

Overview Package Class Use Tree Deprecated Index Help


PREV NEXT FRAMES NO FRAMES All Classes

Uses of Class
org.hermit.android.net.WebBasedData
No usage of org.hermit.android.net.WebBasedData

Overview Package Class Use Tree Deprecated Index Help


PREV NEXT FRAMES NO FRAMES All Classes

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/net/class-use/WebBasedData.html[2/19/2011 9:13:33 AM]


WebBasedData

All Classes Overview Package Class Use Tree Deprecated Index Help
PREV CLASS NEXT CLASS FRAMES NO FRAMES
Packages SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
org.hermit.android.core
org.hermit.android.instru
org.hermit.android.io org.hermit.android.net
org.hermit.android.net
org.hermit.android.notic Class WebBasedData
org.hermit.android.prov
java.lang.Object
org.hermit.android.soun
java.util.Observable
org.hermit.android.widg org.hermit.android.net.WebBasedData

All Implemented Interfaces:


WebFetcher.Listener

public class WebBasedData


extends java.util.Observable
implements WebFetcher.Listener

This class implements a web-based source of data, which is cached in a local


database. The data is assumed to be timestamped records.

Constructor Summary
WebBasedData(java.lang.String name, java.lang.String base,
java.lang.String suff, long interval, boolean ldate,
java.lang.String[] fields)
Create a web-based data source.

Method Summary
Cursor allRecords()
Query for all records we have stored.
Cursor allRecordsSince(long date)
Query for all records we have stored timstamped AFTER a
given date.
void createTable(SQLiteDatabase db)
Create our table in the database.
java.lang.String getName()
Get the name of this source.
ContentValues lastRecord()
Query for the newest record we have stored.
void onWebData(java.net.URL url, java.lang.Object obj,
long fileDate)
This method is invoked when a data record is retrieved
from the URL we were invoked on.
void onWebDone()
This method is invoked when the given URL has been fully
fetched.
void onWebError(java.lang.String msg)

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/net/WebBasedData.html[2/19/2011 9:13:38 AM]


WebBasedData

Handle an error while fetching web data.


protected void process(ContentValues rec)
Optional processing step -- this is called for each record
we read.
void setDatabase(SQLiteDatabase db)
Set the database we use for storing our data.
void update(long now)
Check to see whether we need to update our stored data.
void upgradeTable(SQLiteDatabase db, int oldV, int newV)
Upgrade or table in the database to a new version.

Methods inherited from class java.util.Observable


addObserver, clearChanged, countObservers, deleteObserver, deleteObservers,
hasChanged, notifyObservers, notifyObservers, setChanged

Methods inherited from class java.lang.Object


clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString,
wait, wait, wait

All Classes
AppUtils Constructor Detail
AppUtils.Detail
AudioAnalyser
AudioReader WebBasedData
AudioReader.Listener
public WebBasedData(java.lang.String name,
CachedFile java.lang.String base,
CachedFile.Entry java.lang.String suff,
DatabaseHelper long interval,
boolean ldate,
DbSchema java.lang.String[] fields)
Effect
ErrorDialog Create a web-based data source.
Errors
FileFetcher Parameters:
Gauge name - The name of this source, and its database table.
HelpActivity base - The base URL for this source; this is the whole URL if urlSuff is
HScrollView null.
InfoBox suff - The URL suffix. If not null, the URL is urlBase + date + urlSuff,
Instrument where date is in the format "20091231".
InstrumentSurface interval - Interval in ms between records in the source.
LinedEditText ldate - If true, the source uses long-format dates.
MainActivity fields - Names for the fields in the source.
MainActivity.ActivityList
MultistateImageButton
OneTimeDialog Method Detail
Player
PowerGauge createTable
SpectrumGauge
SplashActivity public void createTable(SQLiteDatabase db)
SurfaceRunner
TableFetcher Create our table in the database.
TableProvider
TableSchema Parameters:
TextGauge db - The database.

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/net/WebBasedData.html[2/19/2011 9:13:38 AM]


WebBasedData

TextInputDialog
TextInputDialog.OnOkL
upgradeTable
TimeZoneActivity
WaveformGauge
WebBasedData
public void upgradeTable(SQLiteDatabase db,
WebFetcher int oldV,
WebFetcher.FetchExce int newV)
WebFetcher.Listener
YesNoDialog Upgrade or table in the database to a new version.
YesNoDialog.OnOkListe
Parameters:
db - The database.
oldV - Version we're upgrading from.
newV - Version we're upgrading to.

setDatabase
public void setDatabase(SQLiteDatabase db)

Set the database we use for storing our data.

Parameters:
db - The database. Will be null if the database is being closed.

getName
public java.lang.String getName()

Get the name of this source.

Returns:
The name of this source.

allRecords
public Cursor allRecords()

Query for all records we have stored. It is the caller's responsibility to call
close() on the cursor when done.

Returns:
A Cursor over all the records, sorted in ascending date order. The Cursor
is positioned before the first record.

allRecordsSince
public Cursor allRecordsSince(long date)

Query for all records we have stored timstamped AFTER a given date. It is the
caller's responsibility to call close() on the cursor when done.

Parameters:

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/net/WebBasedData.html[2/19/2011 9:13:38 AM]


WebBasedData

- Cut-off date -- only return records newer than this date (not
date
equal).
Returns:
A Cursor over all the records, sorted in ascending date order. The Cursor
is positioned before the first record.

lastRecord
public ContentValues lastRecord()

Query for the newest record we have stored.

Returns:
The contents of the last record we have. Returns null if there are no
records.

update
public void update(long now)

Check to see whether we need to update our stored data. If so, kick off a web
fetch. The observers will be notified for any new data that we load.

Parameters:
now - The current time in millis.

process
protected void process(ContentValues rec)

Optional processing step -- this is called for each record we read. It can be
used to add synthesized values.

Parameters:
rec - The record to process.

onWebData
public void onWebData(java.net.URL url,
java.lang.Object obj,
long fileDate)

This method is invoked when a data record is retrieved from the URL we were
invoked on.

Specified by:
onWebData in interface WebFetcher.Listener

Parameters:
url - The URL of the source being loaded.
obj - The object that was loaded; the type depends on the fetcher class
used.
fileDate - The last modified time of the source file, as reported by the

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/net/WebBasedData.html[2/19/2011 9:13:38 AM]


WebBasedData

server, in ms UTC.

onWebDone
public void onWebDone()

This method is invoked when the given URL has been fully fetched.

Specified by:
onWebDone in interface WebFetcher.Listener

onWebError
public void onWebError(java.lang.String msg)

Handle an error while fetching web data.

Specified by:
onWebError in interface WebFetcher.Listener

Parameters:
msg - The error message.

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/net/WebBasedData.html[2/19/2011 9:13:38 AM]


Uses of Class org.hermit.android.core.SurfaceRunner

Overview Package Class Use Tree Deprecated Index Help


PREV NEXT FRAMES NO FRAMES All Classes

Uses of Class
org.hermit.android.core.SurfaceRunner

Packages that use SurfaceRunner


org.hermit.android.instruments

Uses of SurfaceRunner in org.hermit.android.instruments

Subclasses of SurfaceRunner in org.hermit.android.instruments


class InstrumentSurface
Common base for applications which display instruments.

Methods in org.hermit.android.instruments that return SurfaceRunner


protected
SurfaceRunner Instrument.getSurface()
Get the app context of this Element.
protected
SurfaceRunner Gauge.getSurface()
Get the app context of this Element.

Methods in org.hermit.android.instruments with parameters of type SurfaceRunner


PowerGauge AudioAnalyser.getPowerGauge(SurfaceRunner surface)
Get a signal power gauge for this audio analyser.
SpectrumGauge AudioAnalyser.getSpectrumGauge(SurfaceRunner surface)
Get a spectrum analyser gauge for this audio analyser.
WaveformGauge AudioAnalyser.getWaveformGauge(SurfaceRunner surface)
Get a waveform gauge for this audio analyser.

Constructors in org.hermit.android.instruments with parameters of type SurfaceRunner


AudioAnalyser(SurfaceRunner parent)
Create a WindMeter instance.
Gauge(SurfaceRunner parent)
Set up this view.
Gauge(SurfaceRunner parent, int options)
Set up this view.
Gauge(SurfaceRunner parent, int grid, int plot)
Set up this view.
Gauge(SurfaceRunner parent, int options, int grid, int plot)

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/core/class-use/SurfaceRunner.html[2/19/2011 9:13:40 AM]


Uses of Class org.hermit.android.core.SurfaceRunner

Set up this view.


Instrument(SurfaceRunner parent)
Set up this view.
TextGauge(SurfaceRunner parent)
Set up this view, and configure the text fields to be displayed in this element.
TextGauge(SurfaceRunner parent, java.lang.String[] template, int rows)
Set up this view, and configure the text fields to be displayed in this element.

Overview Package Class Use Tree Deprecated Index Help


PREV NEXT FRAMES NO FRAMES All Classes

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/core/class-use/SurfaceRunner.html[2/19/2011 9:13:40 AM]


SurfaceRunner

All Classes Overview Package Class Use Tree Deprecated Index Help
PREV CLASS NEXT CLASS FRAMES NO FRAMES
Packages SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
org.hermit.android.core
org.hermit.android.instru
org.hermit.android.io org.hermit.android.core
org.hermit.android.net
org.hermit.android.notic Class SurfaceRunner
org.hermit.android.prov
java.lang.Object
org.hermit.android.soun
SurfaceView
org.hermit.android.widg org.hermit.android.core.SurfaceRunner

Direct Known Subclasses:


InstrumentSurface

public abstract class SurfaceRunner


extends SurfaceView

Common base for applications with an animated view. This class can be used in
games etc. It handles all the setup states of a SurfaceView, and provides a Thread
which the app can use to manage the animation.

When using this class in an app, the app context must call these methods (usually
from its corresponding Activity methods):

onStart()
onResume()
onPause()
onStop()

The surface is enabled once it is created and sized, and onStart() and onResume()
have been called. You then start and stop it by calling surfaceStart() and
surfaceStop() .

Field Summary
static int LOOPED_TICKER
Surface runner option: use a Looper to drive animations.
static int SURFACE_DYNAMIC
Surface runner option: handle configuration changes dynamically.

Constructor Summary
SurfaceRunner(Context app)
Create a SurfaceRunner instance.
SurfaceRunner(Context app, AttributeSet attrs)
Create a SurfaceRunner instance.
SurfaceRunner(Context app, int options)
Create a SurfaceRunner instance.

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/core/SurfaceRunner.html[2/19/2011 9:13:43 AM]


SurfaceRunner

Method Summary
protected
abstract void animStart()
We are starting the animation loop.
protected
abstract void animStop()
We are stopping the animation loop, for example to pause
the app.
protected
abstract void appSize(int width, int height, Bitmap.Config config)
Set the screen size.
protected
abstract void appStart()
The application is starting.
protected
abstract void appStop()
The application is closing down.
protected
abstract void doDraw(Canvas canvas, long now)
Draw the current frame of the application.
protected
abstract void doUpdate(long now)
Update the state of the application for the current frame.
Bitmap getBitmap()
Get a Bitmap which is the same size and format as the
surface.
Bitmap getBitmap(int w, int h)
Get a Bitmap of a given size, in the same format as the
surface.
java.lang.String getRes(int resid)
Get the String value of a resource.
void onPause()
Pause the app.
void onResume()
We're resuming the app.
void onStart()
The application is starting.
void onStop()
The application is closing down.
boolean onSurfaceThread()
Determine whether the caller is on the surface's animation
thread.
void onWindowFocusChanged(boolean hasWindowFocus)
Handle changes in focus.
boolean optionSet(int option)
Check whether the given option flag is set on this surface.
void postUpdate()
Asynchronously schedule an update; i.e.
void setDebugPerf(boolean enable)
Turn display of performance info on or off.
void setDebugPos(int x, int y)
Set the screen position at which we display performance
info.
void

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/core/SurfaceRunner.html[2/19/2011 9:13:43 AM]


SurfaceRunner

setDelay(long delay)
Set the delay in ms in each iteration of the main loop.
void statsCount(int index, int val)
Increment a performance counter.
protected void statsCreate(java.lang.String[] labels)
Reserve space in the stats display for some application
performance stats.
void statsTime(int index, long val)
Record a performance timer.
void surfaceChanged(SurfaceHolder holder, int format, int width,
int height)
This is called immediately after any structural changes
(format or size) have been made to the surface.
void surfaceCreated(SurfaceHolder holder)
This is called immediately after the surface is first created.
void surfaceDestroyed(SurfaceHolder holder)
This is called immediately before a surface is destroyed.
void surfaceStart()
Start the surface running.
void surfaceStop()
Stop the surface running.

Methods inherited from class java.lang.Object


clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString,
wait, wait, wait

Field Detail
SURFACE_DYNAMIC
public static final int SURFACE_DYNAMIC

Surface runner option: handle configuration changes dynamically. If set,


configuration changes such as screen orientation changes will be passed up to
the app; otherwise, it is assumed that we will re-start for these.

See Also:
Constant Field Values

LOOPED_TICKER
public static final int LOOPED_TICKER

Surface runner option: use a Looper to drive animations. This allows


asynchronous updates to be posted by the app.

See Also:
Constant Field Values

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/core/SurfaceRunner.html[2/19/2011 9:13:43 AM]


SurfaceRunner

Constructor Detail
SurfaceRunner
All Classes
AppUtils public SurfaceRunner(Context app)
AppUtils.Detail
AudioAnalyser Create a SurfaceRunner instance.
AudioReader
AudioReader.Listener Parameters:
CachedFile app - The application context we're running in.
CachedFile.Entry
DatabaseHelper
DbSchema SurfaceRunner
Effect
ErrorDialog public SurfaceRunner(Context app,
Errors int options)
FileFetcher
Gauge Create a SurfaceRunner instance.
HelpActivity
HScrollView Parameters:
app - The application context we're running in.
InfoBox
options - Options for this SurfaceRunner. A bitwise OR of SURFACE_XXX
Instrument
InstrumentSurface
constants.
LinedEditText
MainActivity
MainActivity.ActivityList SurfaceRunner
MultistateImageButton
OneTimeDialog public SurfaceRunner(Context app,
Player AttributeSet attrs)
PowerGauge
Create a SurfaceRunner instance.
SpectrumGauge
SplashActivity
Parameters:
SurfaceRunner
app - The application context we're running in.
TableFetcher
attrs - Layout attributes for this SurfaceRunner.
TableProvider
TableSchema
TextGauge Method Detail
TextInputDialog
TextInputDialog.OnOkL
TimeZoneActivity optionSet
WaveformGauge
WebBasedData public boolean optionSet(int option)
WebFetcher
WebFetcher.FetchExce Check whether the given option flag is set on this surface.
WebFetcher.Listener
YesNoDialog Parameters:
YesNoDialog.OnOkListe option - The option flag to test; one of SURFACE_XXX.
Returns:
true iff the option is set.

setDelay
public void setDelay(long delay)

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/core/SurfaceRunner.html[2/19/2011 9:13:43 AM]


SurfaceRunner

Set the delay in ms in each iteration of the main loop.

Parameters:
delay - The time in ms to sleep each time round the main animation loop.
If zero, we will not sleep, but will run continuously.

If you want to do all your animation under direct app control using
postUpdate() , just set a large delay. You may want to consider using
1000 -- i.e. one second -- to make sure you get a refresh at a decent
interval.

surfaceCreated
public void surfaceCreated(SurfaceHolder holder)

This is called immediately after the surface is first created. Implementations of


this should start up whatever rendering code they desire. Note that only one
thread can ever draw into a Surface, so you should not draw into the Surface
here if your normal rendering will be in another thread.

Parameters:
holder - The SurfaceHolder whose surface is being created.

surfaceChanged
public void surfaceChanged(SurfaceHolder holder,
int format,
int width,
int height)

This is called immediately after any structural changes (format or size) have
been made to the surface. This method is always called at least once, after
surfaceCreated(SurfaceHolder).

Parameters:
holder - The SurfaceHolder whose surface has changed.
format - The new PixelFormat of the surface.
width - The new width of the surface.
height - The new height of the surface.

surfaceDestroyed
public void surfaceDestroyed(SurfaceHolder holder)

This is called immediately before a surface is destroyed. After returning from


this call, you should no longer try to access this surface. If you have a
rendering thread that directly accesses the surface, you must ensure that
thread is no longer touching the Surface before returning from this function.

Parameters:
holder - The SurfaceHolder whose surface is being destroyed.

onStart

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/core/SurfaceRunner.html[2/19/2011 9:13:43 AM]


SurfaceRunner

public void onStart()

The application is starting. Applications must call this from their


Activity.onStart() method.

onResume
public void onResume()

We're resuming the app. Applications must call this from their
Activity.onResume() method.

surfaceStart
public void surfaceStart()

Start the surface running. Applications must call this to set the surface going.
They may use this to implement their own level of start/stop control, for
example to implement a "pause" button.

surfaceStop
public void surfaceStop()

Stop the surface running. Applications may call this to stop the surface running.
They may use this to implement their own level of start/stop control, for
example to implement a "pause" button.

onPause
public void onPause()

Pause the app. Applications must call this from their Activity.onPause() method.

onStop
public void onStop()

The application is closing down. Applications must call this from their
Activity.onStop() method.

onWindowFocusChanged
public void onWindowFocusChanged(boolean hasWindowFocus)

Handle changes in focus. When we lose focus, pause the game so a popup
(like the menu) doesn't cause havoc.

Parameters:

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/core/SurfaceRunner.html[2/19/2011 9:13:43 AM]


SurfaceRunner

hasWindowFocus - True iff we have focus.

postUpdate
public void postUpdate()

Asynchronously schedule an update; i.e. a frame of animation. This can only be


called if the SurfaceRunner was created with the option LOOPED_TICKER.

appStart
protected abstract void appStart()

The application is starting. Perform any initial set-up prior to starting the
application. We may not have a screen size yet, so this is not a good place to
allocate resources which depend on that.

appSize
protected abstract void appSize(int width,
int height,
Bitmap.Config config)

Set the screen size. This is guaranteed to be called before animStart(), but
perhaps not before appStart().

Parameters:
width - The new width of the surface.
height - The new height of the surface.
config - The pixel format of the surface.

animStart
protected abstract void animStart()

We are starting the animation loop. The screen size is known.

doUpdate() and doDraw() may be called from this point on.

animStop
protected abstract void animStop()

We are stopping the animation loop, for example to pause the app.

doUpdate() and doDraw() will not be called from this point on.

appStop
protected abstract void appStop()

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/core/SurfaceRunner.html[2/19/2011 9:13:43 AM]


SurfaceRunner

The application is closing down. Clean up any resources.

doUpdate
protected abstract void doUpdate(long now)

Update the state of the application for the current frame.

Applications must override this, and can use it to update for example the
physics of a game. This may be a no-op in some cases.

doDraw() will always be called after this method is called; however, the
converse is not true, as we sometimes need to draw just to update the screen.
Hence this method is useful for updates which are dependent on time rather
than frames.

Parameters:
now - Current time in ms.

doDraw
protected abstract void doDraw(Canvas canvas,
long now)

Draw the current frame of the application.

Applications must override this, and are expected to draw the entire screen into
the provided canvas.

This method will always be called after a call to doUpdate(), and also when the
screen needs to be re-drawn.

Parameters:
canvas - The Canvas to draw into.
now - Current time in ms. Will be the same as that passed to doUpdate(),
if there was a preceeding call to doUpdate().

getRes
public java.lang.String getRes(int resid)

Get the String value of a resource.

Parameters:
resid - The ID of the resource we want.
Returns:
The resource value.

getBitmap
public Bitmap getBitmap()

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/core/SurfaceRunner.html[2/19/2011 9:13:43 AM]


SurfaceRunner

Get a Bitmap which is the same size and format as the surface. This can be
used to get an off-screen rendering buffer, for example.

Returns:
A Bitmap which is the same size and pixel format as the screen.

getBitmap
public Bitmap getBitmap(int w,
int h)

Get a Bitmap of a given size, in the same format as the surface. This can be
used to get an off-screen rendering buffer, for example.

Parameters:
w - Desired width in pixels.
h - Desired height in pixels.
Returns:
A Bitmap which is the same size and pixel format as the screen.

onSurfaceThread
public boolean onSurfaceThread()

Determine whether the caller is on the surface's animation thread.

Returns:
The resource value.

setDebugPerf
public void setDebugPerf(boolean enable)

Turn display of performance info on or off.

Parameters:
enable - True to enable performance display.

setDebugPos
public void setDebugPos(int x,
int y)

Set the screen position at which we display performance info.

Parameters:
x - Screen X position.
y - Screen Y position.

statsCreate

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/core/SurfaceRunner.html[2/19/2011 9:13:43 AM]


SurfaceRunner

protected void statsCreate(java.lang.String[] labels)

Reserve space in the stats display for some application performance stats. The
given labels will become stats which will be displayed if setDebugPerf(boolean
enable) is passed true. Each stat is subsequently referred to by its index in this
labels array.

This method must be called before appStart() in order for the app's stats to be
displayed. After appStart() is called, the stats content is frozen until the next
appStop() / appStart(). Typically the app should invoke this method from its
constructor. However this method is, of course, optional.

Parameters:
labels - Labels for the app's stats, one label per stat. Labels need to be 7
chars or less.

statsCount
public void statsCount(int index,
int val)

Increment a performance counter. This method is used for counts of specific


quantities, which will be displayed as counts per second; for example frames
per second.

Parameters:
index - Index of the stat to bump (its index in the "labels" argument to
statsCreate(String[] labels) ).
val - Amount to add to the counter.

statsTime
public void statsTime(int index,
long val)

Record a performance timer. This method is used for timings of specific


activities; the average of the recorded values will be displayed.

Parameters:
index - Index of the stat to record (its index in the "labels" argument to
statsCreate(String[] labels) ).
val - The time value for this iteration.

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/core/SurfaceRunner.html[2/19/2011 9:13:43 AM]


SurfaceRunner

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/core/SurfaceRunner.html[2/19/2011 9:13:43 AM]


Uses of Class org.hermit.android.core.AppUtils.Version

Overview Package Class Use Tree Deprecated Index Help


PREV NEXT FRAMES NO FRAMES All Classes

Uses of Class
org.hermit.android.core.AppUtils.Version

Packages that use AppUtils.Version


org.hermit.android.core A library of foundation classes for Android applications.

Uses of AppUtils.Version in org.hermit.android.core

Methods in org.hermit.android.core that return AppUtils.Version


AppUtils.Version AppUtils.getAppVersion()
Get the version info for the current app.

Overview Package Class Use Tree Deprecated Index Help


PREV NEXT FRAMES NO FRAMES All Classes

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/core/class-use/AppUtils.Version.html[2/19/2011 9:13:46 AM]


AppUtils.Version

All Classes Overview Package Class Use Tree Deprecated Index Help
PREV CLASS NEXT CLASS FRAMES NO FRAMES
Packages SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
org.hermit.android.core
org.hermit.android.instru
org.hermit.android.io org.hermit.android.core
org.hermit.android.net
org.hermit.android.notic Class AppUtils.Version
org.hermit.android.prov
java.lang.Object
org.hermit.android.soun
org.hermit.android.core.AppUtils.Version
org.hermit.android.widg
Enclosing class:
AppUtils

public class AppUtils.Version


extends java.lang.Object

Information on an application version.

Field Summary
java.lang.CharSequence appDesc
Description either of the app or the version.
java.lang.CharSequence appName
Application's pretty name.
All Classes int versionCode
AppUtils
Version code of the app.
AppUtils.Detail
java.lang.CharSequence versionName
AudioAnalyser
AudioReader Version name of the app.
AudioReader.Listener
CachedFile
CachedFile.Entry Constructor Summary
DatabaseHelper
DbSchema AppUtils.Version()
Effect
ErrorDialog
Errors
FileFetcher Method Summary
Gauge
HelpActivity Methods inherited from class java.lang.Object
HScrollView
InfoBox clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString,
wait, wait, wait
Instrument
InstrumentSurface
LinedEditText
MainActivity Field Detail
MainActivity.ActivityList
MultistateImageButton
OneTimeDialog appName
Player
PowerGauge public java.lang.CharSequence appName
SpectrumGauge

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/core/AppUtils.Version.html[2/19/2011 9:13:48 AM]


AppUtils.Version

SplashActivity Application's pretty name. null if unknown.


SurfaceRunner
TableFetcher
TableProvider versionCode
TableSchema
TextGauge public int versionCode
TextInputDialog
TextInputDialog.OnOkL Version code of the app. -1 if unknown.
TimeZoneActivity
WaveformGauge
WebBasedData
WebFetcher
versionName
WebFetcher.FetchExce public java.lang.CharSequence versionName
WebFetcher.Listener
YesNoDialog Version name of the app. null if unknown.
YesNoDialog.OnOkListe

appDesc
public java.lang.CharSequence appDesc

Description either of the app or the version. null if unknown.

Constructor Detail
AppUtils.Version
public AppUtils.Version()

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/core/AppUtils.Version.html[2/19/2011 9:13:48 AM]


Uses of Class org.hermit.android.instruments.AudioAnalyser

Overview Package Class Use Tree Deprecated Index Help


PREV NEXT FRAMES NO FRAMES All Classes

Uses of Class
org.hermit.android.instruments.AudioAnalyser
No usage of org.hermit.android.instruments.AudioAnalyser

Overview Package Class Use Tree Deprecated Index Help


PREV NEXT FRAMES NO FRAMES All Classes

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/instruments/class-use/AudioAnalyser.html[2/19/2011 9:13:50 AM]


AudioAnalyser

All Classes Overview Package Class Use Tree Deprecated Index Help
PREV CLASS NEXT CLASS FRAMES NO FRAMES
Packages SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
org.hermit.android.core
org.hermit.android.instru
org.hermit.android.io org.hermit.android.instruments
org.hermit.android.net
org.hermit.android.notic Class AudioAnalyser
org.hermit.android.prov
java.lang.Object
org.hermit.android.soun
org.hermit.android.instruments.Instrument
org.hermit.android.widg org.hermit.android.instruments.AudioAnalyser

public class AudioAnalyser


extends Instrument

An Instrument which analyses an audio stream in various ways.

To use this class, your application must have permission RECORD_AUDIO.

Constructor Summary
AudioAnalyser(SurfaceRunner parent)
Create a WindMeter instance.

Method Summary
void appStart()
The application is starting.
void appStop()
The application is closing down.
void doUpdate(long now)
Update the state of the instrument for the current frame.
PowerGauge getPowerGauge(SurfaceRunner surface)
Get a signal power gauge for this audio analyser.
SpectrumGauge getSpectrumGauge(SurfaceRunner surface)
Get a spectrum analyser gauge for this audio analyser.
WaveformGauge getWaveformGauge(SurfaceRunner surface)
Get a waveform gauge for this audio analyser.
void measureStart()
We are starting the main run; start measurements.
void measureStop()
We are stopping / pausing the run; stop measurements.
protected restoreState(Bundle icicle)
void
Restore the game state from the given Bundle.
protected saveState(Bundle icicle)
void
Save the state of the game in the provided Bundle.
void setAverageLen(int len)
Set the histogram averaging window for this instrument.

http://moonblink.googlecode.com/.../trunk/HermitAndroid/doc/index.html?org/hermit/android/instruments/AudioAnalyser.html[2/19/2011 9:13:52 AM]


AudioAnalyser

void setBlockSize(int size)


Set the input block size for this instrument.
void setDecimation(int rate)
Set the decimation rate for this instrument.
void setSampleRate(int rate)
Set the sample rate for this instrument.
void setWindowFunc(org.hermit.dsp.Window.Function func)
Set the spectrum analyser windowing function for this
instrument.

Methods inherited from class org.hermit.android.instruments.Instrument


getSurface

Methods inherited from class java.lang.Object


clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString,
wait, wait, wait

Constructor Detail
AudioAnalyser
public AudioAnalyser(SurfaceRunner parent)

All Classes Create a WindMeter instance.


AppUtils
AppUtils.Detail Parameters:
AudioAnalyser parent - Parent surface.
AudioReader
AudioReader.Listener
CachedFile Method Detail
CachedFile.Entry
DatabaseHelper setSampleRate
DbSchema
Effect public void setSampleRate(int rate)
ErrorDialog
Errors Set the sample rate for this instrument.
FileFetcher
Gauge Parameters:
HelpActivity rate - The desired rate, in samples/sec.
HScrollView
InfoBox
setBlockSize
Instrument
InstrumentSurface
LinedEditText
public void setBlockSize(int size)
MainActivity
MainActivity.ActivityList
Set the input block size for this instrument.
MultistateImageButton
OneTimeDialog
Parameters:
Player size - The desired block size, in samples. Typical values would be 256,
PowerGauge 512, or 1024. Larger block sizes will mean more work to analyse the
SpectrumGauge spectrum.
SplashActivity

http://moonblink.googlecode.com/.../trunk/HermitAndroid/doc/index.html?org/hermit/android/instruments/AudioAnalyser.html[2/19/2011 9:13:52 AM]


AudioAnalyser

SurfaceRunner
TableFetcher
TableProvider setWindowFunc
TableSchema
TextGauge public void setWindowFunc(org.hermit.dsp.Window.Function func)
TextInputDialog
TextInputDialog.OnOkL Set the spectrum analyser windowing function for this instrument.
TimeZoneActivity
WaveformGauge Parameters:
func - The desired windowing function.
WebBasedData
WebFetcher
Window.Function.BLACKMAN_HARRIS is a good option.
WebFetcher.FetchExce
Window.Function.RECTANGULAR turns off windowing.
WebFetcher.Listener
YesNoDialog
YesNoDialog.OnOkListe setDecimation

public void setDecimation(int rate)

Set the decimation rate for this instrument.

Parameters:
rate - The desired decimation. Only 1 in rate blocks will actually be
processed.

setAverageLen
public void setAverageLen(int len)

Set the histogram averaging window for this instrument.

Parameters:
len - The averaging interval. 1 means no averaging.

appStart
public void appStart()

The application is starting. Perform any initial set-up prior to starting the
application. We may not have a screen size yet, so this is not a good place to
allocate resources which depend on that.

Overrides:
appStart in class Instrument

measureStart
public void measureStart()

We are starting the main run; start measurements.

Overrides:
measureStart in class Instrument

http://moonblink.googlecode.com/.../trunk/HermitAndroid/doc/index.html?org/hermit/android/instruments/AudioAnalyser.html[2/19/2011 9:13:52 AM]


AudioAnalyser

measureStop
public void measureStop()

We are stopping / pausing the run; stop measurements.

Overrides:
measureStop in class Instrument

appStop
public void appStop()

The application is closing down. Clean up any resources.

Overrides:
appStop in class Instrument

getWaveformGauge
public WaveformGauge getWaveformGauge(SurfaceRunner surface)

Get a waveform gauge for this audio analyser.

Parameters:
surface - The surface in which the gauge will be displayed.
Returns:
A gauge which will display the audio waveform.

getSpectrumGauge
public SpectrumGauge getSpectrumGauge(SurfaceRunner surface)

Get a spectrum analyser gauge for this audio analyser.

Parameters:
surface - The surface in which the gauge will be displayed.
Returns:
A gauge which will display the audio waveform.

getPowerGauge
public PowerGauge getPowerGauge(SurfaceRunner surface)

Get a signal power gauge for this audio analyser.

Parameters:
surface - The surface in which the gauge will be displayed.
Returns:
A gauge which will display the signal power in a dB meter.

http://moonblink.googlecode.com/.../trunk/HermitAndroid/doc/index.html?org/hermit/android/instruments/AudioAnalyser.html[2/19/2011 9:13:52 AM]


AudioAnalyser

doUpdate
public final void doUpdate(long now)

Update the state of the instrument for the current frame. This method must be
invoked from the doUpdate() method of the application's SurfaceRunner .

Since this is called frequently, we first check whether new audio data has
actually arrived.

Overrides:
doUpdate in class Instrument

Parameters:
now - Nominal time of the current frame in ms.

saveState
protected void saveState(Bundle icicle)

Save the state of the game in the provided Bundle.

Overrides:
saveState in class Instrument

Parameters:
icicle - The Bundle in which we should save our state.

restoreState
protected void restoreState(Bundle icicle)

Restore the game state from the given Bundle.

Overrides:
restoreState in class Instrument

Parameters:
icicle - The Bundle containing the saved state.

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

http://moonblink.googlecode.com/.../trunk/HermitAndroid/doc/index.html?org/hermit/android/instruments/AudioAnalyser.html[2/19/2011 9:13:52 AM]


Uses of Class org.hermit.android.instruments.Instrument

Overview Package Class Use Tree Deprecated Index Help


PREV NEXT FRAMES NO FRAMES All Classes

Uses of Class
org.hermit.android.instruments.Instrument

Packages that use Instrument


org.hermit.android.instruments

Uses of Instrument in org.hermit.android.instruments

Subclasses of Instrument in org.hermit.android.instruments


class AudioAnalyser
An Instrument which analyses an audio stream in various ways.

Methods in org.hermit.android.instruments with parameters of type Instrument


void InstrumentSurface.addInstrument(Instrument i)
Add an instrument to the system, associated with this surface.

Overview Package Class Use Tree Deprecated Index Help


PREV NEXT FRAMES NO FRAMES All Classes

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/instruments/class-use/Instrument.html[2/19/2011 9:13:54 AM]


Instrument

All Classes Overview Package Class Use Tree Deprecated Index Help
PREV CLASS NEXT CLASS FRAMES NO FRAMES
Packages SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
org.hermit.android.core
org.hermit.android.instru
org.hermit.android.io org.hermit.android.instruments
org.hermit.android.net
org.hermit.android.notic Class Instrument
org.hermit.android.prov
java.lang.Object
org.hermit.android.soun
org.hermit.android.instruments.Instrument
org.hermit.android.widg
Direct Known Subclasses:
AudioAnalyser

public class Instrument


extends java.lang.Object

An instrument which measures some quantity, or accesses or produces some data,


which can be displayed on one or more Gauge objects.

Constructor Summary
Instrument(SurfaceRunner parent)
Set up this view.

Method Summary
void appStart()
The application is starting.
void appStop()
The application is closing down.
protected doUpdate(long now)
void
Update the state of the instrument for the current frame.
protected
SurfaceRunner getSurface()
Get the app context of this Element.
void measureStart()
We are starting the main run; start measurements.
void measureStop()
We are stopping / pausing the run; stop measurements.
protected restoreState(Bundle icicle)
All Classes void
Restore the game state from the given Bundle.
AppUtils protected saveState(Bundle icicle)
AppUtils.Detail void
AudioAnalyser Save the state of the game in the provided Bundle.
AudioReader
AudioReader.Listener Methods inherited from class java.lang.Object
CachedFile
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString,
CachedFile.Entry wait, wait, wait
DatabaseHelper
DbSchema

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/instruments/Instrument.html[2/19/2011 9:13:56 AM]


Instrument

Effect
ErrorDialog Constructor Detail
Errors
FileFetcher
Gauge Instrument
HelpActivity
HScrollView public Instrument(SurfaceRunner parent)
InfoBox
Instrument Set up this view.
InstrumentSurface
LinedEditText Parameters:
MainActivity parent - Parent surface.
MainActivity.ActivityList
MultistateImageButton
OneTimeDialog
Method Detail
Player
PowerGauge appStart
SpectrumGauge
SplashActivity public void appStart()
SurfaceRunner
TableFetcher The application is starting. Perform any initial set-up prior to starting the
TableProvider application.
TableSchema
TextGauge
TextInputDialog measureStart
TextInputDialog.OnOkL
TimeZoneActivity public void measureStart()
WaveformGauge
WebBasedData We are starting the main run; start measurements.
WebFetcher
WebFetcher.FetchExce
WebFetcher.Listener
YesNoDialog measureStop
YesNoDialog.OnOkListe
public void measureStop()

We are stopping / pausing the run; stop measurements.

appStop
public void appStop()

The application is closing down. Clean up any resources.

doUpdate
protected void doUpdate(long now)

Update the state of the instrument for the current frame.

Instruments may override this, and can use it to read the current input state.
This method is invoked in the main animation loop -- i.e. frequently.

Parameters:
now - Nominal time of the current frame in ms.

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/instruments/Instrument.html[2/19/2011 9:13:56 AM]


Instrument

getSurface
protected SurfaceRunner getSurface()

Get the app context of this Element.

Returns:
The app context we're running in.

saveState
protected void saveState(Bundle icicle)

Save the state of the game in the provided Bundle.

Parameters:
icicle - The Bundle in which we should save our state.

restoreState
protected void restoreState(Bundle icicle)

Restore the game state from the given Bundle.

Parameters:
icicle - The Bundle containing the saved state.

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/instruments/Instrument.html[2/19/2011 9:13:56 AM]


Uses of Class org.hermit.android.core.AppUtils

Overview Package Class Use Tree Deprecated Index Help


PREV NEXT FRAMES NO FRAMES All Classes

Uses of Class
org.hermit.android.core.AppUtils

Packages that use AppUtils


org.hermit.android.core A library of foundation classes for Android applications.

Uses of AppUtils in org.hermit.android.core

Methods in org.hermit.android.core that return AppUtils


static AppUtils AppUtils.getInstance(Activity parent)
Get the app utils instance for this Activity.

Overview Package Class Use Tree Deprecated Index Help


PREV NEXT FRAMES NO FRAMES All Classes

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/core/class-use/AppUtils.html[2/19/2011 9:13:58 AM]


AppUtils

All Classes Overview Package Class Use Tree Deprecated Index Help
PREV CLASS NEXT CLASS FRAMES NO FRAMES
Packages SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
org.hermit.android.core
org.hermit.android.instrum
org.hermit.android.io org.hermit.android.core
org.hermit.android.net
org.hermit.android.notice
Class AppUtils
org.hermit.android.provide
java.lang.Object
org.hermit.android.sound
org.hermit.android.core.AppUtils
org.hermit.android.widgets

public class AppUtils


extends java.lang.Object

This class provides some simple application-related utilities.

Nested Class Summary


static class AppUtils.Detail
Version info detail level.
class AppUtils.Version
Information on an application version.

Method Summary
AppUtils.Version getAppVersion()
Get the version info for the current app.
All Classes
static AppUtils getInstance(Activity parent)
AppUtils
AppUtils.Detail Get the app utils instance for this Activity.
AudioAnalyser java.lang.String getVersionString()
AudioReader Get a string containing the name and version info for the current
AudioReader.Listener app's package, in a simple format.
CachedFile
java.lang.String getVersionString(AppUtils.Detail detail)
CachedFile.Entry
DatabaseHelper Get a string containing the name and version info for the current
DbSchema app's package.
Effect
ErrorDialog Methods inherited from class java.lang.Object
Errors
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait,
FileFetcher wait, wait
Gauge
HelpActivity
HScrollView
InfoBox Method Detail
Instrument
InstrumentSurface
LinedEditText getInstance
MainActivity
MainActivity.ActivityListen public static AppUtils getInstance(Activity parent)
MultistateImageButton
OneTimeDialog Get the app utils instance for this Activity.
Player
PowerGauge Parameters:
SpectrumGauge parent - Activity for which we want information.
SplashActivity Returns:
SurfaceRunner The application utilities instance for this app.

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/core/AppUtils.html[2/19/2011 9:14:01 AM]


AppUtils

TableFetcher
TableProvider
TableSchema getAppVersion
TextGauge
TextInputDialog public AppUtils.Version getAppVersion()
TextInputDialog.OnOkList
TimeZoneActivity Get the version info for the current app.
WaveformGauge
WebBasedData Returns:
WebFetcher App version info. null if the info could not be found.
WebFetcher.FetchExcepti
WebFetcher.Listener
YesNoDialog getVersionString
YesNoDialog.OnOkListen
public java.lang.String getVersionString()

Get a string containing the name and version info for the current app's package, in a
simple format.

Returns:
Descriptive name / version string.

getVersionString
public java.lang.String getVersionString(AppUtils.Detail detail)

Get a string containing the name and version info for the current app's package.

Parameters:
detail - How much detail we want.
Returns:
Descriptive name / version string.

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/core/AppUtils.html[2/19/2011 9:14:01 AM]


Uses of Package org.hermit.android.core

Overview Package Class Use Tree Deprecated Index Help


PREV NEXT FRAMES NO FRAMES All Classes

Uses of Package
org.hermit.android.core

Packages that use org.hermit.android.core


org.hermit.android.core A library of foundation classes for Android applications.
org.hermit.android.instruments

Classes in org.hermit.android.core used by


org.hermit.android.core
AppUtils
This class provides some simple application-related utilities.
AppUtils.Detail
Version info detail level.
AppUtils.Version
Information on an application version.
Errors
Error handling and reporting utilities.
MainActivity.ActivityListener
This interface defines a listener for sub-activity results.

Classes in org.hermit.android.core used by


org.hermit.android.instruments
SurfaceRunner
Common base for applications with an animated view.

Overview Package Class Use Tree Deprecated Index Help


PREV NEXT FRAMES NO FRAMES All Classes

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/core/package-use.html[2/19/2011 9:14:04 AM]


org.hermit.android.core

All Classes Overview Package Class Use Tree Deprecated Index Help
PREV PACKAGE NEXT PACKAGE FRAMES NO FRAMES
Packages
org.hermit.android.core
org.hermit.android.instru
org.hermit.android.io
Package org.hermit.android.core
org.hermit.android.net
org.hermit.android.notic A library of foundation classes for Android applications.
org.hermit.android.prov
See:
org.hermit.android.soun Description
org.hermit.android.widg

Class Summary
This class provides some simple application-
AppUtils
related utilities.
Errors Error handling and reporting utilities.
All Classes An activity which displays an application's help, in
HelpActivity
AppUtils a structured format.
AppUtils.Detail An enhanced Activity class, for use as the main
MainActivity
AudioAnalyser activity of an application.
AudioReader
AudioReader.Listener MainActivity.ActivityListener This interface defines a listener for sub-activity
CachedFile results.
CachedFile.Entry OneTimeDialog A class which handles showing one-off notices.
DatabaseHelper
An activity which displays a splash screen and
DbSchema SplashActivity
Effect
then returns to the calling activity.
ErrorDialog Common base for applications with an animated
SurfaceRunner
Errors view.
FileFetcher
Gauge
HelpActivity
HScrollView Enum Summary
InfoBox
Instrument AppUtils.Detail Version info detail level.
InstrumentSurface
LinedEditText
MainActivity
MainActivity.ActivityList
Package org.hermit.android.core Description
MultistateImageButton
OneTimeDialog A library of foundation classes for Android applications.
Player
PowerGauge
Overview Package Class Use Tree Deprecated Index Help
SpectrumGauge
PREV PACKAGE NEXT PACKAGE FRAMES NO FRAMES
SplashActivity
SurfaceRunner
TableFetcher
TableProvider
TableSchema
TextGauge
TextInputDialog
TextInputDialog.OnOkL
TimeZoneActivity

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/core/package-summary.html[2/19/2011 9:14:06 AM]


org.hermit.android.core

WaveformGauge
WebBasedData
WebFetcher
WebFetcher.FetchException
WebFetcher.Listener

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/core/package-summary.html[2/19/2011 9:14:06 AM]


Uses of Class org.hermit.android.core.AppUtils.Detail

Overview Package Class Use Tree Deprecated Index Help


PREV NEXT FRAMES NO FRAMES All Classes

Uses of Class
org.hermit.android.core.AppUtils.Detail

Packages that use AppUtils.Detail


org.hermit.android.core A library of foundation classes for Android applications.

Uses of AppUtils.Detail in org.hermit.android.core

Methods in org.hermit.android.core that return AppUtils.Detail


static AppUtils.Detail AppUtils.Detail.valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.
static AppUtils.Detail[] AppUtils.Detail.values()
Returns an array containing the constants of this enum type, in the order
they are declared.

Methods in org.hermit.android.core with parameters of type AppUtils.Detail


java.lang.String AppUtils.getVersionString(AppUtils.Detail detail)
Get a string containing the name and version info for the current app's package.

Overview Package Class Use Tree Deprecated Index Help


PREV NEXT FRAMES NO FRAMES All Classes

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/core/class-use/AppUtils.Detail.html[2/19/2011 9:14:09 AM]


AppUtils.Detail

All Classes Overview Package Class Use Tree Deprecated Index Help
PREV CLASS NEXT CLASS FRAMES NO FRAMES
Packages SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD DETAIL: ENUM CONSTANTS | FIELD | METHOD
org.hermit.android.core
org.hermit.android.instru
org.hermit.android.io org.hermit.android.core
org.hermit.android.net
org.hermit.android.notic Enum AppUtils.Detail
org.hermit.android.prov
java.lang.Object
org.hermit.android.soun
java.lang.Enum<AppUtils.Detail>
org.hermit.android.widg org.hermit.android.core.AppUtils.Detail

All Implemented Interfaces:


java.io.Serializable, java.lang.Comparable<AppUtils.Detail>

Enclosing class:
AppUtils

public static enum AppUtils.Detail


extends java.lang.Enum<AppUtils.Detail>

Version info detail level.

Enum Constant Summary


DEBUG
Show debug-level detail.
NONE
Do not display.
SIMPLE
Show basic name and version.

All Classes Method Summary


AppUtils static AppUtils.Detail valueOf(java.lang.String name)
AppUtils.Detail
Returns the enum constant of this type with the
AudioAnalyser
specified name.
AudioReader
static AppUtils.Detail[] values()
AudioReader.Listener
CachedFile Returns an array containing the constants of this
CachedFile.Entry enum type, in the order they are declared.
DatabaseHelper
DbSchema
Effect
Methods inherited from class java.lang.Enum
ErrorDialog clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name,
ordinal, toString, valueOf
Errors
FileFetcher
Gauge Methods inherited from class java.lang.Object
HelpActivity getClass, notify, notifyAll, wait, wait, wait
HScrollView
InfoBox
Instrument

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/core/AppUtils.Detail.html[2/19/2011 9:14:12 AM]


AppUtils.Detail

InstrumentSurface Enum Constant Detail


LinedEditText
MainActivity
MainActivity.ActivityList NONE
MultistateImageButton
OneTimeDialog public static final AppUtils.Detail NONE
Player
PowerGauge Do not display.
SpectrumGauge
SplashActivity
SurfaceRunner SIMPLE
TableFetcher
TableProvider public static final AppUtils.Detail SIMPLE
TableSchema
TextGauge Show basic name and version.
TextInputDialog
TextInputDialog.OnOkL
TimeZoneActivity DEBUG
WaveformGauge
WebBasedData public static final AppUtils.Detail DEBUG
WebFetcher
WebFetcher.FetchExce Show debug-level detail.
WebFetcher.Listener
YesNoDialog
YesNoDialog.OnOkListe Method Detail
values
public static AppUtils.Detail[] values()

Returns an array containing the constants of this enum type, in the order they
are declared. This method may be used to iterate over the constants as
follows:
for (AppUtils.Detail c : AppUtils.Detail.values())
System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are
declared

valueOf
public static AppUtils.Detail valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string
must match exactly an identifier used to declare an enum constant in this type.
(Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
java.lang.IllegalArgumentException - if this enum type has no constant
with the specified name

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/core/AppUtils.Detail.html[2/19/2011 9:14:12 AM]


AppUtils.Detail

java.lang.NullPointerException - if the argument is null

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES
SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD DETAIL: ENUM CONSTANTS | FIELD | METHOD

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/core/AppUtils.Detail.html[2/19/2011 9:14:12 AM]


Uses of Package org.hermit.android.instruments

Overview Package Class Use Tree Deprecated Index Help


PREV NEXT FRAMES NO FRAMES All Classes

Uses of Package
org.hermit.android.instruments

Packages that use org.hermit.android.instruments


org.hermit.android.instruments

Classes in org.hermit.android.instruments used by


org.hermit.android.instruments
Gauge
A graphical display which shows some data in a region within a view.
Instrument
An instrument which measures some quantity, or accesses or produces some data, which can be
displayed on one or more Gauge objects.
PowerGauge
A graphical display which displays the signal power in dB from an AudioAnalyser instrument.
SpectrumGauge
A graphical display which displays the audio spectrum from an AudioAnalyser instrument.
WaveformGauge
A graphical display which displays the audio waveform from an AudioAnalyser instrument.

Overview Package Class Use Tree Deprecated Index Help


PREV NEXT FRAMES NO FRAMES All Classes

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/instruments/package-use.html[2/19/2011 9:14:14 AM]


org.hermit.android.instruments

All Classes Overview Package Class Use Tree Deprecated Index Help
PREV PACKAGE NEXT PACKAGE FRAMES NO FRAMES
Packages
org.hermit.android.core
org.hermit.android.instru
org.hermit.android.io
Package org.hermit.android.instruments
org.hermit.android.net
org.hermit.android.notic Class Summary
org.hermit.android.prov
org.hermit.android.soun AudioAnalyser An Instrument which analyses an audio stream in various
org.hermit.android.widg ways.
A graphical display which shows some data in a region within
Gauge
a view.
An instrument which measures some quantity, or accesses or
Instrument produces some data, which can be displayed on one or more
Gauge objects.
InstrumentSurface Common base for applications which display instruments.
All Classes
A graphical display which displays the signal power in dB
AppUtils PowerGauge
AppUtils.Detail from an AudioAnalyser instrument.
AudioAnalyser A graphical display which displays the audio spectrum from
SpectrumGauge
AudioReader an AudioAnalyser instrument.
AudioReader.Listener
A Gauge which displays data in textual form, generally as a
CachedFile TextGauge
CachedFile.Entry grid of numeric values.
DatabaseHelper A graphical display which displays the audio waveform from
WaveformGauge
DbSchema an AudioAnalyser instrument.
Effect
ErrorDialog
Errors
FileFetcher Overview Package Class Use Tree Deprecated Index Help
Gauge PREV PACKAGE NEXT PACKAGE FRAMES NO FRAMES
HelpActivity
HScrollView
InfoBox
Instrument
InstrumentSurface
LinedEditText
MainActivity
MainActivity.ActivityList
MultistateImageButton
OneTimeDialog
Player
PowerGauge
SpectrumGauge
SplashActivity
SurfaceRunner
TableFetcher
TableProvider
TableSchema
TextGauge
TextInputDialog
TextInputDialog.OnOkL
TimeZoneActivity

http://moonblink.googlecode.com/...k/HermitAndroid/doc/index.html?org/hermit/android/instruments/package-summary.html[2/19/2011 9:14:16 AM]


org.hermit.android.instruments

WaveformGauge
WebBasedData
WebFetcher
WebFetcher.FetchException
WebFetcher.Listener

http://moonblink.googlecode.com/...k/HermitAndroid/doc/index.html?org/hermit/android/instruments/package-summary.html[2/19/2011 9:14:16 AM]


Uses of Class org.hermit.android.io.AudioReader

Overview Package Class Use Tree Deprecated Index Help


PREV NEXT FRAMES NO FRAMES All Classes

Uses of Class
org.hermit.android.io.AudioReader
No usage of org.hermit.android.io.AudioReader

Overview Package Class Use Tree Deprecated Index Help


PREV NEXT FRAMES NO FRAMES All Classes

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/io/class-use/AudioReader.html[2/19/2011 9:14:18 AM]


AudioReader

All Classes Overview Package Class Use Tree Deprecated Index Help
PREV CLASS NEXT CLASS FRAMES NO FRAMES
Packages SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
org.hermit.android.core
org.hermit.android.instru
org.hermit.android.io org.hermit.android.io
org.hermit.android.net
org.hermit.android.notic Class AudioReader
org.hermit.android.prov
java.lang.Object
org.hermit.android.soun
org.hermit.android.io.AudioReader
org.hermit.android.widg

public class AudioReader


extends java.lang.Object

A class which reads audio input from the mic in a background thread and passes it to
the caller when ready.

To use this class, your application must have permission RECORD_AUDIO.

Nested Class Summary


static class AudioReader.Listener
Listener for audio reads.
All Classes

Constructor Summary
AppUtils
AppUtils.Detail
AudioAnalyser
AudioReader()
AudioReader
Create an AudioReader instance.
AudioReader.Listener
CachedFile
CachedFile.Entry
DatabaseHelper
Method Summary
DbSchema void startReader(int rate, int block, AudioReader.Listener listener)
Effect Start this reader.
ErrorDialog void stopReader()
Errors
FileFetcher
Start this reader.
Gauge
HelpActivity Methods inherited from class java.lang.Object
HScrollView clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString,
InfoBox wait, wait, wait
Instrument
InstrumentSurface
LinedEditText
MainActivity Constructor Detail
MainActivity.ActivityList
MultistateImageButton
OneTimeDialog AudioReader
Player
PowerGauge public AudioReader()
SpectrumGauge
SplashActivity Create an AudioReader instance.
SurfaceRunner

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/io/AudioReader.html[2/19/2011 9:14:20 AM]


AudioReader

TableFetcher Method Detail


TableProvider
TableSchema
TextGauge startReader
TextInputDialog
TextInputDialog.OnOkL public void startReader(int rate,
TimeZoneActivity int block,
AudioReader.Listener listener)
WaveformGauge
WebBasedData Start this reader.
WebFetcher
WebFetcher.FetchExce Parameters:
WebFetcher.Listener rate - The audio sampling rate, in samples / sec.
YesNoDialog block - Number of samples of input to read at a time. This is different
YesNoDialog.OnOkListe from the system audio buffer size.
listener - Listener to be notified on each completed read.

stopReader
public void stopReader()

Start this reader.

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/io/AudioReader.html[2/19/2011 9:14:20 AM]


Uses of Package org.hermit.android.io

Overview Package Class Use Tree Deprecated Index Help


PREV NEXT FRAMES NO FRAMES All Classes

Uses of Package
org.hermit.android.io

Packages that use org.hermit.android.io


org.hermit.android.io

Classes in org.hermit.android.io used by org.hermit.android.io


AudioReader.Listener
Listener for audio reads.

Overview Package Class Use Tree Deprecated Index Help


PREV NEXT FRAMES NO FRAMES All Classes

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/io/package-use.html[2/19/2011 9:14:22 AM]


org.hermit.android.io

All Classes Overview Package Class Use Tree Deprecated Index Help
PREV PACKAGE NEXT PACKAGE FRAMES NO FRAMES
Packages
org.hermit.android.core
org.hermit.android.instru
org.hermit.android.io
Package org.hermit.android.io
org.hermit.android.net
org.hermit.android.notic Class Summary
org.hermit.android.prov
org.hermit.android.soun AudioReader A class which reads audio input from the mic in a
org.hermit.android.widg background thread and passes it to the caller when ready.
AudioReader.Listener Listener for audio reads.

Overview Package Class Use Tree Deprecated Index Help


PREV PACKAGE NEXT PACKAGE FRAMES NO FRAMES

All Classes
AppUtils
AppUtils.Detail
AudioAnalyser
AudioReader
AudioReader.Listener
CachedFile
CachedFile.Entry
DatabaseHelper
DbSchema
Effect
ErrorDialog
Errors
FileFetcher
Gauge
HelpActivity
HScrollView
InfoBox
Instrument
InstrumentSurface
LinedEditText
MainActivity
MainActivity.ActivityList
MultistateImageButton
OneTimeDialog
Player
PowerGauge
SpectrumGauge
SplashActivity
SurfaceRunner
TableFetcher
TableProvider
TableSchema
TextGauge
TextInputDialog
TextInputDialog.OnOkL
TimeZoneActivity

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/io/package-summary.html[2/19/2011 9:14:24 AM]


org.hermit.android.io

WaveformGauge
WebBasedData
WebFetcher
WebFetcher.FetchException
WebFetcher.Listener

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/io/package-summary.html[2/19/2011 9:14:24 AM]


Uses of Class org.hermit.android.io.AudioReader.Listener

Overview Package Class Use Tree Deprecated Index Help


PREV NEXT FRAMES NO FRAMES All Classes

Uses of Class
org.hermit.android.io.AudioReader.Listener

Packages that use AudioReader.Listener


org.hermit.android.io

Uses of AudioReader.Listener in org.hermit.android.io

Methods in org.hermit.android.io with parameters of type AudioReader.Listener


void AudioReader.startReader(int rate, int block, AudioReader.Listener listener)
Start this reader.

Overview Package Class Use Tree Deprecated Index Help


PREV NEXT FRAMES NO FRAMES All Classes

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/io/class-use/AudioReader.Listener.html[2/19/2011 9:14:27 AM]


AudioReader.Listener

All Classes Overview Package Class Use Tree Deprecated Index Help
PREV CLASS NEXT CLASS FRAMES NO FRAMES
Packages SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
org.hermit.android.core
org.hermit.android.instru
org.hermit.android.io org.hermit.android.io
org.hermit.android.net
org.hermit.android.notic Class AudioReader.Listener
org.hermit.android.prov
java.lang.Object
org.hermit.android.soun
org.hermit.android.io.AudioReader.Listener
org.hermit.android.widg
Enclosing class:
AudioReader

public abstract static class AudioReader.Listener


extends java.lang.Object

Listener for audio reads.

Field Summary
static int ERR_INIT_FAILED
Audio read error code: the audio reader failed to initialise.
static int ERR_OK
Audio read error code: no error.
static int ERR_READ_FAILED
Audio read error code: an audio read failed.

Constructor Summary
AudioReader.Listener()

All Classes
AppUtils
AppUtils.Detail Method Summary
AudioAnalyser
abstract onReadComplete(short[] buffer)
AudioReader void
AudioReader.Listener An audio read has completed.
CachedFile abstract onReadError(int error)
void
CachedFile.Entry An error has occurred.
DatabaseHelper
DbSchema
Effect Methods inherited from class java.lang.Object
ErrorDialog clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString,
Errors wait, wait, wait
FileFetcher
Gauge

Field Detail
HelpActivity
HScrollView
InfoBox
Instrument
InstrumentSurface
ERR_OK

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/io/AudioReader.Listener.html[2/19/2011 9:14:31 AM]


AudioReader.Listener

LinedEditText
public static final int ERR_OK
MainActivity
MainActivity.ActivityList Audio read error code: no error.
MultistateImageButton
OneTimeDialog See Also:
Player Constant Field Values
PowerGauge
SpectrumGauge
SplashActivity
SurfaceRunner ERR_INIT_FAILED
TableFetcher
TableProvider public static final int ERR_INIT_FAILED
TableSchema
TextGauge Audio read error code: the audio reader failed to initialise.
TextInputDialog
TextInputDialog.OnOkL
See Also:
Constant Field Values
TimeZoneActivity
WaveformGauge
WebBasedData
WebFetcher ERR_READ_FAILED
WebFetcher.FetchExce
WebFetcher.Listener public static final int ERR_READ_FAILED
YesNoDialog
YesNoDialog.OnOkListe Audio read error code: an audio read failed.

See Also:
Constant Field Values

Constructor Detail
AudioReader.Listener
public AudioReader.Listener()

Method Detail
onReadComplete
public abstract void onReadComplete(short[] buffer)

An audio read has completed.

Parameters:
buffer - Buffer containing the data.

onReadError
public abstract void onReadError(int error)

An error has occurred. The reader has been terminated.

Parameters:
error - ERR_XXX code describing the error.

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/io/AudioReader.Listener.html[2/19/2011 9:14:31 AM]


AudioReader.Listener

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/io/AudioReader.Listener.html[2/19/2011 9:14:31 AM]


Uses of Package org.hermit.android.net

Overview Package Class Use Tree Deprecated Index Help


PREV NEXT FRAMES NO FRAMES All Classes

Uses of Package
org.hermit.android.net

Packages that use org.hermit.android.net


org.hermit.android.net

Classes in org.hermit.android.net used by


org.hermit.android.net
CachedFile.Entry
Class describing an entry in the cache; i.e.
WebFetcher
This class fetches data from the web without blocking the main app.
WebFetcher.FetchException
Web fetching exception.
WebFetcher.Listener
Listener for incoming web data.

Overview Package Class Use Tree Deprecated Index Help


PREV NEXT FRAMES NO FRAMES All Classes

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/net/package-use.html[2/19/2011 9:14:34 AM]


org.hermit.android.net

All Classes Overview Package Class Use Tree Deprecated Index Help
PREV PACKAGE NEXT PACKAGE FRAMES NO FRAMES
Packages
org.hermit.android.core
org.hermit.android.instru
org.hermit.android.io
Package org.hermit.android.net
org.hermit.android.net
org.hermit.android.notic Interface Summary
org.hermit.android.prov
org.hermit.android.soun WebFetcher.Listener Listener for incoming web data.
org.hermit.android.widg

Class Summary
This class manages a set of web-based files and caches them
CachedFile
locally.
CachedFile.Entry Class describing an entry in the cache; i.e.
All Classes
Concrete instance of WebFetcher which gets a file and stores it
AppUtils FileFetcher
locally.
AppUtils.Detail
Concrete instance of WebFetcher which fetches tabular data
AudioAnalyser TableFetcher
AudioReader from the web.
AudioReader.Listener This class implements a web-based source of data, which is
WebBasedData
CachedFile cached in a local database.
CachedFile.Entry
This class fetches data from the web without blocking the main
DatabaseHelper WebFetcher
DbSchema app.
Effect
ErrorDialog

Exception Summary
Errors
FileFetcher
Gauge WebFetcher.FetchException Web fetching exception.
HelpActivity
HScrollView
InfoBox
Instrument
Overview Package Class Use Tree Deprecated Index Help
InstrumentSurface
PREV PACKAGE NEXT PACKAGE FRAMES NO FRAMES
LinedEditText
MainActivity
MainActivity.ActivityList
MultistateImageButton
OneTimeDialog
Player
PowerGauge
SpectrumGauge
SplashActivity
SurfaceRunner
TableFetcher
TableProvider
TableSchema
TextGauge
TextInputDialog
TextInputDialog.OnOkL
TimeZoneActivity

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/net/package-summary.html[2/19/2011 9:14:36 AM]


org.hermit.android.net

WaveformGauge
WebBasedData
WebFetcher
WebFetcher.FetchException
WebFetcher.Listener

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/net/package-summary.html[2/19/2011 9:14:36 AM]


Uses of Package org.hermit.android.notice

Overview Package Class Use Tree Deprecated Index Help


PREV NEXT FRAMES NO FRAMES All Classes

Uses of Package
org.hermit.android.notice

Packages that use org.hermit.android.notice


org.hermit.android.notice

Classes in org.hermit.android.notice used by


org.hermit.android.notice
TextInputDialog.OnOkListener
Listener invoked when the user clicks the OK button.
YesNoDialog.OnOkListener
Listener invoked when the user clicks the OK button.

Overview Package Class Use Tree Deprecated Index Help


PREV NEXT FRAMES NO FRAMES All Classes

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/notice/package-use.html[2/19/2011 9:14:38 AM]


org.hermit.android.notice

All Classes Overview Package Class Use Tree Deprecated Index Help
PREV PACKAGE NEXT PACKAGE FRAMES NO FRAMES
Packages
org.hermit.android.core
org.hermit.android.instru
org.hermit.android.io
Package org.hermit.android.notice
org.hermit.android.net
org.hermit.android.notic Interface Summary
org.hermit.android.prov
org.hermit.android.soun TextInputDialog.OnOkListener Listener invoked when the user clicks the OK
org.hermit.android.widg button.
Listener invoked when the user clicks the OK
YesNoDialog.OnOkListener
button.

Class Summary
All Classes This class implements a popup error box (a subclass of
ErrorDialog
AppUtils AlertDialog) which can be used to display an error message.
AppUtils.Detail
This class implements a popup info box (a subclass of Dialog)
AudioAnalyser InfoBox which can be used to display help text, about info, license info,
AudioReader etc.
AudioReader.Listener
CachedFile This class implements a popup input box (a subclass of
CachedFile.Entry TextInputDialog AlertDialog) which can be used to display a prompt and read a
DatabaseHelper text string from the user.
DbSchema This class implements a popup dialog box (a subclass of
YesNoDialog
Effect AlertDialog) which can be used to display a yes / no question.
ErrorDialog
Errors
FileFetcher
Gauge Overview Package Class Use Tree Deprecated Index Help
HelpActivity
PREV PACKAGE NEXT PACKAGE FRAMES NO FRAMES
HScrollView
InfoBox
Instrument
InstrumentSurface
LinedEditText
MainActivity
MainActivity.ActivityList
MultistateImageButton
OneTimeDialog
Player
PowerGauge
SpectrumGauge
SplashActivity
SurfaceRunner
TableFetcher
TableProvider
TableSchema
TextGauge
TextInputDialog
TextInputDialog.OnOkL
TimeZoneActivity

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/notice/package-summary.html[2/19/2011 9:14:40 AM]


org.hermit.android.notice

WaveformGauge
WebBasedData
WebFetcher
WebFetcher.FetchException
WebFetcher.Listener

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/notice/package-summary.html[2/19/2011 9:14:40 AM]


Uses of Package org.hermit.android.provider

Overview Package Class Use Tree Deprecated Index Help


PREV NEXT FRAMES NO FRAMES All Classes

Uses of Package
org.hermit.android.provider

Packages that use org.hermit.android.provider


org.hermit.android.provider A library of classes to facilitate the creating of table-based content
providers.

Classes in org.hermit.android.provider used by


org.hermit.android.provider
DatabaseHelper
This class helps open, create, and upgrade the database file.
DbSchema
Class encapsulating the schema for a content provider.
TableSchema
Class encapsulating the schema for a table within a content provider.

Overview Package Class Use Tree Deprecated Index Help


PREV NEXT FRAMES NO FRAMES All Classes

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/provider/package-use.html[2/19/2011 9:14:42 AM]


org.hermit.android.provider

All Classes Overview Package Class Use Tree Deprecated Index Help
PREV PACKAGE NEXT PACKAGE FRAMES NO FRAMES
Packages
org.hermit.android.core
org.hermit.android.instru
org.hermit.android.io
Package org.hermit.android.provider
org.hermit.android.net
org.hermit.android.notic A library of classes to facilitate the creating of table-based content providers.
org.hermit.android.prov
See:
org.hermit.android.soun Description
org.hermit.android.widg

Class Summary
DatabaseHelper This class helps open, create, and upgrade the database file.
DbSchema Class encapsulating the schema for a content provider.
This class is a base for content providers which provide access
TableProvider
to table-organized data in an SQL database.
Class encapsulating the schema for a table within a content
TableSchema
provider.

Package org.hermit.android.provider Description


A library of classes to facilitate the creating of table-based content providers.
Applications may use these classes to create a content provider with the minimum
amount of code, while still retaining reasonable flexibility to implement custom
behaviour.

Simple Usage
The basic usage model is this:

Create a subclass of DbSchema to define the schema of your content provider's


database. Use inner classes which are subclasses of TableSchema to define the
tables.
Create a subclass of TableProvider to implement the content provider. In many
cases this class will consist only of a constructor which passes the schema to
the TableProvider constructor.
Declare the provider in your manifest.

For a simple provider, it's really that easy. All of the code for managing the database,
and doing inserts, queries, etc., is provided for you.

Handling Database Upgrade


The default implementation handles database upgrade by simply deleting the existing
All Classes
database, and creating a fresh one. This is something that many applications will
wish to improve on, and you can do this by providing a custom subclass of
AppUtils DatabaseHelper .
AppUtils.Detail
AudioAnalyser To do this, first create your helper subclass. Override
AudioReader

http://moonblink.googlecode.com/...trunk/HermitAndroid/doc/index.html?org/hermit/android/provider/package-summary.html[2/19/2011 9:14:44 AM]


org.hermit.android.provider

DatabaseHelper.onUpgrade(SQLiteDatabase, int, int) and any other methods you


AudioReader.Listener need. Then, in your TableProvider subclass, override TableProvider.getHelper() to
CachedFile return an instance of your database helper.
CachedFile.Entry
DatabaseHelper
DbSchema Example
Effect
ErrorDialog The following example illustrates a very simple provider, which is the basis for an
Errors app logging broadcast events.
FileFetcher
Gauge First, the schema definition:
HelpActivity
package org.hermit.broadtest.provider;
HScrollView
InfoBox import org.hermit.android.provider.DbSchema;
import org.hermit.android.provider.TableSchema;
Instrument
InstrumentSurface import android.net.Uri;
LinedEditText /**
MainActivity * Class encapsulating the schema for the broadcast content provider.
MainActivity.ActivityList */
public class BroadcastSchema
MultistateImageButton extends DbSchema
OneTimeDialog {
Player private static final String DATABASE_NAME = "broadcasts";
PowerGauge
SpectrumGauge // Current schema version.
private static final int SCHEMA_VERSION = 2;
SplashActivity
SurfaceRunner // Provider authority name.
private static final String AUTHORITY = "com.bn.provider.Broadcast";
TableFetcher
TableProvider public static final class BroadcastTable
TableSchema extends TableSchema
{
TextGauge
TextInputDialog // Name of the broadcasts table.
private static final String TABLE_NAME = "broadcasts";
TextInputDialog.OnOkL
TimeZoneActivity // Base MIME type for the broadcasts table.
WaveformGauge private static final String TABLE_TYPE = "vnd.bn.broadcast";
WebBasedData /**
WebFetcher * The content:// style URL for the broadcasts table.
*/
WebFetcher.FetchExce public static final Uri CONTENT_URI =
WebFetcher.Listener Uri.parse("content://" + AUTHORITY + "/broadcasts");
YesNoDialog /**
YesNoDialog.OnOkListe * The default sort order for the broadcasts table.
*/
public static final String SORT_ORDER = "time DESC";
/**
* Broadcast table field: the title of the broadcast.
*/
public static final String TITLE = "title";
/**
* Broadcast table field: any extras that came with the broadcast.
*/
public static final String EXTRAS = "extras";
/**
* Broadcast table field: the timestamp for when the broadcast was
* received.
*/
public static final String TIME = "time";
// Definitions of the fields.
private static final String[][] FIELDS = {
{ TITLE, "TEXT" },
{ EXTRAS, "TEXT" },
{ TIME, "INTEGER" },

http://moonblink.googlecode.com/...trunk/HermitAndroid/doc/index.html?org/hermit/android/provider/package-summary.html[2/19/2011 9:14:44 AM]


org.hermit.android.provider

};
/**
* A default projection which gets all the fields of the broadcast
* table.
*/
public static final String[] PROJECTION = makeProjection(FIELDS);
/**
* Create a broadcasts table schema instance.
*/
protected BroadcastTable() {
super(TABLE_NAME, TABLE_TYPE, CONTENT_URI, SORT_ORDER, FIELDS);
}
}
/**
* Create a broadcast database schema instance.
*/
protected BroadcastSchema() {
super(DATABASE_NAME, SCHEMA_VERSION, AUTHORITY, TABLE_SCHEMAS);
}
// Our table schemas.
private static final TableSchema[] TABLE_SCHEMAS = {
new BroadcastTable(),
};
}

With that, the provider itself is trivial:


package org.hermit.broadtest.provider;
import org.hermit.android.provider.TableProvider;
/**
* Content provider for stored broadcast events.
*/
public class BroadcastProvider
extends TableProvider
{
/**
* Create an instance of this content provider.
*/
public BroadcastProvider() {
super(new BroadcastSchema());
}
}

And finally, the manifest:


<provider android:name=".provider.BroadcastProvider"
android:authorities="com.bn.provider.Broadcast" />

Overview Package Class Use Tree Deprecated Index Help


PREV PACKAGE NEXT PACKAGE FRAMES NO FRAMES

http://moonblink.googlecode.com/...trunk/HermitAndroid/doc/index.html?org/hermit/android/provider/package-summary.html[2/19/2011 9:14:44 AM]


org.hermit.android.provider

http://moonblink.googlecode.com/...trunk/HermitAndroid/doc/index.html?org/hermit/android/provider/package-summary.html[2/19/2011 9:14:44 AM]


Uses of Package org.hermit.android.sound

Overview Package Class Use Tree Deprecated Index Help


PREV NEXT FRAMES NO FRAMES All Classes

Uses of Package
org.hermit.android.sound

Packages that use org.hermit.android.sound


org.hermit.android.sound These classes provide functions to help apps manage their sound effects.

Classes in org.hermit.android.sound used by


org.hermit.android.sound
Effect
Class representing a specific sound effect.

Overview Package Class Use Tree Deprecated Index Help


PREV NEXT FRAMES NO FRAMES All Classes

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/sound/package-use.html[2/19/2011 9:14:46 AM]


org.hermit.android.sound

All Classes Overview Package Class Use Tree Deprecated Index Help
PREV PACKAGE NEXT PACKAGE FRAMES NO FRAMES
Packages
org.hermit.android.core
org.hermit.android.instru
org.hermit.android.io
Package org.hermit.android.sound
org.hermit.android.net
org.hermit.android.notic These classes provide functions to help apps manage their sound effects.
org.hermit.android.prov
See:
org.hermit.android.soun Description
org.hermit.android.widg

Class Summary
Effect Class representing a specific sound effect.
Player Main sound effects player class.

All Classes
AppUtils Package org.hermit.android.sound Description
AppUtils.Detail
AudioAnalyser These classes provide functions to help apps manage their sound effects.
AudioReader
AudioReader.Listener
CachedFile Overview Package Class Use Tree Deprecated Index Help
CachedFile.Entry PREV PACKAGE NEXT PACKAGE FRAMES NO FRAMES
DatabaseHelper
DbSchema
Effect
ErrorDialog
Errors
FileFetcher
Gauge
HelpActivity
HScrollView
InfoBox
Instrument
InstrumentSurface
LinedEditText
MainActivity
MainActivity.ActivityList
MultistateImageButton
OneTimeDialog
Player
PowerGauge
SpectrumGauge
SplashActivity
SurfaceRunner
TableFetcher
TableProvider
TableSchema
TextGauge
TextInputDialog
TextInputDialog.OnOkL
TimeZoneActivity

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/sound/package-summary.html[2/19/2011 9:14:48 AM]


org.hermit.android.sound

WaveformGauge
WebBasedData
WebFetcher
WebFetcher.FetchException
WebFetcher.Listener

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/sound/package-summary.html[2/19/2011 9:14:48 AM]


Uses of Package org.hermit.android.widgets

Overview Package Class Use Tree Deprecated Index Help


PREV NEXT FRAMES NO FRAMES All Classes

Uses of Package
org.hermit.android.widgets
No usage of org.hermit.android.widgets

Overview Package Class Use Tree Deprecated Index Help


PREV NEXT FRAMES NO FRAMES All Classes

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/widgets/package-use.html[2/19/2011 9:14:50 AM]


org.hermit.android.widgets

All Classes Overview Package Class Use Tree Deprecated Index Help
PREV PACKAGE NEXT PACKAGE FRAMES NO FRAMES
Packages
org.hermit.android.core
org.hermit.android.instru
org.hermit.android.io
Package org.hermit.android.widgets
org.hermit.android.net
org.hermit.android.notic Class Summary
org.hermit.android.prov
org.hermit.android.soun Layout container for a view hierarchy that can be
org.hermit.android.widg HScrollView scrolled by the user, allowing it to be larger than the
physical display.
A custom EditText that draws lines between each line of
LinedEditText
text that is displayed.

MultistateImageButton This class displays an image button which toggles or


cycles through multiple states when clicked.
This class displays a picker which can be used to select
All Classes TimeZoneActivity
a timezone.
AppUtils
AppUtils.Detail
AudioAnalyser
AudioReader Overview Package Class Use Tree Deprecated Index Help
AudioReader.Listener PREV PACKAGE NEXT PACKAGE FRAMES NO FRAMES
CachedFile
CachedFile.Entry
DatabaseHelper
DbSchema
Effect
ErrorDialog
Errors
FileFetcher
Gauge
HelpActivity
HScrollView
InfoBox
Instrument
InstrumentSurface
LinedEditText
MainActivity
MainActivity.ActivityList
MultistateImageButton
OneTimeDialog
Player
PowerGauge
SpectrumGauge
SplashActivity
SurfaceRunner
TableFetcher
TableProvider
TableSchema
TextGauge
TextInputDialog
TextInputDialog.OnOkL
TimeZoneActivity

http://moonblink.googlecode.com/.../trunk/HermitAndroid/doc/index.html?org/hermit/android/widgets/package-summary.html[2/19/2011 9:14:53 AM]


org.hermit.android.widgets

WaveformGauge
WebBasedData
WebFetcher
WebFetcher.FetchException
WebFetcher.Listener

http://moonblink.googlecode.com/.../trunk/HermitAndroid/doc/index.html?org/hermit/android/widgets/package-summary.html[2/19/2011 9:14:53 AM]


org.hermit.android.core Class Hierarchy

All Classes Overview Package Class Use Tree Deprecated Index Help
PREV NEXT FRAMES NO FRAMES
Packages
org.hermit.android.core
org.hermit.android.instru
org.hermit.android.io
Hierarchy For Package org.hermit.android.core
org.hermit.android.net
org.hermit.android.notic Package Hierarchies:
All Packages
org.hermit.android.prov
org.hermit.android.soun
org.hermit.android.widg
Class Hierarchy
java.lang.Object
Activity
org.hermit.android.core.MainActivity
Activity
All Classes org.hermit.android.core.SplashActivity
Activity
AppUtils org.hermit.android.core.HelpActivity
AppUtils.Detail org.hermit.android.core.AppUtils
AudioAnalyser org.hermit.android.core.AppUtils.Version
AudioReader org.hermit.android.core.Errors
AudioReader.Listener org.hermit.android.core.MainActivity.ActivityListener
CachedFile org.hermit.android.core.OneTimeDialog
CachedFile.Entry SurfaceView
DatabaseHelper org.hermit.android.core.SurfaceRunner
DbSchema
Effect
ErrorDialog Enum Hierarchy
Errors
FileFetcher java.lang.Object
Gauge java.lang.Enum<E> (implements java.lang.Comparable<T>,
HelpActivity java.io.Serializable)
HScrollView org.hermit.android.core.AppUtils.Detail
InfoBox
Instrument
InstrumentSurface Overview Package Class Use Tree Deprecated Index Help
LinedEditText PREV NEXT FRAMES NO FRAMES
MainActivity
MainActivity.ActivityList
MultistateImageButton
OneTimeDialog
Player
PowerGauge
SpectrumGauge
SplashActivity
SurfaceRunner
TableFetcher
TableProvider
TableSchema
TextGauge
TextInputDialog
TextInputDialog.OnOkL
TimeZoneActivity

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/core/package-tree.html[2/19/2011 9:14:57 AM]


org.hermit.android.core Class Hierarchy

WaveformGauge
WebBasedData
WebFetcher
WebFetcher.FetchException
WebFetcher.Listener

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/core/package-tree.html[2/19/2011 9:14:57 AM]


org.hermit.android.instruments Class Hierarchy

All Classes Overview Package Class Use Tree Deprecated Index Help
PREV NEXT FRAMES NO FRAMES
Packages
org.hermit.android.core
org.hermit.android.instrum
org.hermit.android.io
Hierarchy For Package org.hermit.android.instruments
org.hermit.android.net
org.hermit.android.notice
Package Hierarchies:
All Packages
org.hermit.android.provide
org.hermit.android.sound
org.hermit.android.widgets
Class Hierarchy
java.lang.Object
org.hermit.android.instruments.Gauge
org.hermit.android.instruments.PowerGauge
org.hermit.android.instruments.SpectrumGauge
org.hermit.android.instruments.TextGauge
All Classes org.hermit.android.instruments.WaveformGauge
AppUtils org.hermit.android.instruments.Instrument
AppUtils.Detail org.hermit.android.instruments.AudioAnalyser
AudioAnalyser SurfaceView
AudioReader org.hermit.android.core.SurfaceRunner
AudioReader.Listener org.hermit.android.instruments.InstrumentSurface
CachedFile
CachedFile.Entry
DatabaseHelper Overview Package Class Use Tree Deprecated Index Help
PREV NEXT FRAMES NO FRAMES
DbSchema
Effect
ErrorDialog
Errors
FileFetcher
Gauge
HelpActivity
HScrollView
InfoBox
Instrument
InstrumentSurface
LinedEditText
MainActivity
MainActivity.ActivityListen
MultistateImageButton
OneTimeDialog
Player
PowerGauge
SpectrumGauge
SplashActivity
SurfaceRunner
TableFetcher
TableProvider
TableSchema
TextGauge
TextInputDialog
TextInputDialog.OnOkList
TimeZoneActivity
WaveformGauge
WebBasedData
WebFetcher
WebFetcher.FetchExcepti
WebFetcher.Listener

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/instruments/package-tree.html[2/19/2011 9:15:00 AM]


org.hermit.android.instruments Class Hierarchy

YesNoDialog

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/instruments/package-tree.html[2/19/2011 9:15:00 AM]


org.hermit.android.io Class Hierarchy

All Classes Overview Package Class Use Tree Deprecated Index Help
PREV NEXT FRAMES NO FRAMES
Packages
org.hermit.android.core
org.hermit.android.instru
org.hermit.android.io
Hierarchy For Package org.hermit.android.io
org.hermit.android.net
org.hermit.android.notic Package Hierarchies:
All Packages
org.hermit.android.prov
org.hermit.android.soun
org.hermit.android.widg
Class Hierarchy
java.lang.Object
org.hermit.android.io.AudioReader
org.hermit.android.io.AudioReader.Listener

All Classes Overview Package Class Use Tree Deprecated Index Help
AppUtils PREV NEXT FRAMES NO FRAMES
AppUtils.Detail
AudioAnalyser
AudioReader
AudioReader.Listener
CachedFile
CachedFile.Entry
DatabaseHelper
DbSchema
Effect
ErrorDialog
Errors
FileFetcher
Gauge
HelpActivity
HScrollView
InfoBox
Instrument
InstrumentSurface
LinedEditText
MainActivity
MainActivity.ActivityList
MultistateImageButton
OneTimeDialog
Player
PowerGauge
SpectrumGauge
SplashActivity
SurfaceRunner
TableFetcher
TableProvider
TableSchema
TextGauge
TextInputDialog
TextInputDialog.OnOkL
TimeZoneActivity

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/io/package-tree.html[2/19/2011 9:15:03 AM]


org.hermit.android.io Class Hierarchy

WaveformGauge
WebBasedData
WebFetcher
WebFetcher.FetchException
WebFetcher.Listener

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/io/package-tree.html[2/19/2011 9:15:03 AM]


org.hermit.android.net Class Hierarchy

All Classes Overview Package Class Use Tree Deprecated Index Help
PREV NEXT FRAMES NO FRAMES
Packages
org.hermit.android.core
org.hermit.android.instru
org.hermit.android.io
Hierarchy For Package org.hermit.android.net
org.hermit.android.net
org.hermit.android.notic Package Hierarchies:
All Packages
org.hermit.android.prov
org.hermit.android.soun
org.hermit.android.widg
Class Hierarchy
java.lang.Object
org.hermit.android.net.CachedFile.Entry
java.util.Observable
org.hermit.android.net.CachedFile (implements
All Classes
org.hermit.android.net.WebFetcher.Listener)
org.hermit.android.net.WebBasedData (implements
AppUtils org.hermit.android.net.WebFetcher.Listener)
AppUtils.Detail java.lang.Thread (implements java.lang.Runnable)
AudioAnalyser org.hermit.android.net.WebFetcher
AudioReader org.hermit.android.net.FileFetcher
AudioReader.Listener org.hermit.android.net.TableFetcher
CachedFile java.lang.Throwable (implements java.io.Serializable)
CachedFile.Entry java.lang.Exception
DatabaseHelper org.hermit.android.net.WebFetcher.FetchException
DbSchema
Effect
ErrorDialog Interface Hierarchy
Errors
FileFetcher org.hermit.android.net.WebFetcher.Listener
Gauge
HelpActivity
HScrollView Overview Package Class Use Tree Deprecated Index Help
InfoBox PREV NEXT FRAMES NO FRAMES
Instrument
InstrumentSurface
LinedEditText
MainActivity
MainActivity.ActivityList
MultistateImageButton
OneTimeDialog
Player
PowerGauge
SpectrumGauge
SplashActivity
SurfaceRunner
TableFetcher
TableProvider
TableSchema
TextGauge
TextInputDialog
TextInputDialog.OnOkL
TimeZoneActivity

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/net/package-tree.html[2/19/2011 9:15:06 AM]


org.hermit.android.net Class Hierarchy

WaveformGauge
WebBasedData
WebFetcher
WebFetcher.FetchException
WebFetcher.Listener

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/net/package-tree.html[2/19/2011 9:15:06 AM]


org.hermit.android.notice Class Hierarchy

All Classes Overview Package Class Use Tree Deprecated Index Help
PREV NEXT FRAMES NO FRAMES
Packages
org.hermit.android.core
org.hermit.android.instru
org.hermit.android.io
Hierarchy For Package org.hermit.android.notice
org.hermit.android.net
org.hermit.android.notic Package Hierarchies:
All Packages
org.hermit.android.prov
org.hermit.android.soun
org.hermit.android.widg
Class Hierarchy
java.lang.Object
AlertDialog
org.hermit.android.notice.YesNoDialog
AlertDialog
All Classes org.hermit.android.notice.ErrorDialog
AlertDialog
AppUtils org.hermit.android.notice.TextInputDialog
AppUtils.Detail Dialog
AudioAnalyser org.hermit.android.notice.InfoBox
AudioReader
AudioReader.Listener
CachedFile Interface Hierarchy
CachedFile.Entry
DatabaseHelper org.hermit.android.notice.TextInputDialog.OnOkListener
DbSchema org.hermit.android.notice.YesNoDialog.OnOkListener
Effect
ErrorDialog
Errors Overview Package Class Use Tree Deprecated Index Help
FileFetcher PREV NEXT FRAMES NO FRAMES
Gauge
HelpActivity
HScrollView
InfoBox
Instrument
InstrumentSurface
LinedEditText
MainActivity
MainActivity.ActivityList
MultistateImageButton
OneTimeDialog
Player
PowerGauge
SpectrumGauge
SplashActivity
SurfaceRunner
TableFetcher
TableProvider
TableSchema
TextGauge
TextInputDialog
TextInputDialog.OnOkL
TimeZoneActivity

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/notice/package-tree.html[2/19/2011 9:15:10 AM]


org.hermit.android.notice Class Hierarchy

WaveformGauge
WebBasedData
WebFetcher
WebFetcher.FetchException
WebFetcher.Listener

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/notice/package-tree.html[2/19/2011 9:15:10 AM]


org.hermit.android.provider Class Hierarchy

All Classes Overview Package Class Use Tree Deprecated Index Help
PREV NEXT FRAMES NO FRAMES
Packages
org.hermit.android.core
org.hermit.android.instru
org.hermit.android.io
Hierarchy For Package
org.hermit.android.net org.hermit.android.provider
org.hermit.android.notic
org.hermit.android.prov Package Hierarchies:
org.hermit.android.soun All Packages
org.hermit.android.widg

Class Hierarchy
java.lang.Object
ContentProvider
org.hermit.android.provider.TableProvider
All Classes org.hermit.android.provider.DbSchema
AppUtils SQLiteOpenHelper
AppUtils.Detail org.hermit.android.provider.DatabaseHelper
AudioAnalyser org.hermit.android.provider.TableSchema
AudioReader
AudioReader.Listener
CachedFile Overview Package Class Use Tree Deprecated Index Help
CachedFile.Entry PREV NEXT FRAMES NO FRAMES

DatabaseHelper
DbSchema
Effect
ErrorDialog
Errors
FileFetcher
Gauge
HelpActivity
HScrollView
InfoBox
Instrument
InstrumentSurface
LinedEditText
MainActivity
MainActivity.ActivityList
MultistateImageButton
OneTimeDialog
Player
PowerGauge
SpectrumGauge
SplashActivity
SurfaceRunner
TableFetcher
TableProvider
TableSchema
TextGauge
TextInputDialog
TextInputDialog.OnOkL
TimeZoneActivity

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/provider/package-tree.html[2/19/2011 9:15:14 AM]


org.hermit.android.provider Class Hierarchy

WaveformGauge
WebBasedData
WebFetcher
WebFetcher.FetchException
WebFetcher.Listener

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/provider/package-tree.html[2/19/2011 9:15:14 AM]


org.hermit.android.sound Class Hierarchy

All Classes Overview Package Class Use Tree Deprecated Index Help
PREV NEXT FRAMES NO FRAMES
Packages
org.hermit.android.core
org.hermit.android.instrum
org.hermit.android.io
Hierarchy For Package org.hermit.android.sound
org.hermit.android.net
org.hermit.android.notice
Package Hierarchies:
All Packages
org.hermit.android.provide
org.hermit.android.sound
org.hermit.android.widgets
Class Hierarchy
java.lang.Object
org.hermit.android.sound.Effect
org.hermit.android.sound.Player

All Classes Overview Package Class Use Tree Deprecated Index Help
PREV NEXT FRAMES NO FRAMES
AppUtils
AppUtils.Detail
AudioAnalyser
AudioReader
AudioReader.Listener
CachedFile
CachedFile.Entry
DatabaseHelper
DbSchema
Effect
ErrorDialog
Errors
FileFetcher
Gauge
HelpActivity
HScrollView
InfoBox
Instrument
InstrumentSurface
LinedEditText
MainActivity
MainActivity.ActivityListen
MultistateImageButton
OneTimeDialog
Player
PowerGauge
SpectrumGauge
SplashActivity
SurfaceRunner
TableFetcher
TableProvider
TableSchema
TextGauge
TextInputDialog
TextInputDialog.OnOkList
TimeZoneActivity
WaveformGauge
WebBasedData
WebFetcher
WebFetcher.FetchExcepti
WebFetcher.Listener

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/sound/package-tree.html[2/19/2011 9:15:18 AM]


org.hermit.android.sound Class Hierarchy

YesNoDialog

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/sound/package-tree.html[2/19/2011 9:15:18 AM]


org.hermit.android.widgets Class Hierarchy

All Classes Overview Package Class Use Tree Deprecated Index Help
PREV NEXT FRAMES NO FRAMES
Packages
org.hermit.android.core
org.hermit.android.instru
org.hermit.android.io
Hierarchy For Package org.hermit.android.widgets
org.hermit.android.net
org.hermit.android.notic Package Hierarchies:
All Packages
org.hermit.android.prov
org.hermit.android.soun
org.hermit.android.widg
Class Hierarchy
java.lang.Object
EditText
org.hermit.android.widgets.LinedEditText
FrameLayout
All Classes org.hermit.android.widgets.HScrollView
ImageButton
AppUtils org.hermit.android.widgets.MultistateImageButton
AppUtils.Detail ListActivity
AudioAnalyser org.hermit.android.widgets.TimeZoneActivity
AudioReader
AudioReader.Listener
CachedFile Overview Package Class Use Tree Deprecated Index Help
CachedFile.Entry PREV NEXT FRAMES NO FRAMES
DatabaseHelper
DbSchema
Effect
ErrorDialog
Errors
FileFetcher
Gauge
HelpActivity
HScrollView
InfoBox
Instrument
InstrumentSurface
LinedEditText
MainActivity
MainActivity.ActivityList
MultistateImageButton
OneTimeDialog
Player
PowerGauge
SpectrumGauge
SplashActivity
SurfaceRunner
TableFetcher
TableProvider
TableSchema
TextGauge
TextInputDialog
TextInputDialog.OnOkL
TimeZoneActivity

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/widgets/package-tree.html[2/19/2011 9:15:21 AM]


org.hermit.android.widgets Class Hierarchy

WaveformGauge
WebBasedData
WebFetcher
WebFetcher.FetchException
WebFetcher.Listener

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/widgets/package-tree.html[2/19/2011 9:15:21 AM]


Uses of Class org.hermit.android.core.MainActivity

Overview Package Class Use Tree Deprecated Index Help


PREV NEXT FRAMES NO FRAMES All Classes

Uses of Class
org.hermit.android.core.MainActivity
No usage of org.hermit.android.core.MainActivity

Overview Package Class Use Tree Deprecated Index Help


PREV NEXT FRAMES NO FRAMES All Classes

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/core/class-use/MainActivity.html[2/19/2011 9:15:23 AM]


MainActivity

All Classes Overview Package Class Use Tree Deprecated Index Help
PREV CLASS NEXT CLASS FRAMES NO FRAMES
Packages SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
org.hermit.android.core
org.hermit.android.instru
org.hermit.android.io org.hermit.android.core
org.hermit.android.net
org.hermit.android.notic Class MainActivity
org.hermit.android.prov
java.lang.Object
org.hermit.android.soun
Activity
org.hermit.android.widg org.hermit.android.core.MainActivity

public class MainActivity


extends Activity

An enhanced Activity class, for use as the main activity of an application. The main
thing this class provides is a nice callback-based mechanism for starting sub-
activities. This makes it easier for different parts of an app to kick off sub-activities
and get the results.

Note: it is best that sub-classes do not implement onActivityResult(int, int, Intent). If


they do, then for safety use small request codes, and call super.onActivityResult(int,
int, Intent) when you get an unknown code.

Author:
Ian Cameron Smith

Nested Class Summary


static class MainActivity.ActivityListener
This interface defines a listener for sub-activity results.

Constructor Summary
MainActivity()

Method Summary
void createEulaBox(int title, int text, int close)
Create a dialog for showing the EULA, or other warnings /
disclaimers.
void createMessageBox(int close)
Deprecated. The message box is now created automatically.
protected onActivityResult(int requestCode, int resultCode, Intent data)
void
Called when an activity you launched exits, giving you the
requestCode you started it with, the resultCode it returned, and any
additional data from it.
protected onCreate(Bundle icicle)
void
Called when the activity is starting.
void

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/core/MainActivity.html[2/19/2011 9:15:27 AM]


MainActivity

reportException(java.lang.Exception e)
Report an unexpected exception to the user by popping up a
dialog with some debug info.
void setAboutInfo(int about)
Set up the about info for dialogs.
void setHomeInfo(int link)
Set up the homepage info for dialogs.
void setHomeInfo(int button, int link)
Deprecated.
void setLicenseInfo(int link)
Set up the license info for dialogs.
void setLicenseInfo(int button, int link)
Deprecated.
void showAbout()
Show an about dialog.
void showEula()
Show the EULA dialog unconditionally.
void showFirstEula()
Show the EULA dialog if this is the first program run.
void startActivityForResult(Intent intent,
MainActivity.ActivityListener listener)
Launch an activity for which you would like a result when it
finished.

Methods inherited from class java.lang.Object


clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString,
wait, wait, wait

All Classes Constructor Detail


AppUtils
AppUtils.Detail MainActivity
AudioAnalyser
AudioReader public MainActivity()
AudioReader.Listener

Method Detail
CachedFile
CachedFile.Entry
DatabaseHelper
DbSchema
Effect
onCreate
ErrorDialog
protected void onCreate(Bundle icicle)
Errors
FileFetcher Called when the activity is starting. This is where most initialisation should go:
Gauge calling setContentView(int) to inflate the activity's UI, etc. You can call finish()
HelpActivity from within this function, in which case onDestroy() will be immediately called
HScrollView without any of the rest of the activity lifecycle executing. Derived classes must
InfoBox call through to the super class's implementation of this method. If they do not,
Instrument an exception will be thrown.
InstrumentSurface
LinedEditText Parameters:
MainActivity

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/core/MainActivity.html[2/19/2011 9:15:27 AM]


MainActivity

icicle - If the activity is being re-initialised after previously being shut


MainActivity.ActivityList down then this Bundle contains the data it most recently supplied in
MultistateImageButton onSaveInstanceState(Bundle). Note: Otherwise it is null.
OneTimeDialog
Player
PowerGauge
SpectrumGauge createEulaBox
SplashActivity
SurfaceRunner public void createEulaBox(int title,
int text,
TableFetcher int close)
TableProvider
TableSchema Create a dialog for showing the EULA, or other warnings / disclaimers. When
TextGauge your app starts, call showFirstEula() to display the dialog the first time your
TextInputDialog app runs. To display it on demand, call showEula() .
TextInputDialog.OnOkL
TimeZoneActivity Parameters:
WaveformGauge title - Resource ID of the dialog title.
WebBasedData text - Resource ID of the EULA / warning text.
WebFetcher close - Resource ID of the close button.
WebFetcher.FetchExce
WebFetcher.Listener
YesNoDialog showFirstEula
YesNoDialog.OnOkListe
public void showFirstEula()

Show the EULA dialog if this is the first program run. You need to have created
the dialog by calling createEulaBox(int, int, int) .

showEula
public void showEula()

Show the EULA dialog unconditionally. You need to have created the dialog by
calling createEulaBox(int, int, int) .

createMessageBox
@Deprecated
public void createMessageBox(int close)

Deprecated. The message box is now created automatically.

Create a dialog for help / about boxes etc. If you want to display one of those,
set up the info in it by calling setHomeInfo(int, int) , setAboutInfo(int) and
setLicenseInfo(int, int) ; then pop up a dialog by calling showAbout().

Parameters:
close - Resource ID of the close button.

setAboutInfo
public void setAboutInfo(int about)

Set up the about info for dialogs. See showAbout().

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/core/MainActivity.html[2/19/2011 9:15:27 AM]


MainActivity

Parameters:
about - Resource ID of the about text.

setHomeInfo
public void setHomeInfo(int link)

Set up the homepage info for dialogs. See showAbout().

Parameters:
link - Resource ID of the URL the button links to.

setHomeInfo
@Deprecated
public void setHomeInfo(int button,
int link)

Deprecated.

Set up the homepage info for dialogs. See showAbout().

Parameters:
button - Resource ID of the button text.
link - Resource ID of the URL the button links to.

setLicenseInfo
public void setLicenseInfo(int link)

Set up the license info for dialogs. See showAbout().

Parameters:
link - Resource ID of the URL the button links to.

setLicenseInfo
@Deprecated
public void setLicenseInfo(int button,
int link)

Deprecated.

Set up the license info for dialogs. See showAbout().

Parameters:
button - Resource ID of the button text.
link - Resource ID of the URL the button links to.

showAbout
public void showAbout()

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/core/MainActivity.html[2/19/2011 9:15:27 AM]


MainActivity

Show an about dialog. You need to have configured it by calling


setAboutInfo(int) , setHomeInfo(int, int) and setLicenseInfo(int, int) .

reportException
public void reportException(java.lang.Exception e)

Report an unexpected exception to the user by popping up a dialog with some


debug info. Don't report the same exception more than twice, and if we get
floods of exceptions, just bomb out.

This method may be called from any thread. The reporting will be deferred to
the UI thread.

Parameters:
e - The exception.

startActivityForResult
public void startActivityForResult(Intent intent,
MainActivity.ActivityListener listener)

Launch an activity for which you would like a result when it finished. When this
activity exits, the given ActivityListener will be invoked.

Note that this method should only be used with Intent protocols that are
defined to return a result. In other protocols (such as ACTION_MAIN or
ACTION_VIEW), you may not get the result when you expect. As a special
case, if you call startActivityForResult() during the initial onCreate() /
onResume() of your activity, then your window will not be displayed until a
result is returned back from the started activity. This method throws
ActivityNotFoundException if there was no Activity found to run the given
Intent.

Parameters:
intent - The intent to start.
listener - Listener to invoke when the activity returns.

onActivityResult
protected void onActivityResult(int requestCode,
int resultCode,
Intent data)

Called when an activity you launched exits, giving you the requestCode you
started it with, the resultCode it returned, and any additional data from it. The
resultCode will be RESULT_CANCELED if the activity explicitly returned that,
didn't return any result, or crashed during its operation.

Parameters:
requestCode - The integer request code originally supplied to
startActivityForResult(), allowing you to identify who this result came
from.

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/core/MainActivity.html[2/19/2011 9:15:27 AM]


MainActivity

resultCode - The integer result code returned by the child activity through
its setResult().
data - Additional data to return to the caller.

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/core/MainActivity.html[2/19/2011 9:15:27 AM]


Uses of Class org.hermit.android.core.SplashActivity

Overview Package Class Use Tree Deprecated Index Help


PREV NEXT FRAMES NO FRAMES All Classes

Uses of Class
org.hermit.android.core.SplashActivity
No usage of org.hermit.android.core.SplashActivity

Overview Package Class Use Tree Deprecated Index Help


PREV NEXT FRAMES NO FRAMES All Classes

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/core/class-use/SplashActivity.html[2/19/2011 9:15:29 AM]


SplashActivity

All Classes Overview Package Class Use Tree Deprecated Index Help
PREV CLASS NEXT CLASS FRAMES NO FRAMES
Packages SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
org.hermit.android.core
org.hermit.android.instrum
org.hermit.android.io org.hermit.android.core
org.hermit.android.net
org.hermit.android.notice
Class SplashActivity
org.hermit.android.provide
java.lang.Object
org.hermit.android.sound
Activity
org.hermit.android.widgets org.hermit.android.core.SplashActivity

public class SplashActivity


extends Activity

An activity which displays a splash screen and then returns to the calling activity.

Field Summary
static java.lang.String EXTRAS_IMAGE_ID
Extras key for the image resource ID.
static java.lang.String EXTRAS_TIME_ID
Extras key for the splash screen display time.

Constructor Summary
SplashActivity()

All Classes Method Summary


AppUtils
static void launch(Context context, int image, long time)
AppUtils.Detail
AudioAnalyser Launch a splash screen displaying the given drawable.
AudioReader void onCreate(Bundle icicle)
AudioReader.Listener Called when the activity is starting.
CachedFile
CachedFile.Entry
DatabaseHelper Methods inherited from class java.lang.Object
DbSchema clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait,
Effect wait, wait
ErrorDialog
Errors
FileFetcher
Gauge Field Detail
HelpActivity
HScrollView
EXTRAS_IMAGE_ID
InfoBox
Instrument public static final java.lang.String EXTRAS_IMAGE_ID
InstrumentSurface
LinedEditText Extras key for the image resource ID. The extras data named by this key is an int
MainActivity which specifies the image to display.
MainActivity.ActivityListen
MultistateImageButton See Also:
OneTimeDialog Constant Field Values
Player
PowerGauge

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/core/SplashActivity.html[2/19/2011 9:15:33 AM]


SplashActivity

EXTRAS_TIME_ID
SpectrumGauge
SplashActivity
SurfaceRunner
public static final java.lang.String EXTRAS_TIME_ID
TableFetcher
TableProvider
Extras key for the splash screen display time. The extras data named by this key is the
TableSchema
time in ms for which the splash screen should be displayed.
TextGauge
TextInputDialog See Also:
TextInputDialog.OnOkList Constant Field Values
TimeZoneActivity
WaveformGauge
WebBasedData Constructor Detail
WebFetcher
WebFetcher.FetchExcepti
WebFetcher.Listener SplashActivity
YesNoDialog
YesNoDialog.OnOkListen public SplashActivity()

Method Detail
onCreate
public void onCreate(Bundle icicle)

Called when the activity is starting. This is where most initialization should go: calling
setContentView(int) to inflate the activity's UI, etc.

Parameters:
icicle - Saved application state, if any.

launch
public static void launch(Context context,
int image,
long time)

Launch a splash screen displaying the given drawable.

Parameters:
context - Application context we're running in.
image - Resource ID of the image to display.
time - Time in ms for which the splash screen should be visible.

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/core/SplashActivity.html[2/19/2011 9:15:33 AM]


Uses of Class org.hermit.android.notice.YesNoDialog

Overview Package Class Use Tree Deprecated Index Help


PREV NEXT FRAMES NO FRAMES All Classes

Uses of Class
org.hermit.android.notice.YesNoDialog
No usage of org.hermit.android.notice.YesNoDialog

Overview Package Class Use Tree Deprecated Index Help


PREV NEXT FRAMES NO FRAMES All Classes

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/notice/class-use/YesNoDialog.html[2/19/2011 9:15:34 AM]


YesNoDialog

All Classes Overview Package Class Use Tree Deprecated Index Help
PREV CLASS NEXT CLASS FRAMES NO FRAMES
Packages SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
org.hermit.android.core
org.hermit.android.instru
org.hermit.android.io org.hermit.android.notice
org.hermit.android.net
org.hermit.android.notic Class YesNoDialog
org.hermit.android.prov
java.lang.Object
org.hermit.android.soun
AlertDialog
org.hermit.android.widg org.hermit.android.notice.YesNoDialog

public class YesNoDialog


extends AlertDialog

This class implements a popup dialog box (a subclass of AlertDialog) which can be
used to display a yes / no question.

Nested Class Summary


static interface YesNoDialog.OnOkListener
Listener invoked when the user clicks the OK button.

Constructor Summary
YesNoDialog(Context parent, java.lang.CharSequence okBut,
java.lang.CharSequence cancelBut)
Create an error dialog.
YesNoDialog(Context parent, int okBut, int cancelBut)
Create an error dialog.

Method Summary
void setOnOkListener(YesNoDialog.OnOkListener listener)
All Classes
Set a listener for the dialog.
AppUtils
void show(java.lang.CharSequence title, java.lang.CharSequence text)
AppUtils.Detail
AudioAnalyser Start the dialog and display it on screen.
AudioReader void show(int title, int text)
AudioReader.Listener Start the dialog and display it on screen.
CachedFile
CachedFile.Entry
DatabaseHelper Methods inherited from class java.lang.Object
DbSchema clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString,
Effect wait, wait, wait
ErrorDialog
Errors

Constructor Detail
FileFetcher
Gauge
HelpActivity
YesNoDialog
HScrollView
InfoBox

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/notice/YesNoDialog.html[2/19/2011 9:15:37 AM]


YesNoDialog

Instrument
public YesNoDialog(Context parent,
InstrumentSurface int okBut,
LinedEditText int cancelBut)
MainActivity
MainActivity.ActivityList Create an error dialog.
MultistateImageButton
OneTimeDialog Parameters:
Player parent - Parent application context.
PowerGauge okBut - The resource ID of the text for the OK button.
SpectrumGauge cancelBut - The resource ID of the text for the cancel button.
SplashActivity
SurfaceRunner
TableFetcher YesNoDialog
TableProvider
TableSchema public YesNoDialog(Context parent,
TextGauge java.lang.CharSequence okBut,
java.lang.CharSequence cancelBut)
TextInputDialog
TextInputDialog.OnOkL
Create an error dialog.
TimeZoneActivity
WaveformGauge
Parameters:
WebBasedData parent - Parent application context.
WebFetcher okBut - The text for the OK button.
WebFetcher.FetchExce cancelBut - The text for the cancel button.
WebFetcher.Listener
YesNoDialog
YesNoDialog.OnOkListe Method Detail
setOnOkListener
public void setOnOkListener(YesNoDialog.OnOkListener listener)

Set a listener for the dialog.

Parameters:
listener - The listener to set.

show
public void show(int title,
int text)

Start the dialog and display it on screen. The window is placed in the
application layer and opaque.

Parameters:
title - Title for the dialog.
text - Input prompt to display in the dialog.

show
public void show(java.lang.CharSequence title,
java.lang.CharSequence text)

Start the dialog and display it on screen. The window is placed in the

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/notice/YesNoDialog.html[2/19/2011 9:15:37 AM]


YesNoDialog

application layer and opaque.

Parameters:
title - Title for the dialog.
text - Input prompt to display in the dialog.

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/notice/YesNoDialog.html[2/19/2011 9:15:37 AM]


Uses of Class org.hermit.android.notice.ErrorDialog

Overview Package Class Use Tree Deprecated Index Help


PREV NEXT FRAMES NO FRAMES All Classes

Uses of Class
org.hermit.android.notice.ErrorDialog
No usage of org.hermit.android.notice.ErrorDialog

Overview Package Class Use Tree Deprecated Index Help


PREV NEXT FRAMES NO FRAMES All Classes

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/notice/class-use/ErrorDialog.html[2/19/2011 9:15:39 AM]


ErrorDialog

All Classes Overview Package Class Use Tree Deprecated Index Help
PREV CLASS NEXT CLASS FRAMES NO FRAMES
Packages SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
org.hermit.android.core
org.hermit.android.instru
org.hermit.android.io org.hermit.android.notice
org.hermit.android.net
org.hermit.android.notic Class ErrorDialog
org.hermit.android.prov
java.lang.Object
org.hermit.android.soun
AlertDialog
org.hermit.android.widg org.hermit.android.notice.ErrorDialog

public class ErrorDialog


extends AlertDialog

This class implements a popup error box (a subclass of AlertDialog) which can be
used to display an error message.

Constructor Summary
ErrorDialog(Context parent, java.lang.CharSequence button)
Create an error dialog.
ErrorDialog(Context parent, int button)
Create an error dialog.

All Classes
Method Summary
void show(java.lang.String text)
AppUtils
AppUtils.Detail Start the dialog and display it on screen.
AudioAnalyser void show(java.lang.String title, java.lang.String text)
AudioReader Start the dialog and display it on screen.
AudioReader.Listener
CachedFile
CachedFile.Entry Methods inherited from class java.lang.Object
DatabaseHelper clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString,
DbSchema wait, wait, wait
Effect
ErrorDialog

Constructor Detail
Errors
FileFetcher
Gauge
HelpActivity
HScrollView
ErrorDialog
InfoBox public ErrorDialog(Context parent,
Instrument int button)
InstrumentSurface
LinedEditText Create an error dialog.
MainActivity
MainActivity.ActivityList Parameters:
MultistateImageButton parent - Parent application context.
OneTimeDialog button - The resource ID of the text for the OK button.
Player

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/notice/ErrorDialog.html[2/19/2011 9:15:43 AM]


ErrorDialog

PowerGauge
SpectrumGauge ErrorDialog
SplashActivity
SurfaceRunner public ErrorDialog(Context parent,
TableFetcher java.lang.CharSequence button)
TableProvider
TableSchema Create an error dialog.
TextGauge
TextInputDialog Parameters:
TextInputDialog.OnOkL parent - Parent application context.
TimeZoneActivity button - The text for the OK button.
WaveformGauge
WebBasedData
WebFetcher
Method Detail
WebFetcher.FetchExce
WebFetcher.Listener show
YesNoDialog
YesNoDialog.OnOkListe public void show(java.lang.String title,
java.lang.String text)

Start the dialog and display it on screen. The window is placed in the
application layer and opaque.

Parameters:
title - Title for the dialog.
text - Text to display in the dialog.

show
public void show(java.lang.String text)

Start the dialog and display it on screen. The window is placed in the
application layer and opaque.

Parameters:
text - Text to display in the dialog.

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/notice/ErrorDialog.html[2/19/2011 9:15:43 AM]


Uses of Class org.hermit.android.notice.TextInputDialog

Overview Package Class Use Tree Deprecated Index Help


PREV NEXT FRAMES NO FRAMES All Classes

Uses of Class
org.hermit.android.notice.TextInputDialog
No usage of org.hermit.android.notice.TextInputDialog

Overview Package Class Use Tree Deprecated Index Help


PREV NEXT FRAMES NO FRAMES All Classes

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/notice/class-use/TextInputDialog.html[2/19/2011 9:15:45 AM]


TextInputDialog

All Classes Overview Package Class Use Tree Deprecated Index Help
PREV CLASS NEXT CLASS FRAMES NO FRAMES
Packages SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
org.hermit.android.core
org.hermit.android.instrum
org.hermit.android.io org.hermit.android.notice
org.hermit.android.net
org.hermit.android.notice
Class TextInputDialog
org.hermit.android.provide
java.lang.Object
org.hermit.android.sound
AlertDialog
org.hermit.android.widgets org.hermit.android.notice.TextInputDialog

public class TextInputDialog


extends AlertDialog

This class implements a popup input box (a subclass of AlertDialog) which can be used to
display a prompt and read a text string from the user.

Nested Class Summary


static interface
TextInputDialog.OnOkListener
Listener invoked when the user clicks the OK button.

Constructor Summary
TextInputDialog(Context parent, java.lang.CharSequence okBut,
java.lang.CharSequence cancelBut)
Create an error dialog.
TextInputDialog(Context parent, int okBut, int cancelBut)
Create an error dialog.

Method Summary
void setOnOkListener(TextInputDialog.OnOkListener listener)
Set a listener for the dialog.
void show(int title, int text)
Start the dialog and display it on screen.
void show(int title, int text, java.lang.String dflt)
Start the dialog and display it on screen.
void show(java.lang.String title, java.lang.String text)
Start the dialog and display it on screen.
void show(java.lang.String title, java.lang.String text, java.lang.String dflt)
All Classes
Start the dialog and display it on screen.
AppUtils
AppUtils.Detail
AudioAnalyser Methods inherited from class java.lang.Object
AudioReader clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait,
AudioReader.Listener wait, wait
CachedFile
CachedFile.Entry

Constructor Detail
DatabaseHelper
DbSchema
Effect
TextInputDialog
ErrorDialog
Errors

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/notice/TextInputDialog.html[2/19/2011 9:15:50 AM]


TextInputDialog

FileFetcher
public TextInputDialog(Context parent,
Gauge int okBut,
HelpActivity int cancelBut)
HScrollView
InfoBox Create an error dialog.
Instrument
InstrumentSurface Parameters:
LinedEditText parent - Parent application context.
MainActivity okBut - The resource ID of the text for the OK button.
MainActivity.ActivityListen cancelBut - The resource ID of the text for the cancel button.
MultistateImageButton
OneTimeDialog
Player TextInputDialog
PowerGauge
SpectrumGauge public TextInputDialog(Context parent,
SplashActivity java.lang.CharSequence okBut,
java.lang.CharSequence cancelBut)
SurfaceRunner
TableFetcher
Create an error dialog.
TableProvider
TableSchema
Parameters:
TextGauge
parent - Parent application context.
TextInputDialog okBut - The text for the OK button.
TextInputDialog.OnOkList cancelBut - The text for the cancel button.
TimeZoneActivity
WaveformGauge
WebBasedData Method Detail
WebFetcher
WebFetcher.FetchExcepti
WebFetcher.Listener setOnOkListener
YesNoDialog
YesNoDialog.OnOkListen public void setOnOkListener(TextInputDialog.OnOkListener listener)

Set a listener for the dialog.

Parameters:
listener - The listener to set.

show
public void show(int title,
int text)

Start the dialog and display it on screen. The window is placed in the application layer
and opaque.

Parameters:
title - Title for the dialog.
text - Input prompt to display in the dialog.

show
public void show(int title,
int text,
java.lang.String dflt)

Start the dialog and display it on screen. The window is placed in the application layer
and opaque.

Parameters:
title - Title for the dialog.
text - Input prompt to display in the dialog.

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/notice/TextInputDialog.html[2/19/2011 9:15:50 AM]


TextInputDialog

dflt - Default text to display in the input field.

show
public void show(java.lang.String title,
java.lang.String text)

Start the dialog and display it on screen. The window is placed in the application layer
and opaque.

Parameters:
title - Title for the dialog.
text - Input prompt to display in the dialog.

show
public void show(java.lang.String title,
java.lang.String text,
java.lang.String dflt)

Start the dialog and display it on screen. The window is placed in the application layer
and opaque.

Parameters:
title - Title for the dialog.
text - Input prompt to display in the dialog.
dflt - Default text to display in the input field.

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/notice/TextInputDialog.html[2/19/2011 9:15:50 AM]


Uses of Class org.hermit.android.net.CachedFile.Entry

Overview Package Class Use Tree Deprecated Index Help


PREV NEXT FRAMES NO FRAMES All Classes

Uses of Class
org.hermit.android.net.CachedFile.Entry

Packages that use CachedFile.Entry


org.hermit.android.net

Uses of CachedFile.Entry in org.hermit.android.net

Methods in org.hermit.android.net that return CachedFile.Entry


CachedFile.Entry CachedFile.getFile(java.net.URL url)
Query for a given file in the cache.

Overview Package Class Use Tree Deprecated Index Help


PREV NEXT FRAMES NO FRAMES All Classes

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/net/class-use/CachedFile.Entry.html[2/19/2011 9:15:52 AM]


CachedFile.Entry

All Classes Overview Package Class Use Tree Deprecated Index Help
PREV CLASS NEXT CLASS FRAMES NO FRAMES
Packages SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
org.hermit.android.core
org.hermit.android.instrum
org.hermit.android.io org.hermit.android.net
org.hermit.android.net
org.hermit.android.notice
Class CachedFile.Entry
org.hermit.android.provide
java.lang.Object
org.hermit.android.sound
org.hermit.android.net.CachedFile.Entry
org.hermit.android.widgets
Enclosing class:
CachedFile

public static final class CachedFile.Entry


extends java.lang.Object

Class describing an entry in the cache; i.e. a cached file.

Field Summary
long
All Classes date
The last modified time of the file, as reported by the server, in ms
AppUtils
UTC.
AppUtils.Detail
AudioAnalyser java.lang.String name
AudioReader The local name of the file.
AudioReader.Listener java.io.File path
CachedFile
The path of the local copy of the file.
CachedFile.Entry
java.net.URL url
DatabaseHelper
DbSchema The URL of the file that was loaded.
Effect
ErrorDialog
Errors Method Summary
FileFetcher
Gauge
HelpActivity Methods inherited from class java.lang.Object
HScrollView clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait,
InfoBox wait, wait
Instrument
InstrumentSurface
LinedEditText
MainActivity
Field Detail
MainActivity.ActivityListen
MultistateImageButton url
OneTimeDialog
Player public final java.net.URL url
PowerGauge
SpectrumGauge The URL of the file that was loaded.
SplashActivity
SurfaceRunner
TableFetcher
TableProvider
name
TableSchema
public java.lang.String name
TextGauge
TextInputDialog
The local name of the file.
TextInputDialog.OnOkList
TimeZoneActivity

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/net/CachedFile.Entry.html[2/19/2011 9:15:57 AM]


CachedFile.Entry

WaveformGauge
WebBasedData path
WebFetcher
WebFetcher.FetchExceptionpublic java.io.File path
WebFetcher.Listener
YesNoDialog The path of the local copy of the file.
YesNoDialog.OnOkListener

date
public long date

The last modified time of the file, as reported by the server, in ms UTC.

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/net/CachedFile.Entry.html[2/19/2011 9:15:57 AM]


Uses of Class org.hermit.android.provider.TableProvider

Overview Package Class Use Tree Deprecated Index Help


PREV NEXT FRAMES NO FRAMES All Classes

Uses of Class
org.hermit.android.provider.TableProvider
No usage of org.hermit.android.provider.TableProvider

Overview Package Class Use Tree Deprecated Index Help


PREV NEXT FRAMES NO FRAMES All Classes

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/provider/class-use/TableProvider.html[2/19/2011 9:15:59 AM]


TableProvider

All Classes Overview Package Class Use Tree Deprecated Index Help
PREV CLASS NEXT CLASS FRAMES NO FRAMES
Packages SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
org.hermit.android.core
org.hermit.android.instru
org.hermit.android.io org.hermit.android.provider
org.hermit.android.net
org.hermit.android.notic Class TableProvider
org.hermit.android.prov
java.lang.Object
org.hermit.android.soun
ContentProvider
org.hermit.android.widg org.hermit.android.provider.TableProvider

public class TableProvider


extends ContentProvider

This class is a base for content providers which provide access to table-organized
data in an SQL database.

Typically, this is used by creating a subclass which is empty other than providing an
appropriate schema to this class's constructor. The bulk of the work in creating a
content provider is in creating the schema, a subclass of DbSchema .

Constructor Summary
TableProvider(DbSchema schema)
Create an instance of this content provider.

Method Summary
int delete(Uri uri, java.lang.String where,
java.lang.String[] whereArgs)
A request to delete one or more rows.
protected
DatabaseHelper getHelper()
Get the database helper which this content provider will
use.
protected getSchema()
DbSchema
Get the database schema.
protected
TableSchema getTableSchema(java.lang.String name)
Get the schema for a specified table.
java.lang.String getType(Uri uri)
Return the MIME type of the data at the given URI.
Uri insert(Uri uri, ContentValues initValues)
Implement this to insert a new row.
boolean onCreate()
Called when the provider is being started.
protected void onInsert(Uri uri, TableSchema table,
ContentValues initValues)
This method is called prior to processing an insert; it is
called after TableSchema.onInsert(ContentValues) .
Cursor query(Uri uri, java.lang.String[] projection,

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/provider/TableProvider.html[2/19/2011 9:16:02 AM]


TableProvider

java.lang.String where, java.lang.String[] whereArgs,


java.lang.String sortOrder)
Receives a query request from a client in a local process,
and returns a Cursor.
protected Cursor queryItem(TableSchema t, java.lang.String[] projection,
long id)
Query for a specified item within a table.
protected Cursor queryItem(TableSchema t, java.lang.String[] projection,
java.lang.String id)
Query for a specified item within a table.
protected Cursor queryItems(TableSchema t, java.lang.String[] projection,
java.lang.String where, java.lang.String[] whereArgs,
java.lang.String sortOrder)
Query for items within a table.
int update(Uri uri, ContentValues values,
java.lang.String where, java.lang.String[] whereArgs)
Update a content URI.

Methods inherited from class java.lang.Object


clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString,
wait, wait, wait

Constructor Detail
TableProvider
public TableProvider(DbSchema schema)

Create an instance of this content provider.

Parameters:
schema - Structure defining the database schema.

Method Detail
onCreate
public boolean onCreate()

Called when the provider is being started.


All Classes Returns:
AppUtils true if the provider was successfully loaded, false otherwise.
AppUtils.Detail
AudioAnalyser
AudioReader getSchema
AudioReader.Listener
CachedFile protected DbSchema getSchema()
CachedFile.Entry
DatabaseHelper Get the database schema.
DbSchema
Effect Returns:

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/provider/TableProvider.html[2/19/2011 9:16:02 AM]


TableProvider

ErrorDialog The schema for this database.


Errors
FileFetcher
Gauge
HelpActivity
getTableSchema
HScrollView protected TableSchema getTableSchema(java.lang.String name)
InfoBox throws java.lang.IllegalArgumentException
Instrument
InstrumentSurface Get the schema for a specified table.
LinedEditText
MainActivity Parameters:
MainActivity.ActivityList name - The name of the table we want.
MultistateImageButton Returns:
OneTimeDialog The schema for the given table.
Player Throws:
PowerGauge java.lang.IllegalArgumentException - No such table.
SpectrumGauge
SplashActivity
SurfaceRunner getHelper
TableFetcher
TableProvider protected DatabaseHelper getHelper()
TableSchema
TextGauge Get the database helper which this content provider will use.
TextInputDialog
TextInputDialog.OnOkL Subclasses may override this to provide a smarter database helper; for
TimeZoneActivity example, to implement a smarter database upgrade process. See
WaveformGauge DatabaseHelper .
WebBasedData
WebFetcher Returns:
WebFetcher.FetchExce A database helper for this content provider.
WebFetcher.Listener
YesNoDialog
YesNoDialog.OnOkListe
getType
public java.lang.String getType(Uri uri)

Return the MIME type of the data at the given URI. This should start with
vnd.android.cursor.item/ for a single record, or vnd.android.cursor.dir/ for
multiple items.

Parameters:
uri - The URI to query.
Returns:
MIME type string for the given URI, or null if there is no type.

query
public Cursor query(Uri uri,
java.lang.String[] projection,
java.lang.String where,
java.lang.String[] whereArgs,
java.lang.String sortOrder)

Receives a query request from a client in a local process, and returns a Cursor.
This is called internally by the ContentResolver.

Parameters:

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/provider/TableProvider.html[2/19/2011 9:16:02 AM]


TableProvider

- The URI to query. This will be the full URI sent by the client; if the
uri
client is requesting a specific record, the URI will end in a record number
that the implementation should parse and add to a WHERE or HAVING
clause, specifying that _id value.
projection - The list of columns to put into the cursor. If null all columns
are included.
where - A selection criteria to apply when filtering rows. If null then all
rows are included.
whereArgs - You may include ?s in selection, which will be replaced by the
values from selectionArgs, in order that they appear in the selection. The
values will be bound as Strings.
sortOrder - How the rows in the cursor should be sorted. If null then the
provider is free to define the sort order.
Returns:
A Cursor or null.

queryItem
protected Cursor queryItem(TableSchema t,
java.lang.String[] projection,
long id)

Query for a specified item within a table.

Parameters:
t - The schema for the table to query.
projection - The list of columns to put into the cursor. If null all columns
are included.
id - The ID of the item we want.
Returns:
A Cursor or null.

queryItem
protected Cursor queryItem(TableSchema t,
java.lang.String[] projection,
java.lang.String id)

Query for a specified item within a table.

Parameters:
t - The schema for the table to query.
projection - The list of columns to put into the cursor. If null all columns
are included.
id - The ID of the item we want, as a String.
Returns:
A Cursor or null.

queryItems
protected Cursor queryItems(TableSchema t,
java.lang.String[] projection,
java.lang.String where,
java.lang.String[] whereArgs,
java.lang.String sortOrder)

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/provider/TableProvider.html[2/19/2011 9:16:02 AM]


TableProvider

Query for items within a table.

Parameters:
t - The schema for the table to query.
projection - The list of columns to put into the cursor. If null all columns
are included.
where - A selection criteria to apply when filtering rows. If null then all
rows are included.
whereArgs - You may include ?s in selection, which will be replaced by the
values from selectionArgs, in order that they appear in the selection. The
values will be bound as Strings.
sortOrder - How the rows in the cursor should be sorted. If null then the
provider is free to define the sort order.
Returns:
A Cursor or null.

onInsert
protected void onInsert(Uri uri,
TableSchema table,
ContentValues initValues)

This method is called prior to processing an insert; it is called after


TableSchema.onInsert(ContentValues) . Subclasses can use this to carry out
additional processing.

Parameters:
uri - The content:// URI of the insertion request.
table - The schema of the table we're inserting into.
initValues - A set of column_name/value pairs to add to the database.

insert
public Uri insert(Uri uri,
ContentValues initValues)

Implement this to insert a new row. As a courtesy, call notifyChange() after


inserting.

Parameters:
uri - The content:// URI of the insertion request.
initValues - A set of column_name/value pairs to add to the database.
Returns:
The URI for the newly inserted item.

delete
public int delete(Uri uri,
java.lang.String where,
java.lang.String[] whereArgs)

A request to delete one or more rows. The selection clause is applied when
performing the deletion, allowing the operation to affect multiple rows in a
directory. As a courtesy, call notifyDelete() after deleting. The implementation
is responsible for parsing out a row ID at the end of the URI, if a specific row is

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/provider/TableProvider.html[2/19/2011 9:16:02 AM]


TableProvider

being deleted. That is, the client would pass in content://contacts/people/22


and the implementation is responsible for parsing the record number (22) when
creating an SQL statement.

Parameters:
uri - The full URI to delete, including a row ID (if a specific record is to
be deleted).
where - An optional restriction to apply to rows when deleting.
whereArgs - You may include ?s in where, which will be replaced by the
values from whereArgs.
Returns:
The number of rows affected.
Throws:
SQLException - Database error.

update
public int update(Uri uri,
ContentValues values,
java.lang.String where,
java.lang.String[] whereArgs)

Update a content URI. All rows matching the optionally provided selection will
have their columns listed as the keys in the values map with the values of
those keys. As a courtesy, call notifyChange() after updating.

Parameters:
uri - The URI to update. This can potentially have a record ID if this is an
update request for a specific record.
values - A Bundle mapping from column names to new column values
(NULL is a valid value).
where - An optional restriction to apply to rows when updating.
whereArgs - You may include ?s in where, which will be replaced by the
values from whereArgs.
Returns:
The number of rows affected.

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/provider/TableProvider.html[2/19/2011 9:16:02 AM]


Uses of Class org.hermit.android.provider.DbSchema

Overview Package Class Use Tree Deprecated Index Help


PREV NEXT FRAMES NO FRAMES All Classes

Uses of Class
org.hermit.android.provider.DbSchema

Packages that use DbSchema


org.hermit.android.provider A library of classes to facilitate the creating of table-based content
providers.

Uses of DbSchema in org.hermit.android.provider

Methods in org.hermit.android.provider that return DbSchema


protected TableProvider.getSchema()
DbSchema
Get the database schema.
protected DatabaseHelper.getSchema()
DbSchema
Get the database schema.

Constructors in org.hermit.android.provider with parameters of type DbSchema


DatabaseHelper(Context context, DbSchema schema)
Creater a helper instance.
TableProvider(DbSchema schema)
Create an instance of this content provider.

Overview Package Class Use Tree Deprecated Index Help


PREV NEXT FRAMES NO FRAMES All Classes

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/provider/class-use/DbSchema.html[2/19/2011 9:16:05 AM]


DbSchema

All Classes Overview Package Class Use Tree Deprecated Index Help
PREV CLASS NEXT CLASS FRAMES NO FRAMES
Packages SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
org.hermit.android.core
org.hermit.android.instru
org.hermit.android.io org.hermit.android.provider
org.hermit.android.net
org.hermit.android.notic Class DbSchema
org.hermit.android.prov
java.lang.Object
org.hermit.android.soun
org.hermit.android.provider.DbSchema
org.hermit.android.widg

public abstract class DbSchema


extends java.lang.Object

Class encapsulating the schema for a content provider. Applications must subclass
this, and provide the necessary information in the call to this base class's
constructor.

An application's subclass will typically provide the following:

Inner classes which are subclasses of TableSchema, defining the schemas of the
individual tables.
A constructor which calls this class's constructor, passing the required
information.

Constructor Summary
protected DbSchema(java.lang.String name, int version, java.lang.String auth,
TableSchema[] tables)
Create a database schema instance.

All Classes
AppUtils Method Summary
AppUtils.Detail java.lang.String getDbName()
AudioAnalyser Get the database name.
AudioReader
int getDbVersion()
AudioReader.Listener
CachedFile Get the database version number.
CachedFile.Entry protected
TableSchema getTable(java.lang.String name)
DatabaseHelper Get the schema for a specified table.
DbSchema
Effect
ErrorDialog Methods inherited from class java.lang.Object
Errors clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString,
FileFetcher wait, wait, wait
Gauge
HelpActivity

Constructor Detail
HScrollView
InfoBox
Instrument
InstrumentSurface
LinedEditText
DbSchema
MainActivity protected DbSchema(java.lang.String name,

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/provider/DbSchema.html[2/19/2011 9:16:11 AM]


DbSchema

MainActivity.ActivityList int version,


MultistateImageButton java.lang.String auth,
TableSchema[] tables)
OneTimeDialog
Player
Create a database schema instance.
PowerGauge
SpectrumGauge
Parameters:
SplashActivity name - Name for the database; e.g. "passages".
SurfaceRunner version - Version number of the database. The upgrade process will be
TableFetcher run when this increments.
TableProvider auth - Authority name for this content provider; e.g.
TableSchema "org.hermit.provider.PassageData".
TextGauge tables - List of table schemas.
TextInputDialog
TextInputDialog.OnOkL
TimeZoneActivity Method Detail
WaveformGauge
WebBasedData
WebFetcher getDbName
WebFetcher.FetchExce
WebFetcher.Listener public java.lang.String getDbName()
YesNoDialog
YesNoDialog.OnOkListe Get the database name.

Returns:
The name of the database.

getDbVersion
public int getDbVersion()

Get the database version number.

Returns:
The database version number.

getTable
protected TableSchema getTable(java.lang.String name)
throws java.lang.IllegalArgumentException

Get the schema for a specified table.

Parameters:
name - The name of the table we want.
Returns:
The schema for the given table.
Throws:
java.lang.IllegalArgumentException - No such table.

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/provider/DbSchema.html[2/19/2011 9:16:11 AM]


Uses of Class org.hermit.android.notice.InfoBox

Overview Package Class Use Tree Deprecated Index Help


PREV NEXT FRAMES NO FRAMES All Classes

Uses of Class
org.hermit.android.notice.InfoBox
No usage of org.hermit.android.notice.InfoBox

Overview Package Class Use Tree Deprecated Index Help


PREV NEXT FRAMES NO FRAMES All Classes

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/notice/class-use/InfoBox.html[2/19/2011 9:16:13 AM]


InfoBox

All Classes Overview Package Class Use Tree Deprecated Index Help
PREV CLASS NEXT CLASS FRAMES NO FRAMES
Packages SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
org.hermit.android.core
org.hermit.android.instru
org.hermit.android.io org.hermit.android.notice
org.hermit.android.net
org.hermit.android.notic Class InfoBox
org.hermit.android.prov
java.lang.Object
org.hermit.android.soun
Dialog
org.hermit.android.widg org.hermit.android.notice.InfoBox

public class InfoBox


extends Dialog

This class implements a popup info box (a subclass of Dialog) which can be used to
display help text, about info, license info, etc.

Field Summary
static int BUTTON_1
Select configurable button 1 -- the middle button.
static int BUTTON_2
Select configurable button 2 -- the middle button.

Constructor Summary
InfoBox(Activity parent)
Create an info box with a "close" button.
InfoBox(Activity parent, int button)
Create an info box.

Method Summary
protected linkButtonPressed(int which)
void
Called when a link button is clicked.
protected okButtonPressed()
void
Called when the OK button is clicked.
void setLinkButton(int which, int label, int link)
Set a link button on this dialog.
void setSubtitle(int textId)
Set the subtitle for the about box.
void setSubtitle(java.lang.String text)
Set the subtitle for the about box.
void show(int text)
Start the dialog and display it on screen.
void show(int title, int text)
Start the dialog and display it on screen.

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/notice/InfoBox.html[2/19/2011 9:16:16 AM]


InfoBox

void show(java.lang.String text)


Start the dialog and display it on screen.

Methods inherited from class java.lang.Object


clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString,
wait, wait, wait
All Classes
AppUtils
AppUtils.Detail
AudioAnalyser Field Detail
AudioReader
AudioReader.Listener
CachedFile BUTTON_1
CachedFile.Entry
DatabaseHelper public static final int BUTTON_1
DbSchema
Effect Select configurable button 1 -- the middle button.
ErrorDialog
Errors See Also:
FileFetcher Constant Field Values
Gauge
HelpActivity
HScrollView BUTTON_2
InfoBox
Instrument public static final int BUTTON_2
InstrumentSurface
LinedEditText Select configurable button 2 -- the middle button.
MainActivity
MainActivity.ActivityList See Also:
MultistateImageButton Constant Field Values
OneTimeDialog
Player
PowerGauge Constructor Detail
SpectrumGauge
SplashActivity InfoBox
SurfaceRunner
TableFetcher public InfoBox(Activity parent)
TableProvider
TableSchema Create an info box with a "close" button.
TextGauge
TextInputDialog Parameters:
TextInputDialog.OnOkL parent - Parent application context.
TimeZoneActivity
WaveformGauge
WebBasedData
WebFetcher
InfoBox
WebFetcher.FetchExce
public InfoBox(Activity parent,
WebFetcher.Listener int button)
YesNoDialog
YesNoDialog.OnOkListe Create an info box.

Parameters:
parent - Parent application context.
button - Resource ID of the text for the OK button.

Method Detail

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/notice/InfoBox.html[2/19/2011 9:16:16 AM]


InfoBox

setLinkButton
public void setLinkButton(int which,
int label,
int link)

Set a link button on this dialog. These are buttons that the user can click to
open a URL, e.g. the project page, license, etc.

Parameters:
which - Which button to set: BUTTON_1 or BUTTON_2.
label - The button label as a resource ID.
link - Resource ID of the URL for the button.

setSubtitle
public void setSubtitle(int textId)

Set the subtitle for the about box.

Parameters:
textId - ID of the subtitle to display; if 0, don't show one.

setSubtitle
public void setSubtitle(java.lang.String text)

Set the subtitle for the about box.

Parameters:
text - Subtitle to display; if null, don't show one.

show
public void show(int title,
int text)

Start the dialog and display it on screen. The window is placed in the
application layer and opaque.

Parameters:
title - Title for the dialog.
text - Text to display in the dialog.

show
public void show(int text)

Start the dialog and display it on screen. The window is placed in the
application layer and opaque.

Parameters:

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/notice/InfoBox.html[2/19/2011 9:16:16 AM]


InfoBox

text - Text to display in the dialog.

show
public void show(java.lang.String text)

Start the dialog and display it on screen. The window is placed in the
application layer and opaque.

Parameters:
text - Text to display in the dialog.

okButtonPressed
protected void okButtonPressed()

Called when the OK button is clicked.

linkButtonPressed
protected void linkButtonPressed(int which)

Called when a link button is clicked.

Parameters:
which - The ID of the link button which has been clicked, as passed to
setLinkButton(int, int, int) .

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/notice/InfoBox.html[2/19/2011 9:16:16 AM]


Uses of Class org.hermit.android.widgets.LinedEditText

Overview Package Class Use Tree Deprecated Index Help


PREV NEXT FRAMES NO FRAMES All Classes

Uses of Class
org.hermit.android.widgets.LinedEditText
No usage of org.hermit.android.widgets.LinedEditText

Overview Package Class Use Tree Deprecated Index Help


PREV NEXT FRAMES NO FRAMES All Classes

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/widgets/class-use/LinedEditText.html[2/19/2011 9:16:18 AM]


LinedEditText

All Classes Overview Package Class Use Tree Deprecated Index Help
PREV CLASS NEXT CLASS FRAMES NO FRAMES
Packages SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
org.hermit.android.core
org.hermit.android.instru
org.hermit.android.io org.hermit.android.widgets
org.hermit.android.net
org.hermit.android.notic Class LinedEditText
org.hermit.android.prov
java.lang.Object
org.hermit.android.soun
EditText
org.hermit.android.widg org.hermit.android.widgets.LinedEditText

public class LinedEditText


extends EditText

A custom EditText that draws lines between each line of text that is displayed.

Constructor Summary
All Classes
LinedEditText(Context context, AttributeSet attrs)
AppUtils
AppUtils.Detail
Construct a widget from a given attribute set.
AudioAnalyser
AudioReader
AudioReader.Listener Method Summary
CachedFile protected onDraw(Canvas canvas)
void
CachedFile.Entry Overridden onDraw method.
DatabaseHelper
DbSchema
Effect Methods inherited from class java.lang.Object
ErrorDialog clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString,
Errors wait, wait, wait
FileFetcher
Gauge
HelpActivity
HScrollView Constructor Detail
InfoBox
Instrument LinedEditText
InstrumentSurface
LinedEditText public LinedEditText(Context context,
MainActivity AttributeSet attrs)
MainActivity.ActivityList
MultistateImageButton Construct a widget from a given attribute set. This is required to allow this
OneTimeDialog widget to be used from XML layouts.
Player
PowerGauge Parameters:
SpectrumGauge context - Context we're running in.
SplashActivity attrs - Attributes for this widget.
SurfaceRunner
TableFetcher
TableProvider Method Detail
TableSchema
TextGauge onDraw
TextInputDialog

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/widgets/LinedEditText.html[2/19/2011 9:16:21 AM]


LinedEditText

TextInputDialog.OnOkListener
protected void onDraw(Canvas canvas)
TimeZoneActivity
WaveformGauge Overridden onDraw method. Draw the text, with lines.
WebBasedData
WebFetcher Parameters:
WebFetcher.FetchException canvas - Canvas to draw into.
WebFetcher.Listener
YesNoDialog
YesNoDialog.OnOkListener Overview Package Class Use Tree Deprecated Index Help
PREV CLASS NEXT CLASS FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/widgets/LinedEditText.html[2/19/2011 9:16:21 AM]


Uses of Class org.hermit.android.sound.Effect

Overview Package Class Use Tree Deprecated Index Help


PREV NEXT FRAMES NO FRAMES All Classes

Uses of Class
org.hermit.android.sound.Effect

Packages that use Effect


org.hermit.android.sound These classes provide functions to help apps manage their sound effects.

Uses of Effect in org.hermit.android.sound

Methods in org.hermit.android.sound that return Effect


Effect Player.addEffect(int sound)
Add a sound effect to this player.
Effect Player.addEffect(int sound, float vol)
Add a sound effect to this player.

Methods in org.hermit.android.sound with parameters of type Effect


int Player.play(Effect effect)
Play the given sound effect.
int Player.play(Effect effect, float rvol, boolean loop)
Play the given sound effect.

Overview Package Class Use Tree Deprecated Index Help


PREV NEXT FRAMES NO FRAMES All Classes

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/sound/class-use/Effect.html[2/19/2011 9:16:23 AM]


Effect

All Classes Overview Package Class Use Tree Deprecated Index Help
PREV CLASS NEXT CLASS FRAMES NO FRAMES
Packages SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
org.hermit.android.core
org.hermit.android.instru
org.hermit.android.io org.hermit.android.sound
org.hermit.android.net
org.hermit.android.notic Class Effect
org.hermit.android.prov
java.lang.Object
org.hermit.android.soun
org.hermit.android.sound.Effect
org.hermit.android.widg

public class Effect


extends java.lang.Object

Class representing a specific sound effect.

Method Summary
boolean isPlaying()
Determine whether this effect is playing.
void loop()
Start playing this sound effect in a continuous loop.
void play()
All Classes Play this sound effect.
AppUtils void play(float rvol)
AppUtils.Detail Play this sound effect.
AudioAnalyser void stop()
AudioReader
AudioReader.Listener Stop this sound effect immediately.
CachedFile
CachedFile.Entry Methods inherited from class java.lang.Object
DatabaseHelper
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString,
DbSchema wait, wait, wait
Effect
ErrorDialog
Errors
FileFetcher Method Detail
Gauge
HelpActivity
HScrollView play
InfoBox
Instrument public void play()
InstrumentSurface
LinedEditText Play this sound effect.
MainActivity
MainActivity.ActivityList
MultistateImageButton play
OneTimeDialog
Player public void play(float rvol)
PowerGauge
SpectrumGauge Play this sound effect.
SplashActivity

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/sound/Effect.html[2/19/2011 9:16:26 AM]


Effect

SurfaceRunner Parameters:
TableFetcher rvol - Relative volume for this sound, 0 - 1.
TableProvider
TableSchema
TextGauge loop
TextInputDialog
TextInputDialog.OnOkL public void loop()
TimeZoneActivity
WaveformGauge Start playing this sound effect in a continuous loop.
WebBasedData
WebFetcher
stop
WebFetcher.FetchExce
WebFetcher.Listener
YesNoDialog
public void stop()
YesNoDialog.OnOkListe
Stop this sound effect immediately.

isPlaying
public final boolean isPlaying()

Determine whether this effect is playing.

Returns:
True if this sound effect is playing.

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/sound/Effect.html[2/19/2011 9:16:26 AM]


Uses of Class org.hermit.android.core.Errors

Overview Package Class Use Tree Deprecated Index Help


PREV NEXT FRAMES NO FRAMES All Classes

Uses of Class
org.hermit.android.core.Errors

Packages that use Errors


org.hermit.android.core A library of foundation classes for Android applications.

Uses of Errors in org.hermit.android.core

Methods in org.hermit.android.core that return Errors


static Errors Errors.getInstance(Context context)
Get the single instance of this class for the given Activity, creating it if necessary.

Overview Package Class Use Tree Deprecated Index Help


PREV NEXT FRAMES NO FRAMES All Classes

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/core/class-use/Errors.html[2/19/2011 9:16:27 AM]


Errors

All Classes Overview Package Class Use Tree Deprecated Index Help
PREV CLASS NEXT CLASS FRAMES NO FRAMES
Packages SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
org.hermit.android.core
org.hermit.android.instru
org.hermit.android.io org.hermit.android.core
org.hermit.android.net
org.hermit.android.notic Class Errors
org.hermit.android.prov
java.lang.Object
org.hermit.android.soun
org.hermit.android.core.Errors
org.hermit.android.widg

public class Errors


extends java.lang.Object

Error handling and reporting utilities.

Author:
Ian Cameron Smith

Method Summary
static Errors getInstance(Context context)
Get the single instance of this class for the given Activity,
creating it if necessary.
static void reportException(Context context, java.lang.Exception e)
All Classes Report an unexpected exception to the user by popping up a
AppUtils dialog with some debug info.
AppUtils.Detail void reportException(java.lang.Exception e)
AudioAnalyser Report an unexpected exception to the user by popping up a
AudioReader dialog with some debug info.
AudioReader.Listener
CachedFile
CachedFile.Entry Methods inherited from class java.lang.Object
DatabaseHelper clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString,
DbSchema wait, wait, wait
Effect
ErrorDialog

Method Detail
Errors
FileFetcher
Gauge
HelpActivity
HScrollView
getInstance
InfoBox
public static Errors getInstance(Context context)
Instrument
InstrumentSurface Get the single instance of this class for the given Activity, creating it if
LinedEditText necessary.
MainActivity
MainActivity.ActivityList Parameters:
MultistateImageButton context - The Activity for which we want an error reporter.
OneTimeDialog Returns:
Player The single instance of this class.
PowerGauge
SpectrumGauge

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/core/Errors.html[2/19/2011 9:16:31 AM]


Errors

SplashActivity
SurfaceRunner reportException
TableFetcher
TableProvider public static void reportException(Context context,
java.lang.Exception e)
TableSchema
TextGauge Report an unexpected exception to the user by popping up a dialog with some
TextInputDialog debug info. Don't report the same exception more than twice, and if we get
TextInputDialog.OnOkL floods of exceptions, just bomb out.
TimeZoneActivity
WaveformGauge This method may be called from any thread. The reporting will be deferred to
WebBasedData the UI thread.
WebFetcher
WebFetcher.FetchExce Parameters:
WebFetcher.Listener context - The Activity for which we want an error reporter.
YesNoDialog e - The exception.
YesNoDialog.OnOkListe

reportException
public void reportException(java.lang.Exception e)

Report an unexpected exception to the user by popping up a dialog with some


debug info. Don't report the same exception more than twice, and if we get
floods of exceptions, just bomb out.

This method may be called from any thread. The reporting will be deferred to
the UI thread.

Parameters:
e - The exception.

Overview Package Class Use Tree Deprecated Index Help


PREV CLASS NEXT CLASS FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/core/Errors.html[2/19/2011 9:16:31 AM]


Uses of Class org.hermit.android.instruments.Gauge

Overview Package Class Use Tree Deprecated Index Help


PREV NEXT FRAMES NO FRAMES All Classes

Uses of Class
org.hermit.android.instruments.Gauge

Packages that use Gauge


org.hermit.android.instruments

Uses of Gauge in org.hermit.android.instruments

Subclasses of Gauge in org.hermit.android.instruments


class PowerGauge
A graphical display which displays the signal power in dB from an AudioAnalyser instrument.
class SpectrumGauge
A graphical display which displays the audio spectrum from an AudioAnalyser instrument.
class TextGauge
A Gauge which displays data in textual form, generally as a grid of numeric values.
class WaveformGauge
A graphical display which displays the audio waveform from an AudioAnalyser instrument.

Methods in org.hermit.android.instruments with parameters of type Gauge


void InstrumentSurface.addGauge(Gauge i)
Add a gauge to this surface.

Overview Package Class Use Tree Deprecated Index Help


PREV NEXT FRAMES NO FRAMES All Classes

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/instruments/class-use/Gauge.html[2/19/2011 9:16:33 AM]


Gauge

All Classes Overview Package Class Use Tree Deprecated Index Help
PREV CLASS NEXT CLASS FRAMES NO FRAMES
Packages SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
org.hermit.android.core
org.hermit.android.instru
org.hermit.android.io org.hermit.android.instruments
org.hermit.android.net
org.hermit.android.notic Class Gauge
org.hermit.android.prov
java.lang.Object
org.hermit.android.soun
org.hermit.android.instruments.Gauge
org.hermit.android.widg
Direct Known Subclasses:
PowerGauge, SpectrumGauge, TextGauge, WaveformGauge

public class Gauge


extends java.lang.Object

A graphical display which shows some data in a region within a view. The data may
come from an Instrument or some other source.

Configuration
Your gauge will be notified of its geometry by a call to setGeometry(Rect). This is
where you should note your position and size and perform any internal layout you
need to do.

Note that if you are running in an app which handles screen configuration changes,
setGeometry(Rect) will be called any time the screen changes size or shape (e.g. on
an orientation change). You should be prepared to handle these subsequent calls by
re-creating data structures, re-doing layout, etc., as required.

Data Updating
It is assumed that your gauge has some kind of data source, but how this works is
up to you.

Drawing Sequence -- User


A gauge may have a background which is rendered separately from its content, for
performance reasons. Hence, a Gauge user must request the background to be
drawn, and then the gauge content to be drawn. If the caller is going to cache the
background, the background need be requested only when the geometry changes.

There are two options. In the non-caching case, the caller may simply call
draw(Canvas, long, boolean) , passing true as the last argument. This asks the
Gauge to draw its background and its content.

In the caching case, the caller should call drawBackground(Canvas) to ask the gauge
to draw its background into the given canvas. Since the gauge will use the same co-
ordinates that it uses to draw to the screen, the canvas will need to be the size of
the screen (or you can translate the co-ordinates). Then, to draw the gauge, the
caller should render the stored background and then call draw(Canvas, long,

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/instruments/Gauge.html[2/19/2011 9:16:36 AM]


Gauge

boolean) .

Drawing Sequence -- Implementor


From the Gauge implementor's point of view, there are two routines to implement:
drawBackgroundBody(Canvas, Paint) (optional), and drawBody(Canvas, Paint, long) .

If your implementation of drawBody(Canvas, Paint, long) draws a complete, opaque


rendition of the gauge, that's all you need; there's no need to provide an
implementation of drawBackgroundBody(). But if your gauge has a separate,
persistent background appearance, you may reap a performance benefit by
separating out its drawing. Do this by implementing drawBackgroundBody(Canvas,
Paint). This routine should draw the gauge background at the gauge's configured
position in the specified Canvas.

A facility is provided for caching background images. To use this, call


cacheBackground() once your layout is set up -- for example at the end of
setGeometry(Rect) . At that point, your background will be fetched (by calling your
implementation of drawBackgroundBody()) and stored; then when someone asks us
to draw our background, the request will be satisfied using the stored bitmap,
without calling your drawBackgroundBody() again.

Constructor Summary
Gauge(SurfaceRunner parent)
Set up this view.
Gauge(SurfaceRunner parent, int options)
Set up this view.
Gauge(SurfaceRunner parent, int grid, int plot)
Set up this view.
Gauge(SurfaceRunner parent, int options, int grid, int plot)
Set up this view.

Method Summary
protected void cacheBackground()
Fetch and cache an image of the background now, then use
that to draw the background on future draw requests.
void draw(Canvas canvas, long now, boolean bg)
This method is called to ask the element to draw its
dynamic content.
void drawBackground(Canvas canvas)
This method is called to ask the element to draw its static
content; i.e.
protected void drawBackgroundBody(Canvas canvas, Paint paint)
Do the subclass-specific parts of drawing the background for
this element.
protected void drawBody(Canvas canvas, Paint paint, long now)
Do the subclass-specific parts of drawing for this element.
protected void drawFinish(Canvas canvas, Paint paint, long now)

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/instruments/Gauge.html[2/19/2011 9:16:36 AM]


Gauge

Wrap up drawing of this element.


protected void drawStart(Canvas canvas, Paint paint, long now)
Do initial parts of drawing for this element.
void error(int error)
An error has occurred.
int getBackgroundColor()
Get the background colour of this element.
static float getBaseTextSize()
Get the base size for text.
Rect getBounds()
Get the bounding rect of this Element.
int getGridColor()
Get the data scale / grid colour of this element.
static float getHeadTextSize()
Get the size for header text.
int getHeight()
Get the height of this element -- i.e.
static int getInnerGap()
Get the amount of padding within atoms within an element.
static int getInterPadding()
Get the amount of padding between major elements in a
view.
static float getMiniTextSize()
Get the size for mini text.
protected getPaint()
Paint
Get this element's Paint.
int getPlotColor()
Get the data plot colour of this element.
int getPreferredHeight()
Get the minimum preferred height for this atom.
int getPreferredWidth()
Get the minimum preferred width for this atom.
static int getSidebarWidth()
Get the sidebar width.
protected
SurfaceRunner getSurface()
Get the app context of this Element.
static float getTextScaleX()
Get the base size for text based on this screen's size.
static Typeface getTextTypeface()
Get the default font for all text.
static float getTinyTextSize()
Get the size for tiny text based on this screen's size.
int getWidth()
Get the width of this element -- i.e.
boolean haveBounds()
Determine whether we have the bounding rect of this

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/instruments/Gauge.html[2/19/2011 9:16:36 AM]


Gauge

Element.
protected void initializePaint(Paint paint)
Set up the paint for this element.
boolean optionSet(int option)
Check whether the given option flag is set on this surface.
void setBackgroundColor(int col)
Set the background colour of this element.
static void setBaseTextSize(float size)
Set the base size for text.
void setDataColors(int grid, int plot)
Set the plot colours of this element.
void setGeometry(Rect bounds)
This is called during layout when the size of this element
has changed.
void setGridColor(int grid)
Set the data scale / grid colour of this element.
static void setHeadTextSize(float size)
Set the size for header text.
static void setInnerGap(int gap)
Set the amount of padding within atoms within an element.
static void setInterPadding(int pad)
Set the amount of padding between major elements in a
view.
static void setMiniTextSize(float size)
Set the size for mini text.
void setPlotColor(int plot)
Set the data plot colour of this element.
static void setSidebarWidth(int width)
Set the sidebar width.
static void setTextScaleX(float scale)
Set the horizontal scaling of the font; this can be used to
produce a tall, thin font.
static void setTextTypeface(Typeface face)
Set the default font for all text.
static void setTinyTextSize(float size)
Set the size for tiny text.

Methods inherited from class java.lang.Object


clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString,
wait, wait, wait

Constructor Detail
Gauge
public Gauge(SurfaceRunner parent)

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/instruments/Gauge.html[2/19/2011 9:16:36 AM]


Gauge

Set up this view.

Parameters:
parent - Parent surface.

Gauge
public Gauge(SurfaceRunner parent,
int options)

All Classes Set up this view.


AppUtils
AppUtils.Detail Parameters:
AudioAnalyser parent - Parent surface.
AudioReader options - Options for this SurfaceRunner. A bitwise OR of GAUGE_XXX
AudioReader.Listener constants.
CachedFile
CachedFile.Entry
DatabaseHelper Gauge
DbSchema
Effect public Gauge(SurfaceRunner parent,
ErrorDialog int grid,
int plot)
Errors
FileFetcher
Set up this view.
Gauge
HelpActivity
Parameters:
HScrollView parent - Parent surface.
InfoBox grid - Colour for drawing a data scale / grid.
Instrument plot - Colour for drawing data plots.
InstrumentSurface
LinedEditText
MainActivity
MainActivity.ActivityList Gauge
MultistateImageButton
OneTimeDialog public Gauge(SurfaceRunner parent,
int options,
Player int grid,
PowerGauge int plot)
SpectrumGauge
SplashActivity Set up this view.
SurfaceRunner
TableFetcher Parameters:
TableProvider parent - Parent surface.
TableSchema options - Options for this SurfaceRunner. A bitwise OR of GAUGE_XXX
TextGauge constants.
TextInputDialog grid - Colour for drawing a data scale / grid.
TextInputDialog.OnOkL plot - Colour for drawing data plots.
TimeZoneActivity
WaveformGauge
WebBasedData
Method Detail
WebFetcher
WebFetcher.FetchExce initializePaint
WebFetcher.Listener
YesNoDialog protected void initializePaint(Paint paint)
YesNoDialog.OnOkListe
Set up the paint for this element. This is called during initialization. Subclasses

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/instruments/Gauge.html[2/19/2011 9:16:36 AM]


Gauge

can override this to do class-specific one-time initialization.

Parameters:
paint - The paint to initialize.

optionSet
public boolean optionSet(int option)

Check whether the given option flag is set on this surface.

Parameters:
option - The option flag to test; one of GAUGE_XXX.
Returns:
true iff the option is set.

setTextTypeface
public static void setTextTypeface(Typeface face)

Set the default font for all text.

Parameters:
face - The default font for all text.

getTextTypeface
public static Typeface getTextTypeface()

Get the default font for all text.

Returns:
The default font for all text.

setBaseTextSize
public static void setBaseTextSize(float size)

Set the base size for text.

Parameters:
size - Base text size for the app.

getBaseTextSize
public static float getBaseTextSize()

Get the base size for text.

Returns:
Base text size for the app.

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/instruments/Gauge.html[2/19/2011 9:16:36 AM]


Gauge

setHeadTextSize
public static void setHeadTextSize(float size)

Set the size for header text.

Parameters:
size - Header text size for the app.

getHeadTextSize
public static float getHeadTextSize()

Get the size for header text.

Returns:
Header text size for the app.

setMiniTextSize
public static void setMiniTextSize(float size)

Set the size for mini text.

Parameters:
size - Mini text size for the app.

getMiniTextSize
public static float getMiniTextSize()

Get the size for mini text.

Returns:
Mini text size for the app.

setTinyTextSize
public static void setTinyTextSize(float size)

Set the size for tiny text.

Parameters:
size - Tiny text size for the app.

getTinyTextSize
public static float getTinyTextSize()

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/instruments/Gauge.html[2/19/2011 9:16:36 AM]


Gauge

Get the size for tiny text based on this screen's size.

Returns:
Tiny text size for the app.

setTextScaleX
public static void setTextScaleX(float scale)

Set the horizontal scaling of the font; this can be used to produce a tall, thin
font.

Parameters:
scale - Horizontal scaling of the font.

getTextScaleX
public static float getTextScaleX()

Get the base size for text based on this screen's size.

Returns:
Horizontal scaling of the font.

setSidebarWidth
public static void setSidebarWidth(int width)

Set the sidebar width.

Parameters:
width - The sidebar width.

getSidebarWidth
public static int getSidebarWidth()

Get the sidebar width.

Returns:
The sidebar width.

setInterPadding
public static void setInterPadding(int pad)

Set the amount of padding between major elements in a view.

Parameters:
pad - The amount of padding between major elements in a view.

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/instruments/Gauge.html[2/19/2011 9:16:36 AM]


Gauge

getInterPadding
public static int getInterPadding()

Get the amount of padding between major elements in a view.

Returns:
The amount of padding between major elements in a view.

setInnerGap
public static void setInnerGap(int gap)

Set the amount of padding within atoms within an element. Specifically the
small gaps in side bars.

Parameters:
gap - The amount of padding within atoms within an element

getInnerGap
public static int getInnerGap()

Get the amount of padding within atoms within an element. Specifically the
small gaps in side bars.

Returns:
The amount of padding within atoms within an element

setGeometry
public void setGeometry(Rect bounds)

This is called during layout when the size of this element has changed. This is
where we first discover our size, so set our geometry to match.

Parameters:
bounds - The bounding rect of this element within its parent View.

cacheBackground
protected void cacheBackground()

Fetch and cache an image of the background now, then use that to draw the
background on future draw requests. The cached image is invalidated the next
time the geometry changes.

Implementations should call this method once their layout is set -- for example
at the end of setGeometry(Rect) -- if they have a significant static background
that they wish to have cached.

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/instruments/Gauge.html[2/19/2011 9:16:36 AM]


Gauge

getPreferredWidth
public int getPreferredWidth()

Get the minimum preferred width for this atom.

Returns:
The minimum preferred width for this atom. Returns zero if we don't
know yet.

getPreferredHeight
public int getPreferredHeight()

Get the minimum preferred height for this atom.

Returns:
The minimum preferred height for this atom. Returns zero if we don't
know yet.

haveBounds
public final boolean haveBounds()

Determine whether we have the bounding rect of this Element.

Returns:
True if our geometry has been set up.

getBounds
public final Rect getBounds()

Get the bounding rect of this Element.

Returns:
The bounding rect of this element within its parent View. This will be 0, 0,
0, 0 if setGeometry() has not been called yet.

getWidth
public final int getWidth()

Get the width of this element -- i.e. the current configured width.

Returns:
The width of this element within its parent View. This will be 0 if
setGeometry() has not been called yet.

getHeight

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/instruments/Gauge.html[2/19/2011 9:16:36 AM]


Gauge

public final int getHeight()

Get the height of this element -- i.e. the current configured height.

Returns:
The height of this element within its parent View. This will be 0 if
setGeometry() has not been called yet.

setBackgroundColor
public void setBackgroundColor(int col)

Set the background colour of this element.

Parameters:
col - The new background colour, in ARGB format.

getBackgroundColor
public int getBackgroundColor()

Get the background colour of this element.

Returns:
The background colour, in ARGB format.

setDataColors
public void setDataColors(int grid,
int plot)

Set the plot colours of this element.

Parameters:
grid - Colour for drawing a data scale / grid.
plot - Colour for drawing data plots.

setGridColor
public void setGridColor(int grid)

Set the data scale / grid colour of this element.

Parameters:
grid - Colour for drawing a data scale / grid.

setPlotColor
public void setPlotColor(int plot)

Set the data plot colour of this element.

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/instruments/Gauge.html[2/19/2011 9:16:36 AM]


Gauge

Parameters:
plot - Colour for drawing a data plot.

getGridColor
public int getGridColor()

Get the data scale / grid colour of this element.

Returns:
Colour for drawing a data scale / grid.

getPlotColor
public int getPlotColor()

Get the data plot colour of this element.

Returns:
Colour for drawing data plots.

error
public void error(int error)

An error has occurred. Notify the user somehow.

Subclasses can override this to do something neat.

Parameters:
error - ERR_XXX code describing the error.</