settings/display/AppGridView.java

/*
 * 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.settings.display;

import android.content.Context;
import android.content.Intent;
import android.content.pm.PackageManager;
import android.content.pm.ResolveInfo;
import android.content.res.TypedArray;
import android.graphics.drawable.Drawable;
import android.os.UserHandle;
import android.util.AttributeSet;
import android.util.IconDrawableFactory;
import android.util.Log;
import android.view.View;
import android.view.ViewGroup;
import android.widget.ArrayAdapter;
import android.widget.GridView;
import android.widget.ImageView;

import androidx.annotation.VisibleForTesting;
import androidx.core.util.Preconditions;

import com.android.settings.R;

import java.util.ArrayList;
import java.util.Collections;
import java.util.List;

/**
 * The grid view for displaying the application entries.
 *
 * <p> The attribute value {@code appCount} from XML should be more than or equal to 1, otherwise
 * throws an {@link IllegalArgumentException}.</p>
 */
public class AppGridView extends GridView {
    private static final String TAG = "AppGridView";

    private static final int APP_COUNT_DEF_VALUE = 6;
    private int mAppCount = APP_COUNT_DEF_VALUE;

    public AppGridView(Context context) {
        super(context);
        init(context);
    }

    public AppGridView(Context context, AttributeSet attrs) {
        super(context, attrs);
        applyAttributeSet(context, attrs);
        init(context);
    }

    public AppGridView(Context context, AttributeSet attrs, int defStyleAttr) {
        super(context, attrs, defStyleAttr);
        applyAttributeSet(context, attrs);
        init(context);
    }

    public AppGridView(Context context, AttributeSet attrs, int defStyleAttr, int defStyleResId) {
        super(context, attrs, defStyleAttr, defStyleResId);
        applyAttributeSet(context, attrs);
        init(context);
    }

    private void init(Context context) {
        setAdapter(new AppsAdapter(context, R.layout.screen_zoom_preview_app_icon,
                android.R.id.text1, android.R.id.icon1, mAppCount));
    }

    private void applyAttributeSet(Context context, AttributeSet attrs) {
        final TypedArray styledAttrs =
                context.obtainStyledAttributes(attrs, R.styleable.AppGridView);
        mAppCount =
                styledAttrs.getInteger(R.styleable.AppGridView_appCount, APP_COUNT_DEF_VALUE);
        Preconditions.checkArgument(mAppCount >= 1,
                /* errorMessage= */ "App count may not be negative or zero");

        styledAttrs.recycle();
    }

    /**
     * Loads application labels and icons.
     */
    @VisibleForTesting
    public static class AppsAdapter extends ArrayAdapter<ActivityEntry> {
        private final PackageManager mPackageManager;
        private final int mIconResId;
        private final int mAppCount;

        public AppsAdapter(Context context, int layout, int textResId, int iconResId,
                int appCount) {
            super(context, layout, textResId);

            mIconResId = iconResId;
            mPackageManager = context.getPackageManager();
            mAppCount = appCount;

            loadAllApps();
        }

        @Override
        public View getView(int position, View convertView, ViewGroup parent) {
            final View view = super.getView(position, convertView, parent);
            final ActivityEntry entry = getItem(position);
            final ImageView iconView = view.findViewById(mIconResId);
            iconView.setImageDrawable(entry.getIcon());
            return view;
        }

        @Override
        public boolean hasStableIds() {
            return true;
        }

        @Override
        public long getItemId(int position) {
            return position;
        }

        @Override
        public boolean isEnabled(int position) {
            return false;
        }

        private void loadAllApps() {
            final Intent mainIntent = new Intent(Intent.ACTION_MAIN, null);
            mainIntent.addCategory(Intent.CATEGORY_LAUNCHER);

            final PackageManager pm = mPackageManager;
            final ArrayList<ActivityEntry> results = new ArrayList<>();
            final List<ResolveInfo> infos = pm.queryIntentActivities(mainIntent, 0);

            if (mAppCount > infos.size()) {
                Log.d(TAG, "Visible app icon count does not meet the target count.");
            }

            final IconDrawableFactory iconFactory = IconDrawableFactory.newInstance(getContext());
            for (ResolveInfo info : infos) {
                final CharSequence label = info.loadLabel(pm);
                if (label != null) {
                    results.add(new ActivityEntry(info, label.toString(), iconFactory));
                }
                if (results.size() >= mAppCount) {
                    break;
                }
            }

            Collections.sort(results);

            addAll(results);
        }
    }

    /**
     * Class used for caching the activity label and icon.
     */
    @VisibleForTesting
    public static class ActivityEntry implements Comparable<ActivityEntry> {

        public final ResolveInfo info;
        public final String label;
        private final IconDrawableFactory mIconFactory;
        private final int mUserId;

        public ActivityEntry(ResolveInfo info, String label, IconDrawableFactory iconFactory) {
            this.info = info;
            this.label = label;
            mIconFactory = iconFactory;
            mUserId = UserHandle.myUserId();
        }

        @Override
        public int compareTo(ActivityEntry entry) {
            return label.compareToIgnoreCase(entry.label);
        }

        @Override
        public String toString() {
            return label;
        }

        public Drawable getIcon() {
            return mIconFactory.getBadgedIcon(
                    info.activityInfo, info.activityInfo.applicationInfo, mUserId);
        }
    }
}