From af2a1a2e5f7dcedb4595fb56e65ace002bcd740c Mon Sep 17 00:00:00 2001 From: Eric Erfanian Date: Mon, 24 Jul 2017 11:01:58 -0700 Subject: Move contacts common LetterTile class into its own package. A subsequent change will move the ContactPhotoManager related code, eventually enabling the removal of contacts/common. Bug: 37208805 Test: TAP PiperOrigin-RevId: 161724700 Change-Id: Ice0789951ae544f6e27bcdaab0c032b218c83613 --- .../common/lettertiles/LetterTileDrawable.java | 439 --------------------- 1 file changed, 439 deletions(-) delete mode 100644 java/com/android/contacts/common/lettertiles/LetterTileDrawable.java (limited to 'java/com/android/contacts/common/lettertiles/LetterTileDrawable.java') diff --git a/java/com/android/contacts/common/lettertiles/LetterTileDrawable.java b/java/com/android/contacts/common/lettertiles/LetterTileDrawable.java deleted file mode 100644 index 73809c467..000000000 --- a/java/com/android/contacts/common/lettertiles/LetterTileDrawable.java +++ /dev/null @@ -1,439 +0,0 @@ -/* - * Copyright (C) 2013 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.contacts.common.lettertiles; - -import android.content.res.Resources; -import android.content.res.TypedArray; -import android.graphics.Bitmap; -import android.graphics.Bitmap.Config; -import android.graphics.Canvas; -import android.graphics.ColorFilter; -import android.graphics.Outline; -import android.graphics.Paint; -import android.graphics.Paint.Align; -import android.graphics.Rect; -import android.graphics.Typeface; -import android.graphics.drawable.Drawable; -import android.support.annotation.IntDef; -import android.support.annotation.NonNull; -import android.support.annotation.Nullable; -import android.telecom.TelecomManager; -import android.text.TextUtils; -import com.android.contacts.common.R; -import com.android.dialer.common.Assert; -import java.lang.annotation.Retention; -import java.lang.annotation.RetentionPolicy; - -/** - * A drawable that encapsulates all the functionality needed to display a letter tile to represent a - * contact image. - */ -public class LetterTileDrawable extends Drawable { - - /** - * ContactType indicates the avatar type of the contact. For a person or for the default when no - * name is provided, it is {@link #TYPE_DEFAULT}, otherwise, for a business it is {@link - * #TYPE_BUSINESS}, and voicemail contacts should use {@link #TYPE_VOICEMAIL}. - */ - @Retention(RetentionPolicy.SOURCE) - @IntDef({TYPE_PERSON, TYPE_BUSINESS, TYPE_VOICEMAIL, TYPE_GENERIC_AVATAR, TYPE_SPAM}) - public @interface ContactType {} - - /** Contact type constants */ - public static final int TYPE_PERSON = 1; - public static final int TYPE_BUSINESS = 2; - public static final int TYPE_VOICEMAIL = 3; - /** - * A generic avatar that features the default icon, default color, and no letter. Useful for - * situations where a contact is anonymous. - */ - public static final int TYPE_GENERIC_AVATAR = 4; - public static final int TYPE_SPAM = 5; - public static final int TYPE_CONFERENCE = 6; - @ContactType public static final int TYPE_DEFAULT = TYPE_PERSON; - - /** - * Shape indicates the letter tile shape. It can be either a {@link #SHAPE_CIRCLE}, otherwise, it - * is a {@link #SHAPE_RECTANGLE}. - */ - @Retention(RetentionPolicy.SOURCE) - @IntDef({SHAPE_CIRCLE, SHAPE_RECTANGLE}) - public @interface Shape {} - - /** Shape constants */ - public static final int SHAPE_CIRCLE = 1; - - public static final int SHAPE_RECTANGLE = 2; - - /** 54% opacity */ - private static final int ALPHA = 138; - /** 100% opacity */ - private static final int SPAM_ALPHA = 255; - /** Default icon scale for vector drawable. */ - private static final float VECTOR_ICON_SCALE = 0.7f; - - /** Reusable components to avoid new allocations */ - private final Paint mPaint = new Paint(); - - private final Rect mRect = new Rect(); - private final char[] mFirstChar = new char[1]; - - /** Letter tile */ - @NonNull private final TypedArray mColors; - - private final int mSpamColor; - private final int mDefaultColor; - private final int mTileFontColor; - private final float mLetterToTileRatio; - @NonNull private final Drawable mDefaultPersonAvatar; - @NonNull private final Drawable mDefaultBusinessAvatar; - @NonNull private final Drawable mDefaultVoicemailAvatar; - @NonNull private final Drawable mDefaultSpamAvatar; - @NonNull private final Drawable mDefaultConferenceAvatar; - - @ContactType private int mContactType = TYPE_DEFAULT; - private float mScale = 1.0f; - private float mOffset = 0.0f; - private boolean mIsCircle = false; - - private int mColor; - private Character mLetter = null; - - private String mDisplayName; - - public LetterTileDrawable(final Resources res) { - mColors = res.obtainTypedArray(R.array.letter_tile_colors); - mSpamColor = res.getColor(R.color.spam_contact_background); - mDefaultColor = res.getColor(R.color.letter_tile_default_color); - mTileFontColor = res.getColor(R.color.letter_tile_font_color); - mLetterToTileRatio = res.getFraction(R.dimen.letter_to_tile_ratio, 1, 1); - mDefaultPersonAvatar = - res.getDrawable(R.drawable.product_logo_avatar_anonymous_white_color_120, null); - mDefaultBusinessAvatar = res.getDrawable(R.drawable.quantum_ic_business_vd_theme_24, null); - mDefaultVoicemailAvatar = res.getDrawable(R.drawable.quantum_ic_voicemail_vd_theme_24, null); - mDefaultSpamAvatar = res.getDrawable(R.drawable.quantum_ic_report_vd_theme_24, null); - mDefaultConferenceAvatar = res.getDrawable(R.drawable.quantum_ic_group_vd_theme_24, null); - - mPaint.setTypeface( - Typeface.create(res.getString(R.string.letter_tile_letter_font_family), Typeface.NORMAL)); - mPaint.setTextAlign(Align.CENTER); - mPaint.setAntiAlias(true); - mPaint.setFilterBitmap(true); - mPaint.setDither(true); - mColor = mDefaultColor; - } - - private Rect getScaledBounds(float scale, float offset) { - // The drawable should be drawn in the middle of the canvas without changing its width to - // height ratio. - final Rect destRect = copyBounds(); - // Crop the destination bounds into a square, scaled and offset as appropriate - final int halfLength = (int) (scale * Math.min(destRect.width(), destRect.height()) / 2); - - destRect.set( - destRect.centerX() - halfLength, - (int) (destRect.centerY() - halfLength + offset * destRect.height()), - destRect.centerX() + halfLength, - (int) (destRect.centerY() + halfLength + offset * destRect.height())); - return destRect; - } - - private Drawable getDrawableForContactType(int contactType) { - switch (contactType) { - case TYPE_BUSINESS: - mScale = VECTOR_ICON_SCALE; - return mDefaultBusinessAvatar; - case TYPE_VOICEMAIL: - mScale = VECTOR_ICON_SCALE; - return mDefaultVoicemailAvatar; - case TYPE_SPAM: - mScale = VECTOR_ICON_SCALE; - return mDefaultSpamAvatar; - case TYPE_CONFERENCE: - mScale = VECTOR_ICON_SCALE; - return mDefaultConferenceAvatar; - case TYPE_PERSON: - case TYPE_GENERIC_AVATAR: - default: - return mDefaultPersonAvatar; - } - } - - private static boolean isEnglishLetter(final char c) { - return ('A' <= c && c <= 'Z') || ('a' <= c && c <= 'z'); - } - - @Override - public void draw(@NonNull final Canvas canvas) { - final Rect bounds = getBounds(); - if (!isVisible() || bounds.isEmpty()) { - return; - } - // Draw letter tile. - drawLetterTile(canvas); - } - - public Bitmap getBitmap(int width, int height) { - Bitmap bitmap = Bitmap.createBitmap(width, height, Config.ARGB_8888); - this.setBounds(0, 0, width, height); - Canvas canvas = new Canvas(bitmap); - this.draw(canvas); - return bitmap; - } - - private void drawLetterTile(final Canvas canvas) { - // Draw background color. - mPaint.setColor(mColor); - - final Rect bounds = getBounds(); - final int minDimension = Math.min(bounds.width(), bounds.height()); - - if (mIsCircle) { - canvas.drawCircle(bounds.centerX(), bounds.centerY(), minDimension / 2, mPaint); - } else { - canvas.drawRect(bounds, mPaint); - } - - // Draw letter/digit only if the first character is an english letter or there's a override - if (mLetter != null) { - // Draw letter or digit. - mFirstChar[0] = mLetter; - - // Scale text by canvas bounds and user selected scaling factor - mPaint.setTextSize(mScale * mLetterToTileRatio * minDimension); - mPaint.getTextBounds(mFirstChar, 0, 1, mRect); - mPaint.setTypeface(Typeface.create("sans-serif", Typeface.NORMAL)); - mPaint.setColor(mTileFontColor); - mPaint.setAlpha(ALPHA); - - // Draw the letter in the canvas, vertically shifted up or down by the user-defined - // offset - canvas.drawText( - mFirstChar, - 0, - 1, - bounds.centerX(), - bounds.centerY() + mOffset * bounds.height() - mRect.exactCenterY(), - mPaint); - } else { - // Draw the default image if there is no letter/digit to be drawn - Drawable drawable = getDrawableForContactType(mContactType); - if (drawable == null) { - throw Assert.createIllegalStateFailException( - "Unable to find drawable for contact type " + mContactType); - } - - drawable.setBounds(getScaledBounds(mScale, mOffset)); - drawable.setAlpha(drawable == mDefaultSpamAvatar ? SPAM_ALPHA : ALPHA); - drawable.draw(canvas); - } - } - - public int getColor() { - return mColor; - } - - public LetterTileDrawable setColor(int color) { - mColor = color; - return this; - } - - /** Returns a deterministic color based on the provided contact identifier string. */ - private int pickColor(final String identifier) { - if (mContactType == TYPE_SPAM) { - return mSpamColor; - } - - if (mContactType == TYPE_VOICEMAIL - || mContactType == TYPE_BUSINESS - || TextUtils.isEmpty(identifier)) { - return mDefaultColor; - } - - // String.hashCode() implementation is not supposed to change across java versions, so - // this should guarantee the same email address always maps to the same color. - // The email should already have been normalized by the ContactRequest. - final int color = Math.abs(identifier.hashCode()) % mColors.length(); - return mColors.getColor(color, mDefaultColor); - } - - @Override - public void setAlpha(final int alpha) { - mPaint.setAlpha(alpha); - } - - @Override - public void setColorFilter(final ColorFilter cf) { - mPaint.setColorFilter(cf); - } - - @Override - public int getOpacity() { - return android.graphics.PixelFormat.OPAQUE; - } - - @Override - public void getOutline(Outline outline) { - if (mIsCircle) { - outline.setOval(getBounds()); - } else { - outline.setRect(getBounds()); - } - - outline.setAlpha(1); - } - - /** - * Scale the drawn letter tile to a ratio of its default size - * - * @param scale The ratio the letter tile should be scaled to as a percentage of its default size, - * from a scale of 0 to 2.0f. The default is 1.0f. - */ - public LetterTileDrawable setScale(float scale) { - mScale = scale; - return this; - } - - /** - * Assigns the vertical offset of the position of the letter tile to the ContactDrawable - * - * @param offset The provided offset must be within the range of -0.5f to 0.5f. If set to -0.5f, - * the letter will be shifted upwards by 0.5 times the height of the canvas it is being drawn - * on, which means it will be drawn with the center of the letter starting at the top edge of - * the canvas. If set to 0.5f, the letter will be shifted downwards by 0.5 times the height of - * the canvas it is being drawn on, which means it will be drawn with the center of the letter - * starting at the bottom edge of the canvas. The default is 0.0f. - */ - public LetterTileDrawable setOffset(float offset) { - Assert.checkArgument(offset >= -0.5f && offset <= 0.5f); - mOffset = offset; - return this; - } - - public LetterTileDrawable setLetter(Character letter) { - mLetter = letter; - return this; - } - - public Character getLetter() { - return this.mLetter; - } - - private LetterTileDrawable setLetterAndColorFromContactDetails( - final String displayName, final String identifier) { - if (!TextUtils.isEmpty(displayName) && isEnglishLetter(displayName.charAt(0))) { - mLetter = Character.toUpperCase(displayName.charAt(0)); - } else { - mLetter = null; - } - mColor = pickColor(identifier); - return this; - } - - private LetterTileDrawable setContactType(@ContactType int contactType) { - mContactType = contactType; - return this; - } - - @ContactType - public int getContactType() { - return this.mContactType; - } - - public LetterTileDrawable setIsCircular(boolean isCircle) { - mIsCircle = isCircle; - return this; - } - - public boolean tileIsCircular() { - return this.mIsCircle; - } - - /** - * Creates a canonical letter tile for use across dialer fragments. - * - * @param displayName The display name to produce the letter in the tile. Null values or numbers - * yield no letter. - * @param identifierForTileColor The string used to produce the tile color. - * @param shape The shape of the tile. - * @param contactType The type of contact, e.g. TYPE_VOICEMAIL. - * @return this - */ - public LetterTileDrawable setCanonicalDialerLetterTileDetails( - @Nullable final String displayName, - @Nullable final String identifierForTileColor, - @Shape final int shape, - final int contactType) { - - this.setIsCircular(shape == SHAPE_CIRCLE); - - /** - * We return quickly under the following conditions: 1. We are asked to draw a default tile, and - * no coloring information is provided, meaning no further initialization is necessary OR 2. - * We've already invoked this method before, set mDisplayName, and found that it has not - * changed. This is useful during events like hangup, when we lose the call state for special - * types of contacts, like voicemail. We keep track of the special case until we encounter a new - * display name. - */ - if (contactType == TYPE_DEFAULT - && ((displayName == null && identifierForTileColor == null) - || (displayName != null && displayName.equals(mDisplayName)))) { - return this; - } - - this.mDisplayName = displayName; - setContactType(contactType); - - // Special contact types receive default color and no letter tile, but special iconography. - if (contactType != TYPE_PERSON) { - this.setLetterAndColorFromContactDetails(null, null); - } else { - if (identifierForTileColor != null) { - this.setLetterAndColorFromContactDetails(displayName, identifierForTileColor); - } else { - this.setLetterAndColorFromContactDetails(displayName, displayName); - } - } - return this; - } - - /** - * Returns the appropriate LetterTileDrawable.TYPE_ based on the given primitive conditions. - * - *

If no special state is detected, yields TYPE_DEFAULT - */ - public static @ContactType int getContactTypeFromPrimitives( - boolean isVoicemailNumber, - boolean isSpam, - boolean isBusiness, - int numberPresentation, - boolean isConference) { - if (isVoicemailNumber) { - return LetterTileDrawable.TYPE_VOICEMAIL; - } else if (isSpam) { - return LetterTileDrawable.TYPE_SPAM; - } else if (isBusiness) { - return LetterTileDrawable.TYPE_BUSINESS; - } else if (numberPresentation == TelecomManager.PRESENTATION_RESTRICTED) { - return LetterTileDrawable.TYPE_GENERIC_AVATAR; - } else if (isConference) { - return LetterTileDrawable.TYPE_CONFERENCE; - } else { - return LetterTileDrawable.TYPE_DEFAULT; - } - } -} -- cgit v1.2.3