PawletOS/app_Settings
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Support slice deep links highlighting menu entries

Browse Source 
- Add an interface to get highlight menu key resource in Sliceable
- Force implementing the new interface in TogglePreferenceController and
  CustomSliceable at syntax level
- Update the slice index db schema

Bug: 204695404
Test: manual, robotest build pass, unit
Change-Id: I0b5068bccd04f1590023de7f3385bc0a4c6fa47b
This commit is contained in:
Jason Chiu
2021-10-31 23:40:26 +08:00
parent e1ec69fa1a
commit 594eb43159
20 changed files with 161 additions and 45 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
src/com/android/settings/core/TogglePreferenceController.java
View File

@@ -89,4 +89,7 @@ public abstract class TogglePreferenceController extends BasePreferenceControlle
public boolean isPublicSlice() {
return false;
}
@Override
public abstract int getSliceHighlightMenuRes();
}

3
src/com/android/settings/slices/CustomSliceable.java
View File

@@ -103,6 +103,9 @@ public interface CustomSliceable extends Sliceable {
return true;
}
@Override
int getSliceHighlightMenuRes();
/**
* Build an instance of a {@link CustomSliceable} which has a {@link Context}-only constructor.
*/

23
src/com/android/settings/slices/SliceBuilderUtils.java
View File

@@ -16,6 +16,8 @@
package com.android.settings.slices;
import static android.provider.Settings.EXTRA_SETTINGS_EMBEDDED_DEEP_LINK_HIGHLIGHT_MENU_KEY;
import static com.android.settings.SettingsActivity.EXTRA_IS_FROM_SLICE;
import static com.android.settings.core.BasePreferenceController.DISABLED_DEPENDENT_SETTING;
import static com.android.settings.slices.SettingsSliceProvider.EXTRA_SLICE_KEY;
@@ -203,8 +205,15 @@ public class SliceBuilderUtils {
}
public static Intent buildSearchResultPageIntent(Context context, String className, String key,
String screenTitle, int sourceMetricsCategory) {
String screenTitle, int sourceMetricsCategory, int highlightMenuRes) {
final Bundle args = new Bundle();
String highlightMenuKey = null;
if (highlightMenuRes != 0) {
highlightMenuKey = context.getString(highlightMenuRes);
if (TextUtils.isEmpty(highlightMenuKey)) {
Log.w(TAG, "Invalid menu key res from: " + screenTitle);
}
}
args.putString(SettingsActivity.EXTRA_FRAGMENT_ARG_KEY, key);
final Intent searchDestination = new SubSettingLauncher(context)
.setDestination(className)
@@ -215,6 +224,7 @@ public class SliceBuilderUtils {
searchDestination
.putExtra(SettingsActivity.EXTRA_FRAGMENT_ARG_KEY, key)
.putExtra(EXTRA_IS_FROM_SLICE, true)
.putExtra(EXTRA_SETTINGS_EMBEDDED_DEEP_LINK_HIGHLIGHT_MENU_KEY, highlightMenuKey)
.setAction("com.android.settings.SEARCH_RESULT_TRAMPOLINE")
.setComponent(null);
searchDestination.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TOP | Intent.FLAG_ACTIVITY_NEW_TASK);
@@ -222,13 +232,22 @@ public class SliceBuilderUtils {
return searchDestination;
}
/**
* Build a search result page intent for {@link CustomSliceable}
*/
public static Intent buildSearchResultPageIntent(Context context, String className, String key,
String screenTitle, int sourceMetricsCategory, CustomSliceable sliceable) {
return buildSearchResultPageIntent(context, className, key, screenTitle,
sourceMetricsCategory, sliceable.getSliceHighlightMenuRes());
}
public static Intent getContentIntent(Context context, SliceData sliceData) {
final Uri contentUri = new Uri.Builder().appendPath(sliceData.getKey()).build();
final String screenTitle = TextUtils.isEmpty(sliceData.getScreenTitle()) ? null
: sliceData.getScreenTitle().toString();
final Intent intent = buildSearchResultPageIntent(context,
sliceData.getFragmentClassName(), sliceData.getKey(),
screenTitle, 0 /* TODO */);
screenTitle, 0 /* TODO */, sliceData.getHighlightMenuRes());
intent.setClassName(context.getPackageName(), SubSettings.class.getName());
intent.setData(contentUri);
return intent;

21
src/com/android/settings/slices/SliceData.java
View File

@@ -19,6 +19,7 @@ package com.android.settings.slices;
import android.annotation.IntDef;
import android.net.Uri;
import android.text.TextUtils;
import android.util.Log;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
@@ -50,6 +51,8 @@ public class SliceData {
int SLIDER = 2;
}
private static final String TAG = "SliceData";
private final String mKey;
private final String mTitle;
@@ -68,6 +71,8 @@ public class SliceData {
private final String mPreferenceController;
private final int mHighlightMenuRes;
@SliceType
private final int mSliceType;
@@ -119,6 +124,10 @@ public class SliceData {
return mUnavailableSliceSubtitle;
}
public int getHighlightMenuRes() {
return mHighlightMenuRes;
}
public boolean isPublicSlice() {
return mIsPublicSlice;
}
@@ -136,6 +145,7 @@ public class SliceData {
mSliceType = builder.mSliceType;
mUnavailableSliceSubtitle = builder.mUnavailableSliceSubtitle;
mIsPublicSlice = builder.mIsPublicSlice;
mHighlightMenuRes = builder.mHighlightMenuRes;
}
@Override
@@ -175,6 +185,8 @@ public class SliceData {
private String mUnavailableSliceSubtitle;
private int mHighlightMenuRes;
private boolean mIsPublicSlice;
public Builder setKey(String key) {
@@ -233,6 +245,11 @@ public class SliceData {
return this;
}
public Builder setHighlightMenuRes(int highlightMenuRes) {
mHighlightMenuRes = highlightMenuRes;
return this;
}
public Builder setIsPublicSlice(boolean isPublicSlice) {
mIsPublicSlice = isPublicSlice;
return this;
@@ -255,6 +272,10 @@ public class SliceData {
throw new InvalidSliceDataException("Preference Controller cannot be empty");
}
if (mHighlightMenuRes == 0) {
Log.w(TAG, "Highlight menu key res is empty: " + mPrefControllerClassName);
}
return new SliceData(this);
}

2
src/com/android/settings/slices/SliceDataConverter.java
View File

@@ -213,6 +213,7 @@ class SliceDataConverter {
final String unavailableSliceSubtitle = bundle.getString(
METADATA_UNAVAILABLE_SLICE_SUBTITLE);
final boolean isPublicSlice = controller.isPublicSlice();
final int highlightMenuRes = controller.getSliceHighlightMenuRes();
final SliceData xmlSlice = new SliceData.Builder()
.setKey(key)
@@ -226,6 +227,7 @@ class SliceDataConverter {
.setSliceType(sliceType)
.setUnavailableSliceSubtitle(unavailableSliceSubtitle)
.setIsPublicSlice(isPublicSlice)
.setHighlightMenuRes(highlightMenuRes)
.build();
xmlSliceData.add(xmlSlice);

10
src/com/android/settings/slices/Sliceable.java
View File

@@ -50,6 +50,8 @@ public interface Sliceable {
* - Must be understandable as a stand-alone Setting.
* <p>
* This does not guarantee the setting is available.
* <p>
* {@link #getSliceHighlightMenuRes} should also be overridden when returning true.
*
* @return {@code true} if the controller should be used as a Slice.
*/
@@ -131,4 +133,12 @@ public interface Sliceable {
default Class<? extends SliceBackgroundWorker> getBackgroundWorkerClass() {
return null;
}
/**
* @return a resource ID that indicates which menu entry should be highlighted in multi-pane
* mode.
*/
default int getSliceHighlightMenuRes() {
return 0;
}
}

4
src/com/android/settings/slices/SlicesDatabaseAccessor.java
View File

@@ -50,6 +50,7 @@ public class SlicesDatabaseAccessor {
IndexColumns.CONTROLLER,
IndexColumns.SLICE_TYPE,
IndexColumns.UNAVAILABLE_SLICE_SUBTITLE,
IndexColumns.HIGHLIGHT_MENU_RESOURCE,
};
private final Context mContext;
@@ -163,6 +164,8 @@ public class SlicesDatabaseAccessor {
cursor.getColumnIndex(IndexColumns.SLICE_TYPE));
final String unavailableSliceSubtitle = cursor.getString(
cursor.getColumnIndex(IndexColumns.UNAVAILABLE_SLICE_SUBTITLE));
final int highlightMenuRes = cursor.getInt(
cursor.getColumnIndex(IndexColumns.HIGHLIGHT_MENU_RESOURCE));
if (isIntentOnly) {
sliceType = SliceData.SliceType.INTENT;
@@ -180,6 +183,7 @@ public class SlicesDatabaseAccessor {
.setUri(uri)
.setSliceType(sliceType)
.setUnavailableSliceSubtitle(unavailableSliceSubtitle)
.setHighlightMenuRes(highlightMenuRes)
.build();
}

66
src/com/android/settings/slices/SlicesDatabaseHelper.java
View File

@@ -36,7 +36,7 @@ public class SlicesDatabaseHelper extends SQLiteOpenHelper {
private static final String DATABASE_NAME = "slices_index.db";
private static final String SHARED_PREFS_TAG = "slices_shared_prefs";
private static final int DATABASE_VERSION = 8;
private static final int DATABASE_VERSION = 9;
public interface Tables {
String TABLE_SLICES_INDEX = "slices_index";
@@ -103,39 +103,43 @@ public class SlicesDatabaseHelper extends SQLiteOpenHelper {
* Whether the slice should be exposed publicly.
*/
String PUBLIC_SLICE = "public_slice";
/**
* Resource ID for the menu entry of the setting.
*/
String HIGHLIGHT_MENU_RESOURCE = "highlight_menu";
}
private static final String CREATE_SLICES_TABLE =
"CREATE VIRTUAL TABLE " + Tables.TABLE_SLICES_INDEX + " USING fts4" +
"(" +
IndexColumns.KEY +
", " +
IndexColumns.SLICE_URI +
", " +
IndexColumns.TITLE +
", " +
IndexColumns.SUMMARY +
", " +
IndexColumns.SCREENTITLE +
", " +
IndexColumns.KEYWORDS +
", " +
IndexColumns.ICON_RESOURCE +
", " +
IndexColumns.FRAGMENT +
", " +
IndexColumns.CONTROLLER +
", " +
IndexColumns.SLICE_TYPE +
", " +
IndexColumns.UNAVAILABLE_SLICE_SUBTITLE +
", "
+
IndexColumns.PUBLIC_SLICE
+
" INTEGER DEFAULT 0 "
+
");";
"CREATE VIRTUAL TABLE " + Tables.TABLE_SLICES_INDEX + " USING fts4"
+ "("
+ IndexColumns.KEY
+ ", "
+ IndexColumns.SLICE_URI
+ ", "
+ IndexColumns.TITLE
+ ", "
+ IndexColumns.SUMMARY
+ ", "
+ IndexColumns.SCREENTITLE
+ ", "
+ IndexColumns.KEYWORDS
+ ", "
+ IndexColumns.ICON_RESOURCE
+ ", "
+ IndexColumns.FRAGMENT
+ ", "
+ IndexColumns.CONTROLLER
+ ", "
+ IndexColumns.SLICE_TYPE
+ ", "
+ IndexColumns.UNAVAILABLE_SLICE_SUBTITLE
+ ", "
+ IndexColumns.PUBLIC_SLICE
+ ", "
+ IndexColumns.HIGHLIGHT_MENU_RESOURCE
+ " INTEGER DEFAULT 0 "
+ ");";
private final Context mContext;

1
src/com/android/settings/slices/SlicesIndexer.java
View File

@@ -116,6 +116,7 @@ class SlicesIndexer implements Runnable {
values.put(IndexColumns.UNAVAILABLE_SLICE_SUBTITLE,
dataRow.getUnavailableSliceSubtitle());
values.put(IndexColumns.PUBLIC_SLICE, dataRow.isPublicSlice());
values.put(IndexColumns.HIGHLIGHT_MENU_RESOURCE, dataRow.getHighlightMenuRes());
database.replaceOrThrow(Tables.TABLE_SLICES_INDEX, null /* nullColumnHack */,
values);