Android PreferenceActivity 學習筆記

時間 2020-09-10

標籤 android preferenceactivity 學習筆記欄目 Android 简体版

原文原文鏈接

在Ap中有時須要設置一些配置參數，這些參數經過配置文件保存。android

爲了設置這些參數，須要提供一個UI，針對這種需求，Android提供了preferenceActivity。
PreferenceActivity經過讀取預先定義的xml文件來生成界面，並可以自動的根據用戶的操做來修改參數，並保存到配置文件中供讀取。
1.MainActivity：
按下Menu按鍵彈出菜單，點擊菜單啓動SettingActivity。
2.SettingActivity繼承自PreferenceActivity：ide

Java代碼

@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
addPreferencesFromResource(R.xml.settings);
}

@Override
	protected void onCreate(Bundle savedInstanceState) {
		super.onCreate(savedInstanceState);
		addPreferencesFromResource(R.xml.settings);
	}

在onCreate函數中加載參數定義文件。函數

Java代碼

public void onSharedPreferenceChanged(SharedPreferences sharedPreferences, String key)；

public void onSharedPreferenceChanged(SharedPreferences sharedPreferences, String key)；

當參數值被改變時會調用此Listener，能夠在此Listener中做一些界面刷新工做，好比當前參數值改變爲新的值。佈局

Java代碼

Preference android.preference.PreferenceActivity.findPreference(CharSequence key);

Preference android.preference.PreferenceActivity.findPreference(CharSequence key);

獲取指定key所對應的preference對象，即便此key在配置文件中還沒有保存，也可以獲得preference對象，而不會是null。this

3.settings.xml：保存在xml目中的參數定義文件，在建立Android XML文件時選擇Preference便可建立一個空的參數定義文件。rest

Xml代碼

<?xml version="1.0" encoding="utf-8"?>
<PreferenceScreen
xmlns:android="http://schemas.android.com/apk/res/android">
</PreferenceScreen>

<?xml version="1.0" encoding="utf-8"?>
	<PreferenceScreen
 		xmlns:android="http://schemas.android.com/apk/res/android">
	</PreferenceScreen>

添加一個CheckBoxPreference子項，並設置屬性：code

Key:checkbox_keyxml

Title:CheckBox Item對象

Summary:test check box itemblog

Xml代碼

<?xml version="1.0" encoding="utf-8"?>
<PreferenceScreen xmlns:android="http://schemas.android.com/apk/res/android">
<CheckBoxPreference android:key="checkbox_key"
android:title="CheckBox Item" android:summary="test check box item"></CheckBoxPreference>
</PreferenceScreen>

<?xml version="1.0" encoding="utf-8"?>
	<PreferenceScreen xmlns:android="http://schemas.android.com/apk/res/android">
	<CheckBoxPreference android:key="checkbox_key"
		android:title="CheckBox Item" android:summary="test check box item"></CheckBoxPreference>
	</PreferenceScreen>

key是用來訪問此參數的值的關鍵字，保存後的配置文件相似以下內容：

Xml代碼

<?xml version='1.0' encoding='utf-8' standalone='yes' ?>
<map>
<boolean name="checkbox_key" value="true" />
</map>

<?xml version='1.0' encoding='utf-8' standalone='yes' ?>
	<map>
		<boolean name="checkbox_key" value="true" />
	</map>

啓動Ap，點擊菜單，便可看到參數設置界面，而且當用戶點擊操做改變了參數值後，也會被自動保存。

4.使用參數值：

SharedPreferences sp = PreferenceManager.getDefaultSharedPreferences(this);

boolean check_test = sp.getBoolean("checkbox_key", false);

進階：

1.保存參數文件的路徑：

/data/data/包名/shared_prefs/包名_preferences.xml

若是想指定保存文件名，可以使用：

getPreferenceManager().setSharedPreferencesName("配置文件名");

2.其餘的參數配置項：

2.1 EditTextPreference：

Xml代碼

<EditTextPreference android:dialogTitle="Edit Text Dialog"
android:key="edittext_key" android:dialogMessage="Please Input text"
android:title="EditText Item" android:summary="test edittext item"></EditTextPreference>

<EditTextPreference android:dialogTitle="Edit Text Dialog"
		android:key="edittext_key" android:dialogMessage="Please Input text"
		android:title="EditText Item" android:summary="test edittext item"></EditTextPreference>

此參數設置項會彈出一個文本輸入對話框，並在配置文件中生成相似如下內容：

彈出對話框的圖標、標題、提示信息、Icon、以及兩個按鈕的文本均可以設定。

至於自定義對話框的佈局，雖然有這個屬性，可是自定義佈局後就不能自動保存值了，

原本覺得只要放一個ID和原來同樣的EditText就能，可是查看源代碼，發現其EditText是new出來的，無法替代。

2.2 PreferenceCategory:一個分類分隔條。只有title屬性有效。

2.3 PreferenceScreen：此項包含的全部子項在新屏幕上顯示，就好像進入二級菜單。

2.4 ListPreference:會彈出一個列表對話框供選擇。

2.5 RingtonePreference：會彈出系統鈴聲列表供選擇。

2.6 Preference：通用參數項。點擊後須要程序本身響應事件。

3.自定義選項：

系統的提供的界面有時不能知足須要，這時就須要自定義選項了。

有兩種方法能夠實現自定義選項，一是用Preference做爲選項，並從新實現onPreferenceTreeClick函數。

一是自定義一個類，相似於EditTextPreference這種系統內置的類，而後引用。

3.1使用一個Preference佔位，而後從新實現onPreferenceTreeClick()函數：

Java代碼

public boolean onPreferenceTreeClick(PreferenceScreen preferenceScreen, Preference preference) {
String key = preference.getKey();
if( key != null ){
if(key.equals("some_key")) {
showDialog(DIALOG_SOME_KEY);
}
}
return super.onPreferenceTreeClick(preferenceScreen, preference);
}

public boolean onPreferenceTreeClick(PreferenceScreen preferenceScreen,	Preference preference) {
		String key = preference.getKey();
		if( key != null ){
			if(key.equals("some_key")) {
				showDialog(DIALOG_SOME_KEY);
			}
		}
		return super.onPreferenceTreeClick(preferenceScreen, preference);
	}

當點擊指定key的Preference時，就會彈出對話框，而後在合適的時機使用以下代碼保存參數便可。

Java代碼

SharedPreferences.Editor editor = preference.getEditor();
editor.putLong("ttt", 123);
editor.commit();

SharedPreferences.Editor editor = preference.getEditor(); editor.putLong("ttt", 123); editor.commit();

此種方法若是要觸發onSharedPreferenceChanged()，能夠經過preference.getOnPreferenceChangeListener()獲取listener而後來呼叫。

3.2自定義選項類：

此處以一個選擇時間的對話框選項爲例。

3.2.1 從DialogPreference繼承一個類：

Java代碼

public class TimePreference extends DialogPreference

public class TimePreference extends DialogPreference

3.2.2 構造函數：

Java代碼

public TimePreference(Context context, AttributeSet attrs) {
super(context, attrs);
setDialogLayoutResource(R.layout.time_preference); //加載佈局文件
}

public TimePreference(Context context, AttributeSet attrs) {
		super(context, attrs);		
		setDialogLayoutResource(R.layout.time_preference);	//加載佈局文件
	}

3.3.3 佈局文件：

Xml代碼

<?xml version="1.0" encoding="utf-8"?>
<RelativeLayout
xmlns:android="http://schemas.android.com/apk/res/android"
android:layout_width="fill_parent"
android:layout_height="fill_parent">
<TimePicker android:layout_height="wrap_content" android:layout_width="wrap_content" android:id="@+id/timePicker_preference" android:layout_centerHorizontal="true"></TimePicker>
</RelativeLayout>

<?xml version="1.0" encoding="utf-8"?>
	<RelativeLayout
	  xmlns:android="http://schemas.android.com/apk/res/android"
	  android:layout_width="fill_parent"
	  android:layout_height="fill_parent">
	<TimePicker android:layout_height="wrap_content" android:layout_width="wrap_content" android:id="@+id/timePicker_preference" android:layout_centerHorizontal="true"></TimePicker>
	</RelativeLayout>

定義了一個id爲timePicker_preference的TimePicker。

3.3.4 界面初始化：在dialog的函數中經過id找到TimePicker，而後使用已經存儲的值或者默認值，再設置到TimerPicker中。

Java代碼

@Override
protected void onBindDialogView(View view) {
super.onBindDialogView(view);
mPicker = (TimePicker)view.findViewById(R.id.timePicker_preference);
if(mPicker != null) {
mPicker.setIs24HourView(true);
long value = mValue;
Date d = new Date(value);
mPicker.setCurrentHour(d.getHours());
mPicker.setCurrentMinute(d.getMinutes());
}
}

@Override
	protected void onBindDialogView(View view) {
		super.onBindDialogView(view);
				
		mPicker = (TimePicker)view.findViewById(R.id.timePicker_preference);
		if(mPicker != null) {			
			mPicker.setIs24HourView(true);
			long value = mValue;
			Date d = new Date(value);
			mPicker.setCurrentHour(d.getHours());
			mPicker.setCurrentMinute(d.getMinutes());
		}
	}

3.3.5 保存值：在對話框關閉時保存值。

Java代碼

@Override
protected void onDialogClosed(boolean positiveResult) {
super.onDialogClosed(positiveResult);
if(positiveResult) {
Date d = new Date(0, 0, 0, mPicker.getCurrentHour(), mPicker.getCurrentMinute(), 0);
long value = d.getTime();
if(callChangeListener(value)) {
setValue(value);
}
}
}

@Override
	protected void onDialogClosed(boolean positiveResult) {
		super.onDialogClosed(positiveResult);
		if(positiveResult) {				
			Date d = new Date(0, 0, 0, mPicker.getCurrentHour(), mPicker.getCurrentMinute(), 0);			
			long value = d.getTime();
			if(callChangeListener(value)) {
				setValue(value);
			}
		}
	}

3.3.6 使用此preference：

在參數定義文件中增長：

Xml代碼

<cn.demo.pa.TimePreference android:key="time_test" android:title="Test time preference"/>

<cn.demo.pa.TimePreference android:key="time_test" android:title="Test time preference"/>

相似於使用自定義控件。

運行便可看到效果：

3.3.7 使用默認值：

在參數定義文件中增長一個定義：

Xml代碼

<cn.demo.pa.TimePreference android:key="time_test" android:title="Test time preference" android:defaultValue="1000000"/>

<cn.demo.pa.TimePreference android:key="time_test" android:title="Test time preference" android:defaultValue="1000000"/>

而且自定的preference類中要實現兩個函數：

Java代碼

@Override
protected Object onGetDefaultValue(TypedArray a, int index) {
return a.getString(index);
}

@Override
protected Object onGetDefaultValue(TypedArray a, int index) {
	return a.getString(index);
}

以及

Java代碼

@Override
protected void onSetInitialValue(boolean restorePersistedValue, Object defaultValue) {
long value;
if(restorePersistedValue) value = getPersistedLong(0);
else {
value = Long.parseLong(defaultValue.toString());
}
setValue(value);
}

@Override
	protected void onSetInitialValue(boolean restorePersistedValue,	Object defaultValue) {
		long value;
		if(restorePersistedValue) value = getPersistedLong(0);
		else {
			value = Long.parseLong(defaultValue.toString());
		}
        setValue(value);
	}

當PreferenceActivity啓動時會構造TimePreference，此時會調用onGetDefaultValue，而後調用 onSetInitialValue，在onSetInitialValue保存初始值，並在onBindDialogView中使用保存的值從而可使用默認值。

http://blog.163.com/guozioo@126/blog/static/6408694720106711453584/