Освой программирование играючи

Сайт Александра Климова

Шкодим

/* Моя кошка замечательно разбирается в программировании. Стоит мне объяснить проблему ей - и все становится ясно. */
John Robbins, Debugging Applications, Microsoft Press, 2000

DrawerLayout

На конференции Google I/O 2013 был представлен новый способ навигации при помощи новой разметки android.support.v4.widget.DrawerLayout, который сразу вызвал повышенный интерес у разработчиков. Давайте изучим его и мы.

За несколько лет использование нового компонента упростилось с появлением Material Design и шаблона Navigation Drawer Activity. Статья немного устарела, но общий принцип работы сохранился.

По английски drawer обозначает выдвижной ящик и данная разметка ведёт себя схожим образом. Пользователь может лёгким движением руки с края экрана выдвинуть панель навигации для быстрого переключения на другое содержимое, например, фрагмент с новым рисунком.

DrawerLayout входит в состав библиотеки Support Library v4 (release 13), который вышел в мае 2013 года и используется по умолчанию в новых проектах, создаваемых в Android Studio.

Если вы нужно добавить библиотеку вручную, то в build.gradle пропишете зависимость.


dependencies {
    compile 'com.android.support:appcompat-v7:23.1.0'
}

Создадим новый проект с минимальной версией API 14. Можно использовать и более старые версии, но тогда придётся отказаться от некоторых новых методов, а также использовать некоторые методы из другого пакета совместимости.

Начнём с разметки. Берётся стандартная разметка, состоящая из FrameLayout и ListView, и оборачивается дополнительно новым родительским элементом android.support.v4.widget.DrawerLayout. На панели инструментов данного компонента нет, поэтому придётся писать код вручную.


<android.support.v4.widget.DrawerLayout
    xmlns:android="http://schemas.android.com/apk/res/android"
    android:id="@+id/drawer_layout"
    android:layout_width="match_parent"
    android:layout_height="match_parent">

    <!-- The main content view -->
    <FrameLayout
        android:id="@+id/content_frame"
        android:layout_width="match_parent"
        android:layout_height="match_parent"/>
    
    <!-- The navigation drawer -->
    <ListView
        android:id="@+id/left_drawer"
        android:layout_width="240dp"
        android:layout_height="match_parent"
        android:layout_gravity="start"
        android:background="#111"
        android:choiceMode="singleChoice"
        android:divider="@android:color/transparent"
        android:dividerHeight="0dp"/>

</android.support.v4.widget.DrawerLayout>

В нашем примере DrawerLayout является корневым элементом разметки. Внутри него используется разметка, которая служит контейнером для фрагментов. Второй компонент ListView служит содержимым для навигации.

Необходимо запомнить несколько важных деталей:

Основной элемент для вывода информации (у нас это FrameLayout) должен быть первым дочерним элементом DrawerLayout. Это связано расположением элементов в Z-порядке.

Высота и ширина основного элемента должна соответствовать высоте и ширине родительского элемента.

Элемент навигации (у нас это ListView) должен использовать атрибут android:layout_gravity. Рекомендуется использовать для него значение start. В этом случае панель навигации будет находиться слева или справа в зависимости от языка (европейский или арабский).

Ширина панели навигации должна быть задана в dp, а высота соответствовать родительскому элементу. Ширина не должна быть больше чем 320dp, чтобы пользователь всегда мог видеть часть основного содержимого экрана. Для минимальной ширины рекомендуют использовать 240dp.

Инициализация навигационного списка

Обычно в DrawerLayout для навигации используют список элементов ListView, который необходимо заполнить через адаптер, например, ArrayAdapter или SimpleCursorAdapter.

Подготовим разметку для отдельного элемента списка в файле res/layout/drawer_list_item.xml:


<TextView xmlns:android="http://schemas.android.com/apk/res/android"
    android:id="@android:id/text1"
    android:layout_width="match_parent"
    android:layout_height="wrap_content"
    android:background="?android:attr/activatedBackgroundIndicator"
    android:gravity="center_vertical"
    android:minHeight="?android:attr/listPreferredItemHeightSmall"
    android:paddingLeft="16dp"
    android:paddingRight="16dp"
    android:textAppearance="?android:attr/textAppearanceListItemSmall"
    android:textColor="#fff" />

Подготовим строковый массив:


<string-array name="cats_array_ru">
    <item>Васька</item>
    <item>Барсик</item>
    <item>Мурзик</item>
    <item>Рыжик</item>
    <item>Кот Бегемот</item>
    <item>Кот Матроскин</item>
    <item>Бублик (у Экслера)</item>
    <item>Дорофей (у Димона)</item>
</string-array>

Заполним список именами котов:


public class MainActivity extends Activity {
    private String[] mCatTitles;
    private ListView mDrawerListView;
    ...

    @Override
    public void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        mCatTitles = getResources().getStringArray(R.array.cats_array_ru);
        mDrawerListView = (ListView) findViewById(R.id.left_drawer);

        // подключим адаптер для списка
        mDrawerListView.setAdapter(new ArrayAdapter<String>(this,
                R.layout.drawer_list_item, mCatTitles));
    }
}

Это минимальный код для того, чтобы увидеть работу выдвижной панели в действии. Запустите проект и движением слева направо вытяните панель. Также вы можете выбрать какой-то элемент списка, который будет подсвечен.

Обработка нажатий в списке

Чтобы обработать нажатия на элементах списка, нужно написать дополнительный код. После заполнения списка именами вызываем обработчик нажатий на элементах списка (setOnItemClickListener()) для изменения содержимого основного экрана в зависимости от выбранного элемента.


// установим слушатель для щелчков по элементам списка
mDrawerListView.setOnItemClickListener(new DrawerItemClickListener());

Когда пользователь щелкает на элементе списка, то система вызывает метод onItemClick() из интерфейса ListView.OnItemClickListener, переданного в setOnItemClickListener().


//  Слушатель для элементов списка в выдвижной панели
private class DrawerItemClickListener implements ListView.OnItemClickListener {
    @Override
    public void onItemClick(AdapterView<?> parent, View view, int position, long id) {
        Toast.makeText(getApplicationContext(), 
                "Выбран пункт " + position, Toast.LENGTH_SHORT).show();
    }
}

Запустим проект ещё раз и проверим, что мы можем определять позицию выбранного элемента.

В реальности нам нужно динамически менять содержимое в основной части экрана в зависимости от выбранного элемента. Код, который будет здесь выполняться, зависит от логики вашей программы. Например, мы можем вставлять различные фрагменты в контейнер FrameLayout через его идентификатор R.id.content_frame

Подготовим внутренний статический класс для фрагмента.


/**
 * Фрагмент, который появится в основной части разметки и покажет кота
 */
public static class CatFragment extends Fragment {
    public static final String ARG_CAT_NUMBER = "cat_number";

    public CatFragment() {
        // Для фрагмента требуется пустой конструктор
    }

    @Override
    public View onCreateView(LayoutInflater inflater, ViewGroup container,
                             Bundle savedInstanceState) {
        View rootView = inflater.inflate(R.layout.fragment_cat, container, false);
        int i = getArguments().getInt(ARG_CAT_NUMBER);
        // имена котов на англ. для нахождения имен файлов
        String catName = getResources().getStringArray(R.array.cats_array)[i];

        String catNameTitle = getResources().getStringArray(R.array.cats_array_ru)[i];

        int imageId = getResources().getIdentifier(catName.toLowerCase(Locale.ROOT),
                "drawable", getActivity().getPackageName());
        ((ImageView) rootView.findViewById(R.id.imageViewCat)).setImageResource(imageId);
        getActivity().setTitle(catNameTitle);
        return rootView;
    }
}

Разметка для фрагмента будет состоять из одного ImageView (файл res/layout/fragment_cat.xml):


<?xml version="1.0" encoding="utf-8"?>
<ImageView
    xmlns:android="http://schemas.android.com/apk/res/android"
    android:id="@+id/imageViewCat"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    android:background="#000000"
    android:gravity="center"
    android:padding="32dp" />

Подготовим второй массив из имён котов на английском языке, которые будут совпадать с именами файлов с картинками котов.


<string-array name="cats_array">
    <item>vaska</item>
    <item>barsik</item>
    <item>murzik</item>
    <item>ryzhik</item>
    <item>begemot</item>
    <item>matroskin</item>
    <item>bublik</item>
    <item>dorofey</item>
</string-array

Вам придётся подготовить картинки с именами vaska.png, barsik.png и т.д. У вас могут быть другие способы сопоставления изображений с именами, не воспринимайте как догму.

Перепишем код для щелчков по элементам списка.


//  Слушатель для элементов списка в выдвижной панели
private class DrawerItemClickListener implements ListView.OnItemClickListener {
    @Override
    public void onItemClick(AdapterView<?> parent, View view, int position, long id) {
        selectItem(position);
    }
}

private void selectItem(int position) {
    // Обновляем содержимое экрана, заменяя фрагменты
    Fragment fragment = new CatFragment();
    Bundle args = new Bundle();
    args.putInt(CatFragment.ARG_CAT_NUMBER, position);
    fragment.setArguments(args);

    FragmentManager fragmentManager = getSupportFragmentManager();
    fragmentManager.beginTransaction().replace(R.id.content_frame, fragment).commit();

    // обновим выбранный элемент списка и закрываем панель
    mDrawerListView.setItemChecked(position, true);
    setTitle(mCatTitles[position]);
    mDrawerLayout.closeDrawer(mDrawerListView);
}

Программа практически готова. В исходном коде в конце статьи есть ещё дополнительный переопределённый метод setTitle(), который может пригодится для работы с ActionBar.

Выдвигаем и задвигаем

Для прослушки событий выдвигания и задвигания панели используется метод setDrawerListener() вашего компонента DrawerLayout, которому нужно передать DrawerLayout.DrawerListener. У данного интерфейса имеются такие события как onDrawerOpened() и onDrawerClosed().

Кроме стандартного способа выдвижения панели движением пальца от края экрана к середине, можно выдвинуть панель путём нажатия на значок программы в панели действий ActionBar. В этом случае вы можете использовать класс ActionBarDrawerToggle, который сохраняет возможности DrawerLayout.DrawerListener для обработки движения пальцем по экрану и добавляет свой способ управления через значок.

При выдвижении и задвигании панели навигации следует следить за заголовком активности, чтобы он соответствовал текущему состоянию экрана.

Используем значок

У пользователя должна быть возможность открыть панель навигации не только жестом Свайп - движением от левого края экрана, но и с помощью касания значка в заголовке активности. При этом у значка должен быть специальный индикатор, подсказывающий о наличии панели навигации. Всё это реализуется с помощью описанного выше класса ActionBarDrawerToggle.

Вам нужно создать экземпляр данного класса с конструктором со следующими аргументами:

  • Активность, которая является хостом для панели
  • класс DrawerLayout
  • растровый ресурс, который будет использоваться в качестве индикатора (можно скачать стандартные значки для темной и светлой темы)
  • строковый ресурс, описывающий действие выдвижения (accessibility)
  • строковый ресурс, описывающий действие закрытия (accessibility).

Это было справедливо в первых версиях библиотеки. Сейчас такой код не сработает, в третьем параметре теперь используется не графический ресурс для индикатора, а новый компонент Toolbar, который можно заменить на null. Возможно вам встретятся старые примеры с устаревшим кодом, которые вы можете быстро исправить. Главная особенность замены - индикатор не нужно подготавливать и сохранять в ресурсах. В заголовке появится системный значок в виде гамбургера, который будет превращаться с анимацией в стрелку во время выдвижения панели. При обратном движении анимация превратит стрелку обратно в гамбургер.

Далее следует вызвать ActionBarDrawerToggle в нескольких местах жизненного цикла активности, а именно в onPostCreate() и onConfigurationChanged().

Ниже будет приведён код приложения. А я сделаю несколько замечаний. В коде будут попадаться ссылки на различные ресурсы. Для строковых ресурсов можете придумать свои строки. Также можно добавить тень к панели при помощи файла 9.png (я закомментировал эту строчку, можно пропустить).

Также в примере добавлен пункт меню для поиска по слову, который находится в заголовке экрана. Вам нужно заменить в ресурсах меню (res/menu/menu_main.xml) один пункт.


<item
    android:id="@+id/action_websearch"
    android:icon="@drawable/action_search"
    android:title="@string/action_websearch"
    app:showAsAction="ifRoom|withText"/>

Данный пример был написан при появлении библиотеки. Чуть позже Гугл представил новый дизайн Material и кое-что изменилось. В частности, раньше панель выдвигалась под заголовком. На данный момент Гугл рекомендует другое поведение - панель должна закрывать и заголовок активности. Кроме того, вместо списка используется новый класс в виде меню. Это тема для другого разговора.

Полный код приложения:


package ru.alexanderklimov.as132;

import android.app.SearchManager;
import android.content.Intent;
import android.content.res.Configuration;
import android.os.Bundle;

import android.support.v4.app.Fragment;
import android.support.v4.app.FragmentManager;
import android.support.v4.view.GravityCompat;
import android.support.v4.widget.DrawerLayout;
import android.support.v7.app.ActionBarDrawerToggle;
import android.support.v7.app.AppCompatActivity;
import android.view.LayoutInflater;
import android.view.Menu;
import android.view.MenuItem;
import android.view.View;
import android.view.ViewGroup;
import android.widget.AdapterView;
import android.widget.ArrayAdapter;
import android.widget.ImageView;
import android.widget.ListView;
import android.widget.Toast;

import java.util.Locale;

public class MainActivity extends AppCompatActivity {

    private String[] mCatTitles;
    private CharSequence mTitle;
    private CharSequence mDrawerTitle;

    private ListView mDrawerListView;
    private DrawerLayout mDrawerLayout;
    private ActionBarDrawerToggle mDrawerToggle;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        mTitle = mDrawerTitle = getTitle();
        mCatTitles = getResources().getStringArray(R.array.cats_array_ru);

        mDrawerLayout = (DrawerLayout) findViewById(R.id.drawer_layout);
        mDrawerListView = (ListView) findViewById(R.id.left_drawer);

        // Тень при открытии панели. По желанию
        //mDrawerLayout.setDrawerShadow(R.drawable.drawer_shadow, GravityCompat.START);

        // подключим адаптер для списка
        mDrawerListView.setAdapter(new ArrayAdapter<>(this,
                R.layout.drawer_list_item, mCatTitles));
        // установим слушатель для щелчков по элементам списка
        mDrawerListView.setOnItemClickListener(new DrawerItemClickListener());

        // Включаем значок у ActionBar для управления выдвижной панелью щелчком
        getSupportActionBar().setDisplayHomeAsUpEnabled(true);
        getSupportActionBar().setHomeButtonEnabled(true);

        // ActionBarDrawerToggle ties together the the proper interactions
        // between the sliding drawer and the action bar app icon
        mDrawerToggle = new ActionBarDrawerToggle(
                this,                  /* host Activity */
                mDrawerLayout,         /* DrawerLayout object */
                null,  /* значок-гамбургер для замены стрелки 'Up' */
                R.string.drawer_open,  /* добавьте строку "open drawer" - описание для  accessibility */
                R.string.drawer_close  /* добавьте "close drawer" - описание для accessibility */
        ) {
            public void onDrawerClosed(View view) {
                getSupportActionBar().setTitle(mTitle);
                invalidateOptionsMenu(); // creates call to onPrepareOptionsMenu()
            }

            public void onDrawerOpened(View drawerView) {
                getSupportActionBar().setTitle(mDrawerTitle);
                invalidateOptionsMenu(); // creates call to onPrepareOptionsMenu()
            }
        };
        mDrawerLayout.setDrawerListener(mDrawerToggle);

        if (savedInstanceState == null) {
            selectItem(0);
        }
    }

    //  Слушатель для элементов списка в выдвижной панели
    private class DrawerItemClickListener implements ListView.OnItemClickListener {
        @Override
        public void onItemClick(AdapterView<?> parent, View view, int position, long id) {
            selectItem(position);
        }
    }

    private void selectItem(int position) {
        // Обновляем содержимое экрана, заменяя фрагменты
        Fragment fragment = new CatFragment();
        Bundle args = new Bundle();
        args.putInt(CatFragment.ARG_CAT_NUMBER, position);
        fragment.setArguments(args);

        FragmentManager fragmentManager = getSupportFragmentManager();
        fragmentManager.beginTransaction().replace(R.id.content_frame, fragment).commit();

        // обновим выбранный элемент списка и закрываем панель
        mDrawerListView.setItemChecked(position, true);
        setTitle(mCatTitles[position]);
        mDrawerLayout.closeDrawer(mDrawerListView);
    }

    @Override
    public void setTitle(CharSequence title) {
        mTitle = title;
        if(getSupportActionBar() != null) {
            getSupportActionBar().setTitle(mTitle);
        }else {
            setTitle(mTitle);
        }
    }

    @Override
    public boolean onCreateOptionsMenu(Menu menu) {
        // Inflate the menu; this adds items to the action bar if it is present.
        getMenuInflater().inflate(R.menu.menu_main, menu);
        return true;
    }

    /* Called whenever we call invalidateOptionsMenu() */
    @Override
    public boolean onPrepareOptionsMenu(Menu menu) {
        // If the nav drawer is open, hide action items related to the content view
        boolean drawerOpen = mDrawerLayout.isDrawerOpen(mDrawerListView);
        menu.findItem(R.id.action_websearch).setVisible(!drawerOpen);
        return super.onPrepareOptionsMenu(menu);
    }

    @Override
    public boolean onOptionsItemSelected(MenuItem item) {
        // The action bar home/up action should open or close the drawer.
        // ActionBarDrawerToggle will take care of this.
        if (mDrawerToggle.onOptionsItemSelected(item)) {
            return true;
        }
        // Handle action buttons
        switch(item.getItemId()) {
            case R.id.action_websearch:
                // create intent to perform web search for this cat
                Intent intent = new Intent(Intent.ACTION_WEB_SEARCH);
                intent.putExtra(SearchManager.QUERY, getSupportActionBar().getTitle());
                // catch event that there's no activity to handle intent
                if (intent.resolveActivity(getPackageManager()) != null) {
                    startActivity(intent);
                } else {
                    Toast.makeText(this, R.string.app_not_available, Toast.LENGTH_LONG).show();
                }
                return true;
            default:
                return super.onOptionsItemSelected(item);
        }
    }

    /**
     * When using the ActionBarDrawerToggle, you must call it during
     * onPostCreate() and onConfigurationChanged()...
     */

    @Override
    protected void onPostCreate(Bundle savedInstanceState) {
        super.onPostCreate(savedInstanceState);
        // Sync the toggle state after onRestoreInstanceState has occurred.
        mDrawerToggle.syncState();
    }

    @Override
    public void onConfigurationChanged(Configuration newConfig) {
        super.onConfigurationChanged(newConfig);
        // Pass any configuration change to the drawer toggls
        mDrawerToggle.onConfigurationChanged(newConfig);
    }

    /**
     * Фрагмент, который появится в основной части разметки и покажет кота
     */
    public static class CatFragment extends Fragment {
        public static final String ARG_CAT_NUMBER = "cat_number";

        public CatFragment() {
            // Для фрагмента требуется пустой конструктор
        }

        @Override
        public View onCreateView(LayoutInflater inflater, ViewGroup container,
                                 Bundle savedInstanceState) {
            View rootView = inflater.inflate(R.layout.fragment_cat, container, false);
            int i = getArguments().getInt(ARG_CAT_NUMBER);
            // имена котов на англ. для нахождения имен файлов
            String catName = getResources().getStringArray(R.array.cats_array)[i];

            String catNameTitle = getResources().getStringArray(R.array.cats_array_ru)[i];

            int imageId = getResources().getIdentifier(catName.toLowerCase(Locale.ROOT),
                    "drawable", getActivity().getPackageName());
            ((ImageView) rootView.findViewById(R.id.imageViewCat)).setImageResource(imageId);
            getActivity().setTitle(catNameTitle);
            return rootView;
        }
    }
}

Дополнительное чтение

Creating a Navigation Drawer - пример из документации. Там же можно скачать исходник, послужившей основой для статьи.

Navigation Drawer - еще одна статья из документации.

DrawerLayout DrawerLayout

Реклама