android code google code

A-Index

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

Overview Package Class Use Tree Deprecated Index Help PREV LETTER NEXT LETTER FRAMES NO FRAMES All Classes

A B C D E F G H I K L M N O P Q R S T U V W Y

A

addEffect(int) - Method in class org.hermit.android.sound.PlayerAdd a sound effect to this player.

addEffect(int, float) - Method in class org.hermit.android.sound.PlayerAdd a sound effect to this player.

addGauge(Gauge) - Method in class org.hermit.android.instruments.InstrumentSurfaceAdd a gauge to this surface.

addHelpFromArrays(int, int) - Method in class org.hermit.android.core.HelpActivityAdd help to this help activity.

addInstrument(Instrument) - Method in class org.hermit.android.instruments.InstrumentSurfaceAdd 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 classorg.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

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 whenready.

AudioReader() - Constructor for class org.hermit.android.io.AudioReaderCreate an AudioReader instance.

AudioReader.Listener - Class in org.hermit.android.ioListener for audio reads.

AudioReader.Listener() - Constructor for class org.hermit.android.io.AudioReader.Listener



Overview

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

Overview Package Class Use Tree Deprecated Index Help PREV NEXT FRAMES NO FRAMES All Classes

HermitAndroidHermitAndroid is a collection of useful classes for Android applications, in a library which can be linkedinto Android projects.

See: Description

Packagesorg.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

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

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

org.hermit.android.widgets

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

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

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


http://code.google.com/p/moonblink/wiki/HermitAndroid

Class Hierarchy

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


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.ObjectActivity

org.hermit.android.core.MainActivityActivity

org.hermit.android.core.SplashActivityActivity

org.hermit.android.core.HelpActivityAlertDialog

org.hermit.android.notice.YesNoDialogAlertDialog

org.hermit.android.notice.ErrorDialogAlertDialog

org.hermit.android.notice.TextInputDialogorg.hermit.android.core.AppUtilsorg.hermit.android.core.AppUtils.Versionorg.hermit.android.io.AudioReaderorg.hermit.android.io.AudioReader.Listenerorg.hermit.android.net.CachedFile.EntryContentProvider

org.hermit.android.provider.TableProviderorg.hermit.android.provider.DbSchemaDialog

org.hermit.android.notice.InfoBoxEditText

org.hermit.android.widgets.LinedEditTextorg.hermit.android.sound.Effectorg.hermit.android.core.ErrorsFrameLayout

org.hermit.android.widgets.HScrollVieworg.hermit.android.instruments.Gauge

org.hermit.android.instruments.PowerGaugeorg.hermit.android.instruments.SpectrumGaugeorg.hermit.android.instruments.TextGaugeorg.hermit.android.instruments.WaveformGauge

ImageButtonorg.hermit.android.widgets.MultistateImageButton

org.hermit.android.instruments.Instrumentorg.hermit.android.instruments.AudioAnalyser

ListActivityorg.hermit.android.widgets.TimeZoneActivity

Class Hierarchy

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

org.hermit.android.core.MainActivity.ActivityListenerjava.util.Observable

org.hermit.android.net.CachedFile (implementsorg.hermit.android.net.WebFetcher.Listener)org.hermit.android.net.WebBasedData (implementsorg.hermit.android.net.WebFetcher.Listener)

org.hermit.android.core.OneTimeDialogorg.hermit.android.sound.PlayerSQLiteOpenHelper

org.hermit.android.provider.DatabaseHelperSurfaceView

org.hermit.android.core.SurfaceRunnerorg.hermit.android.instruments.InstrumentSurface

org.hermit.android.provider.TableSchemajava.lang.Thread (implements java.lang.Runnable)

org.hermit.android.net.WebFetcherorg.hermit.android.net.FileFetcherorg.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.OnOkListenerorg.hermit.android.net.WebFetcher.Listenerorg.hermit.android.notice.YesNoDialog.OnOkListener

Enum Hierarchy

java.lang.Objectjava.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable)

org.hermit.android.core.AppUtils.Detail


Deprecated List

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


Deprecated API

Contents

Deprecated Methods

Deprecated Methodsorg.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)


API Help

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


How This API Document Is OrganizedThis API (Application Programming Interface) document has pages corresponding to the items in thenavigation bar, described as follows.

Overview

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

Package

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

Interfaces (italic)ClassesEnumsExceptionsErrorsAnnotation Types

Class/Interface

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

Class inheritance diagramDirect SubclassesAll Known SubinterfacesAll Known Implementing ClassesClass/interface declarationClass/interface description

Nested Class SummaryField SummaryConstructor SummaryMethod Summary

Field DetailConstructor DetailMethod Detail

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

Annotation Type

API Help


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

Annotation Type declarationAnnotation Type descriptionRequired Element SummaryOptional Element SummaryElement Detail

Enum

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

Enum declarationEnum descriptionEnum Constant SummaryEnum Constant Detail

Use

Each documented package, class and interface has its own Use page. This page describes whatpackages, 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, methodsthat return A, and methods and constructors with parameters of type A. You can access thispage by first going to the package, class or interface, then clicking on the "Use" link in thenavigation bar.

Tree (Class Hierarchy)

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

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

Deprecated API

The Deprecated API page lists all of the API that have been deprecated. A deprecated API is notrecommended 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

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. Thisinformation is of interest to re-implementors, not to developers using the API. While there is no link in thenavigation bar, you can get to this information by going to any serialized class and clicking "SerializedForm" 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.


B-Index




B

BUTTON_1 - Static variable in class org.hermit.android.notice.InfoBoxSelect configurable button 1 -- the middle button.

BUTTON_2 - Static variable in class org.hermit.android.notice.InfoBoxSelect configurable button 2 -- the middle button.



Overview

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

All Classes

Packages org.hermit.android.core org.hermit.android.instrumorg.hermit.android.io org.hermit.android.net org.hermit.android.notice org.hermit.android.provideorg.hermit.android.sound org.hermit.android.widgets

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.ActivityListenMultistateImageButton OneTimeDialog Player PowerGauge SpectrumGauge SplashActivity SurfaceRunner TableFetcher TableProvider TableSchema TextGauge TextInputDialog TextInputDialog.OnOkListTimeZoneActivity WaveformGauge WebBasedData WebFetcher WebFetcher.FetchExceptiWebFetcher.Listener

Overview Package Class Use Tree Deprecated Index Help PREV NEXT FRAMES NO FRAMES

HermitAndroidHermitAndroid is a collection of useful classes for Android applications, in a library whichcan be linked into Android projects.

See: Description

Packagesorg.hermit.android.core A library of foundation classes for Android

applications.





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

org.hermit.android.sound These classes provide functions to help apps managetheir sound effects.


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

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




Overview


YesNoDialog

All Classes

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

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

C-Index




C

cacheBackground() - Method in class org.hermit.android.instruments.GaugeFetch and cache an image of the background now, then use that to draw the background on futuredraw requests.

CachedFile - Class in org.hermit.android.netThis class manages a set of web-based files and caches them locally.

CachedFile(String, URL[]) - Constructor for class org.hermit.android.net.CachedFileCreate a cache of web-based files.

CachedFile.Entry - Class in org.hermit.android.netClass describing an entry in the cache; i.e.

computeHorizontalScrollRange() - Method in class org.hermit.android.widgets.HScrollViewThe 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 classorg.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.MainActivityCreate a dialog for showing the EULA, or other warnings / disclaimers.

createMessageBox(int) - Method in class org.hermit.android.core.MainActivityDeprecated. The message box is now created automatically.

createTable(SQLiteDatabase) - Method in class org.hermit.android.net.CachedFileCreate our table in the database.

createTable(SQLiteDatabase) - Method in class org.hermit.android.net.WebBasedDataCreate our table in the database.



D-Index




D

DatabaseHelper - Class in org.hermit.android.providerThis class helps open, create, and upgrade the database file.

DatabaseHelper(Context, DbSchema) - Constructor for classorg.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 classorg.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.

D-Index


drawBody(Canvas, Paint, long) - Method in class org.hermit.android.instruments.WaveformGaugeDo the subclass-specific parts of drawing for this element.

drawFinish(Canvas, Paint, long) - Method in class org.hermit.android.instruments.GaugeWrap up drawing of this element.

drawStart(Canvas, Paint, long) - Method in class org.hermit.android.instruments.GaugeDo initial parts of drawing for this element.



E-Index




E

Effect - Class in org.hermit.android.soundClass representing a specific sound effect.

ERR_INIT_FAILED - Static variable in class org.hermit.android.io.AudioReader.ListenerAudio read error code: the audio reader failed to initialise.

ERR_OK - Static variable in class org.hermit.android.io.AudioReader.ListenerAudio read error code: no error.

ERR_READ_FAILED - Static variable in class org.hermit.android.io.AudioReader.ListenerAudio read error code: an audio read failed.

error(int) - Method in class org.hermit.android.instruments.GaugeAn error has occurred.

ErrorDialog - Class in org.hermit.android.noticeThis class implements a popup error box (a subclass of AlertDialog) which can be used to display anerror message.

ErrorDialog(Context, int) - Constructor for class org.hermit.android.notice.ErrorDialogCreate an error dialog.

ErrorDialog(Context, CharSequence) - Constructor for class org.hermit.android.notice.ErrorDialogCreate an error dialog.

Errors - Class in org.hermit.android.coreError handling and reporting utilities.

executeKeyEvent(KeyEvent) - Method in class org.hermit.android.widgets.HScrollViewYou can call this function yourself to have the scroll view perform scrolling from a key event, just as ifthe event had been dispatched to it by the view hierarchy.

EXTRAS_IMAGE_ID - Static variable in class org.hermit.android.core.SplashActivityExtras key for the image resource ID.

EXTRAS_TIME_ID - Static variable in class org.hermit.android.core.SplashActivityExtras key for the splash screen display time.



F-Index




F

fetch(URL, long) - Method in class org.hermit.android.net.WebFetcherFetch an object from the given URL.

FileFetcher - Class in org.hermit.android.netConcrete instance of WebFetcher which gets a file and stores it locally.

FileFetcher(Context, URL, String, WebFetcher.Listener, long) - Constructor for classorg.hermit.android.net.FileFetcher

Fetch a file from the web.FileFetcher(Context, URL, String, WebFetcher.Listener, long, long) - Constructor for classorg.hermit.android.net.FileFetcher

Fetch a file from the web.fling(int) - Method in class org.hermit.android.widgets.HScrollView

Fling the scroll view



G-Index




G

Gauge - Class in org.hermit.android.instrumentsA graphical display which shows some data in a region within a view.

Gauge(SurfaceRunner) - Constructor for class org.hermit.android.instruments.GaugeSet up this view.

Gauge(SurfaceRunner, int) - Constructor for class org.hermit.android.instruments.GaugeSet up this view.

Gauge(SurfaceRunner, int, int) - Constructor for class org.hermit.android.instruments.GaugeSet up this view.

Gauge(SurfaceRunner, int, int, int) - Constructor for class org.hermit.android.instruments.GaugeSet up this view.

getAppVersion() - Method in class org.hermit.android.core.AppUtilsGet the version info for the current app.

getBackgroundColor() - Method in class org.hermit.android.instruments.GaugeGet the background colour of this element.

getBaseTextSize() - Static method in class org.hermit.android.instruments.GaugeGet the base size for text.

getBitmap() - Method in class org.hermit.android.core.SurfaceRunnerGet a Bitmap which is the same size and format as the surface.

getBitmap(int, int) - Method in class org.hermit.android.core.SurfaceRunnerGet a Bitmap of a given size, in the same format as the surface.

getBounds() - Method in class org.hermit.android.instruments.GaugeGet the bounding rect of this Element.

getBuffer() - Method in class org.hermit.android.instruments.TextGaugeGet the text buffers for the field values.

getContentUri() - Method in class org.hermit.android.provider.TableSchemaGet the table's content URI.

getDbName() - Method in class org.hermit.android.provider.DbSchemaGet the database name.

getDbVersion() - Method in class org.hermit.android.provider.DbSchemaGet the database version number.

getFile(URL) - Method in class org.hermit.android.net.CachedFileQuery for a given file in the cache.

getGridColor() - Method in class org.hermit.android.instruments.GaugeGet the data scale / grid colour of this element.

getHeadTextSize() - Static method in class org.hermit.android.instruments.GaugeGet the size for header text.

getHeight() - Method in class org.hermit.android.instruments.GaugeGet the height of this element -- i.e.

getHelper() - Method in class org.hermit.android.provider.TableProviderGet the database helper which this content provider will use.

getInnerGap() - Static method in class org.hermit.android.instruments.GaugeGet the amount of padding within atoms within an element.

getInstance(Activity) - Static method in class org.hermit.android.core.AppUtilsGet the app utils instance for this Activity.

getInstance(Context) - Static method in class org.hermit.android.core.ErrorsGet the single instance of this class for the given Activity, creating it if necessary.

getInterPadding() - Static method in class org.hermit.android.instruments.GaugeGet the amount of padding between major elements in a view.

G-Index


getItemType() - Method in class org.hermit.android.provider.TableSchemaGet the MIME type for the items in the table.

getLabelSize() - Method in class org.hermit.android.instruments.PowerGaugeGet the size for the label text.

getLabelSize() - Method in class org.hermit.android.instruments.SpectrumGaugeGet 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.GaugeGet the size for mini text.

getName() - Method in class org.hermit.android.net.WebBasedDataGet the name of this source.

getPaint() - Method in class org.hermit.android.instruments.GaugeGet this element's Paint.

getPlotColor() - Method in class org.hermit.android.instruments.GaugeGet the data plot colour of this element.

getPowerGauge(SurfaceRunner) - Method in class org.hermit.android.instruments.AudioAnalyserGet a signal power gauge for this audio analyser.

getPreferredHeight() - Method in class org.hermit.android.instruments.GaugeGet the minimum preferred height for this atom.

getPreferredHeight() - Method in class org.hermit.android.instruments.TextGaugeGet the minimum height needed to fit all the text.

getPreferredWidth() - Method in class org.hermit.android.instruments.GaugeGet the minimum preferred width for this atom.

getPreferredWidth() - Method in class org.hermit.android.instruments.TextGaugeGet the minimum width needed to fit all the text.

getRes(int) - Method in class org.hermit.android.core.SurfaceRunnerGet the String value of a resource.

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

getSchema() - Method in class org.hermit.android.provider.DatabaseHelperGet the database schema.

getSchema() - Method in class org.hermit.android.provider.TableProviderGet the database schema.

getSidebarWidth() - Static method in class org.hermit.android.instruments.GaugeGet the sidebar width.

getSpectrumGauge(SurfaceRunner) - Method in class org.hermit.android.instruments.AudioAnalyserGet a spectrum analyser gauge for this audio analyser.

getState() - Method in class org.hermit.android.widgets.MultistateImageButtonGet the current state of this button.

getSurface() - Method in class org.hermit.android.instruments.GaugeGet the app context of this Element.

getSurface() - Method in class org.hermit.android.instruments.InstrumentGet the app context of this Element.

getTable(String) - Method in class org.hermit.android.provider.DbSchemaGet the schema for a specified table.

getTableName() - Method in class org.hermit.android.provider.TableSchemaGet the table name.

getTableSchema(String) - Method in class org.hermit.android.provider.TableProviderGet the schema for a specified table.

getTableType() - Method in class org.hermit.android.provider.TableSchemaGet the MIME type for the table as a whole.

getTextColor() - Method in class org.hermit.android.instruments.TextGaugeGet the text colour of this element.

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

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.



H-Index




H

handle(URL, URLConnection, InputStream) - Method in class org.hermit.android.net.FileFetcherFetch a page of data from the given stream.

handle(URL, URLConnection, BufferedReader) - Method in class org.hermit.android.net.TableFetcherFetch a page of data from the given BufferedReader.

handle(URL, URLConnection, InputStream) - Method in class org.hermit.android.net.WebFetcherHandle data from the given stream.

handle(URL, URLConnection, BufferedReader) - Method in class org.hermit.android.net.WebFetcherHandle data from the given BufferedReader.

haveBounds() - Method in class org.hermit.android.instruments.GaugeDetermine whether we have the bounding rect of this Element.

HelpActivity - Class in org.hermit.android.coreAn 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.widgetsLayout container for a view hierarchy that can be scrolled by the user, allowing it to be larger thanthe physical display.

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

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



I-Index




I

InfoBox - Class in org.hermit.android.noticeThis 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.InfoBoxCreate an info box with a "close" button.

InfoBox(Activity, int) - Constructor for class org.hermit.android.notice.InfoBoxCreate an info box.

initializePaint(Paint) - Method in class org.hermit.android.instruments.GaugeSet up the paint for this element.

initializePaint(Paint) - Method in class org.hermit.android.instruments.TextGaugeSet up the paint for this element.

insert(Uri, ContentValues) - Method in class org.hermit.android.provider.TableProviderImplement this to insert a new row.

Instrument - Class in org.hermit.android.instrumentsAn instrument which measures some quantity, or accesses or produces some data, which can bedisplayed on one or more Gauge objects.

Instrument(SurfaceRunner) - Constructor for class org.hermit.android.instruments.InstrumentSet up this view.

InstrumentSurface - Class in org.hermit.android.instrumentsCommon base for applications which display instruments.

InstrumentSurface(Activity) - Constructor for class org.hermit.android.instruments.InstrumentSurfaceCreate a SurfaceRunner instance.

InstrumentSurface(Activity, int) - Constructor for classorg.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



K-Index




K

kill() - Method in class org.hermit.android.net.WebFetcherKill this fetcher.

killAll() - Static method in class org.hermit.android.net.WebFetcherStop all fetch operations.

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



L-Index




L

lastRecord() - Method in class org.hermit.android.net.WebBasedDataQuery for the newest record we have stored.

launch(Context, int, long) - Static method in class org.hermit.android.core.SplashActivityLaunch a splash screen displaying the given drawable.

layout(int, int) - Method in class org.hermit.android.instruments.InstrumentSurfaceLay out the display for a given screen size.

LinedEditText - Class in org.hermit.android.widgetsA custom EditText that draws lines between each line of text that is displayed.

LinedEditText(Context, AttributeSet) - Constructor for class org.hermit.android.widgets.LinedEditTextConstruct a widget from a given attribute set.

linkButtonPressed(int) - Method in class org.hermit.android.notice.InfoBoxCalled when a link button is clicked.

loop() - Method in class org.hermit.android.sound.EffectStart playing this sound effect in a continuous loop.

LOOPED_TICKER - Static variable in class org.hermit.android.core.SurfaceRunnerSurface runner option: use a Looper to drive animations.



M-Index




M

MainActivity - Class in org.hermit.android.coreAn 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.coreThis interface defines a listener for sub-activity results.

MainActivity.ActivityListener() - Constructor for classorg.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 classorg.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 classorg.hermit.android.widgets.MultistateImageButton

Create a multistate image button with a specified set of image resource IDs.MultistateImageButton(Context, AttributeSet, int[]) - Constructor for classorg.hermit.android.widgets.MultistateImageButton

Create a multistate image button with a specified set of image resource IDs.



N-Index




N

name - Variable in class org.hermit.android.net.CachedFile.EntryThe local name of the file.

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



O-Index




O

okButtonPressed() - Method in class org.hermit.android.notice.InfoBoxCalled when the OK button is clicked.

onActivityCanceled(Intent) - Method in class org.hermit.android.core.MainActivity.ActivityListenerCalled when an activity you launched exits with a result code of RESULT_CANCELED.

onActivityFinished(int, Intent) - Method in class org.hermit.android.core.MainActivity.ActivityListenerCalled when an activity you launched exits.

onActivityResult(int, Intent) - Method in class org.hermit.android.core.MainActivity.ActivityListenerCalled when an activity you launched exits with a result code other than RESULT_CANCELED, givingyou the resultCode it returned, and any additional data from it.

onActivityResult(int, int, Intent) - Method in class org.hermit.android.core.MainActivityCalled when an activity you launched exits, giving you the requestCode you started it with, theresultCode it returned, and any additional data from it.

onCreate(Bundle) - Method in class org.hermit.android.core.HelpActivityCalled when the activity is starting.

onCreate(Bundle) - Method in class org.hermit.android.core.MainActivityCalled when the activity is starting.

onCreate(Bundle) - Method in class org.hermit.android.core.SplashActivityCalled when the activity is starting.

onCreate(SQLiteDatabase) - Method in class org.hermit.android.provider.DatabaseHelperCalled when the database is created for the first time.

onCreate() - Method in class org.hermit.android.provider.TableProviderCalled when the provider is being started.

onCreate(Bundle) - Method in class org.hermit.android.widgets.TimeZoneActivityCalled when the activity is starting.

onDraw(Canvas) - Method in class org.hermit.android.widgets.LinedEditTextOverridden onDraw method.

OneTimeDialog - Class in org.hermit.android.coreA class which handles showing one-off notices.

OneTimeDialog(Activity, String, int, int, int) - Constructor for classorg.hermit.android.core.OneTimeDialog

Create a dialog for showing a notice, or other warnings / disclaimers, once only.onInsert(Uri, TableSchema, ContentValues) - Method in classorg.hermit.android.provider.TableProvider

This method is called prior to processing an insert; it is called afterTableSchema.onInsert(ContentValues).

onInsert(ContentValues) - Method in class org.hermit.android.provider.TableSchemaThis 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 classorg.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.

O-Index


onOk() - Method in interface org.hermit.android.notice.YesNoDialog.OnOkListenerThe OK button has been clicked.

onPause() - Method in class org.hermit.android.core.SurfaceRunnerPause the app.

onReadComplete(short[]) - Method in class org.hermit.android.io.AudioReader.ListenerAn audio read has completed.

onReadError(int) - Method in class org.hermit.android.io.AudioReader.ListenerAn error has occurred.

onRequestFocusInDescendants(int, Rect) - Method in class org.hermit.android.widgets.HScrollViewWhen looking for focus in children of a scroll view, need to be a little more careful not to give focusto something that is scrolled off screen.

onRestoreInstanceState(Bundle) - Method in class org.hermit.android.core.HelpActivityThis method is called after onStart() when the activity is being re-initialized from a previously savedstate, given here in state.

onResume() - Method in class org.hermit.android.core.SurfaceRunnerWe're resuming the app.

onSaveInstanceState(Bundle) - Method in class org.hermit.android.core.HelpActivityCalled to retrieve per-instance state from an activity before being killed so that the state can berestored in onCreate(Bundle) or onRestoreInstanceState(Bundle) (the Bundle populated by thismethod 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.SurfaceRunnerThe application is starting.

onStop() - Method in class org.hermit.android.core.SurfaceRunnerThe application is closing down.

onSurfaceThread() - Method in class org.hermit.android.core.SurfaceRunnerDetermine 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.DatabaseHelperCalled when the database needs to be upgraded.

onWebData(URL, Object, long) - Method in class org.hermit.android.net.CachedFileThis 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.WebBasedDataThis 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.ListenerThis 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.CachedFileThis method is invoked when the given URL has been fully fetched.

onWebDone() - Method in class org.hermit.android.net.WebBasedDataThis method is invoked when the given URL has been fully fetched.

onWebDone() - Method in interface org.hermit.android.net.WebFetcher.ListenerThis method is invoked when the URLs have been fully fetched.

onWebError(String) - Method in class org.hermit.android.net.CachedFileHandle an error while fetching web data.

onWebError(String) - Method in class org.hermit.android.net.WebBasedDataHandle an error while fetching web data.

onWebError(String) - Method in interface org.hermit.android.net.WebFetcher.ListenerThis method is invoked if an error occurs when fetching web data.

onWindowFocusChanged(boolean) - Method in class org.hermit.android.core.SurfaceRunnerHandle changes in focus.

optionSet(int) - Method in class org.hermit.android.core.SurfaceRunnerCheck whether the given option flag is set on this surface.

optionSet(int) - Method in class org.hermit.android.instruments.GaugeCheck whether the given option flag is set on this surface.

org.hermit.android.core - package org.hermit.android.core

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



P-Index




P

path - Variable in class org.hermit.android.net.CachedFile.EntryThe path of the local copy of the file.

play() - Method in class org.hermit.android.sound.EffectPlay this sound effect.

play(float) - Method in class org.hermit.android.sound.EffectPlay this sound effect.

play(Effect) - Method in class org.hermit.android.sound.PlayerPlay the given sound effect.

play(Effect, float, boolean) - Method in class org.hermit.android.sound.PlayerPlay the given sound effect.

Player - Class in org.hermit.android.soundMain sound effects player class.

Player(Context) - Constructor for class org.hermit.android.sound.PlayerCreate a sound effect player that can handle 3 streams at once.

Player(Context, int) - Constructor for class org.hermit.android.sound.PlayerCreate a sound effect player.

postUpdate() - Method in class org.hermit.android.core.SurfaceRunnerAsynchronously schedule an update; i.e.

PowerGauge - Class in org.hermit.android.instrumentsA graphical display which displays the signal power in dB from an AudioAnalyser instrument.

process(ContentValues) - Method in class org.hermit.android.net.WebBasedDataOptional processing step -- this is called for each record we read.



Q-Index




Q

query(Uri, String[], String, String[], String) - Method in classorg.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 classorg.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.



R-Index




R

reportException(Context, Exception) - Static method in class org.hermit.android.core.ErrorsReport an unexpected exception to the user by popping up a dialog with some debug info.

reportException(Exception) - Method in class org.hermit.android.core.ErrorsReport an unexpected exception to the user by popping up a dialog with some debug info.

reportException(Exception) - Method in class org.hermit.android.core.MainActivityReport 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 classorg.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.



S-Index




S

saveState(Bundle) - Method in class org.hermit.android.instruments.AudioAnalyserSave the state of the game in the provided Bundle.

saveState(Bundle) - Method in class org.hermit.android.instruments.InstrumentSave the state of the game in the provided Bundle.

scrollTo(int, int) - Method in class org.hermit.android.widgets.HScrollViewsetAboutInfo(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

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 classorg.hermit.android.widgets.MultistateImageButton

Register a callback to be invoked when this view is clicked.setOnOkListener(TextInputDialog.OnOkListener) - Method in classorg.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.

S-Index


setTinyTextSize(float) - Static method in class org.hermit.android.instruments.GaugeSet the size for tiny text.

setWindowFunc(Window.Function) - Method in class org.hermit.android.instruments.AudioAnalyserSet the spectrum analyser windowing function for this instrument.

show() - Method in class org.hermit.android.core.OneTimeDialogShow the dialog unconditionally.

show(String, String) - Method in class org.hermit.android.notice.ErrorDialogStart the dialog and display it on screen.

show(String) - Method in class org.hermit.android.notice.ErrorDialogStart the dialog and display it on screen.

show(int, int) - Method in class org.hermit.android.notice.InfoBoxStart the dialog and display it on screen.

show(int) - Method in class org.hermit.android.notice.InfoBoxStart the dialog and display it on screen.

show(String) - Method in class org.hermit.android.notice.InfoBoxStart the dialog and display it on screen.

show(int, int) - Method in class org.hermit.android.notice.TextInputDialogStart the dialog and display it on screen.

show(int, int, String) - Method in class org.hermit.android.notice.TextInputDialogStart the dialog and display it on screen.

show(String, String) - Method in class org.hermit.android.notice.TextInputDialogStart the dialog and display it on screen.

show(String, String, String) - Method in class org.hermit.android.notice.TextInputDialogStart the dialog and display it on screen.

show(int, int) - Method in class org.hermit.android.notice.YesNoDialogStart the dialog and display it on screen.

show(CharSequence, CharSequence) - Method in class org.hermit.android.notice.YesNoDialogStart the dialog and display it on screen.

showAbout() - Method in class org.hermit.android.core.MainActivityShow an about dialog.

showEula() - Method in class org.hermit.android.core.MainActivityShow the EULA dialog unconditionally.

showFirst() - Method in class org.hermit.android.core.OneTimeDialogShow the dialog if this is the first program run.

showFirstEula() - Method in class org.hermit.android.core.MainActivityShow the EULA dialog if this is the first program run.

smoothScrollBy(int, int) - Method in class org.hermit.android.widgets.HScrollViewLike View#scrollBy, but scroll smoothly instead of immediately.

smoothScrollTo(int, int) - Method in class org.hermit.android.widgets.HScrollViewLike HScrollView.scrollTo(int, int), but scroll smoothly instead of immediately.

SpectrumGauge - Class in org.hermit.android.instrumentsA graphical display which displays the audio spectrum from an AudioAnalyser instrument.

SplashActivity - Class in org.hermit.android.coreAn 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 classorg.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.

S-Index


stop() - Method in class org.hermit.android.sound.EffectStop this sound effect immediately.

stop(int) - Method in class org.hermit.android.sound.PlayerStop the given stream.

stopReader() - Method in class org.hermit.android.io.AudioReaderStart this reader.

SURFACE_CACHE_BG - Static variable in class org.hermit.android.instruments.InstrumentSurfaceInstrument Surface runner option: cache a background bitmap.

SURFACE_DYNAMIC - Static variable in class org.hermit.android.core.SurfaceRunnerSurface runner option: handle configuration changes dynamically.

surfaceChanged(SurfaceHolder, int, int, int) - Method in class org.hermit.android.core.SurfaceRunnerThis is called immediately after any structural changes (format or size) have been made to thesurface.

surfaceCreated(SurfaceHolder) - Method in class org.hermit.android.core.SurfaceRunnerThis is called immediately after the surface is first created.

surfaceDestroyed(SurfaceHolder) - Method in class org.hermit.android.core.SurfaceRunnerThis is called immediately before a surface is destroyed.

SurfaceRunner - Class in org.hermit.android.coreCommon base for applications with an animated view.

SurfaceRunner(Context) - Constructor for class org.hermit.android.core.SurfaceRunnerCreate a SurfaceRunner instance.

SurfaceRunner(Context, int) - Constructor for class org.hermit.android.core.SurfaceRunnerCreate a SurfaceRunner instance.

SurfaceRunner(Context, AttributeSet) - Constructor for class org.hermit.android.core.SurfaceRunnerCreate a SurfaceRunner instance.

surfaceStart() - Method in class org.hermit.android.core.SurfaceRunnerStart the surface running.

surfaceStop() - Method in class org.hermit.android.core.SurfaceRunnerStop the surface running.



T-Index




T

TableFetcher - Class in org.hermit.android.netConcrete instance of WebFetcher which fetches tabular data from the web.

TableProvider - Class in org.hermit.android.providerThis class is a base for content providers which provide access to table-organized data in an SQLdatabase.

TableProvider(DbSchema) - Constructor for class org.hermit.android.provider.TableProviderCreate an instance of this content provider.

TableSchema - Class in org.hermit.android.providerClass encapsulating the schema for a table within a content provider.

TableSchema(String, String, Uri, String, String[][]) - Constructor for classorg.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 classorg.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 aprompt and read a text string from the user.

TextInputDialog(Context, int, int) - Constructor for class org.hermit.android.notice.TextInputDialogCreate an error dialog.

TextInputDialog(Context, CharSequence, CharSequence) - Constructor for classorg.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



U-Index




U

update(Context, long) - Method in class org.hermit.android.net.CachedFileCheck to see whether we need to update our cached copies of the files.

update(long) - Method in class org.hermit.android.net.WebBasedDataCheck to see whether we need to update our stored data.

update(Uri, ContentValues, String, String[]) - Method in classorg.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.



V-Index




V

valueOf(String) - Static method in enum org.hermit.android.core.AppUtils.DetailReturns the enum constant of this type with the specified name.

values() - Static method in enum org.hermit.android.core.AppUtils.DetailReturns an array containing the constants of this enum type, in the order they are declared.

versionCode - Variable in class org.hermit.android.core.AppUtils.VersionVersion code of the app.

versionName - Variable in class org.hermit.android.core.AppUtils.VersionVersion name of the app.



W-Index




W

WaveformGauge - Class in org.hermit.android.instrumentsA graphical display which displays the audio waveform from an AudioAnalyser instrument.

WebBasedData - Class in org.hermit.android.netThis class implements a web-based source of data, which is cached in a local database.

WebBasedData(String, String, String, long, boolean, String[]) - Constructor for classorg.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 classorg.hermit.android.net.WebFetcher

Create a fetcher to get data from a given URL.WebFetcher(URL, WebFetcher.Listener, long, long) - Constructor for classorg.hermit.android.net.WebFetcher

Create a fetcher to get data from a given URL.WebFetcher(URL[], WebFetcher.Listener, long, long) - Constructor for classorg.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 exceptionorg.hermit.android.net.WebFetcher.FetchException

Create a FetchException with a message.WebFetcher.FetchException(String, Exception) - Constructor for exceptionorg.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.



Y-Index




Y

YesNoDialog - Class in org.hermit.android.noticeThis class implements a popup dialog box (a subclass of AlertDialog) which can be used to display ayes / no question.

YesNoDialog(Context, int, int) - Constructor for class org.hermit.android.notice.YesNoDialogCreate an error dialog.

YesNoDialog(Context, CharSequence, CharSequence) - Constructor for classorg.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.



Player

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

Overview Package Class Use Tree Deprecated Index Help PREV CLASS NEXT CLASS FRAMES NO FRAMES All ClassesSUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

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

public class Playerextends java.lang.Object

Main sound effects player class.

Constructor SummaryPlayer(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.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Player

public Player(Context context)

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)


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.

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 soundsare disabled, or if the volume is zero.

stop

public void stop(int id)

Stop the given stream.

Parameters:id - Stream ID to stop.


InstrumentSurface

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


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

public abstract class InstrumentSurfaceextends SurfaceRunner

Common base for applications which display instruments. This class is an extension of SurfaceRunner whichprovides 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 correspondingActivity methods):

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

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

Field Summarystatic int SURFACE_CACHE_BG

Instrument Surface runner option: cache a background bitmap. Fields inherited from class org.hermit.android.core.SurfaceRunnerLOOPED_TICKER, SURFACE_DYNAMIC

Constructor SummaryInstrumentSurface(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)

InstrumentSurface


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

void animStart() We are starting the animation loop.

protected void animStop()

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

void appSize(int width, int height, Bitmap.Config config) Set the screen size.

protected void appStart()

The application is starting.protected

void appStop() The application is closing down.

protected void doDraw(Canvas canvas, long now)

Draw the current frame of the application.protected

void doUpdate(long now) Update the state of the application for the current frame.

protectedabstract

voidlayout(int width, int height) Lay out the display for a given screen size.

Methods inherited from class org.hermit.android.core.SurfaceRunnergetBitmap, 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.Objectclone, 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 todraw their backgrounds into a full- screen bitmap; this bitmap will then be drawn prior to drawing thegauge contents each frame.

See Also:Constant Field Values

Constructor Detail

InstrumentSurface

public InstrumentSurface(Activity app)

Create a SurfaceRunner instance.

Parameters:

InstrumentSurface


app - The application context we're running in.

InstrumentSurface

public InstrumentSurface(Activity app, int options)


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 createone or more Gauges 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 willhave their measurement turned on when the app is visible and running. TheirInstrument.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 thesurface with addInstrument(Instrument).

All gauges added here will have their Gauge.draw(Canvas, long, boolean) method called each timeround 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 layout the gauges.

InstrumentSurface


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

appStart


The application is starting. Perform any initial set-up prior to starting the application. We may nothave 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 beforeappStart().

We call the layout() method here, so subclasses generally don't need to override this. If subclasses dooverride 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.


Specified by:animStart in class SurfaceRunner

animStop


InstrumentSurface


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

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


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 maybe a no-op in some cases.

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

Specified by:doUpdate in class SurfaceRunner

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

doDraw


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 bere-drawn.

Specified by:doDraw in class SurfaceRunner

Parameters:canvas - The Canvas to draw into.

InstrumentSurface


now - Nominal time of the current frame in ms.


HelpActivity

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


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

public class HelpActivityextends 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 canbe added.

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

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

Constructor SummaryHelpActivity()

Method Summaryprotected

void addHelpFromArrays(int titlesId, int textsId) Add help to this help activity.

void onCreate(Bundle icicle) Called when the activity is starting.

protected void onRestoreInstanceState(Bundle inState)

This method is called after onStart() when the activity is being re-initialized from apreviously 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 statecan be restored in onCreate(Bundle) or onRestoreInstanceState(Bundle) (the Bundle populatedby this method will be passed to both).


Constructor Detail

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: callingsetContentView(int) to inflate the activity's UI, etc.

Parameters:icicle - Saved application state, if any.

onRestoreInstanceState


This method is called after onStart() when the activity is being re-initialized from a previously savedstate, given here in state. Most implementations will simply use onCreate(Bundle) to restore theirstate, but it is sometimes convenient to do it here after all of the initialization has been done or toallow subclasses to decide whether to use your default implementation. The default implementation ofthis method performs a restore of any view state that had previously been frozen byonSaveInstanceState(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 berestored in onCreate(Bundle) or onRestoreInstanceState(Bundle) (the Bundle populated by thismethod will be passed to both). If called, this method will occur before onStop(). There are noguarantees 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.

HelpActivity


A title and the corresponding content may both be resource IDs of further arrays. These arrays will beadded 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 reallyrecommended.)

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


HScrollView

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


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

public class HScrollViewextends FrameLayout

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

An HScrollView is a android.widget.FrameLayout, meaning you should place one child in it containing theentire contents to scroll; this child may itself be a layout manager with a complex hierarchy of objects. Achild that is often used is a android.widget.LinearLayout in a vertical orientation, presenting a verticalarray of top-level items that the user can scroll through.

HScrollView only supports horizontally scrolling.

Constructor SummaryHScrollView(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

int computeHorizontalScrollRange() The scroll range of a scroll view is the overall height of all of its children.

void computeScroll()

protected

HScrollView


int computeScrollDeltaToGetChildRectOnScreen(Rect rect) Compute the amount to scroll in the Y direction in order to get a rectangle completely onthe 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 keyevent, just as if the event had been dispatched to it by the view hierarchy.

void fling(int velocityX) Fling the scroll view

protected float getLeftFadingEdgeStrength()

int getMaxScrollAmount()

protected

float getRightFadingEdgeStrength()

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

boolean isSmoothScrollingEnabled()

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

protected

voidmeasureChildWithMargins(View child, int parentWidthMeasureSpec, int widthUsed,int parentHeightMeasureSpec, int heightUsed)

boolean onInterceptTouchEvent(MotionEvent ev)

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

protected

void onMeasure(int widthMeasureSpec, int heightMeasureSpec)

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 togive focus to something that is scrolled off screen.

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

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)

HScrollView


Indicates this ScrollView whether it should stretch its content height to fill the viewportor 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.


Constructor Detail

HScrollView

public HScrollView(Context context)

HScrollView

public HScrollView(Context context, AttributeSet attrs)

Method Detail

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)

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, falseotherwise.

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

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 ifthe 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

HScrollView


- the number of pixels to scroll by on the X axisdy - 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 axisy - 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


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.

HScrollView


requestChildFocus

public void requestChildFocus(View child, View focused)

onRequestFocusInDescendants


When looking for focus in children of a scroll view, need to be a little more careful not to give focusto something that is scrolled off screen. This is more expensive than the defaultandroid.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


onSizeChanged


fling

public void fling(int velocityX)


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

scrollTo

HScrollView


public void scrollTo(int x, int y)

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


WebBasedData

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


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

All Implemented Interfaces:WebFetcher.Listener

public class WebBasedDataextends java.util.Observableimplements WebFetcher.Listener

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

Constructor SummaryWebBasedData(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 wereinvoked 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.

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.ObservableaddObserver, clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged,notifyObservers, notifyObservers, setChanged


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 theformat "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)

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 whendone.

Returns:A Cursor over all the records, sorted in ascending date order. The Cursor is positioned before thefirst 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 tocall 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 thefirst record.

lastRecord

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 observerswill 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 synthesizedvalues.

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

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.


SurfaceRunner

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


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

Direct Known Subclasses:InstrumentSurface

public abstract class SurfaceRunnerextends SurfaceView

Common base for applications with an animated view. This class can be used in games etc. It handles allthe 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 correspondingActivity methods):

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

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

Field Summarystatic int LOOPED_TICKER

Surface runner option: use a Looper to drive animations.static int SURFACE_DYNAMIC

Surface runner option: handle configuration changes dynamically.

Constructor SummarySurfaceRunner(Context app) Create a SurfaceRunner instance.

SurfaceRunner(Context app, AttributeSet attrs) Create a SurfaceRunner instance.

SurfaceRunner(Context app, int options) Create a SurfaceRunner instance.


abstract void animStart()

SurfaceRunner


We are starting the animation loop.protected

abstract void animStop() We are stopping the animation loop, for example to pause the app.

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

Set the screen size.protected

abstract void appStart() The application is starting.

protectedabstract void appStop()

The application is closing down.protected

abstract void doDraw(Canvas canvas, long now) Draw the current frame of the application.

protectedabstract 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)

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) havebeen 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.


Field Detail

SURFACE_DYNAMIC

public static final int SURFACE_DYNAMIC

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


LOOPED_TICKER

public static final int LOOPED_TICKER

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


Constructor Detail

SurfaceRunner

public SurfaceRunner(Context app)


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

SurfaceRunner


SurfaceRunner

public SurfaceRunner(Context app, int options)


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)


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 notsleep, but will run continuously.

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

surfaceCreated

SurfaceRunner


public void surfaceCreated(SurfaceHolder holder)

This is called immediately after the surface is first created. Implementations of this should start upwhatever rendering code they desire. Note that only one thread can ever draw into a Surface, so youshould 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 thesurface. 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 nolonger 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()

SurfaceRunner


Start the surface running. Applications must call this to set the surface going. They may use this toimplement 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 toimplement 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'tcause 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 theSurfaceRunner was created with the option LOOPED_TICKER.

appStart

protected abstract void appStart()


appSize

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 beforeappStart().


animStart

protected abstract void animStart()



animStop

protected abstract void animStop()



appStop

protected abstract void appStop()


doUpdate

protected abstract void doUpdate(long now)


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

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

Parameters:now - Current time in ms.

doDraw

SurfaceRunner


protected abstract void doDraw(Canvas canvas, long now)


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 bere-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 apreceeding 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-screenrendering 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-screenrendering buffer, for example.

Parameters:w - Desired width in pixels.h - Desired height in pixels.


onSurfaceThread

public boolean onSurfaceThread()

SurfaceRunner


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


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 willbecome stats which will be displayed if setDebugPerf(boolean enable) is passed true. Each stat issubsequently 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. AfterappStart() is called, the stats content is frozen until the next appStop() / appStart(). Typically the appshould 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 bedisplayed 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.

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 therecorded 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.


AppUtils.Version

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


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

Enclosing class:AppUtils

public class AppUtils.Versionextends 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 SummaryAppUtils.Version()

Method Summary Methods inherited from class java.lang.Objectclone, 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.

AppUtils.Version

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

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()


AudioAnalyser

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


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

public class AudioAnalyserextends Instrument

An Instrument which analyses an audio stream in various ways.

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

Constructor SummaryAudioAnalyser(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

void restoreState(Bundle icicle) Restore the game state from the given Bundle.

protected void saveState(Bundle icicle)

Save the state of the game in the provided Bundle. void setAverageLen(int len)

Set the histogram averaging window for this instrument.

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.InstrumentgetSurface


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. Largerblock sizes will mean more work to analyse the spectrum.

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)


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

appStart

public void appStart()


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()

AudioAnalyser


We are stopping / pausing the run; stop measurements.

Overrides:measureStop in class Instrument

appStop

public void appStop()


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.



getPowerGauge

public PowerGauge getPowerGauge(SurfaceRunner surface)

Get a signal power gauge for this audio analyser.


Returns:A gauge which will display the signal power in a dB meter.

doUpdate

public final void doUpdate(long now)

AudioAnalyser


Update the state of the instrument for the current frame. This method must be invoked from thedoUpdate() 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


saveState


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.


Instrument

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


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

Direct Known Subclasses:AudioAnalyser

public class Instrumentextends java.lang.Object

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

Constructor SummaryInstrument(SurfaceRunner parent) Set up this view.




void doUpdate(long now) Update the state of the instrument for the current frame.

protected SurfaceRunner getSurface()

Get the app context of this Element. void measureStart()





Save the state of the game in the provided Bundle. Methods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Instrument


Constructor Detail

Instrument

public Instrument(SurfaceRunner parent)

Set up this view.


Method Detail

appStart


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

measureStart



measureStop



appStop



doUpdate


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 invokedin the main animation loop -- i.e. frequently.


Instrument


getSurface


Get the app context of this Element.

Returns:The app context we're running in.

saveState




restoreState





AppUtils

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 Class AppUtilsjava.lang.Object org.hermit.android.core.AppUtils

public class AppUtilsextends java.lang.Object

This class provides some simple application-related utilities.

Nested Class Summarystatic class AppUtils.Detail

Version info detail level. class AppUtils.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.


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.

AppUtils

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

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.



org.hermit.android.core

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

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 SummaryAppUtils 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.

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

SurfaceRunner Common base for applications with an animated view.

Enum SummaryAppUtils.Detail Version info detail level.

Package org.hermit.android.core Description



AppUtils.Detail

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

Overview Package Class Use Tree Deprecated Index Help PREV CLASS NEXT CLASS FRAMES NO FRAMES All ClassesSUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD DETAIL: ENUM CONSTANTS | FIELD | METHOD

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

All Implemented Interfaces:java.io.Serializable, java.lang.Comparable<AppUtils.Detail>


public static enum AppUtils.Detailextends java.lang.Enum<AppUtils.Detail>

Version info detail level.

Enum Constant SummaryDEBUG Show debug-level detail.

NONE Do not display.

SIMPLE Show basic name and version.

Method Summarystatic 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 orderthey are declared.

Methods inherited from class java.lang.Enumclone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString,valueOf

Methods inherited from class java.lang.ObjectgetClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

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. Thismethod 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 anidentifier used to declare an enum constant in this type. (Extraneous whitespace characters are notpermitted.)

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 specifiednamejava.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/instruments/package-summary.html[2/19/2011 9:10:24 AM]


Package org.hermit.android.instruments

Class SummaryAudioAnalyser An Instrument which analyses an audio stream in various ways.

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.

InstrumentSurface Common base for applications which display instruments.

PowerGauge A graphical display which displays the signal power in dB from an AudioAnalyserinstrument.

SpectrumGauge A graphical display which displays the audio spectrum from an AudioAnalyserinstrument.

TextGauge A Gauge which displays data in textual form, generally as a grid of numeric values.

WaveformGauge A graphical display which displays the audio waveform from an AudioAnalyserinstrument.


AudioReader

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 Class AudioReaderjava.lang.Object org.hermit.android.io.AudioReader

public class AudioReaderextends java.lang.Object

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


Nested Class Summarystatic class AudioReader.Listener

Listener for audio reads.

Constructor SummaryAudioReader() 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.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AudioReader

public AudioReader()

Create an AudioReader instance.

Method Detail

AudioReader

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

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 audiobuffer size.listener - Listener to be notified on each completed read.

stopReader

public void stopReader()

Start this reader.



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


Package org.hermit.android.io

Class SummaryAudioReader A class which reads audio input from the mic in a background thread and passes

it to the caller when ready.

AudioReader.Listener Listener for audio reads.


AudioReader.Listener

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


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

Enclosing class:AudioReader

public abstract static class AudioReader.Listenerextends java.lang.Object


Field Summarystatic 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 SummaryAudioReader.Listener()

Method Summaryabstract

void onReadComplete(short[] buffer) An audio read has completed.

abstract void onReadError(int error)

An error has occurred. Methods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ERR_OK



public static final int ERR_OK

Audio read error code: no error.


ERR_INIT_FAILED

public static final int ERR_INIT_FAILED

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


ERR_READ_FAILED

public static final int ERR_READ_FAILED



Constructor Detail


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.

Overview

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

All Classes

Packages org.hermit.android.coreorg.hermit.android.instruorg.hermit.android.io org.hermit.android.net org.hermit.android.noticorg.hermit.android.provorg.hermit.android.sounorg.hermit.android.widg

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.ActivityListMultistateImageButton OneTimeDialog Player PowerGauge SpectrumGauge SplashActivity SurfaceRunner TableFetcher TableProvider TableSchema TextGauge TextInputDialog TextInputDialog.OnOkLTimeZoneActivity


HermitAndroidHermitAndroid is a collection of useful classes for Android applications, in a librarywhich can be linked into Android projects.

See: Description


applications.





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

org.hermit.android.sound These classes provide functions to help appsmanage their sound effects.


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

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




Overview

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

WaveformGauge WebBasedData WebFetcher WebFetcher.FetchExceptionWebFetcher.Listener


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


Package org.hermit.android.net

Interface SummaryWebFetcher.Listener Listener for incoming web data.

Class SummaryCachedFile 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.

WebBasedData This class implements a web-based source of data, which is cached in a localdatabase.

WebFetcher This class fetches data from the web without blocking the main app.

Exception SummaryWebFetcher.FetchException Web fetching exception.



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


Package org.hermit.android.notice

Interface SummaryTextInputDialog.OnOkListener Listener invoked when the user clicks the OK button.

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

Class SummaryErrorDialog This class implements a popup error box (a subclass of AlertDialog) which can be used

to display an error message.

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

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

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


org.hermit.android.provider

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


Package org.hermit.android.provider

A library of classes to facilitate the creating of table-based content providers.

See: Description

Class SummaryDatabaseHelper This class helps open, create, and upgrade the database file.

DbSchema Class encapsulating the schema for a content provider.

TableProvider This class is a base for content providers which provide access to table-organized datain 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 theseclasses to create a content provider with the minimum amount of code, while still retaining reasonableflexibility 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 innerclasses which are subclasses of TableSchema to define the tables.Create a subclass of TableProvider to implement the content provider. In many cases this class willconsist 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, andcreating a fresh one. This is something that many applications will wish to improve on, and you can do thisby 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, overrideTableProvider.getHelper() to return an instance of your database helper.

Example



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

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.



*/ 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:


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" />


org.hermit.android.sound

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


Package org.hermit.android.sound

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

See: Description

Class SummaryEffect Class representing a specific sound effect.

Player Main sound effects player class.

Package org.hermit.android.sound Description




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


Package org.hermit.android.widgets

Class SummaryHScrollView Layout container for a view hierarchy that can be scrolled by the user, allowing

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 multiplestates when clicked.

TimeZoneActivity This class displays a picker which can be used to select a timezone.


Class Hierarchy

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?overview-tree.html[2/19/2011 9:10:43 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.ActivityListMultistateImageButton OneTimeDialog Player


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




org.hermit.android.core.HelpActivityAlertDialog



org.hermit.android.notice.TextInputDialogorg.hermit.android.core.AppUtilsorg.hermit.android.core.AppUtils.Versionorg.hermit.android.io.AudioReaderorg.hermit.android.io.AudioReader.Listenerorg.hermit.android.net.CachedFile.EntryContentProvider

org.hermit.android.provider.TableProviderorg.hermit.android.provider.DbSchemaDialog

org.hermit.android.notice.InfoBoxEditText

org.hermit.android.widgets.LinedEditTextorg.hermit.android.sound.Effectorg.hermit.android.core.ErrorsFrameLayout

org.hermit.android.widgets.HScrollVieworg.hermit.android.instruments.Gauge


ImageButtonorg.hermit.android.widgets.MultistateImageButton


ListActivityorg.hermit.android.widgets.TimeZoneActivity

Class Hierarchy

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

PowerGauge SpectrumGauge SplashActivity SurfaceRunner TableFetcher TableProvider TableSchema TextGauge TextInputDialog TextInputDialog.OnOkLTimeZoneActivity WaveformGauge WebBasedData WebFetcher WebFetcher.FetchExceWebFetcher.Listener YesNoDialog YesNoDialog.OnOkListe

org.hermit.android.core.MainActivity.ActivityListenerjava.util.Observable


org.hermit.android.core.OneTimeDialogorg.hermit.android.sound.PlayerSQLiteOpenHelper

org.hermit.android.provider.DatabaseHelperSurfaceView

org.hermit.android.core.SurfaceRunnerorg.hermit.android.instruments.InstrumentSurface

org.hermit.android.provider.TableSchemajava.lang.Thread (implements java.lang.Runnable)

org.hermit.android.net.WebFetcherorg.hermit.android.net.FileFetcherorg.hermit.android.net.TableFetcher



Interface Hierarchy

org.hermit.android.notice.TextInputDialog.OnOkListenerorg.hermit.android.net.WebFetcher.Listenerorg.hermit.android.notice.YesNoDialog.OnOkListener

Enum Hierarchy

java.lang.Objectjava.lang.Enum<E> (implements java.lang.Comparable<T>,java.io.Serializable)



org.hermit.android.core Class Hierarchy

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


Hierarchy For Package org.hermit.android.core

Package Hierarchies:All Packages

Class Hierarchy




org.hermit.android.core.HelpActivityorg.hermit.android.core.AppUtilsorg.hermit.android.core.AppUtils.Versionorg.hermit.android.core.Errorsorg.hermit.android.core.MainActivity.ActivityListenerorg.hermit.android.core.OneTimeDialogSurfaceView

org.hermit.android.core.SurfaceRunner

Enum Hierarchy

java.lang.Objectjava.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable)



org.hermit.android.instruments Class Hierarchy

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


Hierarchy For Package org.hermit.android.instruments


Class Hierarchy

java.lang.Objectorg.hermit.android.instruments.Gauge



SurfaceVieworg.hermit.android.core.SurfaceRunner

org.hermit.android.instruments.InstrumentSurface


org.hermit.android.io Class Hierarchy

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


Hierarchy For Package org.hermit.android.io


Class Hierarchy

java.lang.Objectorg.hermit.android.io.AudioReaderorg.hermit.android.io.AudioReader.Listener


org.hermit.android.net Class Hierarchy

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


Hierarchy For Package org.hermit.android.net


Class Hierarchy

java.lang.Objectorg.hermit.android.net.CachedFile.Entryjava.util.Observable


java.lang.Thread (implements java.lang.Runnable)org.hermit.android.net.WebFetcher

org.hermit.android.net.FileFetcherorg.hermit.android.net.TableFetcher



Interface Hierarchy

org.hermit.android.net.WebFetcher.Listener


org.hermit.android.notice Class Hierarchy

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


Hierarchy For Package org.hermit.android.notice


Class Hierarchy

java.lang.ObjectAlertDialog



org.hermit.android.notice.TextInputDialogDialog

org.hermit.android.notice.InfoBox

Interface Hierarchy

org.hermit.android.notice.TextInputDialog.OnOkListenerorg.hermit.android.notice.YesNoDialog.OnOkListener


org.hermit.android.provider Class Hierarchy

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


Hierarchy For Package org.hermit.android.provider


Class Hierarchy

java.lang.ObjectContentProvider

org.hermit.android.provider.TableProviderorg.hermit.android.provider.DbSchemaSQLiteOpenHelper

org.hermit.android.provider.DatabaseHelperorg.hermit.android.provider.TableSchema


org.hermit.android.sound Class Hierarchy

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


Hierarchy For Package org.hermit.android.sound


Class Hierarchy

java.lang.Objectorg.hermit.android.sound.Effectorg.hermit.android.sound.Player


org.hermit.android.widgets Class Hierarchy

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


Hierarchy For Package org.hermit.android.widgets


Class Hierarchy

java.lang.ObjectEditText

org.hermit.android.widgets.LinedEditTextFrameLayout

org.hermit.android.widgets.HScrollViewImageButton

org.hermit.android.widgets.MultistateImageButtonListActivity

org.hermit.android.widgets.TimeZoneActivity


MainActivity

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


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

public class MainActivityextends Activity

An enhanced Activity class, for use as the main activity of an application. The main thing this class providesis a nice callback-based mechanism for starting sub-activities. This makes it easier for different parts of anapp 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 forsafety use small request codes, and call super.onActivityResult(int, int, Intent) when you get an unknowncode.

Author:Ian Cameron Smith

Nested Class Summarystatic class MainActivity.ActivityListener

This interface defines a listener for sub-activity results.

Constructor SummaryMainActivity()

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

void onActivityResult(int requestCode, int resultCode, Intent data) Called when an activity you launched exits, giving you the requestCode you started itwith, the resultCode it returned, and any additional data from it.

protected void onCreate(Bundle icicle)

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 debuginfo.

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.


Constructor Detail

MainActivity

public MainActivity()

Method Detail

onCreate


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

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

createEulaBox

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, callshowFirstEula() to display the dialog the first time your app runs. To display it on demand, callshowEula().

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 callingcreateEulaBox(int, int, int).

showEula

public void showEula()

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

createMessageBox

@Deprecatedpublic 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 bycalling setHomeInfo(int, int), setAboutInfo(int) and setLicenseInfo(int, int); then pop up adialog 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

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

@Deprecatedpublic void setHomeInfo(int button, int link)

Deprecated.


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().


setLicenseInfo

@Deprecatedpublic void setLicenseInfo(int button, int link)

Deprecated.



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

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'treport 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, thegiven ActivityListener will be invoked.

Note that this method should only be used with Intent protocols that are defined to return a result. Inother protocols (such as ACTION_MAIN or ACTION_VIEW), you may not get the result when youexpect. 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 startedactivity. This method throws ActivityNotFoundException if there was no Activity found to run the givenIntent.

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, theresultCode it returned, and any additional data from it. The resultCode will be RESULT_CANCELED ifthe activity explicitly returned that, didn't return any result, or crashed during its operation.

Parameters:requestCode - The integer request code originally supplied to startActivityForResult(), allowingyou 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.


SplashActivity

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


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

public class SplashActivityextends Activity

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

Field Summarystatic 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 SummarySplashActivity()

Method Summarystatic 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.Objectclone, 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 theimage to display.

SplashActivity

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


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 forwhich the splash screen should be displayed.


Constructor Detail

SplashActivity

public SplashActivity()

Method Detail

onCreate




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.


YesNoDialog

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


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

public class YesNoDialogextends AlertDialog

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

Nested Class Summarystatic interface YesNoDialog.OnOkListener


Constructor SummaryYesNoDialog(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.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

YesNoDialog

public YesNoDialog(Context parent, int okBut,

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)


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)



YesNoDialog



ErrorDialog

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


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

public class ErrorDialogextends AlertDialog

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

Constructor SummaryErrorDialog(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)


Constructor Detail

ErrorDialog

public ErrorDialog(Context parent, int button)


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

ErrorDialog

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

ErrorDialog

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


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)


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

show

public void show(java.lang.String text)


Parameters:text - Text to display in the dialog.


TextInputDialog

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


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

public class TextInputDialogextends AlertDialog

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

Nested Class Summarystatic interface TextInputDialog.OnOkListener


Constructor SummaryTextInputDialog(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, java.lang.String dflt)


Constructor Detail

TextInputDialog


TextInputDialog

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



TextInputDialog

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



Method Detail

setOnOkListener

public void setOnOkListener(TextInputDialog.OnOkListener listener)



show




show

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

TextInputDialog



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

show




show

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




CachedFile.Entry

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


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

Enclosing class:CachedFile

public static final class CachedFile.Entryextends 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


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

Field Detail

url

public final java.net.URL url


name

public java.lang.String name

CachedFile.Entry

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

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.


TableProvider

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


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

public class TableProviderextends 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 tothis class's constructor. The bulk of the work in creating a content provider is in creating the schema, asubclass of DbSchema.

Constructor SummaryTableProvider(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 DbSchema getSchema()

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 afterTableSchema.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)

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.


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


Get the database schema.

Returns:The schema for this database.

getTableSchema

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

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 asmarter 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/ fora 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 internallyby the ContentResolver.

Parameters:uri - The URI to query. This will be the full URI sent by the client; if the client is requesting aspecific record, the URI will end in a record number that the implementation should parse andadd 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 fromselectionArgs, 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 todefine the sort order.

TableProvider


Returns:A Cursor or null.

queryItem


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.


queryItem

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


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.


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 fromselectionArgs, 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 todefine the sort order.


TableProvider


onInsert

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

This method is called prior to processing an insert; it is called afterTableSchema.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() afterdeleting. The implementation is responsible for parsing out a row ID at the end of the URI, if aspecific row is being deleted. That is, the client would pass in content://contacts/people/22 and theimplementation 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)

TableProvider


Update a content URI. All rows matching the optionally provided selection will have their columnslisted 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 aspecific 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.



DbSchema

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


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

public abstract class DbSchemaextends java.lang.Object

Class encapsulating the schema for a content provider. Applications must subclass this, and provide thenecessary 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 Summaryprotected 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.


Constructor Detail

DbSchema

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

Create a database schema instance.

DbSchema

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

Parameters:name - Name for the database; e.g. "passages".version - Version number of the database. The upgrade process will be run when thisincrements.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






InfoBox

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


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

public class InfoBoxextends Dialog

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

Field Summarystatic int BUTTON_1

Select configurable button 1 -- the middle button.static int BUTTON_2

Select configurable button 2 -- the middle button.

Constructor SummaryInfoBox(Activity parent) Create an info box with a "close" button.

InfoBox(Activity parent, int button) Create an info box.


void linkButtonPressed(int which) Called when a link button is clicked.

protected void okButtonPressed()

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.

InfoBox


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


Field Detail

BUTTON_1

public static final int BUTTON_1



BUTTON_2




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

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. theproject 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)


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

show




show

public void show(int text)



InfoBox


show




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).


LinedEditText

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


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

public class LinedEditTextextends EditText

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

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


void onDraw(Canvas canvas) Overridden onDraw method.


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 fromXML layouts.

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

Method Detail

onDraw

LinedEditText

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

protected void onDraw(Canvas canvas)

Overridden onDraw method. Draw the text, with lines.

Parameters:canvas - Canvas to draw into.


Effect

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


org.hermit.android.sound Class Effectjava.lang.Object org.hermit.android.sound.Effect

public class Effectextends 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.Objectclone, 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)


Parameters:

Effect

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

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.


Errors

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


org.hermit.android.core Class Errorsjava.lang.Object org.hermit.android.core.Errors

public class Errorsextends java.lang.Object

Error handling and reporting utilities.


Method Summarystatic 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 debuginfo.

void reportException(java.lang.Exception e) Report an unexpected exception to the user by popping up a dialog with some debuginfo.


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

Errors

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

public static void reportException(Context context, java.lang.Exception e)



Parameters:context - The Activity for which we want an error reporter.e - The exception.

reportException






Gauge

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


org.hermit.android.instruments Class Gaugejava.lang.Object org.hermit.android.instruments.Gauge

Direct Known Subclasses:PowerGauge, SpectrumGauge, TextGauge, WaveformGauge

public class Gaugeextends java.lang.Object

A graphical display which shows some data in a region within a view. The data may come from anInstrument or some other source.

Configuration

Your gauge will be notified of its geometry by a call to setGeometry(Rect). This is where you should noteyour 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) willbe called any time the screen changes size or shape (e.g. on an orientation change). You should beprepared 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 geometrychanges.

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 backgroundinto 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 thegauge, 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)

Gauge


(optional), and .

If your implementation of drawBody(Canvas, Paint, long) draws a complete, opaque rendition of thegauge, that's all you need; there's no need to provide an implementation of drawBackgroundBody(). But ifyour gauge has a separate, persistent background appearance, you may reap a performance benefit byseparating out its drawing. Do this by implementing drawBackgroundBody(Canvas, Paint). This routineshould 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 isset up -- for example at the end of setGeometry(Rect). At that point, your background will be fetched (bycalling your implementation of drawBackgroundBody()) and stored; then when someone asks us to drawour background, the request will be satisfied using the stored bitmap, without calling yourdrawBackgroundBody() again.

Constructor SummaryGauge(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 Summaryprotected void cacheBackground()

Fetch and cache an image of the background now, then use that to draw thebackground 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()

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

Paint getPaint() 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.


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)

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.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Gauge

public Gauge(SurfaceRunner parent)

Set up this view.


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.

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 doclass-specific one-time initialization.

Parameters:paint - The paint to initialize.

optionSet



Parameters:option - The option flag to test; one of GAUGE_XXX.


setTextTypeface

Gauge


public static void setTextTypeface(Typeface face)


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.

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()

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

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 discoverour 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 futuredraw 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 ofsetGeometry(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()

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 beencalled 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 beencalled 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:

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

Gauge


public void error(int error)

An error has occurred. Notify the user somehow.

Subclasses can override this to do something neat.


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.


drawBackgroundBody

protected void drawBackgroundBody(Canvas canvas, Paint paint)

Do the subclass-specific parts of drawing the background for this element. Subclasses should overridethis if they have significant background content which they would like to draw once only. Whatever isdrawn here will be saved in a bitmap, which will be rendered to the screen before the dynamiccontent 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

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 callingdrawBackground(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 theirdrawing.


drawFinish

protected void drawFinish(Canvas canvas, Paint paint, long now)

Wrap up drawing of this element.


getSurface




Gauge



PowerGauge

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


org.hermit.android.instruments Class PowerGaugejava.lang.Object org.hermit.android.instruments.Gauge org.hermit.android.instruments.PowerGauge

public class PowerGaugeextends Gauge

A graphical display which displays the signal power in dB from an AudioAnalyser instrument. This classcannot be instantiated directly; get an instance by calling AudioAnalyser.getPowerGauge(SurfaceRunner).


void drawBackgroundBody(Canvas canvas, Paint paint) Do the subclass-specific parts of drawing the background for this element.


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.GaugecacheBackground, 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


Method Detail

setBarWidth

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



Overrides:setGeometry in class Gauge


drawBackgroundBody


Do the subclass-specific parts of drawing the background for this element. Subclasses should overridethis if they have significant background content which they would like to draw once only. Whatever isdrawn here will be saved in a bitmap, which will be rendered to the screen before the dynamiccontent is drawn.

Obviously, if implementing this method, don't clear the screen when drawing the dynamic part.

Overrides:drawBackgroundBody in class Gauge

PowerGauge



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 thecontaining SuraceView.

Subclasses should override this to do their drawing.

Overrides:drawBody in class Gauge



SpectrumGauge

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


org.hermit.android.instruments Class SpectrumGaugejava.lang.Object org.hermit.android.instruments.Gauge org.hermit.android.instruments.SpectrumGauge

public class SpectrumGaugeextends Gauge

A graphical display which displays the audio spectrum from an AudioAnalyser instrument. This class cannotbe instantiated directly; get an instance by calling AudioAnalyser.getSpectrumGauge(SurfaceRunner).


void drawBody(Canvas canvas, Paint paint, long now) 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.


Methods inherited from class org.hermit.android.instruments.GaugecacheBackground, 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


Method Detail

setSampleRate


SpectrumGauge




setLabelSize




getLabelSize




setGeometry





drawBody






SpectrumGauge


now - Nominal system time in ms. of this update.


TextGauge

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


org.hermit.android.instruments Class TextGaugejava.lang.Object org.hermit.android.instruments.Gauge org.hermit.android.instruments.TextGauge

public class TextGaugeextends Gauge

A Gauge which displays data in textual form, generally as a grid of numeric values.

Constructor SummaryTextGauge(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.


void drawBody(Canvas canvas, Paint paint, long now) 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.


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.

TextGauge


void setTextSize(float size) Set the text size of this element.

Methods inherited from class org.hermit.android.instruments.GaugecacheBackground, 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


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 tocalling setTextFields() after the basic constructor. We support display of a single field, or a rectangulartable of fields. The caller must call setTextFields(String[] template, int rows) to set the tableformat.


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 tocalling setTextFields() after the basic constructor. We support display of a single field, or a rectangulartable of fields. The fields are specified by passing in sample text values to be measured; we thenallocate the space automatically.

Parameters:parent - Parent surface.template - Strings representing the columns to display. Each one should be a sample piece oftext 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


TextGauge


Set up the paint for this element. This is called during initialisation. Subclasses can override this to doclass-specific one-time initialisation.

Overrides:initializePaint in class Gauge

Parameters:paint - The paint to initialise.

setGeometry





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 andthe 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. Wesupport display of a single field, or a rectangular table of fields. The fields are specified by passing insample text values to be measured; we then allocate the space automatically. This must be calledbefore setText() can be called.

Parameters:template - Strings representing the columns to display. Each one should be a sample piece oftext which will be measured to determine the required space for each column.rows - Number of rows of text to display.

TextGauge


getBuffer

public char[][][] getBuffer()

Get the text buffers for the field values. The caller can change a field's content by writing to theappropriate member of the array, as in "buffer[row][col][0] = 'X';".

Returns:Text buffers for the field values.

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


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.

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






WaveformGauge

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


org.hermit.android.instruments Class WaveformGaugejava.lang.Object org.hermit.android.instruments.Gauge org.hermit.android.instruments.WaveformGauge

public class WaveformGaugeextends Gauge

A graphical display which displays the audio waveform from an AudioAnalyser instrument. This class cannotbe instantiated directly; get an instance by calling AudioAnalyser.getWaveformGauge(SurfaceRunner).




Methods inherited from class org.hermit.android.instruments.GaugecacheBackground, 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


Method Detail

setGeometry





WaveformGauge

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

drawBody







MultistateImageButton

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


org.hermit.android.widgets Class MultistateImageButtonjava.lang.Object ImageButton org.hermit.android.widgets.MultistateImageButton

public class MultistateImageButtonextends ImageButton

This class displays an image button which toggles or cycles through multiple states when clicked.

Constructor SummaryMultistateImageButton(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.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail


public MultistateImageButton(Context context, int[] images)


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]


public MultistateImageButton(Context context, AttributeSet attrs, int[] images)


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 becomesclickable. We override this here because we are using the parent class's listener slot for our ownpurposes.

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.


TimeZoneActivity

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


org.hermit.android.widgets Class TimeZoneActivityjava.lang.Object ListActivity org.hermit.android.widgets.TimeZoneActivity

public class TimeZoneActivityextends 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 SummaryTimeZoneActivity()



void onListItemClick(ListView l, View v, int position, long id) This method will be called when an item in the list is selected.


Constructor Detail

TimeZoneActivity

public TimeZoneActivity()

Method Detail

onCreate



TimeZoneActivity

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

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

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 callgetListView().getItemAtPosition(position) if they need to access the data associated with the selecteditem.

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.


MainActivity.ActivityListener

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


org.hermit.android.core Class MainActivity.ActivityListenerjava.lang.Object org.hermit.android.core.MainActivity.ActivityListener

Enclosing class:MainActivity

public abstract static class MainActivity.ActivityListenerextends java.lang.Object


Constructor SummaryMainActivity.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.


Constructor Detail


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]

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 userpressing "back", or normally, or whatever. The default implementation calls eitheronActivityCanceled(), 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 happenif the user presses "back", or if the activity returned that code explicitly, didn't return any result, orcrashed during its operation.

Applications can override this if they want to be separately notified of a RESULT_CANCELED. Itdoesn'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, givingyou 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 makesense 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.


CachedFile

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


org.hermit.android.net Class CachedFilejava.lang.Object java.util.Observable org.hermit.android.net.CachedFile


public class CachedFileextends java.util.Observableimplements WebFetcher.Listener

This class manages a set of web-based files and caches them locally. Data about the files is held in a localdatabase.

Nested Class Summarystatic class CachedFile.Entry

Class describing an entry in the cache; i.e.

Constructor SummaryCachedFile(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 wereinvoked on.

void onWebDone() This method is invoked when the given URL has been fully fetched.



CachedFile


void update(Context context, long now) Check to see whether we need to update our cached copies of the files.


Methods inherited from class java.util.ObservableaddObserver, clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged,notifyObservers, notifyObservers, setChanged


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




upgradeTable




setDatabase

CachedFile





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; pathwill 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.


Parameters:

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




onWebError






WebFetcher.Listener

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


org.hermit.android.net Interface WebFetcher.Listener

All Known Implementing Classes:CachedFile, WebBasedData

Enclosing class:WebFetcher

public static interface WebFetcher.Listener


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 invokedon.

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.

WebFetcher.Listener

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

onWebError

void onWebError(java.lang.String msg)

This method is invoked if an error occurs when fetching web data.



OneTimeDialog

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


org.hermit.android.core Class OneTimeDialogjava.lang.Object org.hermit.android.core.OneTimeDialog

public class OneTimeDialogextends java.lang.Object

A class which handles showing one-off notices. This can be used for a EULA, or for "new feature" noticeswhich 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 itdoesn't.


Constructor SummaryOneTimeDialog(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 Summaryprotected boolean isAccepted()

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.Objectclone, 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)

OneTimeDialog

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

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 willactually 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 thepreference 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".


DatabaseHelper

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


org.hermit.android.provider Class DatabaseHelperjava.lang.Object SQLiteOpenHelper org.hermit.android.provider.DatabaseHelper

public class DatabaseHelperextends 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. Ifyou don't wish to override it, nothing need be done. If you wish to subclass it, then create your subclassand override TableProvider.getHelper() to return it.

Constructor SummaryDatabaseHelper(Context context, DbSchema schema) Creater a helper instance.

Method Summaryprotected DbSchema getSchema()

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.Objectclone, 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.

DatabaseHelper

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

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 theinitial population of the tables should happen.

The default implementation creates all the fields specified in all of the table schemas. Subclasses mayoverride 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 droptables, 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). Subclassesmay 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 orremove columns you can use ALTER TABLE to rename the old table, then create the new table andthen 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





TableSchema

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


org.hermit.android.provider Class TableSchemajava.lang.Object org.hermit.android.provider.TableSchema

public abstract class TableSchemaextends java.lang.Object

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


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 databasename.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 Summaryprotected 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.


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 prependedautomatically.

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 upa default projection. The returned projection includes all fields, including the implicit "_id" field, whichshould 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 prependedautomatically.

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.

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 inany missing values.

Parameters:values - The fields being added.


WebFetcher

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


org.hermit.android.net Class WebFetcherjava.lang.Object java.lang.Thread org.hermit.android.net.WebFetcher

All Implemented Interfaces:java.lang.Runnable

Direct Known Subclasses:FileFetcher, TableFetcher

public abstract class WebFetcherextends java.lang.Thread

This class fetches data from the web without blocking the main app.

Nested Class Summarystatic class WebFetcher.FetchException

Web fetching exception.static interface WebFetcher.Listener

Listener for incoming web data. Nested classes/interfaces inherited from class java.lang.Threadjava.lang.Thread.State, java.lang.Thread.UncaughtExceptionHandler

Field Summaryprotected

WebFetcher.Listener dataClient

protected java.net.URL[] dataUrls

protected boolean killed

protected long newerThanDate

protected long timeout

Fields inherited from class java.lang.ThreadMAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

WebFetcher


Constructor SummaryWebFetcher(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.


void fetch(java.net.URL url, long newer) Fetch an object from the given URL.

protected void handle(java.net.URL url, java.net.URLConnection conn, java.io.BufferedReader stream)

Handle data from the given BufferedReader.protected

void handle(java.net.URL url, java.net.URLConnection conn, java.io.InputStream stream) 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.ThreadactiveCount, 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.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

timeout

protected final long timeout

killed


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, andpassed as it arrives to the given client. You can start the fetch when you want by calling start(); oryou 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, andpassed as it arrives to the given client. You can start the fetch when you want by calling start(); oryou 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 remoteresource 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)

WebFetcher


Create a fetcher to get data from a given list of URLs. Data will be fetched asynchronously from eachURL in sequence, and passed as it arrives to the given client. If any URL fails, the whole fetch will beaborted. If all URLs succeed, onWebDone() will be called in the listener. You can start the fetch whenyou want by calling start(); or you can pass it to queue() to be executed when other fetches aredone.

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 remoteresource 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,

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 remoteresource 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.


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.



FileFetcher

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


org.hermit.android.net Class FileFetcherjava.lang.Object java.lang.Thread org.hermit.android.net.WebFetcher org.hermit.android.net.FileFetcher


public class FileFetcherextends WebFetcher

Concrete instance of WebFetcher which gets a file and stores it locally. The value passed back to thelistener is the local file name as a File.

Nested Class Summary Nested classes/interfaces inherited from class org.hermit.android.net.WebFetcherWebFetcher.FetchException, WebFetcher.Listener

Nested classes/interfaces inherited from class java.lang.Threadjava.lang.Thread.State, java.lang.Thread.UncaughtExceptionHandler

Field Summary Fields inherited from class org.hermit.android.net.WebFetcherdataClient, dataUrls, killed, newerThanDate, timeout


Constructor SummaryFileFetcher(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.

FileFetcher



void handle(java.net.URL url, java.net.URLConnection conn, java.io.InputStream stream) Fetch a page of data from the given stream.

Methods inherited from class org.hermit.android.net.WebFetcherfetch, handle, kill, killAll, queue, run

Methods inherited from class java.lang.ThreadactiveCount, 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


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)


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


newer - If-modified-since time in ms UTC. The fetch will only be carried out if the remoteresource has been modified since this time. If zero, fetch without this condition.

Method Detail

handle


Fetch a page of data from the given stream.

Overrides:handle in class WebFetcher


Throws:FetchException - Some problem was detected.java.io.IOException - An I/O error occurred.WebFetcher.FetchException


TableFetcher

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


org.hermit.android.net Class TableFetcherjava.lang.Object java.lang.Thread org.hermit.android.net.WebFetcher org.hermit.android.net.TableFetcher


public class TableFetcherextends WebFetcher

Concrete instance of WebFetcher which fetches tabular data from the web. Lines in the file are parsed intofields and passed to the caller in a ContentValues object.

Nested Class Summary Nested classes/interfaces inherited from class org.hermit.android.net.WebFetcherWebFetcher.FetchException, WebFetcher.Listener

Nested classes/interfaces inherited from class java.lang.Threadjava.lang.Thread.UncaughtExceptionHandler




void handle(java.net.URL url, java.net.URLConnection conn, java.io.BufferedReader readc) Fetch a page of data from the given BufferedReader.


Methods inherited from class java.lang.Thread

TableFetcher

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

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


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.


Parameters:url - The URL we're reading.conn - The current connection to the URL.readc - The BufferedReader to read from.



WebFetcher.FetchException

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


org.hermit.android.net Class WebFetcher.FetchExceptionjava.lang.Object java.lang.Throwable java.lang.Exception org.hermit.android.net.WebFetcher.FetchException

All Implemented Interfaces:java.io.Serializable


public static class WebFetcher.FetchExceptionextends java.lang.Exception

Web fetching exception. Used to signal a problem while fetching data.

See Also:Serialized Form

Constructor SummaryWebFetcher.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.ThrowablefillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause,printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString


Constructor Detail


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]

Create a FetchException with a message.

Parameters:s - The exception message.


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.


TextInputDialog.OnOkListener

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


org.hermit.android.notice Interface TextInputDialog.OnOkListener

Enclosing class:TextInputDialog

public static interface TextInputDialog.OnOkListener


Method Summary void onOk(java.lang.CharSequence input)


Method Detail

onOk

void onOk(java.lang.CharSequence input)


Parameters:input - The input text.


YesNoDialog.OnOkListener

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


org.hermit.android.notice Interface YesNoDialog.OnOkListener

Enclosing class:YesNoDialog

public static interface YesNoDialog.OnOkListener


Method Summary void onOk()


Method Detail

onOk

void onOk()



Deprecated List

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?deprecated-list.html[2/19/2011 9:11:57 AM]

All Classes




Deprecated API

Contents

Deprecated Methods

Deprecated Methodsorg.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)


Deprecated List

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?deprecated-list.html[2/19/2011 9:11:57 AM]


API Help

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?help-doc.html[2/19/2011 9:11:59 AM]

All Classes


All Classes AppUtils AppUtils.Detail AudioAnalyser AudioReader AudioReader.Listener CachedFile CachedFile.Entry DatabaseHelper DbSchema


How This API Document Is OrganizedThis API (Application Programming Interface) document has pages corresponding tothe items in the navigation bar, described as follows.

Overview

The Overview page is the front page of this API document and provides alist of all packages with a summary for each. This page can also containan 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)ClassesEnumsExceptionsErrorsAnnotation Types

Class/Interface

Each class, interface, nested class and nested interface has its ownseparate page. Each of these pages has three sections consisting of aclass/interface description, summary tables, and detailed memberdescriptions:

Class inheritance diagramDirect SubclassesAll Known SubinterfacesAll Known Implementing ClassesClass/interface declarationClass/interface description

Nested Class SummaryField SummaryConstructor SummaryMethod Summary

Field DetailConstructor DetailMethod Detail

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

API Help


Effect ErrorDialog Errors FileFetcher Gauge HelpActivity HScrollView InfoBox Instrument InstrumentSurface LinedEditText MainActivity MainActivity.ActivityListMultistateImageButton OneTimeDialog Player PowerGauge SpectrumGauge SplashActivity SurfaceRunner TableFetcher TableProvider TableSchema TextGauge TextInputDialog TextInputDialog.OnOkLTimeZoneActivity WaveformGauge WebBasedData WebFetcher WebFetcher.FetchExceWebFetcher.Listener YesNoDialog YesNoDialog.OnOkListe

Annotation Type

Each annotation type has its own separate page with the followingsections:

Annotation Type declarationAnnotation Type descriptionRequired Element SummaryOptional Element SummaryElement Detail

Enum

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

Enum declarationEnum descriptionEnum Constant SummaryEnum Constant Detail

Use

Each documented package, class and interface has its own Use page.This page describes what packages, classes, methods, constructors andfields use any part of the given class or package. Given a class orinterface A, its Use page includes subclasses of A, fields declared as A,methods that return A, and methods and constructors with parameters oftype A. You can access this page by first going to the package, class orinterface, 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 eachpackage. Each hierarchy page contains a list of classes and a list ofinterfaces. The classes are organized by inheritance structure starting withjava.lang.Object. The interfaces do not inherit from java.lang.Object.

When viewing the Overview page, clicking on "Tree" displays thehierarchy 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. Adeprecated API is not recommended for use, generally due toimprovements, and a replacement API is usually given. Deprecated APIsmay be removed in future implementations.

Index

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

API Help


Prev/Next

These links take you to the next or previous class, interface, package, or relatedpage.

Frames/No Frames

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

Serialized Form

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


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.



http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/constant-values.html[2/19/2011 9:12:01 AM]



Contents

org.hermit.*

org.hermit.*

org.hermit.android.core.SplashActivitypublic 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.SurfaceRunnerpublic static final int LOOPED_TICKER 2

public static final int SURFACE_DYNAMIC 1

org.hermit.android.instruments.InstrumentSurfacepublic static final int SURFACE_CACHE_BG 256

org.hermit.android.io.AudioReader.Listenerpublic 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.InfoBoxpublic static final int BUTTON_1 1

public static final int BUTTON_2 2


Overview


All Classes





See: Description


applications.













Overview



All Classes

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/allclasses-frame.html[2/19/2011 9:12:06 AM]

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/org/hermit/android/core/package-frame.html[2/19/2011 9:12:07 AM]

org.hermit.android.coreClasses AppUtils Errors HelpActivity MainActivity MainActivity.ActivityListener OneTimeDialog SplashActivity SurfaceRunner

Enums AppUtils.Detail


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.instrumentsClasses AudioAnalyser Gauge Instrument InstrumentSurface PowerGauge SpectrumGauge TextGauge WaveformGauge


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.ioClasses AudioReader AudioReader.Listener


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.netInterfaces WebFetcher.Listener

Classes CachedFile CachedFile.Entry FileFetcher TableFetcher WebBasedData WebFetcher

Exceptions WebFetcher.FetchException


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.noticeInterfaces TextInputDialog.OnOkListener YesNoDialog.OnOkListener

Classes ErrorDialog InfoBox TextInputDialog YesNoDialog


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.providerClasses DatabaseHelper DbSchema TableProvider TableSchema


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.soundClasses Effect Player


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

org.hermit.android.widgetsClasses HScrollView LinedEditText MultistateImageButton TimeZoneActivity

Overview


All Classes





See: Description


applications.













Overview



Overview


All Classes





See: Description


applications.













Overview


YesNoDialog

Overview


All Classes





See: Description


applications.













Overview



Overview


All Classes





See: Description


applications.













Overview



Overview


All Classes





See: Description


applications.













Overview



Overview


All Classes





See: Description


applications.













Overview



Overview


All Classes





See: Description


applications.













Overview



Overview


All Classes





See: Description


applications.













Overview


YesNoDialog

Overview


All Classes





See: Description


applications.













Overview



Overview


All Classes





See: Description


applications.













Overview



Overview


All Classes





See: Description


applications.













Overview



Overview


All Classes





See: Description


applications.













Overview



Overview


All Classes





See: Description


applications.













Overview



Overview


All Classes





See: Description


applications.













Overview



Overview


All Classes





See: Description


applications.













Overview



Overview


All Classes





See: Description


applications.













Overview



Overview


All Classes





See: Description


applications.













Overview



Overview


All Classes





See: Description


applications.













Overview



Overview


All Classes





See: Description


applications.













Overview



Overview


All Classes





See: Description


applications.













Overview



Overview


All Classes





See: Description


applications.













Overview



Uses of Class org.hermit.android.sound.Player

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


Uses of Classorg.hermit.android.sound.Player

No usage of org.hermit.android.sound.Player


Player

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

All Classes


All Classes AppUtils AppUtils.Detail AudioAnalyser AudioReader AudioReader.Listener CachedFile

Overview Package Class Use Tree Deprecated Index Help PREV CLASS NEXT CLASS FRAMES NO FRAMES SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

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

public class Playerextends java.lang.Object

Main sound effects player class.

Constructor SummaryPlayer(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.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString,wait, wait, wait

Constructor Detail

Player

public Player(Context context)

Player


CachedFile.Entry DatabaseHelper DbSchema Effect ErrorDialog Errors FileFetcher Gauge HelpActivity HScrollView InfoBox Instrument InstrumentSurface LinedEditText MainActivity MainActivity.ActivityListMultistateImageButton OneTimeDialog Player PowerGauge SpectrumGauge SplashActivity SurfaceRunner TableFetcher TableProvider TableSchema TextGauge TextInputDialog TextInputDialog.OnOkLTimeZoneActivity WaveformGauge WebBasedData WebFetcher WebFetcher.FetchExceWebFetcher.Listener YesNoDialog YesNoDialog.OnOkListe

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)


Parameters:sound - Resource ID of the sound sample for this effect.

Returns:An Effect object representing the new effect. Use this object to actuallyplay the sound.

addEffect

public Effect addEffect(int sound, float vol)


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 actuallyplay the sound.

setGain

public void setGain(float gain)

Set the overall gain for sounds.

Parameters:

Player


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

play

public int play(Effect 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 bezero 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.


Uses of Class org.hermit.android.instruments.InstrumentSurface

http://moonblink.googlecode.com/...unk/HermitAndroid/doc/org/hermit/android/instruments/class-use/InstrumentSurface.html[2/19/2011 9:13:18 AM]


Uses of Classorg.hermit.android.instruments.InstrumentSurface

No usage of org.hermit.android.instruments.InstrumentSurface


InstrumentSurface

http://moonblink.googlecode.com/...k/HermitAndroid/doc/index.html?org/hermit/android/instruments/InstrumentSurface.html[2/19/2011 9:13:21 AM]

All Classes



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

public abstract class InstrumentSurfaceextends SurfaceRunner

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

When using this class in an app, the app context must call these methods (usuallyfrom 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 bycalling SurfaceRunner.surfaceStart() and SurfaceRunner.surfaceStop().

Field Summarystatic int SURFACE_CACHE_BG

Instrument Surface runner option: cache a background bitmap. Fields inherited from class org.hermit.android.core.SurfaceRunnerLOOPED_TICKER, SURFACE_DYNAMIC

Constructor SummaryInstrumentSurface(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.

InstrumentSurface


All Classes AppUtils AppUtils.Detail AudioAnalyser AudioReader AudioReader.Listener CachedFile CachedFile.Entry DatabaseHelper DbSchema Effect ErrorDialog Errors FileFetcher Gauge HelpActivity HScrollView InfoBox Instrument InstrumentSurface

void addInstrument(Instrument i) Add an instrument to the system, associated with this surface.


We are starting the animation loop.protected

void animStop() We are stopping the animation loop, for example to pause theapp.



void appStart() The application is starting.



void doDraw(Canvas canvas, long now) Draw the current frame of the application.


Update the state of the application for the current frame.protectedabstract

voidlayout(int width, int height) Lay out the display for a given screen size.

Methods inherited from class org.hermit.android.core.SurfaceRunnergetBitmap, 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.Objectclone, 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 willask all the gauges to draw their backgrounds into a full- screen bitmap; thisbitmap will then be drawn prior to drawing the gauge contents each frame.


Constructor Detail

InstrumentSurface

public InstrumentSurface(Activity app)

InstrumentSurface


LinedEditText MainActivity MainActivity.ActivityListMultistateImageButton OneTimeDialog Player PowerGauge SpectrumGauge SplashActivity SurfaceRunner TableFetcher TableProvider TableSchema TextGauge TextInputDialog TextInputDialog.OnOkLTimeZoneActivity WaveformGauge WebBasedData WebFetcher WebFetcher.FetchExceWebFetcher.Listener YesNoDialog YesNoDialog.OnOkListe



InstrumentSurface

public InstrumentSurface(Activity app, int options)


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

Method Detail

addInstrument

public void addInstrument(Instrument i)

Add an instrument to the system, associated with this surface. Is is presumedthat the app will create one or more Gauges for this instrument and add themto the surface with addGauge(Gauge).

All instruments added here will be started and stopped when the applicationstarts and stops, and will have their measurement turned on when the app isvisible and running. Their Instrument.doUpdate(long) method will be calledeach 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, itshould 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.

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


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


Specified by:appStart in class SurfaceRunner

appSize


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

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

Specified by:appSize in class SurfaceRunner


animStart




InstrumentSurface



Specified by:animStart in class SurfaceRunner

animStop





Specified by:animStop in class SurfaceRunner

appStop



Specified by:appStop in class SurfaceRunner

doUpdate



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

doDraw() will always be called after this method is called; however, theconverse 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 ratherthan frames.

Specified by:doUpdate in class SurfaceRunner


doDraw



InstrumentSurface


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

This method will always be called after a call to doUpdate(), and also when thescreen 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.


Uses of Class org.hermit.android.core.HelpActivity

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/core/class-use/HelpActivity.html[2/19/2011 9:13:23 AM]


Uses of Classorg.hermit.android.core.HelpActivity

No usage of org.hermit.android.core.HelpActivity


HelpActivity

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

All Classes


All Classes AppUtils AppUtils.Detail AudioAnalyser AudioReader AudioReader.Listener CachedFile CachedFile.Entry DatabaseHelper DbSchema Effect ErrorDialog Errors


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

public class HelpActivityextends Activity

An activity which displays an application's help, in a structured format. Help issupplied via resources arrays; one array contains the titles of the help sections, onecontains 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 andkeyboardHidden configuration changes in your app manifest.

Constructor SummaryHelpActivity()


void addHelpFromArrays(int titlesId, int textsId) Add help to this help activity.



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 beingkilled so that the state can be restored in onCreate(Bundle) oronRestoreInstanceState(Bundle) (the Bundle populated by this methodwill be passed to both).


HelpActivity


FileFetcher Gauge HelpActivity HScrollView InfoBox Instrument InstrumentSurface LinedEditText MainActivity MainActivity.ActivityListMultistateImageButton OneTimeDialog Player PowerGauge SpectrumGauge SplashActivity SurfaceRunner TableFetcher TableProvider TableSchema TextGauge TextInputDialog TextInputDialog.OnOkLTimeZoneActivity WaveformGauge WebBasedData WebFetcher WebFetcher.FetchExceWebFetcher.Listener YesNoDialog YesNoDialog.OnOkListe

Constructor Detail

HelpActivity

public HelpActivity()

Method Detail

onCreate


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


onRestoreInstanceState


This method is called after onStart() when the activity is being re-initializedfrom a previously saved state, given here in state. Most implementations willsimply use onCreate(Bundle) to restore their state, but it is sometimesconvenient to do it here after all of the initialization has been done or to allowsubclasses to decide whether to use your default implementation. The defaultimplementation of this method performs a restore of any view state that hadpreviously been frozen by onSaveInstanceState(Bundle). This method is calledbetween onStart() and onPostCreate(Bundle).

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

onSaveInstanceState

public void onSaveInstanceState(Bundle outState)

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

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

addHelpFromArrays

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 titlesof the help sections, the second contains the bodies of the sections. The arraysmust be the same length.

A title and the corresponding content may both be resource IDs of furtherarrays. These arrays will be added as sub-sections in the most recently-addedsection. 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.


Uses of Class org.hermit.android.widgets.HScrollView

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/widgets/class-use/HScrollView.html[2/19/2011 9:13:27 AM]


Uses of Classorg.hermit.android.widgets.HScrollView

No usage of org.hermit.android.widgets.HScrollView


HScrollView

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

All Classes



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

public class HScrollViewextends FrameLayout

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

An HScrollView is a android.widget.FrameLayout, meaning you should place one childin it containing the entire contents to scroll; this child may itself be a layout managerwith a complex hierarchy of objects. A child that is often used is aandroid.widget.LinearLayout in a vertical orientation, presenting a vertical array oftop-level items that the user can scroll through.

HScrollView only supports horizontally scrolling.

Constructor SummaryHScrollView(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

int computeHorizontalScrollRange() The scroll range of a scroll view is the overall height of all of itschildren.

void computeScroll()

HScrollView


protected

int computeScrollDeltaToGetChildRectOnScreen(Rect rect) Compute the amount to scroll in the Y direction in order to get arectangle completely on the screen (or, if taller than the screen, at leastthe 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 performscrolling from a key event, just as if the event had been dispatched to itby the view hierarchy.

void fling(int velocityX) Fling the scroll view


int getMaxScrollAmount()

protected

float getRightFadingEdgeStrength()

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

boolean isSmoothScrollingEnabled()

protected void

measureChild(View child, int parentWidthMeasureSpec,int parentHeightMeasureSpec)

protected void

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

boolean onInterceptTouchEvent(MotionEvent ev)


protected

void onMeasure(int widthMeasureSpec, int heightMeasureSpec)

protected boolean

onRequestFocusInDescendants(int direction,Rect previouslyFocusedRect) When looking for focus in children of a scroll view, need to be alittle more careful not to give focus to something that is scrolled offscreen.


boolean onTouchEvent(MotionEvent ev)

void requestChildFocus(View child, View focused)

boolean requestChildRectangleOnScreen(View child, Rect rectangle,

boolean immediate)

HScrollView


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.ActivityListMultistateImageButton OneTimeDialog Player PowerGauge SpectrumGauge SplashActivity SurfaceRunner TableFetcher TableProvider TableSchema TextGauge TextInputDialog TextInputDialog.OnOkLTimeZoneActivity WaveformGauge WebBasedData WebFetcher

void requestLayout()

void scrollTo(int x, int y)

void setFillViewport(boolean fillViewport)

Indicates this ScrollView whether it should stretch its contentheight 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 ofimmediately.


Constructor Detail

HScrollView

public HScrollView(Context context)

HScrollView

public HScrollView(Context context, AttributeSet attrs)

Method Detail

getLeftFadingEdgeStrength


getRightFadingEdgeStrength

protected float getRightFadingEdgeStrength()

getMaxScrollAmount

public int getMaxScrollAmount()

Returns:

HScrollView


WebFetcher.FetchExceWebFetcher.Listener YesNoDialog YesNoDialog.OnOkListe

The maximum amount this scroll view will scroll in response to an arrowevent.

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 theviewport or not.

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

isSmoothScrollingEnabled

public boolean isSmoothScrollingEnabled()

Returns:Whether arrow scrolling will animate its transition.

HScrollView


setSmoothScrollingEnabled

public void setSmoothScrollingEnabled(boolean smoothScrollingEnabled)

Set whether arrow scrolling will animate its transition.

Parameters:smoothScrollingEnabled - whether arrow scrolling will animate itstransition

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 froma key event, just as if the event had been dispatched to it by the viewhierarchy.

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

HScrollView


pressedReturns:

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 axisdy - 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 axisy - 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


measureChildWithMargins

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

computeScroll

public void computeScroll()

HScrollView


computeScrollDeltaToGetChildRectOnScreen

protected int computeScrollDeltaToGetChildRectOnScreen(Rect rect)

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

Parameters:rect - The rect.

Returns:The scroll delta.

requestChildFocus

public void requestChildFocus(View child, View focused)

onRequestFocusInDescendants


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

requestChildRectangleOnScreen

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

requestLayout

public void requestLayout()

onLayout


onSizeChanged


HScrollView


fling

public void fling(int velocityX)


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

scrollTo

public void scrollTo(int x, int y)

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


Uses of Class org.hermit.android.net.WebBasedData

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/net/class-use/WebBasedData.html[2/19/2011 9:13:33 AM]


Uses of Classorg.hermit.android.net.WebBasedData

No usage of org.hermit.android.net.WebBasedData


WebBasedData

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

All Classes



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


public class WebBasedDataextends java.util.Observableimplements WebFetcher.Listener

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

Constructor SummaryWebBasedData(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 agiven 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 retrievedfrom the URL we were invoked on.

void onWebDone() This method is invoked when the given URL has been fullyfetched.


WebBasedData


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.ActivityListMultistateImageButton OneTimeDialog Player PowerGauge SpectrumGauge SplashActivity SurfaceRunner TableFetcher TableProvider TableSchema TextGauge

Handle an error while fetching web data.protected void process(ContentValues rec)

Optional processing step -- this is called for each recordwe read.


void update(long now) Check to see whether we need to update our stored data.


Methods inherited from class java.util.ObservableaddObserver, clearChanged, countObservers, deleteObserver, deleteObservers,hasChanged, notifyObservers, notifyObservers, setChanged


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 isnull.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




WebBasedData


TextInputDialog TextInputDialog.OnOkLTimeZoneActivity WaveformGauge WebBasedData WebFetcher WebFetcher.FetchExceWebFetcher.Listener YesNoDialog YesNoDialog.OnOkListe

upgradeTable




setDatabase




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 callclose() on the cursor when done.

Returns:A Cursor over all the records, sorted in ascending date order. The Cursoris 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 thecaller's responsibility to call close() on the cursor when done.

Parameters:

WebBasedData


date - Cut-off date -- only return records newer than this date (notequal).

Returns:A Cursor over all the records, sorted in ascending date order. The Cursoris 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 norecords.

update

public void update(long now)

Check to see whether we need to update our stored data. If so, kick off a webfetch. 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 beused 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 wereinvoked on.


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

WebBasedData


server, in ms UTC.

onWebDone




onWebError






Uses of Class org.hermit.android.core.SurfaceRunner

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 Classorg.hermit.android.core.SurfaceRunner

Packages that use SurfaceRunnerorg.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 SurfaceRunnerprotected

SurfaceRunner Instrument.getSurface() Get the app context of this Element.

protected SurfaceRunner Gauge.getSurface()


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)


Constructors in org.hermit.android.instruments with parameters of type SurfaceRunnerAudioAnalyser(SurfaceRunner parent) Create a WindMeter instance.

Gauge(SurfaceRunner parent) Set up this view.



Gauge(SurfaceRunner parent, int options, int grid, int plot)

Uses of Class org.hermit.android.core.SurfaceRunner

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/core/class-use/SurfaceRunner.html[2/19/2011 9:13:40 AM]

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.


SurfaceRunner

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

All Classes



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

Direct Known Subclasses:InstrumentSurface

public abstract class SurfaceRunnerextends SurfaceView

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

When using this class in an app, the app context must call these methods (usuallyfrom 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() andsurfaceStop().

Field Summarystatic int LOOPED_TICKER

Surface runner option: use a Looper to drive animations.static int SURFACE_DYNAMIC

Surface runner option: handle configuration changes dynamically.

Constructor SummarySurfaceRunner(Context app) Create a SurfaceRunner instance.

SurfaceRunner(Context app, AttributeSet attrs) Create a SurfaceRunner instance.

SurfaceRunner(Context app, int options) Create a SurfaceRunner instance.

SurfaceRunner



abstract void animStart() We are starting the animation loop.

protectedabstract void animStop()

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

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


abstract void appStart() The application is starting.

protectedabstract void appStop()


abstract void doDraw(Canvas canvas, long now) Draw the current frame of the application.

protectedabstract 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 thesurface.

Bitmap getBitmap(int w, int h) Get a Bitmap of a given size, in the same format as thesurface.

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 animationthread.

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 performanceinfo.

void

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 applicationperformance 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.


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 tothe app; otherwise, it is assumed that we will re-start for these.


LOOPED_TICKER

public static final int LOOPED_TICKER

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


SurfaceRunner


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.ActivityListMultistateImageButton OneTimeDialog Player PowerGauge SpectrumGauge SplashActivity SurfaceRunner TableFetcher TableProvider TableSchema TextGauge TextInputDialog TextInputDialog.OnOkLTimeZoneActivity WaveformGauge WebBasedData WebFetcher WebFetcher.FetchExceWebFetcher.Listener YesNoDialog YesNoDialog.OnOkListe

Constructor Detail

SurfaceRunner

public SurfaceRunner(Context app)



SurfaceRunner

public SurfaceRunner(Context app, int options)


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

SurfaceRunner

public SurfaceRunner(Context app, AttributeSet attrs)


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

Method Detail

optionSet



Parameters:option - The option flag to test; one of SURFACE_XXX.


setDelay

public void setDelay(long delay)

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 usingpostUpdate(), just set a large delay. You may want to consider using1000 -- i.e. one second -- to make sure you get a refresh at a decentinterval.

surfaceCreated

public void surfaceCreated(SurfaceHolder holder)

This is called immediately after the surface is first created. Implementations ofthis should start up whatever rendering code they desire. Note that only onethread can ever draw into a Surface, so you should not draw into the Surfacehere 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) havebeen made to the surface. This method is always called at least once, aftersurfaceCreated(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 fromthis call, you should no longer try to access this surface. If you have arendering thread that directly accesses the surface, you must ensure thatthread is no longer touching the Surface before returning from this function.

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

onStart

SurfaceRunner


public void onStart()

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

onResume

public void onResume()

We're resuming the app. Applications must call this from theirActivity.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, forexample 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, forexample 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 theirActivity.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:

SurfaceRunner


hasWindowFocus - True iff we have focus.

postUpdate

public void postUpdate()

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

appStart

protected abstract void appStart()


appSize

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

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


animStart

protected abstract void animStart()



animStop

protected abstract void animStop()



appStop

protected abstract void appStop()

SurfaceRunner



doUpdate

protected abstract void doUpdate(long now)


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

doDraw() will always be called after this method is called; however, theconverse 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 ratherthan frames.

Parameters:now - Current time in ms.

doDraw

protected abstract void doDraw(Canvas canvas, long now)


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

This method will always be called after a call to doUpdate(), and also when thescreen 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.


getBitmap

public Bitmap getBitmap()

SurfaceRunner


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


getBitmap

public Bitmap getBitmap(int w, int h)

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

Parameters:w - Desired width in pixels.h - Desired height in pixels.


onSurfaceThread

public boolean onSurfaceThread()

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


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

SurfaceRunner


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

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

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

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

statsCount

public void statsCount(int index, int val)

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

Parameters:index - Index of the stat to bump (its index in the "labels" argument tostatsCreate(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 specificactivities; the average of the recorded values will be displayed.

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


SurfaceRunner


Uses of Class org.hermit.android.core.AppUtils.Version

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/core/class-use/AppUtils.Version.html[2/19/2011 9:13:46 AM]


Uses of Classorg.hermit.android.core.AppUtils.Version

Packages that use AppUtils.Versionorg.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()



AppUtils.Version

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/core/AppUtils.Version.html[2/19/2011 9:13:48 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.ActivityListMultistateImageButton OneTimeDialog Player PowerGauge SpectrumGauge


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


public class AppUtils.Versionextends java.lang.Object


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 SummaryAppUtils.Version()

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

Field Detail

appName

public java.lang.CharSequence appName

AppUtils.Version

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

SplashActivity SurfaceRunner TableFetcher TableProvider TableSchema TextGauge TextInputDialog TextInputDialog.OnOkLTimeZoneActivity WaveformGauge WebBasedData WebFetcher WebFetcher.FetchExceWebFetcher.Listener YesNoDialog YesNoDialog.OnOkListe

Application's pretty name. null if unknown.

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()


Uses of Class org.hermit.android.instruments.AudioAnalyser

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/instruments/class-use/AudioAnalyser.html[2/19/2011 9:13:50 AM]


Uses of Classorg.hermit.android.instruments.AudioAnalyser

No usage of org.hermit.android.instruments.AudioAnalyser


AudioAnalyser

http://moonblink.googlecode.com/.../trunk/HermitAndroid/doc/index.html?org/hermit/android/instruments/AudioAnalyser.html[2/19/2011 9:13:52 AM]

All Classes



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

public class AudioAnalyserextends Instrument



Constructor SummaryAudioAnalyser(SurfaceRunner parent) Create a WindMeter instance.



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()





Save the state of the game in the provided Bundle. void setAverageLen(int len)


AudioAnalyser


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.ActivityListMultistateImageButton OneTimeDialog Player PowerGauge SpectrumGauge SplashActivity

void setBlockSize(int size) Set the input block size for this instrument.

void setDecimation(int rate) Set the decimation rate for this instrument.


void setWindowFunc(org.hermit.dsp.Window.Function func) Set the spectrum analyser windowing function for thisinstrument.

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


Constructor Detail

AudioAnalyser

public AudioAnalyser(SurfaceRunner parent)

Create a WindMeter instance.


Method Detail

setSampleRate




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 thespectrum.

AudioAnalyser


SurfaceRunner TableFetcher TableProvider TableSchema TextGauge TextInputDialog TextInputDialog.OnOkLTimeZoneActivity WaveformGauge WebBasedData WebFetcher WebFetcher.FetchExceWebFetcher.Listener YesNoDialog YesNoDialog.OnOkListe

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 beprocessed.

setAverageLen

public void setAverageLen(int len)


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

appStart



Overrides:appStart in class Instrument

measureStart



Overrides:measureStart in class Instrument

AudioAnalyser


measureStop



Overrides:measureStop in class Instrument

appStop



Overrides:appStop in class Instrument

getWaveformGauge

public WaveformGauge getWaveformGauge(SurfaceRunner surface)




getSpectrumGauge

public SpectrumGauge getSpectrumGauge(SurfaceRunner surface)




getPowerGauge

public PowerGauge getPowerGauge(SurfaceRunner surface)



Returns:A gauge which will display the signal power in a dB meter.

AudioAnalyser


doUpdate

public final void doUpdate(long now)

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

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

Overrides:doUpdate in class Instrument


saveState



Overrides:saveState in class Instrument


restoreState



Overrides:restoreState in class Instrument



Uses of Class org.hermit.android.instruments.Instrument

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/instruments/class-use/Instrument.html[2/19/2011 9:13:54 AM]


Uses of Classorg.hermit.android.instruments.Instrument

Packages that use Instrumentorg.hermit.android.instruments

Uses of Instrument in org.hermit.android.instruments

Subclasses of Instrument in org.hermit.android.instruments class AudioAnalyser


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.


Instrument

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

All Classes


All Classes AppUtils AppUtils.Detail AudioAnalyser AudioReader AudioReader.Listener CachedFile CachedFile.Entry DatabaseHelper DbSchema


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

Direct Known Subclasses:AudioAnalyser

public class Instrumentextends 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 SummaryInstrument(SurfaceRunner parent) Set up this view.




void doUpdate(long now) Update the state of the instrument for the current frame.


Get the app context of this Element. void measureStart()





Save the state of the game in the provided Bundle. Methods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString,wait, wait, wait

Instrument


Effect ErrorDialog Errors FileFetcher Gauge HelpActivity HScrollView InfoBox Instrument InstrumentSurface LinedEditText MainActivity MainActivity.ActivityListMultistateImageButton OneTimeDialog Player PowerGauge SpectrumGauge SplashActivity SurfaceRunner TableFetcher TableProvider TableSchema TextGauge TextInputDialog TextInputDialog.OnOkLTimeZoneActivity WaveformGauge WebBasedData WebFetcher WebFetcher.FetchExceWebFetcher.Listener YesNoDialog YesNoDialog.OnOkListe

Constructor Detail

Instrument

public Instrument(SurfaceRunner parent)

Set up this view.


Method Detail

appStart


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

measureStart



measureStop



appStop



doUpdate


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.


Instrument


getSurface




saveState




restoreState





Uses of Class org.hermit.android.core.AppUtils

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


Uses of Classorg.hermit.android.core.AppUtils

Packages that use AppUtilsorg.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 AppUtilsstatic AppUtils AppUtils.getInstance(Activity parent)



AppUtils

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/core/AppUtils.html[2/19/2011 9:14:01 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.ActivityListenMultistateImageButton OneTimeDialog Player PowerGauge SpectrumGauge SplashActivity SurfaceRunner


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

public class AppUtilsextends java.lang.Object

This class provides some simple application-related utilities.

Nested Class Summarystatic class AppUtils.Detail

Version info detail level. class AppUtils.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 currentapp's package, in a simple format.

java.lang.String getVersionString(AppUtils.Detail detail) Get a string containing the name and version info for the currentapp's package.

Methods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait,wait, wait

Method Detail

getInstance

public static AppUtils getInstance(Activity parent)


Parameters:parent - Activity for which we want information.

Returns:The application utilities instance for this app.

AppUtils

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

TableFetcher TableProvider TableSchema TextGauge TextInputDialog TextInputDialog.OnOkListTimeZoneActivity WaveformGauge WebBasedData WebFetcher WebFetcher.FetchExceptiWebFetcher.Listener YesNoDialog YesNoDialog.OnOkListen

getAppVersion

public AppUtils.Version getAppVersion()


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 asimple format.


getVersionString

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


Parameters:detail - How much detail we want.



Uses of Package org.hermit.android.core

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


Uses of Packageorg.hermit.android.core

Packages that use org.hermit.android.coreorg.hermit.android.core A library of foundation classes for Android applications.


Classes in org.hermit.android.core used byorg.hermit.android.coreAppUtils This class provides some simple application-related utilities.

AppUtils.Detail Version info detail level.

AppUtils.Version Information on an application version.



Classes in org.hermit.android.core used byorg.hermit.android.instrumentsSurfaceRunner Common base for applications with an animated view.



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

All Classes



Overview Package Class Use Tree Deprecated Index Help PREV PACKAGE NEXT PACKAGE FRAMES NO FRAMES

Package org.hermit.android.core


See: Description

Class SummaryAppUtils This class provides some simple application-

related utilities.


HelpActivity An activity which displays an application's help, ina structured format.

MainActivity An enhanced Activity class, for use as the mainactivity of an application.

MainActivity.ActivityListener This interface defines a listener for sub-activityresults.

OneTimeDialog A class which handles showing one-off notices.

SplashActivity An activity which displays a splash screen andthen returns to the calling activity.

SurfaceRunner Common base for applications with an animatedview.

Enum SummaryAppUtils.Detail Version info detail level.

Package org.hermit.android.core Description




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

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/core/class-use/AppUtils.Detail.html[2/19/2011 9:14:09 AM]


Uses of Classorg.hermit.android.core.AppUtils.Detail

Packages that use AppUtils.Detailorg.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.Detailstatic 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 orderthey are declared.

Methods in org.hermit.android.core with parameters of type AppUtils.Detail java.lang.String AppUtils.getVersionString(AppUtils.Detail detail)



AppUtils.Detail

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/core/AppUtils.Detail.html[2/19/2011 9:14:12 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

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

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

All Implemented Interfaces:java.io.Serializable, java.lang.Comparable<AppUtils.Detail>


public static enum AppUtils.Detailextends java.lang.Enum<AppUtils.Detail>

Version info detail level.

Enum Constant SummaryDEBUG Show debug-level detail.

NONE Do not display.

SIMPLE Show basic name and version.

Method Summarystatic AppUtils.Detail valueOf(java.lang.String name)

Returns the enum constant of this type with thespecified name.

static AppUtils.Detail[] values() Returns an array containing the constants of thisenum type, in the order they are declared.

Methods inherited from class java.lang.Enumclone, compareTo, equals, finalize, getDeclaringClass, hashCode, name,ordinal, toString, valueOf

Methods inherited from class java.lang.ObjectgetClass, notify, notifyAll, wait, wait, wait

AppUtils.Detail


InstrumentSurface LinedEditText MainActivity MainActivity.ActivityListMultistateImageButton OneTimeDialog Player PowerGauge SpectrumGauge SplashActivity SurfaceRunner TableFetcher TableProvider TableSchema TextGauge TextInputDialog TextInputDialog.OnOkLTimeZoneActivity WaveformGauge WebBasedData WebFetcher WebFetcher.FetchExceWebFetcher.Listener YesNoDialog YesNoDialog.OnOkListe

Enum Constant 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 theyare declared. This method may be used to iterate over the constants asfollows:

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 aredeclared

valueOf

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

Returns the enum constant of this type with the specified name. The stringmust 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 constantwith the specified name

Uses of Package org.hermit.android.instruments

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


Uses of Packageorg.hermit.android.instruments

Packages that use org.hermit.android.instrumentsorg.hermit.android.instruments

Classes in org.hermit.android.instruments used byorg.hermit.android.instrumentsGauge 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 bedisplayed 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.



http://moonblink.googlecode.com/...k/HermitAndroid/doc/index.html?org/hermit/android/instruments/package-summary.html[2/19/2011 9:14:16 AM]

All Classes




Package org.hermit.android.instruments

Class SummaryAudioAnalyser An Instrument which analyses an audio stream in various

ways.

Gauge A graphical display which shows some data in a region withina view.

InstrumentAn instrument which measures some quantity, or accesses orproduces some data, which can be displayed on one or moreGauge objects.

InstrumentSurface Common base for applications which display instruments.

PowerGauge A graphical display which displays the signal power in dBfrom an AudioAnalyser instrument.

SpectrumGauge A graphical display which displays the audio spectrum froman AudioAnalyser instrument.

TextGauge A Gauge which displays data in textual form, generally as agrid of numeric values.

WaveformGauge A graphical display which displays the audio waveform froman AudioAnalyser instrument.



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

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/io/class-use/AudioReader.html[2/19/2011 9:14:18 AM]


Uses of Classorg.hermit.android.io.AudioReader

No usage of org.hermit.android.io.AudioReader


AudioReader

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/io/AudioReader.html[2/19/2011 9:14:20 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.ActivityListMultistateImageButton OneTimeDialog Player PowerGauge SpectrumGauge SplashActivity SurfaceRunner


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

public class AudioReaderextends java.lang.Object

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


Nested Class Summarystatic class AudioReader.Listener


Constructor SummaryAudioReader() 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.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString,wait, wait, wait

Constructor Detail

AudioReader

public AudioReader()

Create an AudioReader instance.

AudioReader

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

TableFetcher TableProvider TableSchema TextGauge TextInputDialog TextInputDialog.OnOkLTimeZoneActivity WaveformGauge WebBasedData WebFetcher WebFetcher.FetchExceWebFetcher.Listener YesNoDialog YesNoDialog.OnOkListe

Method Detail

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 differentfrom the system audio buffer size.listener - Listener to be notified on each completed read.

stopReader

public void stopReader()

Start this reader.


Uses of Package org.hermit.android.io

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


Uses of Packageorg.hermit.android.io

Packages that use org.hermit.android.ioorg.hermit.android.io

Classes in org.hermit.android.io used by org.hermit.android.ioAudioReader.Listener Listener for audio reads.



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

All Classes




Package org.hermit.android.io

Class SummaryAudioReader A class which reads audio input from the mic in a

background thread and passes it to the caller when ready.

AudioReader.Listener Listener for audio reads.



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

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/io/class-use/AudioReader.Listener.html[2/19/2011 9:14:27 AM]


Uses of Classorg.hermit.android.io.AudioReader.Listener

Packages that use AudioReader.Listenerorg.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.



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

All Classes




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

Enclosing class:AudioReader

public abstract static class AudioReader.Listenerextends java.lang.Object


Field Summarystatic 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


Constructor SummaryAudioReader.Listener()

Method Summaryabstract

void onReadComplete(short[] buffer) An audio read has completed.

abstract void onReadError(int error)

An error has occurred. Methods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString,wait, wait, wait

Field Detail

ERR_OK




public static final int ERR_OK

Audio read error code: no error.


ERR_INIT_FAILED

public static final int ERR_INIT_FAILED

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


ERR_READ_FAILED

public static final int ERR_READ_FAILED



Constructor Detail


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.


Uses of Package org.hermit.android.net

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


Uses of Packageorg.hermit.android.net

Packages that use org.hermit.android.netorg.hermit.android.net

Classes in org.hermit.android.net used byorg.hermit.android.netCachedFile.Entry Class describing an entry in the cache; i.e.


WebFetcher.FetchException Web fetching exception.

WebFetcher.Listener Listener for incoming web data.



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

All Classes





Interface SummaryWebFetcher.Listener Listener for incoming web data.

Class SummaryCachedFile 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 itlocally.

TableFetcher Concrete instance of WebFetcher which fetches tabular datafrom the web.

WebBasedData This class implements a web-based source of data, which iscached in a local database.

WebFetcher This class fetches data from the web without blocking the mainapp.

Exception SummaryWebFetcher.FetchException Web fetching exception.



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

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


Uses of Packageorg.hermit.android.notice

Packages that use org.hermit.android.noticeorg.hermit.android.notice

Classes in org.hermit.android.notice used byorg.hermit.android.noticeTextInputDialog.OnOkListener Listener invoked when the user clicks the OK button.




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

All Classes




Package org.hermit.android.notice

Interface SummaryTextInputDialog.OnOkListener Listener invoked when the user clicks the OK

button.

YesNoDialog.OnOkListener Listener invoked when the user clicks the OKbutton.

Class SummaryErrorDialog This class implements a popup error box (a subclass of

AlertDialog) which can be used to display an error message.

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

TextInputDialogThis class implements a popup input box (a subclass ofAlertDialog) which can be used to display a prompt and read atext string from the user.

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



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

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


Uses of Packageorg.hermit.android.provider

Packages that use org.hermit.android.providerorg.hermit.android.provider A library of classes to facilitate the creating of table-based content

providers.

Classes in org.hermit.android.provider used byorg.hermit.android.providerDatabaseHelper This class helps open, create, and upgrade the database file.





http://moonblink.googlecode.com/...trunk/HermitAndroid/doc/index.html?org/hermit/android/provider/package-summary.html[2/19/2011 9:14:44 AM]

All Classes


All Classes AppUtils AppUtils.Detail AudioAnalyser AudioReader


Package org.hermit.android.provider

A library of classes to facilitate the creating of table-based content providers.

See: Description

Class SummaryDatabaseHelper This class helps open, create, and upgrade the database file.


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

TableSchema Class encapsulating the schema for a table within a contentprovider.

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 minimumamount of code, while still retaining reasonable flexibility to implement custombehaviour.

Simple Usage

The basic usage model is this:

Create a subclass of DbSchema to define the schema of your content provider'sdatabase. Use inner classes which are subclasses of TableSchema to define thetables.Create a subclass of TableProvider to implement the content provider. In manycases this class will consist only of a constructor which passes the schema tothe 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 existingdatabase, and creating a fresh one. This is something that many applications willwish to improve on, and you can do this by providing a custom subclass ofDatabaseHelper.

To do this, first create your helper subclass. Override



AudioReader.Listener CachedFile CachedFile.Entry DatabaseHelper DbSchema Effect ErrorDialog Errors FileFetcher Gauge HelpActivity HScrollView InfoBox Instrument InstrumentSurface LinedEditText MainActivity MainActivity.ActivityListMultistateImageButton OneTimeDialog Player PowerGauge SpectrumGauge SplashActivity SurfaceRunner TableFetcher TableProvider TableSchema TextGauge TextInputDialog TextInputDialog.OnOkLTimeZoneActivity WaveformGauge WebBasedData WebFetcher WebFetcher.FetchExceWebFetcher.Listener YesNoDialog YesNoDialog.OnOkListe

DatabaseHelper.onUpgrade(SQLiteDatabase, int, int) and any other methods youneed. Then, in your TableProvider subclass, override TableProvider.getHelper() toreturn an instance of your database helper.

Example

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

First, the schema definition:


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. */ 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:


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" />


Uses of Package org.hermit.android.sound

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


Uses of Packageorg.hermit.android.sound

Packages that use org.hermit.android.soundorg.hermit.android.sound These classes provide functions to help apps manage their sound effects.

Classes in org.hermit.android.sound used byorg.hermit.android.soundEffect Class representing a specific sound effect.



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

All Classes




Package org.hermit.android.sound


See: Description

Class SummaryEffect Class representing a specific sound effect.

Player Main sound effects player class.

Package org.hermit.android.sound Description




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

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


Uses of Packageorg.hermit.android.widgets

No usage of org.hermit.android.widgets



http://moonblink.googlecode.com/.../trunk/HermitAndroid/doc/index.html?org/hermit/android/widgets/package-summary.html[2/19/2011 9:14:53 AM]

All Classes




Package org.hermit.android.widgets

Class Summary

HScrollViewLayout container for a view hierarchy that can bescrolled by the user, allowing it to be larger than thephysical display.

LinedEditText A custom EditText that draws lines between each line oftext that is displayed.

MultistateImageButton This class displays an image button which toggles orcycles through multiple states when clicked.

TimeZoneActivity This class displays a picker which can be used to selecta timezone.



http://moonblink.googlecode.com/.../trunk/HermitAndroid/doc/index.html?org/hermit/android/widgets/package-summary.html[2/19/2011 9:14:53 AM]



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

All Classes




Hierarchy For Package org.hermit.android.core


Class Hierarchy




org.hermit.android.core.HelpActivityorg.hermit.android.core.AppUtilsorg.hermit.android.core.AppUtils.Versionorg.hermit.android.core.Errorsorg.hermit.android.core.MainActivity.ActivityListenerorg.hermit.android.core.OneTimeDialogSurfaceView

org.hermit.android.core.SurfaceRunner

Enum Hierarchy

java.lang.Objectjava.lang.Enum<E> (implements java.lang.Comparable<T>,java.io.Serializable)




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



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

All Classes




Hierarchy For Package org.hermit.android.instruments


Class Hierarchy

java.lang.Objectorg.hermit.android.instruments.Gauge



SurfaceVieworg.hermit.android.core.SurfaceRunner

org.hermit.android.instruments.InstrumentSurface



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

YesNoDialog


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

All Classes




Hierarchy For Package org.hermit.android.io


Class Hierarchy

java.lang.Objectorg.hermit.android.io.AudioReaderorg.hermit.android.io.AudioReader.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]



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

All Classes




Hierarchy For Package org.hermit.android.net


Class Hierarchy

java.lang.Objectorg.hermit.android.net.CachedFile.Entryjava.util.Observable


java.lang.Thread (implements java.lang.Runnable)org.hermit.android.net.WebFetcher

org.hermit.android.net.FileFetcherorg.hermit.android.net.TableFetcher



Interface Hierarchy

org.hermit.android.net.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]



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

All Classes




Hierarchy For Package org.hermit.android.notice


Class Hierarchy

java.lang.ObjectAlertDialog



org.hermit.android.notice.TextInputDialogDialog

org.hermit.android.notice.InfoBox

Interface Hierarchy

org.hermit.android.notice.TextInputDialog.OnOkListenerorg.hermit.android.notice.YesNoDialog.OnOkListener



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



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

All Classes




Hierarchy For Packageorg.hermit.android.provider


Class Hierarchy

java.lang.ObjectContentProvider

org.hermit.android.provider.TableProviderorg.hermit.android.provider.DbSchemaSQLiteOpenHelper

org.hermit.android.provider.DatabaseHelperorg.hermit.android.provider.TableSchema



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



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

All Classes




Hierarchy For Package org.hermit.android.sound


Class Hierarchy

java.lang.Objectorg.hermit.android.sound.Effectorg.hermit.android.sound.Player



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

YesNoDialog


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

All Classes




Hierarchy For Package org.hermit.android.widgets


Class Hierarchy

java.lang.ObjectEditText

org.hermit.android.widgets.LinedEditTextFrameLayout

org.hermit.android.widgets.HScrollViewImageButton

org.hermit.android.widgets.MultistateImageButtonListActivity

org.hermit.android.widgets.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]


Uses of Class org.hermit.android.core.MainActivity

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/core/class-use/MainActivity.html[2/19/2011 9:15:23 AM]


Uses of Classorg.hermit.android.core.MainActivity

No usage of org.hermit.android.core.MainActivity


MainActivity

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

All Classes



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

public class MainActivityextends Activity

An enhanced Activity class, for use as the main activity of an application. The mainthing 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-activitiesand get the results.

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


Nested Class Summarystatic class MainActivity.ActivityListener


Constructor SummaryMainActivity()

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.


Called when an activity you launched exits, giving you therequestCode you started it with, the resultCode it returned, and anyadditional data from it.


Called when the activity is starting. void

MainActivity


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

reportException(java.lang.Exception e) Report an unexpected exception to the user by popping up adialog 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 itfinished.


Constructor Detail

MainActivity

public MainActivity()

Method Detail

onCreate


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 calledwithout any of the rest of the activity lifecycle executing. Derived classes mustcall through to the super class's implementation of this method. If they do not,an exception will be thrown.

Parameters:

MainActivity


MainActivity.ActivityListMultistateImageButton OneTimeDialog Player PowerGauge SpectrumGauge SplashActivity SurfaceRunner TableFetcher TableProvider TableSchema TextGauge TextInputDialog TextInputDialog.OnOkLTimeZoneActivity WaveformGauge WebBasedData WebFetcher WebFetcher.FetchExceWebFetcher.Listener YesNoDialog YesNoDialog.OnOkListe

icicle - If the activity is being re-initialised after previously being shutdown then this Bundle contains the data it most recently supplied inonSaveInstanceState(Bundle). Note: Otherwise it is null.

createEulaBox

public void createEulaBox(int title, int text, int close)

Create a dialog for showing the EULA, or other warnings / disclaimers. Whenyour app starts, call showFirstEula() to display the dialog the first time yourapp 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 createdthe dialog by calling createEulaBox(int, int, int).

showEula

public void showEula()

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

createMessageBox

@Deprecatedpublic 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) andsetLicenseInfo(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().

MainActivity


Parameters:about - Resource ID of the about text.

setHomeInfo

public void setHomeInfo(int link)



setHomeInfo

@Deprecatedpublic void setHomeInfo(int button, int link)

Deprecated.



setLicenseInfo

public void setLicenseInfo(int link)



setLicenseInfo

@Deprecatedpublic void setLicenseInfo(int button, int link)

Deprecated.



showAbout

public void showAbout()

MainActivity


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

reportException


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

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


startActivityForResult

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

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

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

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

onActivityResult


Called when an activity you launched exits, giving you the requestCode youstarted it with, the resultCode it returned, and any additional data from it. TheresultCode 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 tostartActivityForResult(), allowing you to identify who this result camefrom.

MainActivity


resultCode - The integer result code returned by the child activity throughits setResult().data - Additional data to return to the caller.


Uses of Class org.hermit.android.core.SplashActivity

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/core/class-use/SplashActivity.html[2/19/2011 9:15:29 AM]


Uses of Classorg.hermit.android.core.SplashActivity

No usage of org.hermit.android.core.SplashActivity


SplashActivity

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/core/SplashActivity.html[2/19/2011 9:15:33 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.ActivityListenMultistateImageButton OneTimeDialog Player PowerGauge


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

public class SplashActivityextends Activity

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

Field Summarystatic 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 SummarySplashActivity()

Method Summarystatic 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.Objectclone, 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 intwhich specifies the image to display.


SplashActivity

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

SpectrumGauge SplashActivity SurfaceRunner TableFetcher TableProvider TableSchema TextGauge TextInputDialog TextInputDialog.OnOkListTimeZoneActivity WaveformGauge WebBasedData WebFetcher WebFetcher.FetchExceptiWebFetcher.Listener YesNoDialog YesNoDialog.OnOkListen

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 thetime in ms for which the splash screen should be displayed.


Constructor Detail

SplashActivity

public SplashActivity()

Method Detail

onCreate




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.


Uses of Class org.hermit.android.notice.YesNoDialog

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/notice/class-use/YesNoDialog.html[2/19/2011 9:15:34 AM]


Uses of Classorg.hermit.android.notice.YesNoDialog

No usage of org.hermit.android.notice.YesNoDialog


YesNoDialog

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/notice/YesNoDialog.html[2/19/2011 9:15:37 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


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

public class YesNoDialogextends AlertDialog

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

Nested Class Summarystatic interface YesNoDialog.OnOkListener


Constructor SummaryYesNoDialog(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. Methods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString,wait, wait, wait

Constructor Detail

YesNoDialog

YesNoDialog


Instrument InstrumentSurface LinedEditText MainActivity MainActivity.ActivityListMultistateImageButton OneTimeDialog Player PowerGauge SpectrumGauge SplashActivity SurfaceRunner TableFetcher TableProvider TableSchema TextGauge TextInputDialog TextInputDialog.OnOkLTimeZoneActivity WaveformGauge WebBasedData WebFetcher WebFetcher.FetchExceWebFetcher.Listener YesNoDialog YesNoDialog.OnOkListe

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



YesNoDialog

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



Method Detail

setOnOkListener

public void setOnOkListener(YesNoDialog.OnOkListener listener)



show


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


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

YesNoDialog


application layer and opaque.



Uses of Class org.hermit.android.notice.ErrorDialog

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/notice/class-use/ErrorDialog.html[2/19/2011 9:15:39 AM]


Uses of Classorg.hermit.android.notice.ErrorDialog

No usage of org.hermit.android.notice.ErrorDialog


ErrorDialog

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/notice/ErrorDialog.html[2/19/2011 9:15:43 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.ActivityListMultistateImageButton OneTimeDialog Player


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

public class ErrorDialogextends AlertDialog

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

Constructor SummaryErrorDialog(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. Methods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString,wait, wait, wait

Constructor Detail

ErrorDialog

public ErrorDialog(Context parent, int button)


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

ErrorDialog

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

PowerGauge SpectrumGauge SplashActivity SurfaceRunner TableFetcher TableProvider TableSchema TextGauge TextInputDialog TextInputDialog.OnOkLTimeZoneActivity WaveformGauge WebBasedData WebFetcher WebFetcher.FetchExceWebFetcher.Listener YesNoDialog YesNoDialog.OnOkListe

ErrorDialog

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


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

Method Detail

show




show





Uses of Class org.hermit.android.notice.TextInputDialog

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/notice/class-use/TextInputDialog.html[2/19/2011 9:15:45 AM]


Uses of Classorg.hermit.android.notice.TextInputDialog

No usage of org.hermit.android.notice.TextInputDialog


TextInputDialog

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

All Classes


All Classes AppUtils AppUtils.Detail AudioAnalyser AudioReader AudioReader.Listener CachedFile CachedFile.Entry DatabaseHelper DbSchema Effect ErrorDialog Errors


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

public class TextInputDialogextends AlertDialog

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

Nested Class Summarystatic interface TextInputDialog.OnOkListener


Constructor SummaryTextInputDialog(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, java.lang.String dflt)

Start the dialog and display it on screen. Methods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait,wait, wait

Constructor Detail

TextInputDialog

TextInputDialog


FileFetcher Gauge HelpActivity HScrollView InfoBox Instrument InstrumentSurface LinedEditText MainActivity MainActivity.ActivityListenMultistateImageButton OneTimeDialog Player PowerGauge SpectrumGauge SplashActivity SurfaceRunner TableFetcher TableProvider TableSchema TextGauge TextInputDialog TextInputDialog.OnOkListTimeZoneActivity WaveformGauge WebBasedData WebFetcher WebFetcher.FetchExceptiWebFetcher.Listener YesNoDialog YesNoDialog.OnOkListen

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



TextInputDialog

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



Method Detail

setOnOkListener

public void setOnOkListener(TextInputDialog.OnOkListener listener)



show


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


show

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



TextInputDialog


dflt - Default text to display in the input field.

show




show

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




Uses of Class org.hermit.android.net.CachedFile.Entry

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


Uses of Classorg.hermit.android.net.CachedFile.Entry

Packages that use CachedFile.Entryorg.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)



CachedFile.Entry

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/net/CachedFile.Entry.html[2/19/2011 9:15:57 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.ActivityListenMultistateImageButton OneTimeDialog Player PowerGauge SpectrumGauge SplashActivity SurfaceRunner TableFetcher TableProvider TableSchema TextGauge TextInputDialog TextInputDialog.OnOkListTimeZoneActivity


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

Enclosing class:CachedFile

public static final class CachedFile.Entryextends 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 msUTC.

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.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait,wait, wait

Field Detail

url

public final java.net.URL url


name

public java.lang.String name

The local name of the file.

CachedFile.Entry

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

WaveformGauge WebBasedData WebFetcher WebFetcher.FetchExceptionWebFetcher.Listener YesNoDialog YesNoDialog.OnOkListener

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.


Uses of Class org.hermit.android.provider.TableProvider

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/provider/class-use/TableProvider.html[2/19/2011 9:15:59 AM]


Uses of Classorg.hermit.android.provider.TableProvider

No usage of org.hermit.android.provider.TableProvider


TableProvider

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

All Classes



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

public class TableProviderextends ContentProvider

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

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

Constructor SummaryTableProvider(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.


Get the database helper which this content provider willuse.


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 iscalled after TableSchema.onInsert(ContentValues).

Cursor query(Uri uri, java.lang.String[] projection,

TableProvider


All Classes AppUtils AppUtils.Detail AudioAnalyser AudioReader AudioReader.Listener CachedFile CachedFile.Entry DatabaseHelper DbSchema Effect

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.


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



Returns:

TableProvider


ErrorDialog Errors FileFetcher Gauge HelpActivity HScrollView InfoBox Instrument InstrumentSurface LinedEditText MainActivity MainActivity.ActivityListMultistateImageButton OneTimeDialog Player PowerGauge SpectrumGauge SplashActivity SurfaceRunner TableFetcher TableProvider TableSchema TextGauge TextInputDialog TextInputDialog.OnOkLTimeZoneActivity WaveformGauge WebBasedData WebFetcher WebFetcher.FetchExceWebFetcher.Listener YesNoDialog YesNoDialog.OnOkListe

The schema for this database.

getTableSchema

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





getHelper


Get the database helper which this content provider will use.

Subclasses may override this to provide a smarter database helper; forexample, to implement a smarter database upgrade process. SeeDatabaseHelper.

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 withvnd.android.cursor.item/ for a single record, or vnd.android.cursor.dir/ formultiple 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:

TableProvider


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


queryItem



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


queryItem

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


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


queryItems

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

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 columnsare included.where - A selection criteria to apply when filtering rows. If null then allrows are included.whereArgs - You may include ?s in selection, which will be replaced by thevalues from selectionArgs, in order that they appear in the selection. Thevalues will be bound as Strings.sortOrder - How the rows in the cursor should be sorted. If null then theprovider is free to define the sort order.


onInsert

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

This method is called prior to processing an insert; it is called afterTableSchema.onInsert(ContentValues). Subclasses can use this to carry outadditional 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() afterinserting.

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 whenperforming the deletion, allowing the operation to affect multiple rows in adirectory. As a courtesy, call notifyDelete() after deleting. The implementationis responsible for parsing out a row ID at the end of the URI, if a specific row is

TableProvider


being deleted. That is, the client would pass in content://contacts/people/22and the implementation is responsible for parsing the record number (22) whencreating an SQL statement.

Parameters:uri - The full URI to delete, including a row ID (if a specific record is tobe deleted).where - An optional restriction to apply to rows when deleting.whereArgs - You may include ?s in where, which will be replaced by thevalues from whereArgs.


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 willhave their columns listed as the keys in the values map with the values ofthose keys. As a courtesy, call notifyChange() after updating.

Parameters:uri - The URI to update. This can potentially have a record ID if this is anupdate 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 thevalues from whereArgs.



Uses of Class org.hermit.android.provider.DbSchema

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


Uses of Classorg.hermit.android.provider.DbSchema

Packages that use DbSchemaorg.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 DbSchemaprotected DbSchema TableProvider.getSchema()

Get the database schema.protected DbSchema DatabaseHelper.getSchema()


Constructors in org.hermit.android.provider with parameters of type DbSchemaDatabaseHelper(Context context, DbSchema schema) Creater a helper instance.

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


DbSchema

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/provider/DbSchema.html[2/19/2011 9:16:11 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


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

public abstract class DbSchemaextends java.lang.Object

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


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

Constructor Summaryprotected 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.


Constructor Detail

DbSchema

protected DbSchema(java.lang.String name,

DbSchema

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

MainActivity.ActivityListMultistateImageButton OneTimeDialog Player PowerGauge SpectrumGauge SplashActivity SurfaceRunner TableFetcher TableProvider TableSchema TextGauge TextInputDialog TextInputDialog.OnOkLTimeZoneActivity WaveformGauge WebBasedData WebFetcher WebFetcher.FetchExceWebFetcher.Listener YesNoDialog YesNoDialog.OnOkListe

int version, java.lang.String auth, TableSchema[] tables)

Create a database schema instance.

Parameters:name - Name for the database; e.g. "passages".version - Version number of the database. The upgrade process will berun 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






Uses of Class org.hermit.android.notice.InfoBox

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/notice/class-use/InfoBox.html[2/19/2011 9:16:13 AM]


Uses of Classorg.hermit.android.notice.InfoBox

No usage of org.hermit.android.notice.InfoBox


InfoBox

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

All Classes



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

public class InfoBoxextends Dialog

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

Field Summarystatic int BUTTON_1

Select configurable button 1 -- the middle button.static int BUTTON_2


Constructor SummaryInfoBox(Activity parent) Create an info box with a "close" button.

InfoBox(Activity parent, int button) Create an info box.


void linkButtonPressed(int which) Called when a link button is clicked.


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.

InfoBox



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


Field Detail

BUTTON_1




BUTTON_2




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

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 toopen 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)


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

setSubtitle

public void setSubtitle(java.lang.String text)


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

show




show

public void show(int text)


Parameters:

InfoBox


text - Text to display in the dialog.

show




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 tosetLinkButton(int, int, int).


Uses of Class org.hermit.android.widgets.LinedEditText

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


Uses of Classorg.hermit.android.widgets.LinedEditText

No usage of org.hermit.android.widgets.LinedEditText


LinedEditText

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/widgets/LinedEditText.html[2/19/2011 9:16: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.ActivityListMultistateImageButton OneTimeDialog Player PowerGauge SpectrumGauge SplashActivity SurfaceRunner TableFetcher TableProvider TableSchema TextGauge TextInputDialog


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

public class LinedEditTextextends EditText

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

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


void onDraw(Canvas canvas) Overridden onDraw method.


Constructor Detail

LinedEditText

public LinedEditText(Context context, AttributeSet attrs)

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

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

Method Detail

onDraw

LinedEditText

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

TextInputDialog.OnOkListenerTimeZoneActivity WaveformGauge WebBasedData WebFetcher WebFetcher.FetchExceptionWebFetcher.Listener YesNoDialog YesNoDialog.OnOkListener

protected void onDraw(Canvas canvas)

Overridden onDraw method. Draw the text, with lines.



Uses of Class org.hermit.android.sound.Effect

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/sound/class-use/Effect.html[2/19/2011 9:16:23 AM]


Uses of Classorg.hermit.android.sound.Effect

Packages that use Effectorg.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)


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)



Effect

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/sound/Effect.html[2/19/2011 9:16:26 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.ActivityListMultistateImageButton OneTimeDialog Player PowerGauge SpectrumGauge SplashActivity


org.hermit.android.sound Class Effectjava.lang.Object org.hermit.android.sound.Effect

public class Effectextends 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.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString,wait, wait, wait

Method Detail

play

public void play()


play

public void play(float rvol)


Effect

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/sound/Effect.html[2/19/2011 9:16:26 AM]

SurfaceRunner TableFetcher TableProvider TableSchema TextGauge TextInputDialog TextInputDialog.OnOkLTimeZoneActivity WaveformGauge WebBasedData WebFetcher WebFetcher.FetchExceWebFetcher.Listener YesNoDialog YesNoDialog.OnOkListe

Parameters: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.


Uses of Class org.hermit.android.core.Errors

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/core/class-use/Errors.html[2/19/2011 9:16:27 AM]


Uses of Classorg.hermit.android.core.Errors

Packages that use Errorsorg.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 Errorsstatic Errors Errors.getInstance(Context context)

Get the single instance of this class for the given Activity, creating it if necessary.


Errors

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/core/Errors.html[2/19/2011 9:16:31 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.ActivityListMultistateImageButton OneTimeDialog Player PowerGauge SpectrumGauge


org.hermit.android.core Class Errorsjava.lang.Object org.hermit.android.core.Errors

public class Errorsextends java.lang.Object

Error handling and reporting utilities.


Method Summarystatic 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 adialog with some debug info.

void reportException(java.lang.Exception e) Report an unexpected exception to the user by popping up adialog with some debug info.


Method Detail

getInstance

public static Errors getInstance(Context context)

Get the single instance of this class for the given Activity, creating it ifnecessary.

Parameters:context - The Activity for which we want an error reporter.

Returns:The single instance of this class.

Errors

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/core/Errors.html[2/19/2011 9:16:31 AM]

SplashActivity SurfaceRunner TableFetcher TableProvider TableSchema TextGauge TextInputDialog TextInputDialog.OnOkLTimeZoneActivity WaveformGauge WebBasedData WebFetcher WebFetcher.FetchExceWebFetcher.Listener YesNoDialog YesNoDialog.OnOkListe

reportException

public static void reportException(Context context, java.lang.Exception e)



Parameters:context - The Activity for which we want an error reporter.e - The exception.

reportException






Uses of Class org.hermit.android.instruments.Gauge

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/instruments/class-use/Gauge.html[2/19/2011 9:16:33 AM]


Uses of Classorg.hermit.android.instruments.Gauge

Packages that use Gaugeorg.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.


Gauge

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/instruments/Gauge.html[2/19/2011 9:16:36 AM]

All Classes



org.hermit.android.instruments Class Gaugejava.lang.Object org.hermit.android.instruments.Gauge

Direct Known Subclasses:PowerGauge, SpectrumGauge, TextGauge, WaveformGauge

public class Gaugeextends java.lang.Object

A graphical display which shows some data in a region within a view. The data maycome from an Instrument or some other source.

Configuration

Your gauge will be notified of its geometry by a call to setGeometry(Rect). This iswhere you should note your position and size and perform any internal layout youneed 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. onan orientation change). You should be prepared to handle these subsequent calls byre-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 isup to you.

Drawing Sequence -- User

A gauge may have a background which is rendered separately from its content, forperformance reasons. Hence, a Gauge user must request the background to bedrawn, and then the gauge content to be drawn. If the caller is going to cache thebackground, the background need be requested only when the geometry changes.

There are two options. In the non-caching case, the caller may simply calldraw(Canvas, long, boolean), passing true as the last argument. This asks theGauge to draw its background and its content.

In the caching case, the caller should call drawBackground(Canvas) to ask the gaugeto 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 ofthe screen (or you can translate the co-ordinates). Then, to draw the gauge, thecaller should render the stored background and then call draw(Canvas, long,

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, opaquerendition of the gauge, that's all you need; there's no need to provide animplementation of drawBackgroundBody(). But if your gauge has a separate,persistent background appearance, you may reap a performance benefit byseparating out its drawing. Do this by implementing drawBackgroundBody(Canvas,Paint). This routine should draw the gauge background at the gauge's configuredposition in the specified Canvas.

A facility is provided for caching background images. To use this, callcacheBackground() once your layout is set up -- for example at the end ofsetGeometry(Rect). At that point, your background will be fetched (by calling yourimplementation of drawBackgroundBody()) and stored; then when someone asks usto draw our background, the request will be satisfied using the stored bitmap,without calling your drawBackgroundBody() again.

Constructor SummaryGauge(SurfaceRunner parent) Set up this view.



Gauge(SurfaceRunner parent, int options, int grid, int plot) Set up this view.

Method Summaryprotected void cacheBackground()

Fetch and cache an image of the background now, then usethat 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 itsdynamic content.

void drawBackground(Canvas canvas) This method is called to ask the element to draw its staticcontent; i.e.

protected void drawBackgroundBody(Canvas canvas, Paint paint) Do the subclass-specific parts of drawing the background forthis element.

protected void drawBody(Canvas canvas, Paint paint, long now) Do the subclass-specific parts of drawing for this element.


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 aview.

static float getMiniTextSize() Get the size for mini text.


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

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 elementhas 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 aview.

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 toproduce 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.


Constructor Detail

Gauge

public Gauge(SurfaceRunner parent)

Gauge



Set up this view.


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_XXXconstants.

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_XXXconstants.grid - Colour for drawing a data scale / grid.plot - Colour for drawing data plots.

Method Detail

initializePaint


Set up the paint for this element. This is called during initialization. Subclasses

Gauge


can override this to do class-specific one-time initialization.

Parameters:paint - The paint to initialize.

optionSet



Parameters:option - The option flag to test; one of GAUGE_XXX.


setTextTypeface

public static void setTextTypeface(Typeface face)


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.

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()

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, thinfont.

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.

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 thesmall 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 thesmall gaps in side bars.

Returns:The amount of padding within atoms within an element

setGeometry


This is called during layout when the size of this element has changed. This iswhere we first discover our size, so set our geometry to match.


cacheBackground

protected void cacheBackground()

Fetch and cache an image of the background now, then use that to draw thebackground on future draw requests. The cached image is invalidated the nexttime the geometry changes.

Implementations should call this method once their layout is set -- for exampleat the end of setGeometry(Rect) -- if they have a significant static backgroundthat they wish to have cached.

Gauge


getPreferredWidth


Get the minimum preferred width for this atom.

Returns:The minimum preferred width for this atom. Returns zero if we don'tknow yet.

getPreferredHeight


Get the minimum preferred height for this atom.

Returns:The minimum preferred height for this atom. Returns zero if we don'tknow 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 ifsetGeometry() has not been called yet.

getHeight

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 ifsetGeometry() 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.

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.


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. thebackground / chrome.


Gauge


drawBackgroundBody


Do the subclass-specific parts of drawing the background for this element.Subclasses should override this if they have significant background contentwhich they would like to draw once only. Whatever is drawn here will be savedin a bitmap, which will be rendered to the screen before the dynamic content isdrawn.

Obviously, if implementing this method, don't clear the screen when drawingthe dynamic part.


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 - 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 cheaperthan calling drawBackground(Canvas) before this method.

drawStart

protected void drawStart(Canvas canvas, Paint paint, long now)

Do initial parts of drawing for this element.


drawBody


Do the subclass-specific parts of drawing for this element. Subclasses shouldoverride this to do their drawing.

Gauge



drawFinish


Wrap up drawing of this element.


getSurface





Uses of Class org.hermit.android.instruments.PowerGauge

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/instruments/class-use/PowerGauge.html[2/19/2011 9:16:39 AM]


Uses of Classorg.hermit.android.instruments.PowerGauge

Packages that use PowerGaugeorg.hermit.android.instruments

Uses of PowerGauge in org.hermit.android.instruments

Methods in org.hermit.android.instruments that return PowerGauge PowerGauge AudioAnalyser.getPowerGauge(SurfaceRunner surface)



PowerGauge

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/instruments/PowerGauge.html[2/19/2011 9:16:43 AM]

All Classes


All Classes AppUtils AppUtils.Detail AudioAnalyser AudioReader AudioReader.Listener CachedFile CachedFile.Entry DatabaseHelper DbSchema Effect ErrorDialog Errors FileFetcher Gauge HelpActivity


org.hermit.android.instruments Class PowerGaugejava.lang.Object org.hermit.android.instruments.Gauge org.hermit.android.instruments.PowerGauge

public class PowerGaugeextends 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 callingAudioAnalyser.getPowerGauge(SurfaceRunner).


void drawBackgroundBody(Canvas canvas, Paint paint) Do the subclass-specific parts of drawing the background for this element.


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.GaugecacheBackground, 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


Method Detail

setBarWidth

public void setBarWidth(int width)

PowerGauge


HScrollView InfoBox Instrument InstrumentSurface LinedEditText MainActivity MainActivity.ActivityListenMultistateImageButton OneTimeDialog Player PowerGauge SpectrumGauge SplashActivity SurfaceRunner TableFetcher TableProvider TableSchema TextGauge TextInputDialog TextInputDialog.OnOkListTimeZoneActivity WaveformGauge WebBasedData WebFetcher WebFetcher.FetchExceptiWebFetcher.Listener YesNoDialog YesNoDialog.OnOkListen

Set the overall thickness of the bar.

Parameters:width - Overall width in pixels of the bar.

setLabelSize




getLabelSize




setGeometry


This is called during layout when the size of this element has changed. This is wherewe first discover our size, so set our geometry to match.



drawBackgroundBody


Do the subclass-specific parts of drawing the background for this element. Subclassesshould override this if they have significant background content which they would liketo draw once only. Whatever is drawn here will be saved in a bitmap, which will berendered to the screen before the dynamic content is drawn.

Obviously, if implementing this method, don't clear the screen when drawing thedynamic part.

Overrides:drawBackgroundBody in class Gauge


PowerGauge


drawBody


Do the subclass-specific parts of drawing for this element. This method is called on thethread of the containing SuraceView.





Uses of Class org.hermit.android.instruments.SpectrumGauge

http://moonblink.googlecode.com/.../trunk/HermitAndroid/doc/org/hermit/android/instruments/class-use/SpectrumGauge.html[2/19/2011 9:16:45 AM]


Uses of Classorg.hermit.android.instruments.SpectrumGauge

Packages that use SpectrumGaugeorg.hermit.android.instruments

Uses of SpectrumGauge in org.hermit.android.instruments

Methods in org.hermit.android.instruments that return SpectrumGauge SpectrumGauge AudioAnalyser.getSpectrumGauge(SurfaceRunner surface)



SpectrumGauge

http://moonblink.googlecode.com/...runk/HermitAndroid/doc/index.html?org/hermit/android/instruments/SpectrumGauge.html[2/19/2011 9:16:48 AM]

All Classes


All Classes AppUtils AppUtils.Detail AudioAnalyser AudioReader AudioReader.Listener CachedFile CachedFile.Entry DatabaseHelper DbSchema Effect ErrorDialog Errors FileFetcher Gauge HelpActivity HScrollView


org.hermit.android.instruments Class SpectrumGaugejava.lang.Object org.hermit.android.instruments.Gauge org.hermit.android.instruments.SpectrumGauge

public class SpectrumGaugeextends Gauge

A graphical display which displays the audio spectrum from an AudioAnalyserinstrument. This class cannot be instantiated directly; get an instance by callingAudioAnalyser.getSpectrumGauge(SurfaceRunner).



float getLabelSize() Get the size for the label text.

void setGeometry(Rect bounds) This is called during layout when the size of this element haschanged.

void setLabelSize(float size) Set the size for the label text.


Methods inherited from class org.hermit.android.instruments.GaugecacheBackground, 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


Method Detail

SpectrumGauge


InfoBox Instrument InstrumentSurface LinedEditText MainActivity MainActivity.ActivityListMultistateImageButton OneTimeDialog Player PowerGauge SpectrumGauge SplashActivity SurfaceRunner TableFetcher TableProvider TableSchema TextGauge TextInputDialog TextInputDialog.OnOkLTimeZoneActivity WaveformGauge WebBasedData WebFetcher WebFetcher.FetchExceWebFetcher.Listener YesNoDialog YesNoDialog.OnOkListe

setSampleRate




setLabelSize




getLabelSize




setGeometry





drawBody


Do the subclass-specific parts of drawing for this element. This method is calledon the thread of the containing SuraceView.


Overrides:

SpectrumGauge


drawBody in class Gauge



Uses of Class org.hermit.android.instruments.TextGauge

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/instruments/class-use/TextGauge.html[2/19/2011 9:16:51 AM]


Uses of Classorg.hermit.android.instruments.TextGauge

No usage of org.hermit.android.instruments.TextGauge


TextGauge

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/instruments/TextGauge.html[2/19/2011 9:16:54 AM]

All Classes



org.hermit.android.instruments Class TextGaugejava.lang.Object org.hermit.android.instruments.Gauge org.hermit.android.instruments.TextGauge

public class TextGaugeextends Gauge

A Gauge which displays data in textual form, generally as a grid of numeric values.

Constructor SummaryTextGauge(SurfaceRunner parent) Set up this view, and configure the text fields to be displayed in thiselement.

TextGauge(SurfaceRunner parent, java.lang.String[] template, int rows) Set up this view, and configure the text fields to be displayed in thiselement.


void drawBody(Canvas canvas, Paint paint, long now) 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.


Set up the paint for this element. void setGeometry(Rect bounds)

This is called during layout when the size of this element haschanged.

void setMargins(int left, int top, int right, int bottom) Set the margins around the displayed text.

void setTextColor(int col)

TextGauge


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.ActivityListMultistateImageButton OneTimeDialog

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. void setTextSize(float size)

Set the text size of this element. Methods inherited from class org.hermit.android.instruments.GaugecacheBackground, 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


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. Wesupport display of a single field, or a rectangular table of fields. The caller mustcall setTextFields(String[] template, int rows) to set the table format.


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. Wesupport display of a single field, or a rectangular table of fields. The fields arespecified by passing in sample text values to be measured; we then allocatethe space automatically.

Parameters:parent - Parent surface.template - Strings representing the columns to display. Each one shouldbe a sample piece of text which will be measured to determine therequired space for each column. Must be provided.rows - Number of rows of text to display.

TextGauge


Player PowerGauge SpectrumGauge SplashActivity SurfaceRunner TableFetcher TableProvider TableSchema TextGauge TextInputDialog TextInputDialog.OnOkLTimeZoneActivity WaveformGauge WebBasedData WebFetcher WebFetcher.FetchExceWebFetcher.Listener YesNoDialog YesNoDialog.OnOkListe

Method Detail

initializePaint


Set up the paint for this element. This is called during initialisation. Subclassescan override this to do class-specific one-time initialisation.

Overrides:initializePaint in class Gauge

Parameters:paint - The paint to initialise.

setGeometry





setMargins

public void setMargins(int left, int top, int right, int bottom)

Set the margins around the displayed text. This the total space between theedges 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 tableof fields. The fields are specified by passing in sample text values to bemeasured; we then allocate the space automatically. This must be called before

TextGauge


setText() can be called.

Parameters:template - Strings representing the columns to display. Each one shouldbe a sample piece of text which will be measured to determine therequired space for each column.rows - Number of rows of text to display.

getBuffer

public char[][][] getBuffer()

Get the text buffers for the field values. The caller can change a field's contentby writing to the appropriate member of the array, as in "buffer[row][col][0] ='X';".

Returns:Text buffers for the field values.

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 ifsetTextFields() hasn't been called.

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 ifsetTextFields() hasn't been called.

setTextColor

public void setTextColor(int col)

Set the text colour of this element.

Parameters:

TextGauge


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.

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






TextGauge


Uses of Class org.hermit.android.instruments.WaveformGauge

http://moonblink.googlecode.com/...trunk/HermitAndroid/doc/org/hermit/android/instruments/class-use/WaveformGauge.html[2/19/2011 9:16:56 AM]


Uses of Classorg.hermit.android.instruments.WaveformGauge

Packages that use WaveformGaugeorg.hermit.android.instruments

Uses of WaveformGauge in org.hermit.android.instruments

Methods in org.hermit.android.instruments that return WaveformGauge WaveformGauge AudioAnalyser.getWaveformGauge(SurfaceRunner surface)



WaveformGauge

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/instruments/WaveformGauge.html[2/19/2011 9:16:58 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.ActivityListenMultistateImageButton OneTimeDialog Player PowerGauge SpectrumGauge SplashActivity SurfaceRunner TableFetcher TableProvider TableSchema TextGauge TextInputDialog


org.hermit.android.instruments Class WaveformGaugejava.lang.Object org.hermit.android.instruments.Gauge org.hermit.android.instruments.WaveformGauge

public class WaveformGaugeextends Gauge

A graphical display which displays the audio waveform from an AudioAnalyser instrument.This class cannot be instantiated directly; get an instance by callingAudioAnalyser.getWaveformGauge(SurfaceRunner).




Methods inherited from class org.hermit.android.instruments.GaugecacheBackground, 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


Method Detail

setGeometry


This is called during layout when the size of this element has changed. This is wherewe first discover our size, so set our geometry to match.



WaveformGauge

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/instruments/WaveformGauge.html[2/19/2011 9:16:58 AM]


drawBody


Do the subclass-specific parts of drawing for this element. This method is called on thethread of the containing SuraceView.





Uses of Class org.hermit.android.widgets.MultistateImageButton

http://moonblink.googlecode.com/...unk/HermitAndroid/doc/org/hermit/android/widgets/class-use/MultistateImageButton.html[2/19/2011 9:17:01 AM]


Uses of Classorg.hermit.android.widgets.MultistateImageButton

No usage of org.hermit.android.widgets.MultistateImageButton



http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/widgets/MultistateImageButton.html[2/19/2011 9:17:06 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.ActivityListenMultistateImageButton OneTimeDialog Player


org.hermit.android.widgets Class MultistateImageButtonjava.lang.Object ImageButton org.hermit.android.widgets.MultistateImageButton

public class MultistateImageButtonextends ImageButton

This class displays an image button which toggles or cycles through multiple states whenclicked.

Constructor SummaryMultistateImageButton(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.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait,wait, wait

Constructor Detail


public MultistateImageButton(Context context, int[] images)


Parameters:context - Parent application.images - Resource IDs of the images to use for each state.



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

PowerGauge SpectrumGauge SplashActivity SurfaceRunner TableFetcher TableProvider TableSchema TextGauge TextInputDialog TextInputDialog.OnOkListTimeZoneActivity WaveformGauge WebBasedData WebFetcher WebFetcher.FetchExceptiWebFetcher.Listener YesNoDialog YesNoDialog.OnOkListen

public MultistateImageButton(Context context, AttributeSet attrs, int[] images)


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'slistener 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.


Uses of Class org.hermit.android.widgets.TimeZoneActivity

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/widgets/class-use/TimeZoneActivity.html[2/19/2011 9:17:08 AM]


Uses of Classorg.hermit.android.widgets.TimeZoneActivity

No usage of org.hermit.android.widgets.TimeZoneActivity


TimeZoneActivity

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/widgets/TimeZoneActivity.html[2/19/2011 9:17:14 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.ActivityListenMultistateImageButton OneTimeDialog Player PowerGauge SpectrumGauge SplashActivity SurfaceRunner TableFetcher TableProvider TableSchema TextGauge TextInputDialog


org.hermit.android.widgets Class TimeZoneActivityjava.lang.Object ListActivity org.hermit.android.widgets.TimeZoneActivity

public class TimeZoneActivityextends ListActivity

This class displays a picker which can be used to select a timezone. Options are provided toadd app-specific zones, such as "local", "nautical", etc.

Constructor SummaryTimeZoneActivity()



void onListItemClick(ListView l, View v, int position, long id) This method will be called when an item in the list is selected.


Constructor Detail

TimeZoneActivity

public TimeZoneActivity()

Method Detail

onCreate



Parameters:icicle - If the activity is being re-initialized after previously being shut downthen this Bundle contains the data it most recently supplied inonSaveInstanceState(Bundle). Note: Otherwise it is null.

TimeZoneActivity

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/widgets/TimeZoneActivity.html[2/19/2011 9:17:14 AM]


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 callgetListView().getItemAtPosition(position) if they need to access the data associatedwith 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.


Uses of Class org.hermit.android.core.MainActivity.ActivityListener

http://moonblink.googlecode.com/...k/HermitAndroid/doc/org/hermit/android/core/class-use/MainActivity.ActivityListener.html[2/19/2011 9:17:17 AM]


Uses of Classorg.hermit.android.core.MainActivity.ActivityListener

Packages that use MainActivity.ActivityListenerorg.hermit.android.core A library of foundation classes for Android applications.

Uses of MainActivity.ActivityListener inorg.hermit.android.core

Methods in org.hermit.android.core with parameters of type MainActivity.ActivityListener void MainActivity.startActivityForResult(Intent intent, MainActivity.ActivityListener listener)

Launch an activity for which you would like a result when it finished.



http://moonblink.googlecode.com/.../HermitAndroid/doc/index.html?org/hermit/android/core/MainActivity.ActivityListener.html[2/19/2011 9:17:22 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


org.hermit.android.core Class MainActivity.ActivityListenerjava.lang.Object org.hermit.android.core.MainActivity.ActivityListener

Enclosing class:MainActivity

public abstract static class MainActivity.ActivityListenerextends java.lang.Object


Constructor SummaryMainActivity.ActivityListener()

Method Summary void onActivityCanceled(Intent data)

Called when an activity you launched exits with a result code ofRESULT_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 otherthan RESULT_CANCELED, giving you the resultCode it returned, and anyadditional data from it.


Constructor Detail


public MainActivity.ActivityListener()

Method Detail



MainActivity MainActivity.ActivityListMultistateImageButton OneTimeDialog Player PowerGauge SpectrumGauge SplashActivity SurfaceRunner TableFetcher TableProvider TableSchema TextGauge TextInputDialog TextInputDialog.OnOkLTimeZoneActivity WaveformGauge WebBasedData WebFetcher WebFetcher.FetchExceWebFetcher.Listener YesNoDialog YesNoDialog.OnOkListe

onActivityFinished

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, eitherby an error, the user pressing "back", or normally, or whatever. The defaultimplementation calls either onActivityCanceled(), if resultCode ==RESULT_CANCELED, or else onActivityResult().

Parameters:resultCode - The integer result code returned by the child activity throughits 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 ofRESULT_CANCELED. This will happen if the user presses "back", or if theactivity returned that code explicitly, didn't return any result, or crashed duringits operation.

Applications can override this if they want to be separately notified of aRESULT_CANCELED. It doesn't make sense to override bothonActivityFinished() 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 thanRESULT_CANCELED, giving you the resultCode it returned, and any additionaldata from it.

Applications can override this if they want to be separately notified of a normalexit. It doesn't make sense to override both onActivityFinished() and thismethod.

Parameters:resultCode - The integer result code returned by the child activity throughits setResult().data - Additional data returned by the activity.


Uses of Class org.hermit.android.net.CachedFile

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/net/class-use/CachedFile.html[2/19/2011 9:17:23 AM]


Uses of Classorg.hermit.android.net.CachedFile

No usage of org.hermit.android.net.CachedFile


CachedFile

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

All Classes



org.hermit.android.net Class CachedFilejava.lang.Object java.util.Observable org.hermit.android.net.CachedFile


public class CachedFileextends java.util.Observableimplements WebFetcher.Listener

This class manages a set of web-based files and caches them locally. Data about thefiles is held in a local database.

Nested Class Summarystatic class CachedFile.Entry

Class describing an entry in the cache; i.e.

Constructor SummaryCachedFile(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 wascorrupted).

void onWebData(java.net.URL url, java.lang.Object obj,long date) This method is invoked when a data item is retrieved fromthe URL we were invoked on.

void onWebDone() This method is invoked when the given URL has been fullyfetched.


CachedFile




void update(Context context, long now) Check to see whether we need to update our cachedcopies of the files.


Methods inherited from class java.util.ObservableaddObserver, clearChanged, countObservers, deleteObserver, deleteObservers,hasChanged, notifyObservers, notifyObservers, setChanged


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




upgradeTable



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

CachedFile


newV - Version we're upgrading to.

setDatabase




getFile

public CachedFile.Entry getFile(java.net.URL url)


Parameters:url - The URL of the file we want.

Returns:null if the URL is not being cached at all. Otherwise, an Entry containinginfo on the file; path will be non-null if the file has been loaded, and datewill 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 localfiles are kept.now - The current time in millis.

onWebData

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

CachedFile


This method is invoked when a data item is retrieved from the URL we wereinvoked on.


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

onWebDone




onWebError






Uses of Interface org.hermit.android.net.WebFetcher.Listener

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/net/class-use/WebFetcher.Listener.html[2/19/2011 9:17:29 AM]


Uses of Interfaceorg.hermit.android.net.WebFetcher.Listener

Packages that use WebFetcher.Listenerorg.hermit.android.net

Uses of WebFetcher.Listener in org.hermit.android.net

Classes in org.hermit.android.net that implement WebFetcher.Listener class CachedFile

This class manages a set of web-based files and caches them locally. class WebBasedData

This class implements a web-based source of data, which is cached in a local database.

Fields in org.hermit.android.net declared as WebFetcher.Listenerprotected

WebFetcher.Listener WebFetcher.dataClient

Constructors in org.hermit.android.net with parameters of type WebFetcher.ListenerFileFetcher(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.

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.


WebFetcher.Listener

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/net/WebFetcher.Listener.html[2/19/2011 9:17:32 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.ActivityListMultistateImageButton OneTimeDialog Player PowerGauge SpectrumGauge SplashActivity SurfaceRunner TableFetcher TableProvider TableSchema


org.hermit.android.net Interface WebFetcher.Listener

All Known Implementing Classes:CachedFile, WebBasedData


public static interface WebFetcher.Listener


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 theURLs 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 wewere invoked on.

Parameters:url - The URL that this record came from.obj - The object that was loaded; the type depends on the fetcher classused.date - The last modified time of the source file, as reported by the server,in ms UTC.

onWebDone

void ()

WebFetcher.Listener

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/net/WebFetcher.Listener.html[2/19/2011 9:17:32 AM]

TextGauge TextInputDialog TextInputDialog.OnOkListenerTimeZoneActivity WaveformGauge WebBasedData WebFetcher WebFetcher.FetchExceptionWebFetcher.Listener YesNoDialog YesNoDialog.OnOkListener

onWebDone

This method is invoked when the URLs have been fully fetched.

onWebError


This method is invoked if an error occurs when fetching web data.



Uses of Class org.hermit.android.core.OneTimeDialog

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/core/class-use/OneTimeDialog.html[2/19/2011 9:17:34 AM]


Uses of Classorg.hermit.android.core.OneTimeDialog

No usage of org.hermit.android.core.OneTimeDialog


OneTimeDialog

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/core/OneTimeDialog.html[2/19/2011 9:17:37 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.ActivityList


org.hermit.android.core Class OneTimeDialogjava.lang.Object org.hermit.android.core.OneTimeDialog

public class OneTimeDialogextends 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 beshown; most times it doesn't.


Constructor SummaryOneTimeDialog(Activity parent, java.lang.String name, int title, int text,int close) Create a dialog for showing a notice, or other warnings / disclaimers, onceonly.

Method Summaryprotected boolean isAccepted()

Query whether the dialog has been shown to the user andaccepted.

void show() Show the dialog unconditionally.

void showFirst() Show the dialog if this is the first program run.


Constructor Detail

OneTimeDialog

public OneTimeDialog(Activity parent,

OneTimeDialog

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/core/OneTimeDialog.html[2/19/2011 9:17:37 AM]

MultistateImageButton OneTimeDialog Player PowerGauge SpectrumGauge SplashActivity SurfaceRunner TableFetcher TableProvider TableSchema TextGauge TextInputDialog TextInputDialog.OnOkLTimeZoneActivity WaveformGauge WebBasedData WebFetcher WebFetcher.FetchExceWebFetcher.Listener YesNoDialog YesNoDialog.OnOkListe

java.lang.String name, int title, int text, int close)

Create a dialog for showing a notice, or other warnings / disclaimers, onceonly.

When your app starts, call showFirst() to display the dialog the first time yourapp runs. This will actually show it if it hasn't been seen for the current versionof 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 beused 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".


Uses of Class org.hermit.android.provider.DatabaseHelper

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/provider/class-use/DatabaseHelper.html[2/19/2011 9:17:39 AM]


Uses of Classorg.hermit.android.provider.DatabaseHelper

Packages that use DatabaseHelperorg.hermit.android.provider A library of classes to facilitate the creating of table-based content

providers.

Uses of DatabaseHelper in org.hermit.android.provider

Methods in org.hermit.android.provider that return DatabaseHelperprotected

DatabaseHelper TableProvider.getHelper() Get the database helper which this content provider will use.


DatabaseHelper

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/provider/DatabaseHelper.html[2/19/2011 9:17:43 AM]

All Classes




org.hermit.android.provider Class DatabaseHelperjava.lang.Object SQLiteOpenHelper org.hermit.android.provider.DatabaseHelper

public class DatabaseHelperextends 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 adatabase upgrade handler. If you don't wish to override it, nothing need be done. Ifyou wish to subclass it, then create your subclass and overrideTableProvider.getHelper() to return it.

Constructor SummaryDatabaseHelper(Context context, DbSchema schema) Creater a helper instance.

Method Summaryprotected DbSchema getSchema()

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.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString,wait, wait, wait

Constructor Detail

DatabaseHelper

public DatabaseHelper(Context context, DbSchema schema)

Creater a helper instance.

DatabaseHelper



Parameters:context - Application context.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 thecreation of tables and the initial population of the tables should happen.

The default implementation creates all the fields specified in all of the tableschemas. 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 shoulduse this method to drop tables, add tables, or do anything else it needs toupgrade to the new schema version.

The default implementation simply deletes all tables and calls#onOpen(SQLiteDatabase). Subclasses may override this method to do a moreintelligent upgrade.

If you add new columns you can use ALTER TABLE to insert them into a livetable. If you rename or remove columns you can use ALTER TABLE to renamethe old table, then create the new table and then populate the new table withthe contents of the old table.

Parameters:db - The new database.oldVersion - The old database version.newVersion - The new database version.

getSchema




Overview Package Class Use Tree Deprecated Index Help

Uses of Class org.hermit.android.provider.TableSchema

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/provider/class-use/TableSchema.html[2/19/2011 9:17:48 AM]


Uses of Classorg.hermit.android.provider.TableSchema

Packages that use TableSchemaorg.hermit.android.provider A library of classes to facilitate the creating of table-based content

providers.

Uses of TableSchema in org.hermit.android.provider

Methods in org.hermit.android.provider that return TableSchemaprotected

TableSchema DbSchema.getTable(java.lang.String name) Get the schema for a specified table.

protected TableSchema TableProvider.getTableSchema(java.lang.String name)


Methods in org.hermit.android.provider with parameters of type TableSchemaprotected

void TableProvider.onInsert(Uri uri, TableSchema table, ContentValues initValues) This method is called prior to processing an insert; it is called afteronInsert(ContentValues).

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

Query for a specified item within a table.protected Cursor

TableProvider.queryItem(TableSchema t, java.lang.String[] projection,java.lang.String id) Query for a specified item within a table.

protected Cursor

TableProvider.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.

Constructors in org.hermit.android.provider with parameters of type TableSchemaDbSchema(java.lang.String name, int version, java.lang.String auth, TableSchema[] tables) Create a database schema instance.


TableSchema

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/provider/TableSchema.html[2/19/2011 9:17:53 AM]

All Classes


All Classes AppUtils AppUtils.Detail AudioAnalyser AudioReader AudioReader.Listener CachedFile CachedFile.Entry DatabaseHelper DbSchema Effect


org.hermit.android.provider Class TableSchemajava.lang.Object org.hermit.android.provider.TableSchema

public abstract class TableSchemaextends java.lang.Object

Class encapsulating the schema for a table within a content provider. Applications mustsubclass this, and provide the necessary information in the call to this base class'sconstructor.


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 forthe table.For each column in the table, a public static final String field defining thecolumn's database name.A public static final String[] PROJECTION field, defining the default projection forthe table.A constructor which calls this class's constructor, passing the required information.

Constructor Summaryprotected 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 fielddefinitions.

void onInsert(ContentValues values) This method is called when a new row is added into thistable.


TableSchema


ErrorDialog Errors FileFetcher Gauge HelpActivity HScrollView InfoBox Instrument InstrumentSurface LinedEditText MainActivity MainActivity.ActivityListenMultistateImageButton OneTimeDialog Player PowerGauge SpectrumGauge SplashActivity SurfaceRunner TableFetcher TableProvider TableSchema TextGauge TextInputDialog TextInputDialog.OnOkListTimeZoneActivity WaveformGauge WebBasedData WebFetcher WebFetcher.FetchExceptiWebFetcher.Listener YesNoDialog YesNoDialog.OnOkListen

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 andtype. 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 bysubclasses 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 andtype. 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.

Returns:

TableSchema


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 overridethis to fill in any missing values.

Parameters:values - The fields being added.


Uses of Class org.hermit.android.net.WebFetcher

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/net/class-use/WebFetcher.html[2/19/2011 9:17:56 AM]


Uses of Classorg.hermit.android.net.WebFetcher

Packages that use WebFetcherorg.hermit.android.net

Uses of WebFetcher in org.hermit.android.net

Subclasses of WebFetcher in org.hermit.android.net class FileFetcher

Concrete instance of WebFetcher which gets a file and stores it locally. class TableFetcher

Concrete instance of WebFetcher which fetches tabular data from the web.

Methods in org.hermit.android.net with parameters of type WebFetcherstatic void WebFetcher.queue(WebFetcher fetcher)

Queue a web fetch.


WebFetcher

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/net/WebFetcher.html[2/19/2011 9:17:58 AM]

All Classes



org.hermit.android.net Class WebFetcherjava.lang.Object java.lang.Thread org.hermit.android.net.WebFetcher


Direct Known Subclasses:FileFetcher, TableFetcher

public abstract class WebFetcherextends java.lang.Thread

This class fetches data from the web without blocking the main app.

Nested Class Summarystatic class WebFetcher.FetchException

Web fetching exception.static interface WebFetcher.Listener

Listener for incoming web data. Nested classes/interfaces inherited from class java.lang.Threadjava.lang.Thread.State, java.lang.Thread.UncaughtExceptionHandler

Field Summaryprotected

WebFetcher.Listener dataClient

protected java.net.URL[] dataUrls


protected long newerThanDate

protected long timeout


WebFetcher


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

Constructor SummaryWebFetcher(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.


void fetch(java.net.URL url, long newer) Fetch an object from the given URL.

protected void

handle(java.net.URL url, java.net.URLConnection conn,java.io.BufferedReader stream) Handle data from the given BufferedReader.

protected void

handle(java.net.URL url, java.net.URLConnection conn,java.io.InputStream stream) 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.ThreadactiveCount, 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.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait,wait

Field Detail

timeout

protected final long timeout

WebFetcher


MainActivity MainActivity.ActivityListMultistateImageButton OneTimeDialog Player PowerGauge SpectrumGauge SplashActivity SurfaceRunner TableFetcher TableProvider TableSchema TextGauge TextInputDialog TextInputDialog.OnOkLTimeZoneActivity WaveformGauge WebBasedData WebFetcher WebFetcher.FetchExceWebFetcher.Listener YesNoDialog YesNoDialog.OnOkListe

killed


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 fetchedasynchronously from the URL, and passed as it arrives to the given client. Youcan start the fetch when you want by calling start(); or you can pass it toqueue() 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 fetchedasynchronously from the URL, and passed as it arrives to the given client. Youcan start the fetch when you want by calling start(); or you can pass it toqueue() 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

WebFetcher


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)

Create a fetcher to get data from a given list of URLs. Data will be fetchedasynchronously from each URL in sequence, and passed as it arrives to thegiven client. If any URL fails, the whole fetch will be aborted. If all URLssucceed, onWebDone() will be called in the listener. You can start the fetchwhen you want by calling start(); or you can pass it to queue() to be executedwhen 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 carriedout 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()

WebFetcher


Thread's main method. Just fetch the URLs in sequence. If one fails, stopthere.

Specified by:run in interface java.lang.Runnable

Overrides:run in class java.lang.Thread

fetch

protected void fetch(java.net.URL url, 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 carriedout 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 atimeout.java.io.IOException - An I/O error occurred.

handle


Handle data from the given stream.



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.

WebFetcher


Parameters:url - The URL we're reading.conn - The current connection to the URL.stream - The BufferedReader to read from.



Uses of Class org.hermit.android.net.FileFetcher

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/net/class-use/FileFetcher.html[2/19/2011 9:18:00 AM]


Uses of Classorg.hermit.android.net.FileFetcher

No usage of org.hermit.android.net.FileFetcher


FileFetcher

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/net/FileFetcher.html[2/19/2011 9:18:02 AM]

All Classes


All Classes AppUtils AppUtils.Detail AudioAnalyser AudioReader AudioReader.Listener CachedFile CachedFile.Entry DatabaseHelper


org.hermit.android.net Class FileFetcherjava.lang.Object java.lang.Thread org.hermit.android.net.WebFetcher org.hermit.android.net.FileFetcher


public class FileFetcherextends WebFetcher

Concrete instance of WebFetcher which gets a file and stores it locally. The valuepassed back to the listener is the local file name as a File.

Nested Class Summary Nested classes/interfaces inherited from classorg.hermit.android.net.WebFetcherWebFetcher.FetchException, WebFetcher.Listener

Nested classes/interfaces inherited from class java.lang.Threadjava.lang.Thread.State, java.lang.Thread.UncaughtExceptionHandler



Constructor SummaryFileFetcher(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.

FileFetcher


DbSchema Effect ErrorDialog Errors FileFetcher Gauge HelpActivity HScrollView InfoBox Instrument InstrumentSurface LinedEditText MainActivity MainActivity.ActivityListMultistateImageButton OneTimeDialog Player PowerGauge SpectrumGauge SplashActivity SurfaceRunner TableFetcher TableProvider TableSchema TextGauge TextInputDialog TextInputDialog.OnOkLTimeZoneActivity WaveformGauge WebBasedData WebFetcher WebFetcher.FetchExceWebFetcher.Listener YesNoDialog YesNoDialog.OnOkListe


voidhandle(java.net.URL url, java.net.URLConnection conn,java.io.InputStream stream) Fetch a page of data from the given stream.




Constructor Detail

FileFetcher

public FileFetcher(Context context, java.net.URL url, java.lang.String name, WebFetcher.Listener client, long timeout)


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 aFile 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)


FileFetcher


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 aFile object.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 carriedout if the remote resource has been modified since this time. If zero,fetch without this condition.

Method Detail

handle


Fetch a page of data from the given stream.





Uses of Class org.hermit.android.net.TableFetcher

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/org/hermit/android/net/class-use/TableFetcher.html[2/19/2011 9:18:04 AM]


Uses of Classorg.hermit.android.net.TableFetcher

No usage of org.hermit.android.net.TableFetcher


TableFetcher

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/net/TableFetcher.html[2/19/2011 9:18:06 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.ActivityListMultistateImageButton OneTimeDialog


org.hermit.android.net Class TableFetcherjava.lang.Object java.lang.Thread org.hermit.android.net.WebFetcher org.hermit.android.net.TableFetcher


public class TableFetcherextends WebFetcher

Concrete instance of WebFetcher which fetches tabular data from the web. Lines inthe file are parsed into fields and passed to the caller in a ContentValues object.

Nested Class Summary Nested classes/interfaces inherited from classorg.hermit.android.net.WebFetcherWebFetcher.FetchException, WebFetcher.Listener

Nested classes/interfaces inherited from class java.lang.Threadjava.lang.Thread.UncaughtExceptionHandler




voidhandle(java.net.URL url, java.net.URLConnection conn,java.io.BufferedReader readc) Fetch a page of data from the given BufferedReader.


TableFetcher

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/net/TableFetcher.html[2/19/2011 9:18:06 AM]

Player PowerGauge SpectrumGauge SplashActivity SurfaceRunner TableFetcher TableProvider TableSchema TextGauge TextInputDialog TextInputDialog.OnOkLTimeZoneActivity WaveformGauge WebBasedData WebFetcher WebFetcher.FetchExceWebFetcher.Listener YesNoDialog YesNoDialog.OnOkListe



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.


Parameters:url - The URL we're reading.conn - The current connection to the URL.readc - The BufferedReader to read from.



Uses of Class org.hermit.android.net.WebFetcher.FetchException

http://moonblink.googlecode.com/...nk/HermitAndroid/doc/org/hermit/android/net/class-use/WebFetcher.FetchException.html[2/19/2011 9:18:08 AM]


Uses of Classorg.hermit.android.net.WebFetcher.FetchException

Packages that use WebFetcher.FetchExceptionorg.hermit.android.net

Uses of WebFetcher.FetchException in org.hermit.android.net

Methods in org.hermit.android.net that throw WebFetcher.FetchExceptionprotected

void WebFetcher.fetch(java.net.URL url, long newer) Fetch an object from the given URL.

protected void

TableFetcher.handle(java.net.URL url, java.net.URLConnection conn,java.io.BufferedReader readc) Fetch a page of data from the given BufferedReader.

protected void

WebFetcher.handle(java.net.URL url, java.net.URLConnection conn,java.io.BufferedReader stream) Handle data from the given BufferedReader.

protected void

FileFetcher.handle(java.net.URL url, java.net.URLConnection conn,java.io.InputStream stream) Fetch a page of data from the given stream.

protected void

WebFetcher.handle(java.net.URL url, java.net.URLConnection conn,java.io.InputStream stream) Handle data from the given stream.



http://moonblink.googlecode.com/...k/HermitAndroid/doc/index.html?org/hermit/android/net/WebFetcher.FetchException.html[2/19/2011 9:18:11 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.ActivityListMultistateImageButton OneTimeDialog Player PowerGauge SpectrumGauge SplashActivity SurfaceRunner TableFetcher


org.hermit.android.net Class WebFetcher.FetchExceptionjava.lang.Object java.lang.Throwable java.lang.Exception org.hermit.android.net.WebFetcher.FetchException

All Implemented Interfaces:java.io.Serializable


public static class WebFetcher.FetchExceptionextends java.lang.Exception

Web fetching exception. Used to signal a problem while fetching data.

See Also:Serialized Form

Constructor SummaryWebFetcher.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.ThrowablefillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace,initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace,toString


Constructor Detail



http://moonblink.googlecode.com/...k/HermitAndroid/doc/index.html?org/hermit/android/net/WebFetcher.FetchException.html[2/19/2011 9:18:11 AM]

TableProvider TableSchema TextGauge TextInputDialog TextInputDialog.OnOkListenerTimeZoneActivity WaveformGauge WebBasedData WebFetcher WebFetcher.FetchExceptionWebFetcher.Listener YesNoDialog YesNoDialog.OnOkListener

public WebFetcher.FetchException(java.lang.String s)

Create a FetchException with a message.

Parameters:s - The exception message.


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.


Serialized Form

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/serialized-form.html[2/19/2011 9:18:13 AM]


Serialized Form


Class org.hermit.android.net.WebFetcher.FetchExceptionextends java.lang.Exception implements Serializable

serialVersionUID: 4699577452411347104L


Uses of Interface org.hermit.android.notice.TextInputDialog.OnOkListener

http://moonblink.googlecode.com/...ermitAndroid/doc/org/hermit/android/notice/class-use/TextInputDialog.OnOkListener.html[2/19/2011 9:18:14 AM]


Uses of Interfaceorg.hermit.android.notice.TextInputDialog.OnOkListener

Packages that use TextInputDialog.OnOkListenerorg.hermit.android.notice

Uses of TextInputDialog.OnOkListener inorg.hermit.android.notice

Methods in org.hermit.android.notice with parameters of type TextInputDialog.OnOkListener void TextInputDialog.setOnOkListener(TextInputDialog.OnOkListener listener)




http://moonblink.googlecode.com/...mitAndroid/doc/index.html?org/hermit/android/notice/TextInputDialog.OnOkListener.html[2/19/2011 9:18:18 AM]

All Classes




org.hermit.android.notice Interface TextInputDialog.OnOkListener

Enclosing class:TextInputDialog

public static interface TextInputDialog.OnOkListener


Method Summary void onOk(java.lang.CharSequence input)


Method Detail

onOk

void onOk(java.lang.CharSequence input)


Parameters:input - The input text.



http://moonblink.googlecode.com/...mitAndroid/doc/index.html?org/hermit/android/notice/TextInputDialog.OnOkListener.html[2/19/2011 9:18:18 AM]


Uses of Interface org.hermit.android.notice.YesNoDialog.OnOkListener

http://moonblink.googlecode.com/...k/HermitAndroid/doc/org/hermit/android/notice/class-use/YesNoDialog.OnOkListener.html[2/19/2011 9:18:19 AM]


Uses of Interfaceorg.hermit.android.notice.YesNoDialog.OnOkListener

Packages that use YesNoDialog.OnOkListenerorg.hermit.android.notice

Uses of YesNoDialog.OnOkListener inorg.hermit.android.notice

Methods in org.hermit.android.notice with parameters of type YesNoDialog.OnOkListener void YesNoDialog.setOnOkListener(YesNoDialog.OnOkListener listener)




http://moonblink.googlecode.com/...HermitAndroid/doc/index.html?org/hermit/android/notice/YesNoDialog.OnOkListener.html[2/19/2011 9:18:23 AM]

All Classes




org.hermit.android.notice Interface YesNoDialog.OnOkListener

Enclosing class:YesNoDialog

public static interface YesNoDialog.OnOkListener


Method Summary void onOk()


Method Detail

onOk

void onOk()




http://moonblink.googlecode.com/...HermitAndroid/doc/index.html?org/hermit/android/notice/YesNoDialog.OnOkListener.html[2/19/2011 9:18:23 AM]

WaveformGauge WebBasedData WebFetcher WebFetcher.FetchExceptionWebFetcher.Listener YesNoDialog


http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?constant-values.html[2/19/2011 9:18:25 AM]

All Classes





Contents

org.hermit.*

org.hermit.*

org.hermit.android.core.SplashActivitypublic 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.SurfaceRunnerpublic static final int LOOPED_TICKER 2

public static final int SURFACE_DYNAMIC 1

org.hermit.android.instruments.InstrumentSurfacepublic static final int SURFACE_CACHE_BG 256

org.hermit.android.io.AudioReader.Listenerpublic 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.InfoBoxpublic static final int BUTTON_1 1

public static final int BUTTON_2 2



http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?constant-values.html[2/19/2011 9:18:25 AM]


Overview

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/sound//class-usePlayer.html[2/19/2011 9:18:29 AM]

All Classes





See: Description


applications.













Overview

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/sound//class-usePlayer.html[2/19/2011 9:18:29 AM]


Overview

http://moonblink.googlecode.com/...ndroid/doc/index.html?org/hermit/android/instruments//class-useInstrumentSurface.html[2/19/2011 9:18:34 AM]

All Classes





See: Description


applications.













Overview

http://moonblink.googlecode.com/...ndroid/doc/index.html?org/hermit/android/instruments//class-useInstrumentSurface.html[2/19/2011 9:18:34 AM]


Overview

http://moonblink.googlecode.com/.../trunk/HermitAndroid/doc/index.html?org/hermit/android/core//class-useHelpActivity.html[2/19/2011 9:18:36 AM]

All Classes





See: Description


applications.













Overview

http://moonblink.googlecode.com/.../trunk/HermitAndroid/doc/index.html?org/hermit/android/core//class-useHelpActivity.html[2/19/2011 9:18:36 AM]


Overview

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/widgets//class-useHScrollView.html[2/19/2011 9:18:40 AM]

All Classes





See: Description


applications.













Overview

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/widgets//class-useHScrollView.html[2/19/2011 9:18:40 AM]

YesNoDialog

Overview

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/net//class-useWebBasedData.html[2/19/2011 9:18:43 AM]

All Classes





See: Description


applications.













Overview

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/net//class-useWebBasedData.html[2/19/2011 9:18:43 AM]

YesNoDialog

Overview

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/core//class-useSurfaceRunner.html[2/19/2011 9:18:47 AM]

All Classes





See: Description


applications.













Overview

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/core//class-useSurfaceRunner.html[2/19/2011 9:18:47 AM]

YesNoDialog

Overview

http://moonblink.googlecode.com/...k/HermitAndroid/doc/index.html?org/hermit/android/core//class-useAppUtils.Version.html[2/19/2011 9:18:51 AM]

All Classes





See: Description


applications.













Overview

http://moonblink.googlecode.com/...k/HermitAndroid/doc/index.html?org/hermit/android/core//class-useAppUtils.Version.html[2/19/2011 9:18:51 AM]


Overview

http://moonblink.googlecode.com/...rmitAndroid/doc/index.html?org/hermit/android/instruments//class-useAudioAnalyser.html[2/19/2011 9:18:54 AM]

All Classes





See: Description


applications.













Overview

http://moonblink.googlecode.com/...rmitAndroid/doc/index.html?org/hermit/android/instruments//class-useAudioAnalyser.html[2/19/2011 9:18:54 AM]


Overview

http://moonblink.googlecode.com/...HermitAndroid/doc/index.html?org/hermit/android/instruments//class-useInstrument.html[2/19/2011 9:18:56 AM]

All Classes





See: Description


applications.













Overview

http://moonblink.googlecode.com/...HermitAndroid/doc/index.html?org/hermit/android/instruments//class-useInstrument.html[2/19/2011 9:18:56 AM]


Overview

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/core//class-useAppUtils.html[2/19/2011 9:18:58 AM]

All Classes





See: Description


applications.













Overview

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/core//class-useAppUtils.html[2/19/2011 9:18:58 AM]



http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/core/package-use.html[2/19/2011 9:19:01 AM]

All Classes




Uses of Packageorg.hermit.android.core

Packages that use org.hermit.android.coreorg.hermit.android.core A library of foundation classes for Android

applications.


Classes in org.hermit.android.core used byorg.hermit.android.coreAppUtils This class provides some simple application-related utilities.

AppUtils.Detail Version info detail level.

AppUtils.Version Information on an application version.



Classes in org.hermit.android.core used byorg.hermit.android.instrumentsSurfaceRunner Common base for applications with an animated view.



http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/core/package-use.html[2/19/2011 9:19:01 AM]


Overview

http://moonblink.googlecode.com/...unk/HermitAndroid/doc/index.html?org/hermit/android/core//class-useAppUtils.Detail.html[2/19/2011 9:19:03 AM]

All Classes





See: Description


applications.













Overview

http://moonblink.googlecode.com/...unk/HermitAndroid/doc/index.html?org/hermit/android/core//class-useAppUtils.Detail.html[2/19/2011 9:19:03 AM]



http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/instruments/package-use.html[2/19/2011 9:19:07 AM]

All Classes




Uses of Packageorg.hermit.android.instruments

Packages that useorg.hermit.android.instrumentsorg.hermit.android.instruments

Classes in org.hermit.android.instruments usedby org.hermit.android.instrumentsGauge A graphical display which shows some data in a region within a view.

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

PowerGauge A graphical display which displays the signal power in dB from anAudioAnalyser instrument.

SpectrumGauge A graphical display which displays the audio spectrum from an AudioAnalyserinstrument.

WaveformGauge A graphical display which displays the audio waveform from anAudioAnalyser instrument.



http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/instruments/package-use.html[2/19/2011 9:19:07 AM]


Overview

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/io//class-useAudioReader.html[2/19/2011 9:19:09 AM]

All Classes





See: Description


applications.













Overview

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/io//class-useAudioReader.html[2/19/2011 9:19:09 AM]



http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/io/package-use.html[2/19/2011 9:19:12 AM]

All Classes




Uses of Packageorg.hermit.android.io

Packages that use org.hermit.android.ioorg.hermit.android.io

Classes in org.hermit.android.io used byorg.hermit.android.ioAudioReader.Listener Listener for audio reads.



http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/io/package-use.html[2/19/2011 9:19:12 AM]


Overview

http://moonblink.googlecode.com/...HermitAndroid/doc/index.html?org/hermit/android/io//class-useAudioReader.Listener.html[2/19/2011 9:19:15 AM]

All Classes





See: Description


applications.













Overview

http://moonblink.googlecode.com/...HermitAndroid/doc/index.html?org/hermit/android/io//class-useAudioReader.Listener.html[2/19/2011 9:19:15 AM]



http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/net/package-use.html[2/19/2011 9:19:18 AM]

All Classes




Uses of Packageorg.hermit.android.net

Packages that use org.hermit.android.netorg.hermit.android.net

Classes in org.hermit.android.net used byorg.hermit.android.netCachedFile.Entry Class describing an entry in the cache; i.e.


WebFetcher.FetchException Web fetching exception.

WebFetcher.Listener Listener for incoming web data.



http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/net/package-use.html[2/19/2011 9:19:18 AM]



http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/notice/package-use.html[2/19/2011 9:19:23 AM]

All Classes




Uses of Packageorg.hermit.android.notice

Packages that use org.hermit.android.noticeorg.hermit.android.notice

Classes in org.hermit.android.notice used byorg.hermit.android.noticeTextInputDialog.OnOkListener Listener invoked when the user clicks the OK button.




http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/notice/package-use.html[2/19/2011 9:19:23 AM]

YesNoDialog


http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/provider/package-use.html[2/19/2011 9:19:25 AM]

All Classes




Uses of Packageorg.hermit.android.provider

Packages that use org.hermit.android.providerorg.hermit.android.provider A library of classes to facilitate the creating of

table-based content providers.

Classes in org.hermit.android.provider used byorg.hermit.android.providerDatabaseHelper This class helps open, create, and upgrade the database file.





http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/provider/package-use.html[2/19/2011 9:19:25 AM]



http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/sound/package-use.html[2/19/2011 9:19:28 AM]

All Classes




Uses of Packageorg.hermit.android.sound

Packages that use org.hermit.android.soundorg.hermit.android.sound These classes provide functions to help apps manage

their sound effects.

Classes in org.hermit.android.sound used byorg.hermit.android.soundEffect Class representing a specific sound effect.



http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/sound/package-use.html[2/19/2011 9:19:28 AM]



http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/widgets/package-use.html[2/19/2011 9:19:30 AM]

All Classes




Uses of Packageorg.hermit.android.widgets

No usage of org.hermit.android.widgets



http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/widgets/package-use.html[2/19/2011 9:19:30 AM]


Overview

http://moonblink.googlecode.com/.../trunk/HermitAndroid/doc/index.html?org/hermit/android/core//class-useMainActivity.html[2/19/2011 9:19:33 AM]

All Classes





See: Description


applications.













Overview

http://moonblink.googlecode.com/.../trunk/HermitAndroid/doc/index.html?org/hermit/android/core//class-useMainActivity.html[2/19/2011 9:19:33 AM]


Overview

http://moonblink.googlecode.com/...runk/HermitAndroid/doc/index.html?org/hermit/android/core//class-useSplashActivity.html[2/19/2011 9:19:35 AM]

All Classes





See: Description


applications.













Overview

http://moonblink.googlecode.com/...runk/HermitAndroid/doc/index.html?org/hermit/android/core//class-useSplashActivity.html[2/19/2011 9:19:35 AM]


Overview

http://moonblink.googlecode.com/...unk/HermitAndroid/doc/index.html?org/hermit/android/notice//class-useYesNoDialog.html[2/19/2011 9:19:37 AM]

All Classes





See: Description


applications.













Overview

http://moonblink.googlecode.com/...unk/HermitAndroid/doc/index.html?org/hermit/android/notice//class-useYesNoDialog.html[2/19/2011 9:19:37 AM]


Overview

http://moonblink.googlecode.com/...trunk/HermitAndroid/doc/index.html?org/hermit/android/notice//class-useErrorDialog.html[2/19/2011 9:19:40 AM]

All Classes





See: Description


applications.













Overview

http://moonblink.googlecode.com/...trunk/HermitAndroid/doc/index.html?org/hermit/android/notice//class-useErrorDialog.html[2/19/2011 9:19:40 AM]


Overview

http://moonblink.googlecode.com/.../HermitAndroid/doc/index.html?org/hermit/android/notice//class-useTextInputDialog.html[2/19/2011 9:19:43 AM]

All Classes





See: Description


applications.













Overview

http://moonblink.googlecode.com/.../HermitAndroid/doc/index.html?org/hermit/android/notice//class-useTextInputDialog.html[2/19/2011 9:19:43 AM]


Overview

http://moonblink.googlecode.com/...nk/HermitAndroid/doc/index.html?org/hermit/android/net//class-useCachedFile.Entry.html[2/19/2011 9:19:45 AM]

All Classes





See: Description


applications.













Overview

http://moonblink.googlecode.com/...nk/HermitAndroid/doc/index.html?org/hermit/android/net//class-useCachedFile.Entry.html[2/19/2011 9:19:45 AM]


Overview

http://moonblink.googlecode.com/.../HermitAndroid/doc/index.html?org/hermit/android/provider//class-useTableProvider.html[2/19/2011 9:19:48 AM]

All Classes





See: Description


applications.













Overview

http://moonblink.googlecode.com/.../HermitAndroid/doc/index.html?org/hermit/android/provider//class-useTableProvider.html[2/19/2011 9:19:48 AM]


Overview

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/provider//class-useDbSchema.html[2/19/2011 9:19:51 AM]

All Classes





See: Description


applications.













Overview

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/provider//class-useDbSchema.html[2/19/2011 9:19:51 AM]

YesNoDialog

Overview

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/notice//class-useInfoBox.html[2/19/2011 9:19:54 AM]

All Classes





See: Description


applications.













Overview

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/notice//class-useInfoBox.html[2/19/2011 9:19:54 AM]


Overview

http://moonblink.googlecode.com/...k/HermitAndroid/doc/index.html?org/hermit/android/widgets//class-useLinedEditText.html[2/19/2011 9:19:56 AM]

All Classes





See: Description


applications.













Overview

http://moonblink.googlecode.com/...k/HermitAndroid/doc/index.html?org/hermit/android/widgets//class-useLinedEditText.html[2/19/2011 9:19:56 AM]


Overview

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/sound//class-useEffect.html[2/19/2011 9:19:59 AM]

All Classes





See: Description


applications.













Overview

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/sound//class-useEffect.html[2/19/2011 9:19:59 AM]


Overview

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/core//class-useErrors.html[2/19/2011 9:20:01 AM]

All Classes





See: Description


applications.













Overview

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/core//class-useErrors.html[2/19/2011 9:20:01 AM]


Overview

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/instruments//class-useGauge.html[2/19/2011 9:20:09 AM]

All Classes





See: Description


applications.













Overview

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/instruments//class-useGauge.html[2/19/2011 9:20:09 AM]

YesNoDialog

Overview

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/instruments//class-usePowerGauge.html[2/19/2011 9:20:11 AM]

All Classes





See: Description


applications.













Overview

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/instruments//class-usePowerGauge.html[2/19/2011 9:20:11 AM]

YesNoDialog

Overview

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/instruments//class-useSpectrumGauge.html[2/19/2011 9:20:16 AM]

All Classes





See: Description


applications.













Overview

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/instruments//class-useSpectrumGauge.html[2/19/2011 9:20:16 AM]

YesNoDialog

Overview

http://moonblink.googlecode.com/...HermitAndroid/doc/index.html?org/hermit/android/instruments//class-useTextGauge.html[2/19/2011 9:20:19 AM]

All Classes





See: Description


applications.













Overview

http://moonblink.googlecode.com/...HermitAndroid/doc/index.html?org/hermit/android/instruments//class-useTextGauge.html[2/19/2011 9:20:19 AM]


Overview

http://moonblink.googlecode.com/...itAndroid/doc/index.html?org/hermit/android/instruments//class-useWaveformGauge.html[2/19/2011 9:20:22 AM]

All Classes





See: Description


applications.













Overview

http://moonblink.googlecode.com/...itAndroid/doc/index.html?org/hermit/android/instruments//class-useWaveformGauge.html[2/19/2011 9:20:22 AM]


Overview

http://moonblink.googlecode.com/...ndroid/doc/index.html?org/hermit/android/widgets//class-useMultistateImageButton.html[2/19/2011 9:20:25 AM]

All Classes





See: Description


applications.













Overview

http://moonblink.googlecode.com/...ndroid/doc/index.html?org/hermit/android/widgets//class-useMultistateImageButton.html[2/19/2011 9:20:25 AM]


Overview

http://moonblink.googlecode.com/...ermitAndroid/doc/index.html?org/hermit/android/widgets//class-useTimeZoneActivity.html[2/19/2011 9:20:28 AM]

All Classes





See: Description


applications.













Overview

http://moonblink.googlecode.com/...ermitAndroid/doc/index.html?org/hermit/android/widgets//class-useTimeZoneActivity.html[2/19/2011 9:20:28 AM]


Overview

http://moonblink.googlecode.com/...droid/doc/index.html?org/hermit/android/core//class-useMainActivity.ActivityListener.html[2/19/2011 9:20:30 AM]

All Classes





See: Description


applications.













Overview

http://moonblink.googlecode.com/...droid/doc/index.html?org/hermit/android/core//class-useMainActivity.ActivityListener.html[2/19/2011 9:20:30 AM]

WaveformGauge WebBasedData WebFetcher WebFetcher.FetchExceptionWebFetcher.Listener YesNoDialog

Overview

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/net//class-useCachedFile.html[2/19/2011 9:20:34 AM]

All Classes





See: Description


applications.













Overview

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/net//class-useCachedFile.html[2/19/2011 9:20:34 AM]

YesNoDialog

Overview

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/net//class-useWebFetcher.Listener.html[2/19/2011 9:20:37 AM]

All Classes





See: Description


applications.













Overview

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/net//class-useWebFetcher.Listener.html[2/19/2011 9:20:37 AM]

YesNoDialog

Overview

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/core//class-useOneTimeDialog.html[2/19/2011 9:20:42 AM]

All Classes





See: Description


applications.













Overview

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/core//class-useOneTimeDialog.html[2/19/2011 9:20:42 AM]

YesNoDialog

Overview

http://moonblink.googlecode.com/...ermitAndroid/doc/index.html?org/hermit/android/provider//class-useDatabaseHelper.html[2/19/2011 9:20:47 AM]

All Classes





See: Description


applications.













Overview

http://moonblink.googlecode.com/...ermitAndroid/doc/index.html?org/hermit/android/provider//class-useDatabaseHelper.html[2/19/2011 9:20:47 AM]


Overview

http://moonblink.googlecode.com/.../HermitAndroid/doc/index.html?org/hermit/android/provider//class-useTableSchema.html[2/19/2011 9:20:50 AM]

All Classes





See: Description


applications.













Overview

http://moonblink.googlecode.com/.../HermitAndroid/doc/index.html?org/hermit/android/provider//class-useTableSchema.html[2/19/2011 9:20:50 AM]


Overview

http://moonblink.googlecode.com/.../trunk/HermitAndroid/doc/index.html?org/hermit/android/net//class-useWebFetcher.html[2/19/2011 9:20:52 AM]

All Classes





See: Description


applications.













Overview

http://moonblink.googlecode.com/.../trunk/HermitAndroid/doc/index.html?org/hermit/android/net//class-useWebFetcher.html[2/19/2011 9:20:52 AM]


Overview

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/net//class-useFileFetcher.html[2/19/2011 9:20:55 AM]

All Classes





See: Description


applications.













Overview

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?org/hermit/android/net//class-useFileFetcher.html[2/19/2011 9:20:55 AM]


Overview

http://moonblink.googlecode.com/.../trunk/HermitAndroid/doc/index.html?org/hermit/android/net//class-useTableFetcher.html[2/19/2011 9:20:57 AM]

All Classes





See: Description


applications.













Overview

http://moonblink.googlecode.com/.../trunk/HermitAndroid/doc/index.html?org/hermit/android/net//class-useTableFetcher.html[2/19/2011 9:20:57 AM]


Overview

http://moonblink.googlecode.com/...ndroid/doc/index.html?org/hermit/android/net//class-useWebFetcher.FetchException.html[2/19/2011 9:20:59 AM]

All Classes





See: Description


applications.













Overview

http://moonblink.googlecode.com/...ndroid/doc/index.html?org/hermit/android/net//class-useWebFetcher.FetchException.html[2/19/2011 9:20:59 AM]


Serialized Form

http://moonblink.googlecode.com/svn/trunk/HermitAndroid/doc/index.html?serialized-form.html[2/19/2011 9:21:02 AM]

All Classes

Packages org.hermit.android.core org.hermit.android.instrumeorg.hermit.android.io org.hermit.android.net org.hermit.android.notice org.hermit.android.providerorg.hermit.android.sound org.hermit.android.widgets

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.ActivityListeneMultistateImageButton OneTimeDialog Player PowerGauge SpectrumGauge SplashActivity SurfaceRunner TableFetcher TableProvider TableSchema TextGauge TextInputDialog TextInputDialog.OnOkListeTimeZoneActivity WaveformGauge WebBasedData WebFetcher WebFetcher.FetchExceptioWebFetcher.Listener YesNoDialog


Serialized Form


Classorg.hermit.android.net.WebFetcher.FetchExceptionextends java.lang.Exception implements Serializable

serialVersionUID: 4699577452411347104L


Overview

http://moonblink.googlecode.com/...d/doc/index.html?org/hermit/android/notice//class-useTextInputDialog.OnOkListener.html[2/19/2011 9:21:04 AM]

All Classes





See: Description


applications.













Overview

http://moonblink.googlecode.com/...d/doc/index.html?org/hermit/android/notice//class-useTextInputDialog.OnOkListener.html[2/19/2011 9:21:04 AM]


Overview

http://moonblink.googlecode.com/...droid/doc/index.html?org/hermit/android/notice//class-useYesNoDialog.OnOkListener.html[2/19/2011 9:21:08 AM]

All Classes





See: Description


applications.













Overview

http://moonblink.googlecode.com/...droid/doc/index.html?org/hermit/android/notice//class-useYesNoDialog.OnOkListener.html[2/19/2011 9:21:08 AM]


android code google code

Documents

Transcript of android code google code