contacts/activities/ActionBarAdapter.java

/*
 * Copyright (C) 2010 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.activities;

import com.android.contacts.R;
import com.android.contacts.activities.ActionBarAdapter.Listener.Action;
import com.android.contacts.list.ContactListFilterController;
import com.android.contacts.list.ContactListFilterController.ContactListFilterListener;
import com.android.contacts.list.ContactsRequest;

import android.app.ActionBar;
import android.app.ActionBar.LayoutParams;
import android.content.Context;
import android.os.Bundle;
import android.text.TextUtils;
import android.view.LayoutInflater;
import android.view.View;
import android.widget.SearchView;
import android.widget.SearchView.OnCloseListener;
import android.widget.SearchView.OnQueryTextListener;

/**
 * Adapter for the action bar at the top of the Contacts activity.
 */
public class ActionBarAdapter
        implements OnQueryTextListener, OnCloseListener, ContactListFilterListener {

    public interface Listener {
        public enum Action {
            CHANGE_SEARCH_QUERY, START_SEARCH_MODE, STOP_SEARCH_MODE
        }

        void onAction(Action action);
    }

    private static final String EXTRA_KEY_SEARCH_MODE = "navBar.searchMode";
    private static final String EXTRA_KEY_QUERY = "navBar.query";
    private static final String EXTRA_KEY_SELECTED_TAB = "navBar.selectedTab";

    private boolean mSearchMode;
    private String mQueryString;

    private String mSearchLabelText;
    private SearchView mSearchView;

    private final Context mContext;

    private Listener mListener;
    private ContactListFilterController mFilterController;

    private ActionBar mActionBar;

    private View mCustomSearchView;
    private LayoutParams mLayoutParams;
    private boolean mIsSearchInOverflowMenu;

    public ActionBarAdapter(Context context, Listener listener) {
        mContext = context;
        mListener = listener;
        mSearchLabelText = mContext.getString(R.string.search_label);
    }

    public void onCreate(Bundle savedState, ContactsRequest request, ActionBar actionBar,
            boolean searchInOverflowMenu) {
        mActionBar = actionBar;
        mQueryString = null;
        mIsSearchInOverflowMenu = searchInOverflowMenu;

        if (savedState != null) {
            mSearchMode = savedState.getBoolean(EXTRA_KEY_SEARCH_MODE);
            mQueryString = savedState.getString(EXTRA_KEY_QUERY);
        } else {
            mSearchMode = request.isSearchMode();
            mQueryString = request.getQueryString();
        }

        if (mSearchView != null) {
            mSearchView.setQuery(mQueryString, false);
        }

        update();
    }

    public void setSearchView(SearchView searchView) {
        mSearchView = searchView;
        mSearchView.setOnQueryTextListener(this);
        mSearchView.setOnCloseListener(this);
        mSearchView.setQuery(mQueryString, false);
    }

    public void setListener(Listener listener) {
        mListener = listener;
    }

    public void setContactListFilterController(ContactListFilterController controller) {
        mFilterController = controller;
        mFilterController.addListener(this);
    }

    public boolean isSearchInOverflowMenu() {
        return mIsSearchInOverflowMenu;
    }

    public boolean isSearchMode() {
        return mSearchMode;
    }

    public void setSearchMode(boolean flag) {
        if (mSearchMode != flag) {
            mSearchMode = flag;
            update();
            if (mSearchView == null) {
                return;
            }
            if (mSearchMode) {
                mSearchView.requestFocus();
            } else {
                mSearchView.setQuery(null, false);
            }
        }
    }

    public String getQueryString() {
        return mQueryString;
    }

    public void setQueryString(String query) {
        mQueryString = query;
        if (mSearchView != null) {
            mSearchView.setQuery(query, false);
        }
    }

    public void update() {
        if (mSearchMode) {
            // If the search icon was in the overflow menu, then inflate a custom view containing
            // a search view for the action bar (and hide the tabs).
            if (mIsSearchInOverflowMenu) {
                if (mCustomSearchView == null) {
                    mCustomSearchView = LayoutInflater.from(mContext).inflate(
                            R.layout.custom_action_bar, null);
                    mLayoutParams = new LayoutParams(LayoutParams.MATCH_PARENT,
                            LayoutParams.WRAP_CONTENT);
                    SearchView searchView = (SearchView) mCustomSearchView.
                            findViewById(R.id.search_view);
                    searchView.setQueryHint(mContext.getString(R.string.hint_findContacts));
                    setSearchView(searchView);
                }
                mActionBar.setDisplayShowCustomEnabled(true);
                mActionBar.setCustomView(mCustomSearchView, mLayoutParams);
                mSearchView.requestFocus();
            } else {
                mActionBar.setTitle(mSearchLabelText);
            }
            mActionBar.setNavigationMode(ActionBar.NAVIGATION_MODE_STANDARD);
            if (mListener != null) {
                mListener.onAction(Action.START_SEARCH_MODE);
            }
        } else {
            mActionBar.setDisplayShowCustomEnabled(false);
            mActionBar.setNavigationMode(ActionBar.NAVIGATION_MODE_TABS);
            mActionBar.setTitle(null);
            if (mListener != null) {
                mListener.onAction(Action.STOP_SEARCH_MODE);
            }
        }
    }

    @Override
    public boolean onQueryTextChange(String queryString) {
        // TODO: Clean up SearchView code because it keeps setting the SearchView query,
        // invoking onQueryChanged, setting up the fragment again, invalidating the options menu,
        // storing the SearchView again, and etc... unless we add in the early return statements.
        if (queryString.equals(mQueryString)) {
            return false;
        }
        mQueryString = queryString;
        if (!mSearchMode) {
            if (!TextUtils.isEmpty(queryString)) {
                setSearchMode(true);
            }
        } else if (mListener != null) {
            mListener.onAction(Action.CHANGE_SEARCH_QUERY);
        }

        return true;
    }

    @Override
    public boolean onQueryTextSubmit(String query) {
        return true;
    }

    @Override
    public boolean onClose() {
        setSearchMode(false);
        return false;
    }

    public void onSaveInstanceState(Bundle outState) {
        outState.putBoolean(EXTRA_KEY_SEARCH_MODE, mSearchMode);
        outState.putString(EXTRA_KEY_QUERY, mQueryString);
        outState.putInt(EXTRA_KEY_SELECTED_TAB, mActionBar.getSelectedNavigationIndex());
    }

    public void onRestoreInstanceState(Bundle savedState) {
        mSearchMode = savedState.getBoolean(EXTRA_KEY_SEARCH_MODE);
        mQueryString = savedState.getString(EXTRA_KEY_QUERY);
        mActionBar.setSelectedNavigationItem(savedState.getInt(EXTRA_KEY_SELECTED_TAB));
    }

    @Override
    public void onContactListFiltersLoaded() {
        update();
    }

    @Override
    public void onContactListFilterChanged() {
        update();
    }

    @Override
    public void onContactListFilterCustomizationRequest() {
    }
}