Android Open Source - PICwidget Preference Utils

• Back to Widget/lock  ↑

From Project

Back to project page PICwidget.

License

The source code is released under:

Apache License

Java Source Code

/*
 * Copyright 2014 Jason J.//  w w  w . j ava  2  s .  c  om
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 * 
 * http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */
package com.ovrhere.android.picwidget.prefs;


import android.content.Context;
import android.content.SharedPreferences;
import android.content.res.Resources;

import com.ovrhere.android.picwidget.R;

/**
 * Branched from MorseFlash:
 * Preference Utility for handling the preferences and the preference container.
 * Has ability to set defaults. Keeps widget preferences separate. 
 * @author Jason J.
 * @version 0.2.0-20140819
 */
public class PreferenceUtils {
  /* The class name. */
  //final static private String CLASS_NAME = PreferenceUtils.class.getSimpleName();  
  /** The key for the first run/preferences set pref. */
  final static protected String KEY_PREFERENCES_SET = "com.ovrhere.picwdiget.KEY_FIRST_RUN";
  /** The stub used to separate the id from the preference filename. */
  final static protected String ID_STUB = "_ID_";
  
  /** The pref value for the first run/preferences set . 
   * @see {@link #KEY_PREFERENCES_SET} */
  final static protected boolean VALUE_PREFERENCES_SET   = true;
  
  /** Used to determine if the preferences have been set to default or if this
   * the first run.
   * @param context The current context.
   * @param appWidgetId The unique id of the appWidget to id preference file.
   * @return <code>true</code> if the first run, <code>false</code> otherwise.
   */
  static public boolean isFirstRun(Context context, int appWidgetId){
    SharedPreferences prefs = getPreferences(context, appWidgetId);
    //if the default value not set, then true.
    return (prefs.getBoolean(KEY_PREFERENCES_SET, !VALUE_PREFERENCES_SET) 
        == !VALUE_PREFERENCES_SET);
  }
  
  /** Returns the {@link SharedPreferences} file  using private mode. 
   * @param context The current context to be used. 
   * @param appWidgetId The unique id of the appWidget to id preference file. */
  static public SharedPreferences getPreferences(Context context, int appWidgetId){
    /* This is safe as SharedPreferences is a shared instance for the application
     * and thus will not leak.     */
    context = context.getApplicationContext();
    return context.getSharedPreferences(
        context.getResources().getString(R.string.com_ovrhere_picwidget_PREFERENCE_FILE_KEY)
        +ID_STUB+appWidgetId, 
        Context.MODE_PRIVATE); 
  }
  
  /** Sets the application's preferences using the default values. 
   * @param context The current context to be used. 
   * @param appWidgetId The unique id of the appWidget to id preference file.
   * @see res/values/preferences_info.xml */
  static public void setToDefault(Context context, int appWidgetId){
    SharedPreferences.Editor prefs = getPreferences(context, appWidgetId).edit();
    Resources r = context.getResources();    
    _setDefaults(r, prefs);    
    prefs.commit();
  }
  
  /////////////////////////////////////////////////////////////////////////////////////////////////
  /// Utility functions
  ////////////////////////////////////////////////////////////////////////////////////////////////
  /** Sets defaults. Does not commit.
   * @param r The {@link Resources} manager to use getting strings from 
   * res/values/preferences_info.xml
   * @param prefEdit The {@link SharedPreferences} editor to use to commit. */
  static private void _setDefaults(Resources r, SharedPreferences.Editor prefEdit){
    //Thought: Consider using parallel arrays in res to respect open-close?
    
    prefEdit.putBoolean(
        r.getString(R.string.com_ovrhere_picwidget_pref_KEY_DISPLAY_PICTURE),
        r.getBoolean(R.bool.com_ovrhere_picwidget_pref_DEF_VALUE_DISPLAY_PICTURE)
        );
    
    prefEdit.putString(
        r.getString(R.string.com_ovrhere_picwidget_pref_KEY_CONTACT_PHONE_NUMBER),
        r.getString(R.string.com_ovrhere_picwidget_pref_DEF_VALUE_CONTACT_PHONE_NUMBER)
        );
    
    prefEdit.putString(
        r.getString(R.string.com_ovrhere_picwidget_pref_KEY_INFO_CONTENT),
        r.getString(R.string.com_ovrhere_picwidget_pref_DEF_VALUE_INFO_CONTENT)
        );
    
    prefEdit.putString(
        r.getString(R.string.com_ovrhere_picwidget_pref_KEY_TIME_DISPLAY),
        r.getString(R.string.com_ovrhere_picwidget_pref_DEF_VALUE_TIME_DISPLAY)
        );
    
    //first run has completed.
    prefEdit.putBoolean(KEY_PREFERENCES_SET, VALUE_PREFERENCES_SET);
  }    
}

Java Source Code List

• Back to Widget/lock  ↑