Java tutorial
/* * 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 net.ddns.mlsoftlaberge.trycorder.contacts; import android.annotation.SuppressLint; import android.annotation.TargetApi; import android.app.Activity; import android.app.SearchManager; import android.content.Context; import android.content.Intent; import android.content.res.AssetFileDescriptor; import android.database.Cursor; import android.graphics.Bitmap; import android.media.MediaPlayer; import android.net.Uri; import android.os.Build; import android.os.Bundle; import android.provider.ContactsContract.Contacts; import android.provider.ContactsContract.Contacts.Photo; import android.support.v4.app.ListFragment; import android.support.v4.app.LoaderManager; import android.support.v4.content.CursorLoader; import android.support.v4.content.Loader; import android.support.v4.widget.CursorAdapter; import android.text.SpannableString; import android.text.TextUtils; import android.text.style.TextAppearanceSpan; import android.util.DisplayMetrics; import android.util.Log; import android.util.TypedValue; import android.view.LayoutInflater; import android.view.Menu; import android.view.MenuInflater; import android.view.MenuItem; import android.view.View; import android.view.ViewGroup; import android.widget.AbsListView; import android.widget.AdapterView; import android.widget.AlphabetIndexer; import android.widget.Button; import android.widget.ImageButton; import android.widget.QuickContactBadge; import android.widget.SearchView; import android.widget.SectionIndexer; import android.widget.TextView; import net.ddns.mlsoftlaberge.trycorder.BuildConfig; import net.ddns.mlsoftlaberge.trycorder.R; import java.io.FileDescriptor; import java.io.FileNotFoundException; import java.io.IOException; import java.util.Locale; /** * This fragment displays a list of contacts stored in the Contacts Provider. Each item in the list * shows the contact's thumbnail photo and display name. On devices with large screens, this * fragment's UI appears as part of a two-pane layout, along with the UI of * ContactAdminFragment. On smaller screens, this fragment's UI appears as a single pane. * <p/> * This Fragment retrieves contacts based on a search string. If the user doesn't enter a search * string, then the list contains all the contacts in the Contacts Provider. If the user enters a * search string, then the list contains only those contacts whose data matches the string. The * Contacts Provider itself controls the matching algorithm, which is a "substring" search: if the * search string is a substring of any of the contacts data, then there is a match. * <p/> * On newer API platforms, the search is implemented in a SearchView in the ActionBar; as the user * types the search string, the list automatically refreshes to display results ("type to filter"). * On older platforms, the user must enter the full string and trigger the search. In response, the * trigger starts a new Activity which loads a fresh instance of this fragment. The resulting UI * displays the filtered list and disables the search feature to prevent furthering searching. */ public class ContactsListFragment extends ListFragment implements AdapterView.OnItemClickListener, LoaderManager.LoaderCallbacks<Cursor> { // Defines a tag for identifying log entries private static final String TAG = "ContactsListFragment"; // Bundle key for saving previously selected search result item private static final String STATE_PREVIOUSLY_SELECTED_KEY = "net.ddns.mlsoftlaberge.trycorder.contacts.SELECTED_ITEM"; private ContactsAdapter mAdapter; // The main query adapter private ImageLoader mImageLoader; // Handles loading the contact image in a background thread // Contact selected listener that allows the activity holding this fragment to be notified of // a contact being selected private OnContactsInteractionListener mOnContactSelectedListener; // keep the flag if we want starred filter or not private int starredfind = 1; private View mContainer; /** * Fragments require an empty constructor. */ public ContactsListFragment() { } @Override public void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); // Create the main contacts adapter mAdapter = new ContactsAdapter(getActivity()); /* * An ImageLoader object loads and resizes an image in the background and binds it to the * QuickContactBadge in each item layout of the ListView. ImageLoader implements memory * caching for each image, which substantially improves refreshes of the ListView as the * user scrolls through it. * * To learn more about downloading images asynchronously and caching the results, read the * Android training class Displaying Bitmaps Efficiently. * * http://developer.android.com/training/displaying-bitmaps/ */ mImageLoader = new ImageLoader(getActivity(), getListPreferredItemHeight()) { @Override protected Bitmap processBitmap(Object data) { // This gets called in a background thread and passed the data from // ImageLoader.loadImage(). return loadContactPhotoThumbnail((String) data, getImageSize()); } }; // Set a placeholder loading image for the image loader mImageLoader.setLoadingImage(R.drawable.ic_contact_picture); // Add a cache to the image loader mImageLoader.addImageCache(getActivity().getSupportFragmentManager(), 0.1f); } private ImageButton mBacktopButton; private Button mBackButton; private Button mAddButton; private Button mBudgetButton; private Button mStarredButton; @Override public View onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState) { // Inflate the list fragment layout View view = inflater.inflate(R.layout.contact_list_fragment, container, false); // the main content screen mContainer = view.findViewById(R.id.main_content); // the search button mBacktopButton = (ImageButton) view.findViewById(R.id.backtop_button); mBacktopButton.setOnClickListener(new View.OnClickListener() { @Override public void onClick(View view) { buttonsound(); buttonback(); } }); // the search button mBackButton = (Button) view.findViewById(R.id.back_button); mBackButton.setOnClickListener(new View.OnClickListener() { @Override public void onClick(View view) { buttonsound(); buttonback(); } }); // the search button mAddButton = (Button) view.findViewById(R.id.add_button); mAddButton.setOnClickListener(new View.OnClickListener() { @Override public void onClick(View view) { buttonsound(); buttonadd(); } }); // the search button mBudgetButton = (Button) view.findViewById(R.id.budget_button); mBudgetButton.setOnClickListener(new View.OnClickListener() { @Override public void onClick(View view) { buttonsound(); buttonbudget(); } }); // the search button mStarredButton = (Button) view.findViewById(R.id.starred_button); mStarredButton.setOnClickListener(new View.OnClickListener() { @Override public void onClick(View view) { buttonsound(); buttonstarred(); } }); // return the filled view return view; } private void buttonsound() { MediaPlayer mediaPlayer = MediaPlayer.create(getActivity().getBaseContext(), R.raw.keyok2); mediaPlayer.start(); // no need to call prepare(); create() does that for you } private void buttonback() { getActivity().finish(); } private void buttonadd() { final Intent intent = new Intent(Intent.ACTION_INSERT, Contacts.CONTENT_URI); startActivity(intent); } private void buttonbudget() { Intent intentbudget = new Intent(getActivity(), ContactsBudgetActivity.class); startActivity(intentbudget); } private void buttonstarred() { // switch the starred flag on/off if (starredfind == 0) { starredfind = 1; } else { starredfind = 0; } // reread the list with new flag getLoaderManager().restartLoader(ContactsQuery.QUERY_ID, null, ContactsListFragment.this); } @Override public void onActivityCreated(Bundle savedInstanceState) { super.onActivityCreated(savedInstanceState); // Set up ListView, assign adapter and set some listeners. The adapter was previously // created in onCreate(). setListAdapter(mAdapter); getListView().setOnItemClickListener(this); getListView().setOnScrollListener(new AbsListView.OnScrollListener() { @Override public void onScrollStateChanged(AbsListView absListView, int scrollState) { // Pause image loader to ensure smoother scrolling when flinging if (scrollState == AbsListView.OnScrollListener.SCROLL_STATE_FLING) { mImageLoader.setPauseWork(true); } else { mImageLoader.setPauseWork(false); } } @Override public void onScroll(AbsListView absListView, int i, int i1, int i2) { } }); // reread the list with new flag getLoaderManager().restartLoader(ContactsQuery.QUERY_ID, null, ContactsListFragment.this); } @Override public void onAttach(Activity activity) { super.onAttach(activity); try { // Assign callback listener which the holding activity must implement. This is used // so that when a contact item is interacted with (selected by the user) the holding // activity will be notified and can take further action such as populating the contact // detail pane (if in multi-pane layout) or starting a new activity with the contact // details (single pane layout). mOnContactSelectedListener = (OnContactsInteractionListener) activity; } catch (ClassCastException e) { throw new ClassCastException(activity.toString() + " must implement OnContactsInteractionListener"); } } @Override public void onPause() { super.onPause(); // In the case onPause() is called during a fling the image loader is // un-paused to let any remaining background work complete. mImageLoader.setPauseWork(false); } @Override public void onItemClick(AdapterView<?> parent, View v, int position, long id) { buttonsound(); // Gets the Cursor object currently bound to the ListView final Cursor cursor = mAdapter.getCursor(); // Moves to the Cursor row corresponding to the ListView item that was clicked cursor.moveToPosition(position); // Creates a contact lookup Uri from contact ID and lookup_key final Uri uri = Contacts.getLookupUri(cursor.getLong(ContactsQuery.ID), cursor.getString(ContactsQuery.LOOKUP_KEY)); // Notifies the parent activity that the user selected a contact. In a two-pane layout, the // parent activity loads a ContactAdminFragment that displays the details for the selected // contact. In a single-pane layout, the parent activity starts a new activity that // displays contact details in its own Fragment. mOnContactSelectedListener.onContactSelected(uri); } /** * Called when ListView selection is cleared, for example * when search mode is finished and the currently selected * contact should no longer be selected. */ private void onSelectionCleared() { // Uses callback to notify activity this contains this fragment mOnContactSelectedListener.onSelectionCleared(); // Clears currently checked item getListView().clearChoices(); } @Override public void onSaveInstanceState(Bundle outState) { super.onSaveInstanceState(outState); } @Override public Loader<Cursor> onCreateLoader(int id, Bundle args) { // If this is the loader for finding contacts in the Contacts Provider // (the only one supported) if (id == ContactsQuery.QUERY_ID) { Uri contentUri; // There are two types of searches, one which displays all contacts and // one which filters contacts by a search query. If mSearchTerm is set // then a search query has been entered and the latter should be used. contentUri = ContactsQuery.CONTENT_URI; // Returns a new CursorLoader for querying the Contacts table. No arguments are used // for the selection clause. The search string is either encoded onto the content URI, // or no contacts search string is used. The other search criteria are constants. See // the ContactsQuery interface. if (starredfind == 0) { return new CursorLoader(getActivity(), contentUri, ContactsQuery.PROJECTION, ContactsQuery.SELECTION, null, ContactsQuery.SORT_ORDER); } else { return new CursorLoader(getActivity(), contentUri, ContactsQuery.PROJECTION, ContactsQuery.SELECTION2, null, ContactsQuery.SORT_ORDER); } } Log.e(TAG, "onCreateLoader - incorrect ID provided (" + id + ")"); return null; } @Override public void onLoadFinished(Loader<Cursor> loader, Cursor data) { // This swaps the new cursor into the adapter. if (loader.getId() == ContactsQuery.QUERY_ID) { mAdapter.swapCursor(data); } } @Override public void onLoaderReset(Loader<Cursor> loader) { if (loader.getId() == ContactsQuery.QUERY_ID) { // When the loader is being reset, clear the cursor from the adapter. This allows the // cursor resources to be freed. mAdapter.swapCursor(null); } } /** * Gets the preferred height for each item in the ListView, in pixels, after accounting for * screen density. ImageLoader uses this value to resize thumbnail images to match the ListView * item height. * * @return The preferred height in pixels, based on the current theme. */ private int getListPreferredItemHeight() { final TypedValue typedValue = new TypedValue(); // Resolve list item preferred height theme attribute into typedValue getActivity().getTheme().resolveAttribute(android.R.attr.listPreferredItemHeight, typedValue, true); // Create a new DisplayMetrics object final DisplayMetrics metrics = new android.util.DisplayMetrics(); // Populate the DisplayMetrics getActivity().getWindowManager().getDefaultDisplay().getMetrics(metrics); // Return theme value based on DisplayMetrics return (int) typedValue.getDimension(metrics); } /** * Decodes and scales a contact's image from a file pointed to by a Uri in the contact's data, * and returns the result as a Bitmap. The column that contains the Uri varies according to the * platform version. * * @param photoData For platforms prior to Android 3.0, provide the Contact._ID column value. * For Android 3.0 and later, provide the Contact.PHOTO_THUMBNAIL_URI value. * @param imageSize The desired target width and height of the output image in pixels. * @return A Bitmap containing the contact's image, resized to fit the provided image size. If * no thumbnail exists, returns null. */ private Bitmap loadContactPhotoThumbnail(String photoData, int imageSize) { // Ensures the Fragment is still added to an activity. As this method is called in a // background thread, there's the possibility the Fragment is no longer attached and // added to an activity. If so, no need to spend resources loading the contact photo. if (!isAdded() || getActivity() == null) { return null; } // Instantiates an AssetFileDescriptor. Given a content Uri pointing to an image file, the // ContentResolver can return an AssetFileDescriptor for the file. AssetFileDescriptor afd = null; // This "try" block catches an Exception if the file descriptor returned from the Contacts // Provider doesn't point to an existing file. try { Uri thumbUri; // If Android 3.0 or later, converts the Uri passed as a string to a Uri object. if (Utils.hasHoneycomb()) { thumbUri = Uri.parse(photoData); } else { // For versions prior to Android 3.0, appends the string argument to the content // Uri for the Contacts table. final Uri contactUri = Uri.withAppendedPath(Contacts.CONTENT_URI, photoData); // Appends the content Uri for the Contacts.Photo table to the previously // constructed contact Uri to yield a content URI for the thumbnail image thumbUri = Uri.withAppendedPath(contactUri, Photo.CONTENT_DIRECTORY); } // Retrieves a file descriptor from the Contacts Provider. To learn more about this // feature, read the reference documentation for // ContentResolver#openAssetFileDescriptor. afd = getActivity().getContentResolver().openAssetFileDescriptor(thumbUri, "r"); // Gets a FileDescriptor from the AssetFileDescriptor. A BitmapFactory object can // decode the contents of a file pointed to by a FileDescriptor into a Bitmap. FileDescriptor fileDescriptor = afd.getFileDescriptor(); if (fileDescriptor != null) { // Decodes a Bitmap from the image pointed to by the FileDescriptor, and scales it // to the specified width and height return ImageLoader.decodeSampledBitmapFromDescriptor(fileDescriptor, imageSize, imageSize); } } catch (FileNotFoundException e) { // If the file pointed to by the thumbnail URI doesn't exist, or the file can't be // opened in "read" mode, ContentResolver.openAssetFileDescriptor throws a // FileNotFoundException. if (BuildConfig.DEBUG) { Log.d(TAG, "Contact photo thumbnail not found for contact " + photoData + ": " + e.toString()); } } finally { // If an AssetFileDescriptor was returned, try to close it if (afd != null) { try { afd.close(); } catch (IOException e) { // Closing a file descriptor might cause an IOException if the file is // already closed. Nothing extra is needed to handle this. } } } // If the decoding failed, returns null return null; } /** * This is a subclass of CursorAdapter that supports binding Cursor columns to a view layout. * If those items are part of search results, the search string is marked by highlighting the * query text. An {@link AlphabetIndexer} is used to allow quicker navigation up and down the * ListView. */ private class ContactsAdapter extends CursorAdapter implements SectionIndexer { private LayoutInflater mInflater; // Stores the layout inflater private AlphabetIndexer mAlphabetIndexer; // Stores the AlphabetIndexer instance /** * Instantiates a new Contacts Adapter. * * @param context A context that has access to the app's layout. */ public ContactsAdapter(Context context) { super(context, null, 0); // Stores inflater for use later mInflater = LayoutInflater.from(context); // Loads a string containing the English alphabet. To fully localize the app, provide a // strings.xml file in res/values-<x> directories, where <x> is a locale. In the file, // define a string with android:name="alphabet" and contents set to all of the // alphabetic characters in the language in their proper sort order, in upper case if // applicable. final String alphabet = "ABCDEFGHIJKLMNOPQRSTUVWXYZ"; // Instantiates a new AlphabetIndexer bound to the column used to sort contact names. // The cursor is left null, because it has not yet been retrieved. mAlphabetIndexer = new AlphabetIndexer(null, ContactsQuery.SORT_KEY, alphabet); } /** * Overrides newView() to inflate the list item views. */ @Override public View newView(Context context, Cursor cursor, ViewGroup viewGroup) { // Inflates the list item layout. final View itemLayout = mInflater.inflate(R.layout.contact_list_item, viewGroup, false); // Creates a new ViewHolder in which to store handles to each view resource. This // allows bindView() to retrieve stored references instead of calling findViewById for // each instance of the layout. final ViewHolder holder = new ViewHolder(); holder.text1 = (TextView) itemLayout.findViewById(android.R.id.text1); holder.text2 = (TextView) itemLayout.findViewById(android.R.id.text2); holder.icon = (QuickContactBadge) itemLayout.findViewById(android.R.id.icon); // Stores the resourceHolder instance in itemLayout. This makes resourceHolder // available to bindView and other methods that receive a handle to the item view. itemLayout.setTag(holder); // Returns the item layout view return itemLayout; } /** * Binds data from the Cursor to the provided view. */ @Override public void bindView(View view, Context context, Cursor cursor) { // Gets handles to individual view resources final ViewHolder holder = (ViewHolder) view.getTag(); // For Android 3.0 and later, gets the thumbnail image Uri from the current Cursor row. // For platforms earlier than 3.0, this isn't necessary, because the thumbnail is // generated from the other fields in the row. final String photoUri = cursor.getString(ContactsQuery.PHOTO_THUMBNAIL_DATA); final String displayName = cursor.getString(ContactsQuery.DISPLAY_NAME); // If the user didn't do a search, or the search string didn't match a display // name, show the display name without highlighting holder.text1.setText(displayName); // If the search search is empty, hide the second line of text holder.text2.setVisibility(View.GONE); // Processes the QuickContactBadge. A QuickContactBadge first appears as a contact's // thumbnail image with styling that indicates it can be touched for additional // information. When the user clicks the image, the badge expands into a dialog box // containing the contact's details and icons for the built-in apps that can handle // each detail type. // Generates the contact lookup Uri final Uri contactUri = Contacts.getLookupUri(cursor.getLong(ContactsQuery.ID), cursor.getString(ContactsQuery.LOOKUP_KEY)); // Binds the contact's lookup Uri to the QuickContactBadge holder.icon.assignContactUri(contactUri); // Loads the thumbnail image pointed to by photoUri into the QuickContactBadge in a // background worker thread mImageLoader.loadImage(photoUri, holder.icon); } /** * Overrides swapCursor to move the new Cursor into the AlphabetIndex as well as the * CursorAdapter. */ @Override public Cursor swapCursor(Cursor newCursor) { // Update the AlphabetIndexer with new cursor as well mAlphabetIndexer.setCursor(newCursor); return super.swapCursor(newCursor); } /** * An override of getCount that simplifies accessing the Cursor. If the Cursor is null, * getCount returns zero. As a result, no test for Cursor == null is needed. */ @Override public int getCount() { if (getCursor() == null) { return 0; } return super.getCount(); } /** * Defines the SectionIndexer.getSections() interface. */ @Override public Object[] getSections() { return mAlphabetIndexer.getSections(); } /** * Defines the SectionIndexer.getPositionForSection() interface. */ @Override public int getPositionForSection(int i) { if (getCursor() == null) { return 0; } return mAlphabetIndexer.getPositionForSection(i); } /** * Defines the SectionIndexer.getSectionForPosition() interface. */ @Override public int getSectionForPosition(int i) { if (getCursor() == null) { return 0; } return mAlphabetIndexer.getSectionForPosition(i); } /** * A class that defines fields for each resource ID in the list item layout. This allows * ContactsAdapter.newView() to store the IDs once, when it inflates the layout, instead of * calling findViewById in each iteration of bindView. */ private class ViewHolder { TextView text1; TextView text2; QuickContactBadge icon; } } /** * This interface must be implemented by any activity that loads this fragment. When an * interaction occurs, such as touching an item from the ListView, these callbacks will * be invoked to communicate the event back to the activity. */ public interface OnContactsInteractionListener { /** * Called when a contact is selected from the ListView. * * @param contactUri The contact Uri. */ public void onContactSelected(Uri contactUri); /** * Called when the ListView selection is cleared like when * a contact search is taking place or is finishing. */ public void onSelectionCleared(); } /** * This interface defines constants for the Cursor and CursorLoader, based on constants defined * in the {@link android.provider.ContactsContract.Contacts} class. */ public interface ContactsQuery { // An identifier for the loader final static int QUERY_ID = 1; // A content URI for the Contacts table final static Uri CONTENT_URI = Contacts.CONTENT_URI; // The search/filter query Uri final static Uri FILTER_URI = Contacts.CONTENT_FILTER_URI; // The selection clause for the CursorLoader query. The search criteria defined here // restrict results to contacts that have a display name and are linked to visible groups. // Notice that the search on the string provided by the user is implemented by appending // the search string to CONTENT_FILTER_URI. @SuppressLint("InlinedApi") final static String SELECTION = (Utils.hasHoneycomb() ? Contacts.DISPLAY_NAME_PRIMARY : Contacts.DISPLAY_NAME) + "<>''" + " AND " + Contacts.IN_VISIBLE_GROUP + "=1"; // The selection clause for the CursorLoader query. The search criteria defined here // restrict results to contacts that have a display name and are linked to visible groups. // Notice that the search on the string provided by the user is implemented by appending // the search string to CONTENT_FILTER_URI. @SuppressLint("InlinedApi") final static String SELECTION2 = (Utils.hasHoneycomb() ? Contacts.DISPLAY_NAME_PRIMARY : Contacts.DISPLAY_NAME) + "<>''" + " AND " + Contacts.IN_VISIBLE_GROUP + "=1" + " AND " + Contacts.STARRED + "=1"; // The desired sort order for the returned Cursor. In Android 3.0 and later, the primary // sort key allows for localization. In earlier versions. use the display name as the sort // key. @SuppressLint("InlinedApi") final static String SORT_ORDER = Utils.hasHoneycomb() ? Contacts.SORT_KEY_PRIMARY : Contacts.DISPLAY_NAME; // The projection for the CursorLoader query. This is a list of columns that the Contacts // Provider should return in the Cursor. @SuppressLint("InlinedApi") final static String[] PROJECTION = { // The contact's row id Contacts._ID, // A pointer to the contact that is guaranteed to be more permanent than _ID. Given // a contact's current _ID value and LOOKUP_KEY, the Contacts Provider can generate // a "permanent" contact URI. Contacts.LOOKUP_KEY, // In platform version 3.0 and later, the Contacts table contains // DISPLAY_NAME_PRIMARY, which either contains the contact's displayable name or // some other useful identifier such as an email address. This column isn't // available in earlier versions of Android, so you must use Contacts.DISPLAY_NAME // instead. Utils.hasHoneycomb() ? Contacts.DISPLAY_NAME_PRIMARY : Contacts.DISPLAY_NAME, // In Android 3.0 and later, the thumbnail image is pointed to by // PHOTO_THUMBNAIL_URI. In earlier versions, there is no direct pointer; instead, // you generate the pointer from the contact's ID value and constants defined in // android.provider.ContactsContract.Contacts. Utils.hasHoneycomb() ? Contacts.PHOTO_THUMBNAIL_URI : Contacts._ID, // The sort order column for the returned Cursor, used by the AlphabetIndexer SORT_ORDER, }; // The query column numbers which map to each value in the projection final static int ID = 0; final static int LOOKUP_KEY = 1; final static int DISPLAY_NAME = 2; final static int PHOTO_THUMBNAIL_DATA = 3; final static int SORT_KEY = 4; } }