GuideBuilder (guideview API)

java.lang.Object
- com.binioter.guideview.GuideBuilder

```
public class GuideBuilder
extends java.lang.Object
```
遮罩系统构建器
本系统能够快速的为一个Activity里的任何一个View控件创建一个遮罩式的引导页。

工作原理
首先它需要一个目标View或者它的id,我们通过findViewById来得到这个View，计算它在屏幕上的区域targetRect,参见 setTargetViewId(int)与setTargetView(View)通过这个区域，开始绘制一个覆盖整个Activity的遮罩，可以定义蒙板的颜色setFullingColorId(int)和透明度 setAlpha(int)。然而目标View的区域不会被绘制从而实现高亮的效果。
接下来是在相对于这个targetRect的区域绘制一些图片或者文字。我们把这样一张图片或者文字抽象成一个Component接口 Component,设置文字或者图片等 Component#getView(android.view.LayoutInflater) . 所有的图片文字都是相对于targetRect来定义的。可以设定额外的x， Component.getXOffset() ;y偏移量, Component.getYOffset()。
可以对遮罩系统设置可见状态的发生变化时的监听回调 setOnVisibilityChangedListener(OnVisibilityChangedListener)
可以对遮罩系统设置开始和结束时的动画效果 setEnterAnimationId(int) setExitAnimationId(int)
Created by binIoter

嵌套类概要

嵌套类
限定符和类型	类和说明
`static interface`	`GuideBuilder.OnSlideListener` 手势滑动监听
`static interface`	`GuideBuilder.OnVisibilityChangedListener` 遮罩可见发生变化时的事件监听
`static class`	`GuideBuilder.SlideState`

构造器概要

构造器
构造器和说明

GuideBuilder()
构造函数

构造器
构造器和说明
`GuideBuilder()` 构造函数

方法概要

All Methods Instance Methods Concrete Methods
限定符和类型	方法和说明
`GuideBuilder`	`addComponent(Component component)` 添加一个控件
`Guide`	`createGuide()` 创建Guide，非Fragment版本
`GuideBuilder`	`setAlpha(int alpha)` 设置蒙板透明度
`GuideBuilder`	`setAutoDismiss(boolean b)` 是否在点击的时候自动退出蒙板
`GuideBuilder`	`setEnterAnimationId(int id)` 设置进入动画
`GuideBuilder`	`setExitAnimationId(int id)` 设置退出动画
`GuideBuilder`	`setFullingColorId(int id)` 设置蒙板颜色的资源id
`GuideBuilder`	`setHighTargetCorner(int corner)` 设置高亮区域的圆角大小
`GuideBuilder`	`setHighTargetGraphStyle(int style)` 设置高亮区域的图形样式
`GuideBuilder`	`setHighTargetPadding(int padding)` 设置高亮区域的padding
`GuideBuilder`	`setHighTargetPaddingBottom(int padding)` 设置高亮区域的底部padding
`GuideBuilder`	`setHighTargetPaddingLeft(int padding)` 设置高亮区域的左侧padding
`GuideBuilder`	`setHighTargetPaddingRight(int padding)` 设置高亮区域的右侧padding
`GuideBuilder`	`setHighTargetPaddingTop(int padding)` 设置高亮区域的顶部padding
`GuideBuilder`	`setOnSlideListener(GuideBuilder.OnSlideListener onSlideListener)` 设置手势滑动的监听回调
`GuideBuilder`	`setOnVisibilityChangedListener(GuideBuilder.OnVisibilityChangedListener onVisibilityChangedListener)` 设置遮罩可见状态变化时的监听回调
`GuideBuilder`	`setOutsideTouchable(boolean touchable)` 设置遮罩系统是否可点击并处理点击事件
`GuideBuilder`	`setOverlayTarget(boolean b)` 是否覆盖目标
`GuideBuilder`	`setTargetView(View v)` 设置目标view
`GuideBuilder`	`setTargetViewId(int id)` 设置目标View的id

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - GuideBuilder
```
public GuideBuilder()
```
    构造函数
- 方法详细资料
  - setAlpha
```
public GuideBuilder setAlpha(int alpha)
```
    设置蒙板透明度
    
    参数:
    
    alpha - [0-255] 0 表示完全透明，255表示不透明
    
    返回:
    
    GuideBuilder
  - setTargetView
```
public GuideBuilder setTargetView(View v)
```
    设置目标view
  - setTargetViewId
```
public GuideBuilder setTargetViewId(@IdRes
                                    int id)
```
    设置目标View的id
    
    参数:
    
    id - 目标View的id
    
    返回:
    
    GuideBuilder
  - setHighTargetCorner
```
public GuideBuilder setHighTargetCorner(int corner)
```
    设置高亮区域的圆角大小
    
    返回:
    
    GuideBuilder
  - setHighTargetGraphStyle
```
public GuideBuilder setHighTargetGraphStyle(int style)
```
    设置高亮区域的图形样式
    
    返回:
    
    GuideBuilder
  - setFullingColorId
```
public GuideBuilder setFullingColorId(@IdRes
                                      int id)
```
    设置蒙板颜色的资源id
    
    参数:
    
    id - 资源id
    
    返回:
    
    GuideBuilder
  - setAutoDismiss
```
public GuideBuilder setAutoDismiss(boolean b)
```
    是否在点击的时候自动退出蒙板
    
    参数:
    
    b - true if needed
    
    返回:
    
    GuideBuilder
  - setOverlayTarget
```
public GuideBuilder setOverlayTarget(boolean b)
```
    是否覆盖目标
    
    参数:
    
    b - true 遮罩将会覆盖整个屏幕
    
    返回:
    
    GuideBuilder
  - setEnterAnimationId
```
public GuideBuilder setEnterAnimationId(@AnimatorRes
                                        int id)
```
    设置进入动画
    
    参数:
    
    id - 进入动画的id
    
    返回:
    
    GuideBuilder
  - setExitAnimationId
```
public GuideBuilder setExitAnimationId(@AnimatorRes
                                       int id)
```
    设置退出动画
    
    参数:
    
    id - 退出动画的id
    
    返回:
    
    GuideBuilder
  - addComponent
```
public GuideBuilder addComponent(Component component)
```
    添加一个控件
    
    参数:
    
    component - 被添加的控件
    
    返回:
    
    GuideBuilder
  - setOnVisibilityChangedListener
```
public GuideBuilder setOnVisibilityChangedListener(GuideBuilder.OnVisibilityChangedListener onVisibilityChangedListener)
```
    设置遮罩可见状态变化时的监听回调
  - setOnSlideListener
```
public GuideBuilder setOnSlideListener(GuideBuilder.OnSlideListener onSlideListener)
```
    设置手势滑动的监听回调
  - setOutsideTouchable
```
public GuideBuilder setOutsideTouchable(boolean touchable)
```
    设置遮罩系统是否可点击并处理点击事件
    
    参数:
    
    touchable - true 遮罩不可点击，处于不可点击状态 false 可点击，遮罩自己可以处理自身点击事件
  - setHighTargetPadding
```
public GuideBuilder setHighTargetPadding(int padding)
```
    设置高亮区域的padding
    
    返回:
    
    GuideBuilder
  - setHighTargetPaddingLeft
```
public GuideBuilder setHighTargetPaddingLeft(int padding)
```
    设置高亮区域的左侧padding
    
    返回:
    
    GuideBuilder
  - setHighTargetPaddingTop
```
public GuideBuilder setHighTargetPaddingTop(int padding)
```
    设置高亮区域的顶部padding
    
    返回:
    
    GuideBuilder
  - setHighTargetPaddingRight
```
public GuideBuilder setHighTargetPaddingRight(int padding)
```
    设置高亮区域的右侧padding
    
    返回:
    
    GuideBuilder
  - setHighTargetPaddingBottom
```
public GuideBuilder setHighTargetPaddingBottom(int padding)
```
    设置高亮区域的底部padding
    
    返回:
    
    GuideBuilder
  - createGuide
```
public Guide createGuide()
```
    创建Guide，非Fragment版本
    
    返回:
    
    Guide

类 GuideBuilder

遮罩系统构建器

工作原理

嵌套类概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

GuideBuilder

方法详细资料

setAlpha

setTargetView

setTargetViewId

setHighTargetCorner

setHighTargetGraphStyle

setFullingColorId

setAutoDismiss

setOverlayTarget

setEnterAnimationId

setExitAnimationId

addComponent

setOnVisibilityChangedListener

setOnSlideListener

setOutsideTouchable

setHighTargetPadding

setHighTargetPaddingLeft

setHighTargetPaddingTop

setHighTargetPaddingRight

setHighTargetPaddingBottom

createGuide