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

Шаблоны фрагментов

В этом документе рассказывается, как использовать конструкторы шаблонов в Android Jetpack для создания фрагментов.

Как определить шаблон фрагмента

Фрагменты создаются с помощью ListBuilder. ListBuilder позволяет добавлять в список строки разных типов. В этом разделе описывается каждый из этих типов строк и то, как они создаются.

SliceAction

Самый базовый элемент шаблона Slice – это SliceAction. SliceAction содержит ярлык и PendingIntent и может быть одним из следующих объектов:

Кнопка со значком
Переключатель по умолчанию
Специальный переключатель (графический объект с состояниями "включено" и "выключено").

Класс SliceAction используется конструкторами шаблонов, описанными в этом разделе. Для SliceAction можно задать режим изображения, который определяет, как изображение будет представлено в действии:

ICON_IMAGE: крошечный размер и возможность тонирования
SMALL_IMAGE: маленький размер, нельзя тонировать.
LARGE_IMAGE: самый большой размер, без тонирования

HeaderBuilder

В большинстве случаев для шаблона нужно задать заголовок с помощью тега HeaderBuilder. Заголовок может поддерживать следующее:

Название
Подзаголовок
Подзаголовок сводки
Главное действие

Ниже приведены примеры конфигураций заголовков. Обратите внимание, что серые поля показывают потенциальные места расположения значков и отступов:

Отображение заголовка на разных платформах

Когда требуется фрагмент, поверхность отображения определяет, как его отрисовать. Обратите внимание, что на разных платформах объявления могут выглядеть по-разному.

В объявлениях меньшего размера обычно показывается только заголовок (если он есть). Если вы указали сводку для заголовка, вместо подзаголовка будет показан текст сводки.

Если вы не указали заголовок в шаблоне, вместо него обычно показывается первая строка, добавленная в ListBuilder.

Пример HeaderBuilder – простой фрагмент списка с заголовком

Kotlin

fun createSliceWithHeader(sliceUri: Uri) =
    list(context, sliceUri, ListBuilder.INFINITY) {
        setAccentColor(0xff0F9D) // Specify color for tinting icons
        header {
            title = "Get a ride"
            subtitle = "Ride in 4 min"
            summary = "Work in 1 hour 45 min | Home in 12 min"
        }
        row {
            title = "Home"
            subtitle = "12 miles | 12 min | $9.00"
            addEndItem(
                IconCompat.createWithResource(context, R.drawable.ic_home),
                ListBuilder.ICON_IMAGE
            )
        }
    }

Java

public Slice createSliceWithHeader(Uri sliceUri) {
    if (getContext() == null) {
        return null;
    }

    // Construct the parent.
    ListBuilder listBuilder = new ListBuilder(getContext(), sliceUri, ListBuilder.INFINITY)
            .setAccentColor(0xff0F9D58) // Specify color for tinting icons.
            .setHeader( // Create the header and add to slice.
                    new HeaderBuilder()
                            .setTitle("Get a ride")
                            .setSubtitle("Ride in 4 min.")
                            .setSummary("Work in 1 hour 45 min | Home in 12 min.")
            ).addRow(new RowBuilder() // Add a row.
                    .setPrimaryAction(
                            createActivityAction()) // A slice always needs a SliceAction.
                    .setTitle("Home")
                    .setSubtitle("12 miles | 12 min | $9.00")
                    .addEndItem(IconCompat.createWithResource(getContext(), R.drawable.ic_home),
                            SliceHints.ICON_IMAGE)
            ); // Add more rows if needed...
    return listBuilder.build();
}

SliceActions в заголовках

В заголовках фрагментов также могут отображаться SliceActions:

Kotlin

fun createSliceWithActionInHeader(sliceUri: Uri): Slice {
    // Construct our slice actions.
    val noteAction = SliceAction.create(
        takeNoteIntent,
        IconCompat.createWithResource(context, R.drawable.ic_pencil),
        ICON_IMAGE,
        "Take note"
    )

    val voiceNoteAction = SliceAction.create(
        voiceNoteIntent,
        IconCompat.createWithResource(context, R.drawable.ic_mic),
        ICON_IMAGE,
        "Take voice note"
    )

    val cameraNoteAction = SliceAction.create(
        cameraNoteIntent,
        IconCompat.createWithResource(context, R.drawable.ic_camera),
        ICON_IMAGE,
        "Create photo note"
    )

    // Construct the list.
    return list(context, sliceUri, ListBuilder.INFINITY) {
        setAccentColor(0xfff4b4) // Specify color for tinting icons
        header {
            title = "Create new note"
            subtitle = "Easily done with this note taking app"
        }
        addAction(noteAction)
        addAction(voiceNoteAction)
        addAction(cameraNoteAction)
    }
}

Java

public Slice createSliceWithActionInHeader(Uri sliceUri) {
    if (getContext() == null) {
        return null;
    }
    // Construct our slice actions.
    SliceAction noteAction = SliceAction.create(takeNoteIntent,
            IconCompat.createWithResource(getContext(), R.drawable.ic_pencil),
            ListBuilder.ICON_IMAGE, "Take note");

    SliceAction voiceNoteAction = SliceAction.create(voiceNoteIntent,
            IconCompat.createWithResource(getContext(), R.drawable.ic_mic),
            ListBuilder.ICON_IMAGE,
            "Take voice note");

    SliceAction cameraNoteAction = SliceAction.create(cameraNoteIntent,
            IconCompat.createWithResource(getContext(), R.drawable.ic_camera),
            ListBuilder.ICON_IMAGE,
            "Create photo note");


    // Construct the list.
    ListBuilder listBuilder = new ListBuilder(getContext(), sliceUri, ListBuilder.INFINITY)
            .setAccentColor(0xfff4b400) // Specify color for tinting icons
            .setHeader(new HeaderBuilder() // Construct the header.
                    .setTitle("Create new note")
                    .setSubtitle("Easily done with this note taking app")
            )
            .addRow(new RowBuilder()
                    .setTitle("Enter app")
                    .setPrimaryAction(createActivityAction())
            )
            // Add the actions to the ListBuilder.
            .addAction(noteAction)
            .addAction(voiceNoteAction)
            .addAction(cameraNoteAction);
    return listBuilder.build();
}

RowBuilder

Вы можете создать строку контента с помощью RowBuilder. Строка может содержать:

Название
Подзаголовок
Начальный элемент: SliceAction, значок или временная метка.
Конечные элементы: SliceAction, Icon или временная метка.
Главное действие

Вы можете комбинировать содержимое строк разными способами с учетом следующих ограничений:

Элементы Start не будут показываться в первой строке фрагмента.
Конечные объекты не могут быть смесью объектов SliceAction и Icon
В строке может быть только одна временная метка.

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

Пример RowBuilder – переключатель Wi-Fi

В примере ниже показана строка с основным действием и переключателем по умолчанию.

Kotlin

fun createActionWithActionInRow(sliceUri: Uri): Slice {
    // Primary action - open wifi settings.
    val wifiAction = SliceAction.create(
        wifiSettingsPendingIntent,
        IconCompat.createWithResource(context, R.drawable.ic_wifi),
        ICON_IMAGE,
        "Wi-Fi Settings"
    )

    // Toggle action - toggle wifi.
    val toggleAction = SliceAction.createToggle(
        wifiTogglePendingIntent,
        "Toggle Wi-Fi",
        isConnected /* isChecked */
    )

    // Create the parent builder.
    return list(context, wifiUri, ListBuilder.INFINITY) {
        setAccentColor(0xff4285) // Specify color for tinting icons / controls.
        row {
            title = "Wi-Fi"
            primaryAction = wifiAction
            addEndItem(toggleAction)
        }
    }
}

Java

public Slice createActionWithActionInRow(Uri sliceUri) {
    if (getContext() == null) {
        return null;
    }
    // Primary action - open wifi settings.
    SliceAction primaryAction = SliceAction.create(wifiSettingsPendingIntent,
            IconCompat.createWithResource(getContext(), R.drawable.ic_wifi),
            ListBuilder.ICON_IMAGE,
            "Wi-Fi Settings"
    );

    // Toggle action - toggle wifi.
    SliceAction toggleAction = SliceAction.createToggle(wifiTogglePendingIntent,
            "Toggle Wi-Fi", isConnected /* isChecked */);

    // Create the parent builder.
    ListBuilder listBuilder = new ListBuilder(getContext(), wifiUri, ListBuilder.INFINITY)
            // Specify color for tinting icons / controls.
            .setAccentColor(0xff4285f4)
            // Create and add a row.
            .addRow(new RowBuilder()
                    .setTitle("Wi-Fi")
                    .setPrimaryAction(primaryAction)
                    .addEndItem(toggleAction));
    // Build the slice.
    return listBuilder.build();
}

GridBuilder

Вы можете создать сетку контента с помощью GridBuilder. Сетка может поддерживать следующие типы изображений:

ICON_IMAGE: крошечный размер и возможность окрашивания.
SMALL_IMAGE: маленький размер, нельзя тонировать.
LARGE_IMAGE: самый большой размер, без тонирования

Ячейка сетки создается с помощью CellBuilder. Ячейка может содержать до двух строк текста и одно изображение. Ячейка не может быть пустой.

Примеры сеток показаны на изображениях ниже.

Пример GridRowBuilder – рестораны поблизости

В примере ниже показана строка сетки, содержащая изображения и текст.

Kotlin

fun createSliceWithGridRow(sliceUri: Uri): Slice {
    // Create the parent builder.
    return list(context, sliceUri, ListBuilder.INFINITY) {
        header {
            title = "Famous restaurants"
            primaryAction = SliceAction.create(
                pendingIntent, icon, ListBuilder.ICON_IMAGE, "Famous restaurants"
            )
        }
        gridRow {
            cell {
                addImage(image1, LARGE_IMAGE)
                addTitleText("Top Restaurant")
                addText("0.3 mil")
                contentIntent = intent1
            }
            cell {
                addImage(image2, LARGE_IMAGE)
                addTitleText("Fast and Casual")
                addText("0.5 mil")
                contentIntent = intent2
            }
            cell {
                addImage(image3, LARGE_IMAGE)
                addTitleText("Casual Diner")
                addText("0.9 mi")
                contentIntent = intent3
            }
            cell {
                addImage(image4, LARGE_IMAGE)
                addTitleText("Ramen Spot")
                addText("1.2 mi")
                contentIntent = intent4
            }
        }
    }
}

Java

public Slice createSliceWithGridRow(Uri sliceUri) {
      if (getContext() == null) {
          return null;
      }
      // Create the parent builder.
      ListBuilder listBuilder = new ListBuilder(getContext(), sliceUri, ListBuilder.INFINITY)
              .setHeader(
                      // Create the header.
                      new HeaderBuilder()
                              .setTitle("Famous restaurants")
                              .setPrimaryAction(SliceAction
                                      .create(pendingIntent, icon, ListBuilder.ICON_IMAGE,
                                              "Famous restaurants"))
              )
              // Add a grid row to the list.
              .addGridRow(new GridRowBuilder()
                      // Add cells to the grid row.
                      .addCell(new CellBuilder()
                              .addImage(image1, ListBuilder.LARGE_IMAGE)
                              .addTitleText("Top Restaurant")
                              .addText("0.3 mil")
                              .setContentIntent(intent1)
                      ).addCell(new CellBuilder()
                              .addImage(image2, ListBuilder.LARGE_IMAGE)
                              .addTitleText("Fast and Casual")
                              .addText("0.5 mil")
                              .setContentIntent(intent2)
                      )
                      .addCell(new CellBuilder()
                              .addImage(image3, ListBuilder.LARGE_IMAGE)
                              .addTitleText("Casual Diner")
                              .addText("0.9 mi")
                              .setContentIntent(intent3))
                      .addCell(new CellBuilder()
                              .addImage(image4, ListBuilder.LARGE_IMAGE)
                              .addTitleText("Ramen Spot")
                              .addText("1.2 mi")
                              .setContentIntent(intent4))
                      // Every slice needs a primary action.
                      .setPrimaryAction(createActivityAction())
              );
      return listBuilder.build();
  }

RangeBuilder

С помощью RangeBuilder можно создать строку, содержащую индикатор выполнения или диапазон ввода, например ползунок.

Примеры индикатора выполнения и ползунка показаны на изображениях ниже.

Пример RangeBuilder – ползунок

В примере ниже показано, как создать фрагмент с ползунком громкости, используя InputRangeBuilder. Чтобы создать строку прогресса, используйте addRange().

Kotlin

fun createSliceWithRange(sliceUri: Uri): Slice {
    return list(context, sliceUri, ListBuilder.INFINITY) {
        inputRange {
            title = "Ring Volume"
            inputAction = volumeChangedPendingIntent
            max = 100
            value = 30
        }
    }
}

Java

public Slice createSliceWithRange(Uri sliceUri) {
    if (getContext() == null) {
        return null;
    }
    // Construct the parent.
    ListBuilder listBuilder = new ListBuilder(getContext(), sliceUri, ListBuilder.INFINITY)
            .addRow(new RowBuilder() // Every slice needs a row.
                    .setTitle("Enter app")
                      // Every slice needs a primary action.
                    .setPrimaryAction(createActivityAction())
            )
            .addInputRange(new InputRangeBuilder() // Create the input row.
                    .setTitle("Ring Volume")
                    .setInputAction(volumeChangedPendingIntent)
                    .setMax(100)
                    .setValue(30)
            );
    return listBuilder.build();
}

Контент с задержкой

Фрагмент должен возвращаться из метода SliceProvider.onBindSlice() как можно быстрее. Вызовы, требующие много времени, могут привести к проблемам с отображением, например к мерцанию и резкому изменению размера.

Если у вас есть фрагмент, который не может быть загружен быстро, вы можете создать его с плейсхолдером, указав в конструкторе, что контент загружается. Когда контент будет готов к показу, вызовите getContentResolver().notifyChange(sliceUri, null), используя URI фрагмента. Это приводит к еще одному вызову SliceProvider.onBindSlice(), где вы можете снова создать фрагмент с новым контентом.

Пример контента с задержкой – поездка на работу

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

Kotlin

fun createSliceShowingLoading(sliceUri: Uri): Slice {
    // We’re waiting to load the time to work so indicate that on the slice by
    // setting the subtitle with the overloaded method and indicate true.
    return list(context, sliceUri, ListBuilder.INFINITY) {
        row {
            title = "Ride to work"
            setSubtitle(null, true)
            addEndItem(IconCompat.createWithResource(context, R.drawable.ic_work), ICON_IMAGE)
        }
    }
}

Java

public Slice createSliceShowingLoading(Uri sliceUri) {
    if (getContext() == null) {
        return null;
    }
    // Construct the parent.
    ListBuilder listBuilder = new ListBuilder(getContext(), sliceUri, ListBuilder.INFINITY)
            // Construct the row.
            .addRow(new RowBuilder()
                    .setPrimaryAction(createActivityAction())
                    .setTitle("Ride to work")
                    // We’re waiting to load the time to work so indicate that on the slice by
                    // setting the subtitle with the overloaded method and indicate true.
                    .setSubtitle(null, true)
                    .addEndItem(IconCompat.createWithResource(getContext(), R.drawable.ic_work),
                            ListBuilder.ICON_IMAGE)
            );
    return listBuilder.build();
}

private SliceAction createActivityAction() {
    return SliceAction.create(
            PendingIntent.getActivity(
                    getContext(),
                    0,
                    new Intent(getContext(), MainActivity.class),
                    0
            ),
            IconCompat.createWithResource(getContext(), R.drawable.ic_home),
            ListBuilder.ICON_IMAGE,
            "Enter app"
    );
}

Как отключить прокрутку в Slice

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

В качестве примера рассмотрим фрагмент со списком сетей Wi-Fi.

Если список сетей Wi-Fi длинный, а прокрутка отключена, вы можете добавить кнопку Ещё, чтобы пользователи могли увидеть все элементы списка. Вы можете добавить эту кнопку с помощью addSeeMoreAction(), как показано в примере ниже.

Kotlin

fun seeMoreActionSlice(sliceUri: Uri) =
    list(context, sliceUri, ListBuilder.INFINITY) {
        // [START_EXCLUDE]
        // [END_EXCLUDE]
        setSeeMoreAction(seeAllNetworksPendingIntent)
        // [START_EXCLUDE]
        // [END_EXCLUDE]
    }

Java

public Slice seeMoreActionSlice(Uri sliceUri) {
    if (getContext() == null) {
        return null;
    }
    ListBuilder listBuilder = new ListBuilder(getContext(), sliceUri, ListBuilder.INFINITY);
    // [START_EXCLUDE]
    listBuilder.addRow(new RowBuilder()
            .setTitle("Hello")
            .setPrimaryAction(createActivityAction())
    );
    // [END_EXCLUDE]
    listBuilder.setSeeMoreAction(seeAllNetworksPendingIntent);
    // [START_EXCLUDE]
    // [END_EXCLUDE]
    return listBuilder.build();
}

Вот как это выглядит:

Если нажать Ещё, будет отправлен запрос seeAllNetworksPendingIntent.

Если вы хотите добавить собственное сообщение или строку, используйте RowBuilder:

Kotlin

fun seeMoreRowSlice(sliceUri: Uri) =
    list(context, sliceUri, ListBuilder.INFINITY) {
        // [START_EXCLUDE]
        // [END_EXCLUDE]
        seeMoreRow {
            title = "See all available networks"
            addEndItem(
                IconCompat.createWithResource(context, R.drawable.ic_right_caret), ICON_IMAGE
            )
            primaryAction = SliceAction.create(
                seeAllNetworksPendingIntent,
                IconCompat.createWithResource(context, R.drawable.ic_wifi),
                ListBuilder.ICON_IMAGE,
                "Wi-Fi Networks"
            )
        }
    }

Java

public Slice seeMoreRowSlice(Uri sliceUri) {
    if (getContext() == null) {
        return null;
    }
    ListBuilder listBuilder = new ListBuilder(getContext(), sliceUri, ListBuilder.INFINITY)
            // [START_EXCLUDE]
            .addRow(new RowBuilder()
                    .setTitle("Hello")
                    .setPrimaryAction(createActivityAction())
            )
            // [END_EXCLUDE]
            .setSeeMoreRow(new RowBuilder()
                    .setTitle("See all available networks")
                    .addEndItem(IconCompat
                                    .createWithResource(getContext(), R.drawable
                                            .ic_right_caret),
                            ListBuilder.ICON_IMAGE)
                    .setPrimaryAction(SliceAction.create(seeAllNetworksPendingIntent,
                            IconCompat.createWithResource(getContext(), R.drawable.ic_wifi),
                            ListBuilder.ICON_IMAGE,
                            "Wi-Fi Networks"))
            );
    // [START_EXCLUDE]
    // [END_EXCLUDE]
    return listBuilder.build();
}

Строка или действие, добавленные этим методом, отображаются, только если выполняется одно из следующих условий:

Докладчик вашего фрагмента отключил прокрутку в режиме просмотра.
Не все строки помещаются в доступном пространстве.

Объединение шаблонов

Вы можете создать информативный динамический фрагмент, объединив несколько типов строк. Например, фрагмент может содержать строку заголовка, сетку с одним изображением и сетку с двумя ячейками текста.

Вот фрагмент со строкой заголовка и сеткой, содержащей три ячейки.

Шаблоны фрагментов Оптимизируйте свои подборки Сохраняйте и классифицируйте контент в соответствии со своими настройками.

Как определить шаблон фрагмента

SliceAction

HeaderBuilder

Отображение заголовка на разных платформах

Пример HeaderBuilder – простой фрагмент списка с заголовком

Kotlin

Java

SliceActions в заголовках

Kotlin

Java

RowBuilder

Пример RowBuilder – переключатель Wi-Fi

Kotlin

Java

GridBuilder

Пример GridRowBuilder – рестораны поблизости

Kotlin

Java

RangeBuilder

Пример RangeBuilder – ползунок

Kotlin

Java

Контент с задержкой

Пример контента с задержкой – поездка на работу

Kotlin

Java

Как отключить прокрутку в Slice

Kotlin

Java

Kotlin

Java

Объединение шаблонов

Шаблоны фрагментов