/*
 * Copyright (C) 2016 The Android Open Source Project
 *
 * 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.android.settingslib;

import android.content.Context;
import android.content.res.TypedArray;
import android.graphics.drawable.Drawable;
import android.os.UserHandle;
import android.support.v7.preference.Preference;
import android.support.v7.preference.PreferenceViewHolder;
import android.text.TextUtils;
import android.util.AttributeSet;
import android.util.TypedValue;
import android.view.View;
import android.widget.TextView;

import static com.android.settingslib.RestrictedLockUtils.EnforcedAdmin;

Helper class for managing settings preferences that can be disabled by device admins via user restrictions.
/** * Helper class for managing settings preferences that can be disabled * by device admins via user restrictions. */
public class RestrictedPreferenceHelper { private final Context mContext; private final Preference mPreference; private boolean mDisabledByAdmin; private EnforcedAdmin mEnforcedAdmin; private String mAttrUserRestriction = null; private boolean mUseAdminDisabledSummary = false; public RestrictedPreferenceHelper(Context context, Preference preference, AttributeSet attrs) { mContext = context; mPreference = preference; if (attrs != null) { final TypedArray attributes = context.obtainStyledAttributes(attrs, R.styleable.RestrictedPreference); final TypedValue userRestriction = attributes.peekValue(R.styleable.RestrictedPreference_userRestriction); CharSequence data = null; if (userRestriction != null && userRestriction.type == TypedValue.TYPE_STRING) { if (userRestriction.resourceId != 0) { data = context.getText(userRestriction.resourceId); } else { data = userRestriction.string; } } mAttrUserRestriction = data == null ? null : data.toString(); // If the system has set the user restriction, then we shouldn't add the padlock. if (RestrictedLockUtils.hasBaseUserRestriction(mContext, mAttrUserRestriction, UserHandle.myUserId())) { mAttrUserRestriction = null; return; } final TypedValue useAdminDisabledSummary = attributes.peekValue(R.styleable.RestrictedPreference_useAdminDisabledSummary); if (useAdminDisabledSummary != null) { mUseAdminDisabledSummary = (useAdminDisabledSummary.type == TypedValue.TYPE_INT_BOOLEAN && useAdminDisabledSummary.data != 0); } } }
Modify PreferenceViewHolder to add padlock if restriction is disabled.
/** * Modify PreferenceViewHolder to add padlock if restriction is disabled. */
public void onBindViewHolder(PreferenceViewHolder holder) { if (mDisabledByAdmin) { holder.itemView.setEnabled(true); } if (mUseAdminDisabledSummary) { final TextView summaryView = (TextView) holder.findViewById(android.R.id.summary); if (summaryView != null) { final CharSequence disabledText = summaryView.getContext().getText( R.string.disabled_by_admin_summary_text); if (mDisabledByAdmin) { summaryView.setText(disabledText); } else if (TextUtils.equals(disabledText, summaryView.getText())) { // It's previously set to disabled text, clear it. summaryView.setText(null); } } } } public void useAdminDisabledSummary(boolean useSummary) { mUseAdminDisabledSummary = useSummary; }
Check if the preference is disabled if so handle the click by informing the user.
Returns:true if the method handled the click.
/** * Check if the preference is disabled if so handle the click by informing the user. * * @return true if the method handled the click. */
public boolean performClick() { if (mDisabledByAdmin) { RestrictedLockUtils.sendShowAdminSupportDetailsIntent(mContext, mEnforcedAdmin); return true; } return false; }
Disable / enable if we have been passed the restriction in the xml.
/** * Disable / enable if we have been passed the restriction in the xml. */
public void onAttachedToHierarchy() { if (mAttrUserRestriction != null) { checkRestrictionAndSetDisabled(mAttrUserRestriction, UserHandle.myUserId()); } }
Set the user restriction that is used to disable this preference.
Params:
  • userRestriction – constant from UserManager
  • userId – user to check the restriction for.
/** * Set the user restriction that is used to disable this preference. * * @param userRestriction constant from {@link android.os.UserManager} * @param userId user to check the restriction for. */
public void checkRestrictionAndSetDisabled(String userRestriction, int userId) { EnforcedAdmin admin = RestrictedLockUtils.checkIfRestrictionEnforced(mContext, userRestriction, userId); setDisabledByAdmin(admin); }
Disable this preference based on the enforce admin.
Params:
  • EnforcedAdmin – Details of the admin who enforced the restriction. If it is null, then this preference will be enabled. Otherwise, it will be disabled.
Returns:true if the disabled state was changed.
/** * Disable this preference based on the enforce admin. * * @param EnforcedAdmin Details of the admin who enforced the restriction. If it * is {@code null}, then this preference will be enabled. Otherwise, it will be disabled. * @return true if the disabled state was changed. */
public boolean setDisabledByAdmin(EnforcedAdmin admin) { final boolean disabled = (admin != null ? true : false); mEnforcedAdmin = admin; boolean changed = false; if (mDisabledByAdmin != disabled) { mDisabledByAdmin = disabled; changed = true; } mPreference.setEnabled(!disabled); return changed; } public boolean isDisabledByAdmin() { return mDisabledByAdmin; } }