GuideCaseView.Builder (xui

java.lang.Object
- com.xuexiang.xui.widget.guidview.GuideCaseView.Builder

Enclosing class:: GuideCaseView

public static class GuideCaseView.Builder
extends java.lang.Object

Builder class for GuideCaseView

Constructor Summary

Constructors
Constructor and Description

Builder(android.app.Activity activity)
Constructor for Builder class

Constructors
Constructor and Description
`Builder(android.app.Activity activity)` Constructor for Builder class

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GuideCaseView.Builder`	`adjustHeight(int adjustHeight)` 调整的高度
`GuideCaseView.Builder`	`backgroundColor(int backgroundColor)` 设置引导朦层的背景颜色
`GuideCaseView`	`build()` builds the builder
`GuideCaseView.Builder`	`closeOnTouch(boolean closeOnTouch)`
`GuideCaseView.Builder`	`customView(int layoutResource, OnViewInflateListener listener)` 设置自定义引导朦层布局
`GuideCaseView.Builder`	`disableFocusAnimation()` disable Focus Animation
`GuideCaseView.Builder`	`dismissListener(DismissListener dismissListener)` 设置引导朦层消失的监听
`GuideCaseView.Builder`	`enterAnimation(android.view.animation.Animation enterAnimation)` 设置进入动画
`GuideCaseView.Builder`	`exitAnimation(android.view.animation.Animation exitAnimation)` 设置退出动画
`GuideCaseView.Builder`	`fitSystemWindows(boolean fitSystemWindows)` This should be the same as root view's fitSystemWindows value
`GuideCaseView.Builder`	`fitWindowsAuto()` 自动适应屏幕高度
`GuideCaseView.Builder`	`focusAnimationMaxValue(int focusAnimationMaxValue)`
`GuideCaseView.Builder`	`focusAnimationStep(int focusAnimationStep)`
`GuideCaseView.Builder`	`focusBorderColor(int focusBorderColor)` 设置聚焦边框的颜色
`GuideCaseView.Builder`	`focusBorderSize(int focusBorderSize)` 设置聚焦边框的粗细
`GuideCaseView.Builder`	`focusCircleAtPosition(int positionX, int positionY, int radius)` Focus circle at specific position 自定义聚焦的环形区域
`GuideCaseView.Builder`	`focusCircleRadiusFactor(double focusCircleRadiusFactor)`
`GuideCaseView.Builder`	`focusOn(android.view.View view)` 设置聚焦的控件
`GuideCaseView.Builder`	`focusRectAtPosition(int positionX, int positionY, int positionWidth, int positionHeight)` Focus round rectangle at specific position 自定义聚焦的矩形区域
`GuideCaseView.Builder`	`focusShape(FocusShape focusShape)` 设置聚焦的形状，默认是圆形
`GuideCaseView.Builder`	`picture(int pictureResId)` 设置图片资源
`GuideCaseView.Builder`	`picture(int pictureResId, int width, int height)`
`GuideCaseView.Builder`	`pictureGravity(int pictureGravity)`
`GuideCaseView.Builder`	`pictureGravity(int pictureGravity, int offsetX, int offsetY)`
`GuideCaseView.Builder`	`pictureOffSet(int offsetX, int offsetY)`
`GuideCaseView.Builder`	`pictureOffSetX(int offsetX)`
`GuideCaseView.Builder`	`pictureOffSetY(int offsetY)`
`GuideCaseView.Builder`	`roundRectRadius(int roundRectRadius)`
`GuideCaseView.Builder`	`setFocusOffSetX(int offSetX)` 调整聚焦的X偏移
`void`	`show()` 显示
`GuideCaseView.Builder`	`showOnce(java.lang.String id)`
`GuideCaseView.Builder`	`title(android.text.Spanned title)`
`GuideCaseView.Builder`	`title(java.lang.String title)` 设置标题文字
`GuideCaseView.Builder`	`titleGravity(int titleGravity)`
`GuideCaseView.Builder`	`titleSize(int titleSize, int unit)` the defined text size overrides any defined size in the default or provided style
`GuideCaseView.Builder`	`titleStyle(int style, int titleGravity)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Builder
```
public Builder(android.app.Activity activity)
```
    Constructor for Builder class
    
    Parameters:
    
    activity - Activity to show GuideCaseView in
- Method Detail
  - title
```
public GuideCaseView.Builder title(java.lang.String title)
```
    设置标题文字
    
    Parameters:
    
    title - title text
    
    Returns:
    
    Builder
  - title
```
public GuideCaseView.Builder title(android.text.Spanned title)
```
    Parameters:
    
    title - title text
    
    Returns:
    
    Builder
  - picture
```
public GuideCaseView.Builder picture(int pictureResId)
```
    设置图片资源
    
    Parameters:
    
    pictureResId - 图片资源Id
    
    Returns:
    
    Builder
  - picture
```
public GuideCaseView.Builder picture(int pictureResId,
                                     int width,
                                     int height)
```
    Parameters:
    
    pictureResId - 图片资源Id
    
    width - 图片资源Id
    
    height - 图片资源Id
    
    Returns:
    
    Builder
  - pictureGravity
```
public GuideCaseView.Builder pictureGravity(int pictureGravity)
```
    Parameters:
    
    pictureGravity - picture gravity
    
    Returns:
    
    Builder
  - pictureGravity
```
public GuideCaseView.Builder pictureGravity(int pictureGravity,
                                            int offsetX,
                                            int offsetY)
```
    Parameters:
    
    pictureGravity - picture gravity
    
    Returns:
    
    Builder
  - pictureOffSet
```
public GuideCaseView.Builder pictureOffSet(int offsetX,
                                           int offsetY)
```
    Returns:
    
    Builder
  - pictureOffSetX
```
public GuideCaseView.Builder pictureOffSetX(int offsetX)
```
    Returns:
    
    Builder
  - pictureOffSetY
```
public GuideCaseView.Builder pictureOffSetY(int offsetY)
```
    Returns:
    
    Builder
  - titleStyle
```
public GuideCaseView.Builder titleStyle(int style,
                                        int titleGravity)
```
    Parameters:
    
    style - title text style
    
    titleGravity - title gravity
    
    Returns:
    
    Builder
  - focusBorderColor
```
public GuideCaseView.Builder focusBorderColor(int focusBorderColor)
```
    设置聚焦边框的颜色
    
    Parameters:
    
    focusBorderColor - Border color for focus shape
    
    Returns:
    
    Builder
  - focusBorderSize
```
public GuideCaseView.Builder focusBorderSize(int focusBorderSize)
```
    设置聚焦边框的粗细
    
    Parameters:
    
    focusBorderSize - Border size for focus shape
    
    Returns:
    
    Builder
  - titleGravity
```
public GuideCaseView.Builder titleGravity(int titleGravity)
```
    Parameters:
    
    titleGravity - title gravity
    
    Returns:
    
    Builder
  - titleSize
```
public GuideCaseView.Builder titleSize(int titleSize,
                                       int unit)
```
    the defined text size overrides any defined size in the default or provided style
    
    Parameters:
    
    titleSize - title size
    
    unit - title text unit
    
    Returns:
    
    Builder
  - showOnce
```
public GuideCaseView.Builder showOnce(java.lang.String id)
```
    Parameters:
    
    id - unique identifier for GuideCaseView
    
    Returns:
    
    Builder
  - focusOn
```
public GuideCaseView.Builder focusOn(android.view.View view)
```
    设置聚焦的控件
    
    Parameters:
    
    view - view to focus
    
    Returns:
    
    Builder
  - backgroundColor
```
public GuideCaseView.Builder backgroundColor(int backgroundColor)
```
    设置引导朦层的背景颜色
    
    Parameters:
    
    backgroundColor - background color of GuideCaseView
    
    Returns:
    
    Builder
  - focusCircleRadiusFactor
```
public GuideCaseView.Builder focusCircleRadiusFactor(double focusCircleRadiusFactor)
```
    Parameters:
    
    focusCircleRadiusFactor - focus circle radius factor (default value = 1)
    
    Returns:
    
    Builder
  - customView
```
public GuideCaseView.Builder customView(int layoutResource,
                                        OnViewInflateListener listener)
```
    设置自定义引导朦层布局
    
    Parameters:
    
    layoutResource - custom view layout resource
    
    listener - inflate listener for custom view
    
    Returns:
    
    Builder
  - enterAnimation
```
public GuideCaseView.Builder enterAnimation(android.view.animation.Animation enterAnimation)
```
    设置进入动画
    
    Parameters:
    
    enterAnimation - enter animation for GuideCaseView
    
    Returns:
    
    Builder
  - exitAnimation
```
public GuideCaseView.Builder exitAnimation(android.view.animation.Animation exitAnimation)
```
    设置退出动画
    【设置推出动画的时候，请一定注意设置动画监听setAnimationListener，并在onAnimationEnd执行GuideCaseView的removeView}方法】
    
    Parameters:
    
    exitAnimation - exit animation for GuideCaseView
    
    Returns:
    
    Builder
  - closeOnTouch
```
public GuideCaseView.Builder closeOnTouch(boolean closeOnTouch)
```
    Parameters:
    
    closeOnTouch - closes on touch if enabled
    
    Returns:
    
    Builder
  - fitSystemWindows
```
public GuideCaseView.Builder fitSystemWindows(boolean fitSystemWindows)
```
    This should be the same as root view's fitSystemWindows value
    
    Parameters:
    
    fitSystemWindows - fitSystemWindows value
    
    Returns:
    
    Builder
  - fitWindowsAuto
```
public GuideCaseView.Builder fitWindowsAuto()
```
    自动适应屏幕高度
    
    Returns:
  - adjustHeight
```
public GuideCaseView.Builder adjustHeight(int adjustHeight)
```
    调整的高度
    
    Parameters:
    
    adjustHeight -
    
    Returns:
  - setFocusOffSetX
```
public GuideCaseView.Builder setFocusOffSetX(int offSetX)
```
    调整聚焦的X偏移
    
    Returns:
  - focusShape
```
public GuideCaseView.Builder focusShape(FocusShape focusShape)
```
    设置聚焦的形状，默认是圆形
    
    Parameters:
    
    focusShape -
    
    Returns:
  - focusRectAtPosition
```
public GuideCaseView.Builder focusRectAtPosition(int positionX,
                                                 int positionY,
                                                 int positionWidth,
                                                 int positionHeight)
```
    Focus round rectangle at specific position 自定义聚焦的矩形区域
    
    Parameters:
    
    positionX - focus at specific position Y coordinate
    
    positionY - focus at specific position circle radius
    
    positionWidth - focus at specific position rectangle width
    
    positionHeight - focus at specific position rectangle height
    
    Returns:
    
    Builder
  - focusCircleAtPosition
```
public GuideCaseView.Builder focusCircleAtPosition(int positionX,
                                                   int positionY,
                                                   int radius)
```
    Focus circle at specific position 自定义聚焦的环形区域
    
    Parameters:
    
    positionX - focus at specific position Y coordinate
    
    positionY - focus at specific position circle radius
    
    radius - focus at specific position circle radius
    
    Returns:
    
    Builder
  - dismissListener
```
public GuideCaseView.Builder dismissListener(DismissListener dismissListener)
```
    设置引导朦层消失的监听
    
    Parameters:
    
    dismissListener - the dismiss listener
    
    Returns:
    
    Builder
  - roundRectRadius
```
public GuideCaseView.Builder roundRectRadius(int roundRectRadius)
```
  - disableFocusAnimation
```
public GuideCaseView.Builder disableFocusAnimation()
```
    disable Focus Animation
    
    Returns:
    
    Builder
  - focusAnimationMaxValue
```
public GuideCaseView.Builder focusAnimationMaxValue(int focusAnimationMaxValue)
```
  - focusAnimationStep
```
public GuideCaseView.Builder focusAnimationStep(int focusAnimationStep)
```
  - build
```
public GuideCaseView build()
```
    builds the builder
    
    Returns:
    
    GuideCaseView with given parameters
  - show
```
public void show()
```
    显示

Class GuideCaseView.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

title

title

picture

picture

pictureGravity

pictureGravity

pictureOffSet

pictureOffSetX

pictureOffSetY

titleStyle

focusBorderColor

focusBorderSize

titleGravity

titleSize

showOnce

focusOn

backgroundColor

focusCircleRadiusFactor

customView

enterAnimation

exitAnimation

closeOnTouch

fitSystemWindows

fitWindowsAuto

adjustHeight

setFocusOffSetX

focusShape

focusRectAtPosition

focusCircleAtPosition

dismissListener

roundRectRadius

disableFocusAnimation

focusAnimationMaxValue

focusAnimationStep

build

show