src/com/android/settings/search/SearchIndexableResources.java

   1 /*
   2  * Copyright (C) 2014 The Android Open Source Project
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *      http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 package com.android.settings.search;
  18
  19 import android.provider.SearchIndexableResource;
  20 import android.support.annotation.DrawableRes;
  21 import android.support.annotation.VisibleForTesting;
  22 import android.support.annotation.XmlRes;
  23
  24 import android.text.TextUtils;
  25 import com.android.settings.DateTimeSettings;
  26 import com.android.settings.DeviceInfoSettings;
  27 import com.android.settings.DisplaySettings;
  28 import com.android.settings.EncryptionAndCredential;
  29 import com.android.settings.LegalSettings;
  30 import com.android.settings.R;
  31 import com.android.settings.ScreenPinningSettings;
  32 import com.android.settings.SecuritySettings;
  33 import com.android.settings.accessibility.AccessibilitySettings;
  34 import com.android.settings.accessibility.AccessibilityShortcutPreferenceFragment;
  35 import com.android.settings.accessibility.MagnificationPreferenceFragment;
  36 import com.android.settings.accounts.UserAndAccountDashboardFragment;
  37 import com.android.settings.applications.AdvancedAppSettings;
  38 import com.android.settings.applications.AppAndNotificationDashboardFragment;
  39 import com.android.settings.applications.SpecialAccessSettings;
  40 import com.android.settings.applications.assist.ManageAssist;
  41 import com.android.settings.backup.BackupSettingsActivity;
  42 import com.android.settings.backup.BackupSettingsFragment;
  43 import com.android.settings.bluetooth.BluetoothSettings;
  44 import com.android.settings.connecteddevice.ConnectedDeviceDashboardFragment;
  45 import com.android.settings.support.SupportDashboardActivity;
  46 import com.android.settings.datausage.DataUsageMeteredSettings;
  47 import com.android.settings.datausage.DataUsageSummary;
  48 import com.android.settings.development.DevelopmentSettings;
  49 import com.android.settings.deviceinfo.StorageDashboardFragment;
  50 import com.android.settings.deviceinfo.StorageSettings;
  51 import com.android.settings.display.AmbientDisplaySettings;
  52 import com.android.settings.display.ScreenZoomSettings;
  53 import com.android.settings.dream.DreamSettings;
  54 import com.android.settings.enterprise.EnterprisePrivacySettings;
  55 import com.android.settings.fuelgauge.BatterySaverSettings;
  56 import com.android.settings.fuelgauge.PowerUsageAdvanced;
  57 import com.android.settings.fuelgauge.PowerUsageSummary;
  58 import com.android.settings.gestures.AssistGestureSettings;
  59 import com.android.settings.gestures.DoubleTapPowerSettings;
  60 import com.android.settings.gestures.DoubleTapScreenSettings;
  61 import com.android.settings.gestures.DoubleTwistGestureSettings;
  62 import com.android.settings.gestures.PickupGestureSettings;
  63 import com.android.settings.gestures.SwipeToNotificationSettings;
  64 import com.android.settings.inputmethod.AvailableVirtualKeyboardFragment;
  65 import com.android.settings.inputmethod.PhysicalKeyboardFragment;
  66 import com.android.settings.inputmethod.VirtualKeyboardFragment;
  67 import com.android.settings.language.LanguageAndInputSettings;
  68 import com.android.settings.location.LocationSettings;
  69 import com.android.settings.location.ScanningSettings;
  70 import com.android.settings.network.NetworkDashboardFragment;
  71 import com.android.settings.nfc.PaymentSettings;
  72 import com.android.settings.notification.ChannelImportanceSettings;
  73 import com.android.settings.notification.ConfigureNotificationSettings;
  74 import com.android.settings.notification.SoundSettings;
  75 import com.android.settings.notification.ZenModePrioritySettings;
  76 import com.android.settings.notification.ZenModeSettings;
  77 import com.android.settings.notification.ZenModeVisualInterruptionSettings;
  78 import com.android.settings.print.PrintSettingsFragment;
  79 import com.android.settings.security.LockscreenDashboardFragment;
  80 import com.android.settings.sim.SimSettings;
  81 import com.android.settings.system.ResetDashboardFragment;
  82 import com.android.settings.system.SystemDashboardFragment;
  83 import com.android.settings.tts.TtsEnginePreferenceFragment;
  84 import com.android.settings.users.UserSettings;
  85 import com.android.settings.wallpaper.WallpaperTypeSettings;
  86 import com.android.settings.wifi.ConfigureWifiSettings;
  87 import com.android.settings.wifi.SavedAccessPointsWifiSettings;
  88 import com.android.settings.wifi.WifiSettings;
  89
  90 import java.util.Collection;
  91 import java.util.HashMap;
  92
  93 public final class SearchIndexableResources {
  94
  95     /**
  96      * Identifies subsettings which have an {@link SearchIndexableResource#intentAction} but
  97      * whose intents should still be treated as subsettings inside of Settings.
  98      */
  99     public static final String SUBSETTING_TARGET_PACKAGE = "subsetting_target_package";
 100
 101     @XmlRes
 102     public static final int NO_DATA_RES_ID = 0;
 103
 104     @VisibleForTesting(otherwise = VisibleForTesting.PRIVATE)
 105     static final HashMap<String, SearchIndexableResource> sResMap = new HashMap<>();
 106
 107     @VisibleForTesting
 108     static void addIndex(Class<?> indexClass, @XmlRes int xmlResId,
 109             @DrawableRes int iconResId) {
 110         addIndex(indexClass, xmlResId, iconResId, null /* targetAction */);
 111     }
 112
 113     @VisibleForTesting
 114     static void addIndex(Class<?> indexClass, @XmlRes int xmlResId,
 115             @DrawableRes int iconResId, String targetAction) {
 116         String className = indexClass.getName();
 117         SearchIndexableResource resource =
 118                 new SearchIndexableResource(0, xmlResId, className, iconResId);
 119
 120         if (!TextUtils.isEmpty(targetAction)) {
 121             resource.intentAction = targetAction;
 122             resource.intentTargetPackage = SUBSETTING_TARGET_PACKAGE;
 123         }
 124
 125         sResMap.put(className, resource);
 126     }
 127
 128     static {
 129         addIndex(WifiSettings.class, NO_DATA_RES_ID, R.drawable.ic_settings_wireless);
 130         addIndex(NetworkDashboardFragment.class, NO_DATA_RES_ID, R.drawable.ic_settings_wireless);
 131         addIndex(ConfigureWifiSettings.class, NO_DATA_RES_ID, R.drawable.ic_settings_wireless);
 132         addIndex(SavedAccessPointsWifiSettings.class, NO_DATA_RES_ID,
 133                 R.drawable.ic_settings_wireless);
 134         addIndex(BluetoothSettings.class, NO_DATA_RES_ID, R.drawable.ic_settings_bluetooth);
 135         addIndex(SimSettings.class, NO_DATA_RES_ID, R.drawable.ic_sim_sd);
 136         addIndex(DataUsageSummary.class, NO_DATA_RES_ID, R.drawable.ic_settings_data_usage);
 137         addIndex(DataUsageMeteredSettings.class, NO_DATA_RES_ID, R.drawable.ic_settings_data_usage);
 138         addIndex(ScreenZoomSettings.class, NO_DATA_RES_ID, R.drawable.ic_settings_display);
 139         addIndex(DisplaySettings.class, NO_DATA_RES_ID, R.drawable.ic_settings_display,
 140                 "android.settings.DISPLAY_SETTINGS");
 141         addIndex(AmbientDisplaySettings.class, NO_DATA_RES_ID, R.drawable.ic_settings_display);
 142         addIndex(WallpaperTypeSettings.class, NO_DATA_RES_ID, R.drawable.ic_settings_display);
 143         addIndex(ConfigureNotificationSettings.class,
 144                 R.xml.configure_notification_settings, R.drawable.ic_settings_notifications);
 145         addIndex(AppAndNotificationDashboardFragment.class, NO_DATA_RES_ID,
 146                 R.drawable.ic_settings_applications);
 147         addIndex(SoundSettings.class, NO_DATA_RES_ID, R.drawable.ic_settings_sound,
 148                 "android.settings.SOUND_SETTINGS");
 149         addIndex(ZenModeSettings.class,
 150                 R.xml.zen_mode_settings, R.drawable.ic_settings_notifications);
 151         addIndex(ZenModePrioritySettings.class,
 152                 R.xml.zen_mode_priority_settings, R.drawable.ic_settings_notifications);
 153         addIndex(StorageSettings.class, NO_DATA_RES_ID, R.drawable.ic_settings_storage);
 154         addIndex(PowerUsageSummary.class,
 155                 R.xml.power_usage_summary, R.drawable.ic_settings_battery);
 156         addIndex(PowerUsageAdvanced.class, NO_DATA_RES_ID, R.drawable.ic_settings_battery);
 157         addIndex(BatterySaverSettings.class,
 158                 R.xml.battery_saver_settings, R.drawable.ic_settings_battery);
 159         addIndex(AdvancedAppSettings.class, NO_DATA_RES_ID, R.drawable.ic_settings_applications);
 160         addIndex(ManageAssist.class, NO_DATA_RES_ID, R.drawable.ic_settings_applications);
 161         addIndex(SpecialAccessSettings.class, NO_DATA_RES_ID, R.drawable.ic_settings_applications);
 162         addIndex(UserSettings.class, NO_DATA_RES_ID, R.drawable.ic_settings_multiuser);
 163         addIndex(AssistGestureSettings.class, NO_DATA_RES_ID, R.drawable.ic_settings_gestures);
 164         addIndex(PickupGestureSettings.class, NO_DATA_RES_ID, R.drawable.ic_settings_gestures);
 165         addIndex(DoubleTapScreenSettings.class, NO_DATA_RES_ID, R.drawable.ic_settings_gestures);
 166         addIndex(DoubleTapPowerSettings.class, NO_DATA_RES_ID, R.drawable.ic_settings_gestures);
 167         addIndex(DoubleTwistGestureSettings.class, NO_DATA_RES_ID, R.drawable.ic_settings_gestures);
 168         addIndex(SwipeToNotificationSettings.class, NO_DATA_RES_ID,
 169                 R.drawable.ic_settings_gestures);
 170         addIndex(LanguageAndInputSettings.class, NO_DATA_RES_ID, R.drawable.ic_settings_language);
 171         addIndex(LocationSettings.class, R.xml.location_settings, R.drawable.ic_settings_location);
 172         addIndex(ScanningSettings.class, R.xml.location_scanning, R.drawable.ic_settings_location);
 173         addIndex(SecuritySettings.class, NO_DATA_RES_ID, R.drawable.ic_settings_security);
 174         addIndex(EncryptionAndCredential.class, NO_DATA_RES_ID, R.drawable.ic_settings_security);
 175         addIndex(ScreenPinningSettings.class, NO_DATA_RES_ID, R.drawable.ic_settings_security);
 176         addIndex(UserAndAccountDashboardFragment.class, NO_DATA_RES_ID,
 177                 R.drawable.ic_settings_accounts);
 178         addIndex(VirtualKeyboardFragment.class, NO_DATA_RES_ID, R.drawable.ic_settings_language);
 179         addIndex(AvailableVirtualKeyboardFragment.class,
 180                 NO_DATA_RES_ID, R.drawable.ic_settings_language);
 181         addIndex(PhysicalKeyboardFragment.class, NO_DATA_RES_ID, R.drawable.ic_settings_language);
 182         addIndex(BackupSettingsActivity.class, NO_DATA_RES_ID, R.drawable.ic_settings_backup);
 183         addIndex(BackupSettingsFragment.class, NO_DATA_RES_ID, R.drawable.ic_settings_backup);
 184         addIndex(DateTimeSettings.class, NO_DATA_RES_ID, R.drawable.ic_settings_date_time);
 185         addIndex(AccessibilitySettings.class, NO_DATA_RES_ID, R.drawable.ic_settings_accessibility);
 186         addIndex(PrintSettingsFragment.class, NO_DATA_RES_ID, R.drawable.ic_settings_print);
 187         addIndex(DevelopmentSettings.class, NO_DATA_RES_ID, R.drawable.ic_settings_development);
 188         addIndex(DeviceInfoSettings.class, NO_DATA_RES_ID, R.drawable.ic_settings_about);
 189         addIndex(LegalSettings.class, NO_DATA_RES_ID, R.drawable.ic_settings_about);
 190         addIndex(ZenModeVisualInterruptionSettings.class,
 191                 R.xml.zen_mode_visual_interruptions_settings,
 192                 R.drawable.ic_settings_notifications);
 193         addIndex(SystemDashboardFragment.class, NO_DATA_RES_ID, R.drawable.ic_settings_about);
 194         addIndex(ResetDashboardFragment.class, NO_DATA_RES_ID, R.drawable.ic_restore);
 195         addIndex(StorageDashboardFragment.class, NO_DATA_RES_ID, R.drawable.ic_settings_storage);
 196         addIndex(ConnectedDeviceDashboardFragment.class, NO_DATA_RES_ID,
 197                 R.drawable.ic_devices_other);
 198         addIndex(EnterprisePrivacySettings.class, NO_DATA_RES_ID, R.drawable.ic_settings_about);
 199         addIndex(PaymentSettings.class, NO_DATA_RES_ID, R.drawable.ic_settings_nfc_payment);
 200         addIndex(
 201                 TtsEnginePreferenceFragment.class, NO_DATA_RES_ID, R.drawable.ic_settings_language);
 202         addIndex(LockscreenDashboardFragment.class, R.xml.security_lockscreen_settings,
 203             R.drawable.ic_settings_security);
 204         addIndex(MagnificationPreferenceFragment.class, NO_DATA_RES_ID,
 205                 R.drawable.ic_settings_accessibility);
 206         addIndex(AccessibilityShortcutPreferenceFragment.class, NO_DATA_RES_ID,
 207                 R.drawable.ic_settings_accessibility);
 208         addIndex(ChannelImportanceSettings.class, NO_DATA_RES_ID,
 209                 R.drawable.ic_settings_notifications);
 210         addIndex(DreamSettings.class, NO_DATA_RES_ID, R.drawable.ic_settings_display);
 211         addIndex(SupportDashboardActivity.class, NO_DATA_RES_ID, R.drawable.ic_help);
 212     }
 213
 214     private SearchIndexableResources() {
 215     }
 216
 217     public static int size() {
 218         return sResMap.size();
 219     }
 220
 221     public static SearchIndexableResource getResourceByName(String className) {
 222         return sResMap.get(className);
 223     }
 224
 225     public static Collection<SearchIndexableResource> values() {
 226         return sResMap.values();
 227     }
 228 }