com.github.amlcurran.showcaseview

Class ShowcaseView.Builder

java.lang.Object

com.github.amlcurran.showcaseview.ShowcaseView.Builder

Enclosing class:

ShowcaseView

public static class ShowcaseView.Builder
extends Object

Builder class which allows easier creation of ShowcaseViews. It is recommended that you use this Builder class.

Constructor Summary

Constructors

Constructor and Description
ShowcaseView.Builder(android.app.Activity activity)
ShowcaseView.Builder(android.app.Activity activity, boolean useNewStyle) Deprecated. use withHoloShowcase(), withNewStyleShowcase(), or setShowcaseDrawer(ShowcaseDrawer)

Method Summary

Methods

Modifier and Type	Method and Description
ShowcaseView.Builder	blockAllTouches() Block any touch made on the ShowcaseView, even inside the showcase
ShowcaseView	build() Create the ShowcaseView and show it.
ShowcaseView.Builder	doNotBlockTouches() Don't make the ShowcaseView block touches on itself.
ShowcaseView.Builder	hideOnTouchOutside() Make this ShowcaseView hide when the user touches outside the showcased area.
ShowcaseView.Builder	replaceEndButton(android.widget.Button button) Replace the end button with the one provided.
ShowcaseView.Builder	replaceEndButton(int buttonResourceId) Replace the end button with the one provided.
ShowcaseView.Builder	setContentText(CharSequence text) Set the descriptive text shown on the ShowcaseView.
ShowcaseView.Builder	setContentText(int resId) Set the descriptive text shown on the ShowcaseView.
ShowcaseView.Builder	setContentTextPaint(android.text.TextPaint textPaint) Sets the paint that will draw the text as specified by setContentText(CharSequence) or setContentText(int).
ShowcaseView.Builder	setContentTitle(CharSequence title) Set the title text shown on the ShowcaseView.
ShowcaseView.Builder	setContentTitle(int resId) Set the title text shown on the ShowcaseView.
ShowcaseView.Builder	setContentTitlePaint(android.text.TextPaint textPaint) Sets the paint that will draw the text as specified by setContentTitle(CharSequence) or setContentTitle(int).
ShowcaseView.Builder	setOnClickListener(android.view.View.OnClickListener onClickListener) Set a listener which will override the button clicks.
ShowcaseView.Builder	setParent(android.view.ViewGroup parent, int index)
ShowcaseView.Builder	setShowcaseDrawer(ShowcaseDrawer showcaseDrawer) Set a custom showcase drawer which will be responsible for measuring and drawing the showcase
ShowcaseView.Builder	setShowcaseEventListener(OnShowcaseEventListener showcaseEventListener)
ShowcaseView.Builder	setStyle(int theme) Set the style of the ShowcaseView.
ShowcaseView.Builder	setTarget(Target target) Set the target of the showcase.
ShowcaseView.Builder	singleShot(long shotId) Set the ShowcaseView to only ever show once.
ShowcaseView.Builder	useDecorViewAsParent() Uses the android decor view to insert a showcase, this is not recommended as then UI elements in showcase view can hide behind the nav bar
ShowcaseView.Builder	withHoloShowcase() Draw a holo-style showcase.
ShowcaseView.Builder	withMaterialShowcase() Draw a material style showcase.
ShowcaseView.Builder	withNewStyleShowcase() Draw a new-style showcase.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ShowcaseView.Builder

public ShowcaseView.Builder(android.app.Activity activity)

ShowcaseView.Builder

@Deprecated
public ShowcaseView.Builder(android.app.Activity activity,
                               boolean useNewStyle)

Deprecated. use withHoloShowcase(), withNewStyleShowcase(), or setShowcaseDrawer(ShowcaseDrawer)

Parameters:

useNewStyle - should use "new style" showcase (see withNewStyleShowcase()

Method Detail

build

public ShowcaseView build()

Create the ShowcaseView and show it.

Returns:

the created ShowcaseView

withHoloShowcase

public ShowcaseView.Builder withHoloShowcase()

Draw a holo-style showcase. This is the default.

withNewStyleShowcase

public ShowcaseView.Builder withNewStyleShowcase()

Draw a new-style showcase.

withMaterialShowcase

public ShowcaseView.Builder withMaterialShowcase()

Draw a material style showcase.

setShowcaseDrawer

public ShowcaseView.Builder setShowcaseDrawer(ShowcaseDrawer showcaseDrawer)

Set a custom showcase drawer which will be responsible for measuring and drawing the showcase

setContentTitle

public ShowcaseView.Builder setContentTitle(int resId)

Set the title text shown on the ShowcaseView.

setContentTitle

public ShowcaseView.Builder setContentTitle(CharSequence title)

Set the title text shown on the ShowcaseView.

setContentText

public ShowcaseView.Builder setContentText(int resId)

Set the descriptive text shown on the ShowcaseView.

setContentText

public ShowcaseView.Builder setContentText(CharSequence text)

Set the descriptive text shown on the ShowcaseView.

setTarget

public ShowcaseView.Builder setTarget(Target target)

Set the target of the showcase.

Parameters:

target - a Target representing the item to showcase (e.g., a button, or action item).

setStyle

public ShowcaseView.Builder setStyle(int theme)

Set the style of the ShowcaseView. See the sample app for example styles.

setOnClickListener

public ShowcaseView.Builder setOnClickListener(android.view.View.OnClickListener onClickListener)

Set a listener which will override the button clicks.

Note that you will have to manually hide the ShowcaseView

doNotBlockTouches

public ShowcaseView.Builder doNotBlockTouches()

Don't make the ShowcaseView block touches on itself. This doesn't block touches in the showcased area.

By default, the ShowcaseView does block touches

hideOnTouchOutside

public ShowcaseView.Builder hideOnTouchOutside()

Make this ShowcaseView hide when the user touches outside the showcased area. This enables doNotBlockTouches() as well.

By default, the ShowcaseView doesn't hide on touch.

singleShot

public ShowcaseView.Builder singleShot(long shotId)

Set the ShowcaseView to only ever show once.

Parameters:

shotId - a unique identifier (across the app) to store whether this ShowcaseView has been shown.

setShowcaseEventListener

public ShowcaseView.Builder setShowcaseEventListener(OnShowcaseEventListener showcaseEventListener)

setParent

public ShowcaseView.Builder setParent(android.view.ViewGroup parent,
                             int index)

setContentTextPaint

public ShowcaseView.Builder setContentTextPaint(android.text.TextPaint textPaint)

Sets the paint that will draw the text as specified by setContentText(CharSequence) or setContentText(int). If you're using a TextAppearance (set by setStyle(int), then this TextPaint will override that TextAppearance.

setContentTitlePaint

public ShowcaseView.Builder setContentTitlePaint(android.text.TextPaint textPaint)

Sets the paint that will draw the text as specified by setContentTitle(CharSequence) or setContentTitle(int). If you're using a TextAppearance (set by setStyle(int), then this TextPaint will override that TextAppearance.

replaceEndButton

public ShowcaseView.Builder replaceEndButton(android.widget.Button button)

Replace the end button with the one provided. Note that this resets any OnClickListener provided by View.setOnClickListener(OnClickListener), so call this method before that one.

replaceEndButton

public ShowcaseView.Builder replaceEndButton(int buttonResourceId)

Replace the end button with the one provided. Note that this resets any OnClickListener provided by View.setOnClickListener(OnClickListener), so call this method before that one.

blockAllTouches

public ShowcaseView.Builder blockAllTouches()

Block any touch made on the ShowcaseView, even inside the showcase

useDecorViewAsParent

public ShowcaseView.Builder useDecorViewAsParent()

Uses the android decor view to insert a showcase, this is not recommended as then UI elements in showcase view can hide behind the nav bar