Hansel And Gretel 项目技术文档

1. 安装指南

1.1 通过 Android Library Project 引入

HanselAndGretel 是一个 Android 库项目，无法通过独立的 JAR 文件引入，因为它依赖于 Android 的 theming 功能。你可以通过以下方式将其作为库项目引入：

• Eclipse: 参考 Android 开发者文档，将 HanselAndGretel 项目作为库项目引用。
• Ant: 同样，你可以通过 Ant 构建工具将 HanselAndGretel 项目作为库项目引用。

1.2 通过 Maven 引入

如果你使用 Maven 进行项目管理，可以通过在 pom.xml 文件中添加以下依赖来引入 HanselAndGretel 库：

<dependency>
  <groupId>com.jakewharton</groupId>
  <artifactId>hanselandgretel</artifactId>
  <version>1.0.2</version>
  <type>apklib</type>
</dependency>

1.3 依赖项

HanselAndGretel 项目依赖于 Android Support Library 中的 Fragment 类。请确保你的项目中已经包含了 Android Support Library。

2. 项目的使用说明

2.1 在布局文件中添加 BreadCrumbs 控件

在你的布局文件中，通常在显示 Fragment 的容器上方添加 FragmentBreadCrumbs 控件：

<android.support.v4.app.FragmentBreadCrumbs
    android:id="@+id/breadcrumbs"
    android:layout_width="fill_parent"
    android:layout_height="40dp" />

2.2 在 Activity 中绑定 BreadCrumbs 控件

在你的 Activity 的 onCreate 方法中，绑定 FragmentBreadCrumbs 控件到当前 Activity：

FragmentBreadCrumbs crumbs = (FragmentBreadCrumbs)findViewById(R.id.breadcrumbs);
crumbs.setActivity(this);

2.3 添加样式属性

在你的主题中添加必要的样式属性：

<item name="hagDividerVertical">@drawable/hag__divider_dark</item>
<item name="hagSelectableItemBackground">@drawable/hag__background_dark</item>

或者你可以指定自己的 drawable 资源作为分隔符和背景。

2.4 设置初始视图的标题（可选）

如果你希望为初始视图设置标题，可以在 FragmentBreadCrumbs 控件中设置标题：

crumbs.setTitle("Settings", null);

3. 项目 API 使用文档

3.1 FragmentBreadCrumbs 类

FragmentBreadCrumbs 是 HanselAndGretel 库的核心类，用于在 Android 应用中显示 Fragment 的面包屑导航。

3.1.1 方法

• setActivity(Activity activity): 将 FragmentBreadCrumbs 控件绑定到指定的 Activity。
• setTitle(CharSequence title, CharSequence shortTitle): 设置当前 Fragment 的标题。

3.2 样式属性

• hagDividerVertical: 设置面包屑导航中的垂直分隔符。
• hagSelectableItemBackground: 设置面包屑导航项的背景。

4. 项目安装方式

4.1 通过 Android Library Project 安装

1. 下载 HanselAndGretel 项目源码。
2. 在 Eclipse 或 Android Studio 中导入该项目。
3. 将 HanselAndGretel 项目作为库项目引用。

4.2 通过 Maven 安装

1. 在 pom.xml 文件中添加 HanselAndGretel 的依赖。
2. 运行 mvn install 命令安装依赖。

通过以上步骤，你可以在你的 Android 项目中成功集成并使用 HanselAndGretel 库。