First pass at the TimePreference

.gitignore

@@ -0,0 +1,6 @@
+bin
+gen
+.settings
+local.properties
+*.swp
+*.jar

LICENSE

@@ -0,0 +1,27 @@
+Copyright (c) 2010, Boston Android
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+o Redistributions of source code must retain the above copyright notice, this
+list of conditions and the following disclaimer.
+
+o Redistributions in binary form must reproduce the above copyright notice,
+this list of conditions and the following disclaimer in the documentation
+and/or other materials provided with the distribution.
+
+o Neither the name of Boston Android nor the names of its contributors may be
+used to endorse or promote products derived from this software without specific
+prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

README

@@ -0,0 +1,30 @@
+In Eclipse with your project open:
+
+  1. In the Package Explorer right click on your project and select "Properties".
+  2. Select "Java Build Path" -> "Libraries".
+  3. "Add External JARs..." then select the TimePreference.jar file.
+
+In your activity that descends from PreferenceActivity:
+
+  import org.bostonandroid.timepreference.TimePreference;
+
+In your preference XML:
+
+  <org.bostonandroid.timepreference.TimePreference
+     android:key="alert_at" android:title="@string/alert_at"
+     android:defaultValue="14:01" />
+
+To quickly get the Time selected for "alert_at", in your PreferenceActivity:
+
+  TimePreference.getTimeFor(
+    PreferenceManager.getDefaultSharePreferences(this),
+    "alert_at");
+
+To set the time use .setTime(String).
+
+
+To make the JAR:
+
+With just the TimePreference source code loaded in Eclipse:
+
+  In the Package Explorer right click on the "default.jardesc" file and select "Create JAR"

TimePreference/.classpath

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<classpath>
+	<classpathentry kind="src" path="src"/>
+	<classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER"/>
+	<classpathentry kind="lib" path="/usr/local/android-sdk-linux_86/platforms/android-8/android.jar"/>
+	<classpathentry kind="output" path="bin"/>
+</classpath>

TimePreference/.project

@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<projectDescription>
+	<name>TimePreference</name>
+	<comment></comment>
+	<projects>
+	</projects>
+	<buildSpec>
+		<buildCommand>
+			<name>org.eclipse.jdt.core.javabuilder</name>
+			<arguments>
+			</arguments>
+		</buildCommand>
+	</buildSpec>
+	<natures>
+		<nature>org.eclipse.jdt.core.javanature</nature>
+	</natures>
+</projectDescription>

TimePreference/default.jardesc

@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<jardesc>
+    <jar path="TimePreferenceActivity/libs/TimePreference.jar"/>
+    <options buildIfNeeded="true" compress="true" descriptionLocation="/TimePreference/default.jardesc" exportErrors="false" exportWarnings="false" includeDirectoryEntries="false" overwrite="false" saveDescription="true" storeRefactorings="false" useSourceFolders="false"/>
+    <storedRefactorings deprecationInfo="true" structuralOnly="false"/>
+    <selectedProjects/>
+    <manifest generateManifest="true" manifestLocation="" manifestVersion="1.0" reuseManifest="false" saveManifest="false" usesManifest="true">
+        <sealing sealJar="false">
+            <packagesToSeal/>
+            <packagesToUnSeal/>
+        </sealing>
+    </manifest>
+    <selectedElements exportClassFiles="true" exportJavaFiles="true" exportOutputFolder="false">
+        <javaElement handleIdentifier="=TimePreference"/>
+    </selectedElements>
+</jardesc>

TimePreference/src/org/bostonandroid/timepreference/TimePreference.java

@@ -0,0 +1,271 @@
+package org.bostonandroid.timepreference;
+
+import java.text.DateFormat;
+import java.text.ParseException;
+import java.text.SimpleDateFormat;
+import java.util.Calendar;
+import java.util.Date;
+import java.util.GregorianCalendar;
+
+import android.content.Context;
+import android.content.DialogInterface;
+import android.content.SharedPreferences;
+import android.content.res.TypedArray;
+import android.os.Parcel;
+import android.os.Parcelable;
+import android.preference.DialogPreference;
+import android.util.AttributeSet;
+import android.view.View;
+import android.widget.DatePicker;
+import android.widget.TimePicker;
+
+public class TimePreference extends DialogPreference implements TimePicker.OnTimeChangedListener {
+  private String timeString;
+  private String changedValueCanBeNull;
+  private TimePicker timePicker;
+
+  public TimePreference(Context context, AttributeSet attrs, int defStyle) {
+    super(context, attrs, defStyle);
+  }
+
+  public TimePreference(Context context, AttributeSet attrs) {
+    super(context, attrs);
+  }
+
+  /**
+   * Produces a DatePicker set to the date produced by {@link #getTime()}. When
+   * overriding be sure to call the super.
+   * 
+   * @return a DatePicker with the date set
+   */
+  @Override
+  protected View onCreateDialogView() {
+    this.timePicker = new TimePicker(getContext());
+    Calendar calendar = getTime();
+    this.timePicker.setCurrentHour(calendar.get(Calendar.HOUR));
+    this.timePicker.setCurrentMinute(calendar.get(Calendar.MINUTE));
+    this.timePicker.setOnTimeChangedListener(this);
+    return this.timePicker;
+  }
+
+  /**
+   * Produces the date used for the date picker. If the user has not selected a
+   * date, produces the default from the XML's android:defaultValue. If the
+   * default is not set in the XML or if the XML's default is invalid it uses
+   * the value produced by {@link #defaultCalendar()}.
+   * 
+   * @return the Calendar for the date picker
+   */
+  public Calendar getTime() {
+    try {
+      Date date = formatter().parse(defaultValue());
+      Calendar cal = Calendar.getInstance();
+      cal.setTime(date);
+      return cal;
+    } catch (java.text.ParseException e) {
+      return defaultCalendar();
+    }
+  }
+
+  /**
+   * Set the selected date to the specified string.
+   * 
+   * @param dateString
+   *          The date, represented as a string, in the format specified by
+   *          {@link #formatter()}.
+   */
+  public void setDate(String dateString) {
+    this.timeString = dateString;
+  }
+
+  /**
+   * Produces the date formatter used for dates in the XML. The default is yyyy.MM.dd.
+   * Override this to change that.
+   * 
+   * @return the SimpleDateFormat used for XML dates
+   */
+  public static DateFormat formatter() {
+    return new SimpleDateFormat("HH:mm");
+  }
+
+  /**
+   * Produces the date formatter used for showing the date in the summary. The default is MMMM dd, yyyy.
+   * Override this to change it.
+   * 
+   * @return the SimpleDateFormat used for summary dates
+   */
+  public static DateFormat summaryFormatter() {
+    return DateFormat.getTimeInstance();
+  }
+
+  @Override
+  protected Object onGetDefaultValue(TypedArray a, int index) {
+    return a.getString(index);
+  }
+
+  /**
+   * Called when the date picker is shown or restored. If it's a restore it gets
+   * the persisted value, otherwise it persists the value.
+   */
+  @Override
+  protected void onSetInitialValue(boolean restoreValue, Object def) {
+    if (restoreValue) {
+      this.timeString = getPersistedString(defaultValue());
+      setTheTime(this.timeString);
+    } else {
+      boolean wasNull = this.timeString == null;
+      setDate((String) def);
+      if (!wasNull)
+        persistTime(this.timeString);
+    }
+  }
+
+  /**
+   * Called when Android pauses the activity.
+   */
+  @Override
+  protected Parcelable onSaveInstanceState() {
+    if (isPersistent())
+      return super.onSaveInstanceState();
+    else
+      return new SavedState(super.onSaveInstanceState());
+  }
+
+  /**
+   * Called when Android restores the activity.
+   */
+  @Override
+  protected void onRestoreInstanceState(Parcelable state) {
+    if (state == null || !state.getClass().equals(SavedState.class)) {
+      super.onRestoreInstanceState(state);
+      setTheTime(((SavedState) state).dateValue);
+    } else {
+      SavedState s = (SavedState) state;
+      super.onRestoreInstanceState(s.getSuperState());
+      setTheTime(s.dateValue);
+    }
+  }
+
+  /**
+   * TODO: Called when the user changes the date.
+   */
+  public void onTimeChanged(TimePicker view, int hour, int minute) {
+    Calendar selected = new GregorianCalendar(1970,0,1,hour,minute);
+    this.changedValueCanBeNull = formatter().format(selected.getTime());
+  }
+
+  /**
+   * Called when the dialog is closed. If the close was by pressing "OK" it
+   * saves the value.
+   */
+  @Override
+  protected void onDialogClosed(boolean shouldSave) {
+    if (shouldSave && this.changedValueCanBeNull != null) {
+      setTheTime(this.changedValueCanBeNull);
+      this.changedValueCanBeNull = null;
+    }
+  }
+
+  private void setTheTime(String s) {
+    setDate(s);
+    persistTime(s);
+  }
+
+  private void persistTime(String s) {
+    persistString(s);
+    setSummary(summaryFormatter().format(getTime().getTime()));
+  }
+
+  /**
+   * The default date to use when the XML does not set it or the XML has an
+   * error.
+   * 
+   * @return the Calendar set to the default date
+   */
+  public static Calendar defaultCalendar() {
+    return new GregorianCalendar(1970, 0, 1, 0, 0);
+  }
+
+  /**
+   * The defaultCalendar() as a string using the {@link #formatter()}.
+   * 
+   * @return a String representation of the default date
+   */
+  public static String defaultCalendarString() {
+    return formatter().format(defaultCalendar().getTime());
+  }
+
+  private String defaultValue() {
+    if (this.timeString == null)
+      setDate(defaultCalendarString());
+    return this.timeString;
+  }
+
+  /**
+   * Called whenever the user clicks on a button. Invokes {@link #onDateChanged(DatePicker, int, int, int)}
+   * and {@link #onDialogClosed(boolean)}. Be sure to call the super when overriding.
+   */
+  @Override
+  public void onClick(DialogInterface dialog, int which) {
+    super.onClick(dialog, which);
+    timePicker.clearFocus();
+    onTimeChanged(timePicker, timePicker.getCurrentHour(), timePicker.getCurrentMinute());
+    onDialogClosed(which == DialogInterface.BUTTON1); // OK?
+  }
+
+  /**
+   * Produces the date the user has selected for the given preference, as a
+   * calendar.
+   * 
+   * @param preferences
+   *          the SharedPreferences to get the date from
+   * @param field
+   *          the name of the preference to get the date from
+   * @return a Calendar that the user has selected
+   */
+  public static Calendar getTimeFor(SharedPreferences preferences, String field) {
+    Date date = stringToDate(preferences.getString(field,
+        defaultCalendarString()));
+    Calendar cal = Calendar.getInstance();
+    cal.setTime(date);
+    return cal;
+  }
+
+  private static Date stringToDate(String timeString) {
+    try {
+      return formatter().parse(timeString);
+    } catch (ParseException e) {
+      return defaultCalendar().getTime();
+    }
+  }
+
+  private static class SavedState extends BaseSavedState {
+    String dateValue;
+
+    public SavedState(Parcel p) {
+      super(p);
+      dateValue = p.readString();
+    }
+
+    public SavedState(Parcelable p) {
+      super(p);
+    }
+
+    @Override
+    public void writeToParcel(Parcel out, int flags) {
+      super.writeToParcel(out, flags);
+      out.writeString(dateValue);
+    }
+
+    @SuppressWarnings("unused")
+    public static final Parcelable.Creator<SavedState> CREATOR = new Parcelable.Creator<SavedState>() {
+      public SavedState createFromParcel(Parcel in) {
+        return new SavedState(in);
+      }
+
+      public SavedState[] newArray(int size) {
+        return new SavedState[size];
+      }
+    };
+  }
+}

TimePreferenceTest/.classpath

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<classpath>
+	<classpathentry kind="src" path="src"/>
+	<classpathentry kind="src" path="gen"/>
+	<classpathentry kind="con" path="com.android.ide.eclipse.adt.ANDROID_FRAMEWORK"/>
+	<classpathentry kind="lib" path="libs/TimePreference.jar"/>
+	<classpathentry kind="output" path="bin"/>
+</classpath>