com.braunster.tutorialview.view

Class TutorialLayout

java.lang.Object

android.view.View

android.view.ViewGroup

android.widget.RelativeLayout

com.braunster.tutorialview.view.TutorialLayout

All Implemented Interfaces:

android.graphics.drawable.Drawable.Callback, android.view.accessibility.AccessibilityEventSource, android.view.KeyEvent.Callback, android.view.ViewManager, android.view.ViewParent, TutorialInterface, TutorialViewInterface, WalkThroughInterface

public class TutorialLayout
extends android.widget.RelativeLayout
implements TutorialViewInterface, WalkThroughInterface

Created by braunster on 04/12/14.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	TutorialLayout.WalkThroughListener

Nested classes/interfaces inherited from class android.widget.RelativeLayout

android.widget.RelativeLayout.LayoutParams

Nested classes/interfaces inherited from class android.view.ViewGroup

android.view.ViewGroup.MarginLayoutParams, android.view.ViewGroup.OnHierarchyChangeListener

Nested classes/interfaces inherited from class android.view.View

android.view.View.AccessibilityDelegate, android.view.View.BaseSavedState, android.view.View.DragShadowBuilder, android.view.View.MeasureSpec, android.view.View.OnApplyWindowInsetsListener, android.view.View.OnAttachStateChangeListener, android.view.View.OnClickListener, android.view.View.OnCreateContextMenuListener, android.view.View.OnDragListener, android.view.View.OnFocusChangeListener, android.view.View.OnGenericMotionListener, android.view.View.OnHoverListener, android.view.View.OnKeyListener, android.view.View.OnLayoutChangeListener, android.view.View.OnLongClickListener, android.view.View.OnSystemUiVisibilityChangeListener, android.view.View.OnTouchListener

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEBUG
static java.lang.String	TAG

Fields inherited from class android.widget.RelativeLayout

ABOVE, ALIGN_BASELINE, ALIGN_BOTTOM, ALIGN_END, ALIGN_LEFT, ALIGN_PARENT_BOTTOM, ALIGN_PARENT_END, ALIGN_PARENT_LEFT, ALIGN_PARENT_RIGHT, ALIGN_PARENT_START, ALIGN_PARENT_TOP, ALIGN_RIGHT, ALIGN_START, ALIGN_TOP, BELOW, CENTER_HORIZONTAL, CENTER_IN_PARENT, CENTER_VERTICAL, END_OF, LEFT_OF, RIGHT_OF, START_OF, TRUE

Fields inherited from class android.view.ViewGroup

CLIP_TO_PADDING_MASK, FOCUS_AFTER_DESCENDANTS, FOCUS_BEFORE_DESCENDANTS, FOCUS_BLOCK_DESCENDANTS, LAYOUT_MODE_CLIP_BOUNDS, LAYOUT_MODE_OPTICAL_BOUNDS, PERSISTENT_ALL_CACHES, PERSISTENT_ANIMATION_CACHE, PERSISTENT_NO_CACHE, PERSISTENT_SCROLLING_CACHE

Fields inherited from class android.view.View

ACCESSIBILITY_LIVE_REGION_ASSERTIVE, ACCESSIBILITY_LIVE_REGION_NONE, ACCESSIBILITY_LIVE_REGION_POLITE, ALPHA, DRAWING_CACHE_QUALITY_AUTO, DRAWING_CACHE_QUALITY_HIGH, DRAWING_CACHE_QUALITY_LOW, EMPTY_STATE_SET, ENABLED_FOCUSED_SELECTED_STATE_SET, ENABLED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET, ENABLED_FOCUSED_STATE_SET, ENABLED_FOCUSED_WINDOW_FOCUSED_STATE_SET, ENABLED_SELECTED_STATE_SET, ENABLED_SELECTED_WINDOW_FOCUSED_STATE_SET, ENABLED_STATE_SET, ENABLED_WINDOW_FOCUSED_STATE_SET, FIND_VIEWS_WITH_CONTENT_DESCRIPTION, FIND_VIEWS_WITH_TEXT, FOCUS_BACKWARD, FOCUS_DOWN, FOCUS_FORWARD, FOCUS_LEFT, FOCUS_RIGHT, FOCUS_UP, FOCUSABLES_ALL, FOCUSABLES_TOUCH_MODE, FOCUSED_SELECTED_STATE_SET, FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET, FOCUSED_STATE_SET, FOCUSED_WINDOW_FOCUSED_STATE_SET, GONE, HAPTIC_FEEDBACK_ENABLED, IMPORTANT_FOR_ACCESSIBILITY_AUTO, IMPORTANT_FOR_ACCESSIBILITY_NO, IMPORTANT_FOR_ACCESSIBILITY_NO_HIDE_DESCENDANTS, IMPORTANT_FOR_ACCESSIBILITY_YES, INVISIBLE, KEEP_SCREEN_ON, LAYER_TYPE_HARDWARE, LAYER_TYPE_NONE, LAYER_TYPE_SOFTWARE, LAYOUT_DIRECTION_INHERIT, LAYOUT_DIRECTION_LOCALE, LAYOUT_DIRECTION_LTR, LAYOUT_DIRECTION_RTL, MEASURED_HEIGHT_STATE_SHIFT, MEASURED_SIZE_MASK, MEASURED_STATE_MASK, MEASURED_STATE_TOO_SMALL, NO_ID, OVER_SCROLL_ALWAYS, OVER_SCROLL_IF_CONTENT_SCROLLS, OVER_SCROLL_NEVER, PRESSED_ENABLED_FOCUSED_SELECTED_STATE_SET, PRESSED_ENABLED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET, PRESSED_ENABLED_FOCUSED_STATE_SET, PRESSED_ENABLED_FOCUSED_WINDOW_FOCUSED_STATE_SET, PRESSED_ENABLED_SELECTED_STATE_SET, PRESSED_ENABLED_SELECTED_WINDOW_FOCUSED_STATE_SET, PRESSED_ENABLED_STATE_SET, PRESSED_ENABLED_WINDOW_FOCUSED_STATE_SET, PRESSED_FOCUSED_SELECTED_STATE_SET, PRESSED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET, PRESSED_FOCUSED_STATE_SET, PRESSED_FOCUSED_WINDOW_FOCUSED_STATE_SET, PRESSED_SELECTED_STATE_SET, PRESSED_SELECTED_WINDOW_FOCUSED_STATE_SET, PRESSED_STATE_SET, PRESSED_WINDOW_FOCUSED_STATE_SET, ROTATION, ROTATION_X, ROTATION_Y, SCALE_X, SCALE_Y, SCREEN_STATE_OFF, SCREEN_STATE_ON, SCROLL_AXIS_HORIZONTAL, SCROLL_AXIS_NONE, SCROLL_AXIS_VERTICAL, SCROLLBAR_POSITION_DEFAULT, SCROLLBAR_POSITION_LEFT, SCROLLBAR_POSITION_RIGHT, SCROLLBARS_INSIDE_INSET, SCROLLBARS_INSIDE_OVERLAY, SCROLLBARS_OUTSIDE_INSET, SCROLLBARS_OUTSIDE_OVERLAY, SELECTED_STATE_SET, SELECTED_WINDOW_FOCUSED_STATE_SET, SOUND_EFFECTS_ENABLED, STATUS_BAR_HIDDEN, STATUS_BAR_VISIBLE, SYSTEM_UI_FLAG_FULLSCREEN, SYSTEM_UI_FLAG_HIDE_NAVIGATION, SYSTEM_UI_FLAG_IMMERSIVE, SYSTEM_UI_FLAG_IMMERSIVE_STICKY, SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN, SYSTEM_UI_FLAG_LAYOUT_HIDE_NAVIGATION, SYSTEM_UI_FLAG_LAYOUT_STABLE, SYSTEM_UI_FLAG_LOW_PROFILE, SYSTEM_UI_FLAG_VISIBLE, SYSTEM_UI_LAYOUT_FLAGS, TEXT_ALIGNMENT_CENTER, TEXT_ALIGNMENT_GRAVITY, TEXT_ALIGNMENT_INHERIT, TEXT_ALIGNMENT_TEXT_END, TEXT_ALIGNMENT_TEXT_START, TEXT_ALIGNMENT_VIEW_END, TEXT_ALIGNMENT_VIEW_START, TEXT_DIRECTION_ANY_RTL, TEXT_DIRECTION_FIRST_STRONG, TEXT_DIRECTION_INHERIT, TEXT_DIRECTION_LOCALE, TEXT_DIRECTION_LTR, TEXT_DIRECTION_RTL, TRANSLATION_X, TRANSLATION_Y, TRANSLATION_Z, VIEW_LOG_TAG, VISIBLE, WINDOW_FOCUSED_STATE_SET, X, Y, Z

Constructor Summary

Constructors

Constructor and Description
TutorialLayout(android.content.Context context)
TutorialLayout(android.content.Context context, android.util.AttributeSet attrs)
TutorialLayout(android.content.Context context, android.util.AttributeSet attrs, int defStyleAttr)

Method Summary

Modifier and Type	Method and Description
void	changeActionBarColor(boolean mChangeActionBarColor) If true and an action bar is given to the view the action bar background color will be changed to the tutorial color.
void	closeTutorial()
long	getAnimationDuration()
AbstractTutorialView.AnimationType	getAnimationType()
int	getTutorialBackgroundColor()
int	getTutorialGotItPosition()
int	getTutorialInfoLayoutId()
int	getTutorialInfoTextPosition()
java.lang.String	getTutorialText()
int	getTutorialTextColor()
int	getTutorialTextSize()
java.lang.String	getTutorialTextTypeFace()
AbstractTutorialView	getTutorialView()
void	hide()
boolean	isShowing()
boolean	isWalkThrough()
void	nextTutorial(Tutorial tutorial) Moving to the next tutorial in the walk through.
void	setActionBar(android.app.ActionBar actionBar) Setting the action bar, Used only if you pace the Tutorial view inside your root view.
void	setActionBarRestoreColor(int mActionBarColor) The of the color that will be set as the action bar color when the tutorial view will be closed.
void	setAnimationDuration(long duration)
void	setAnimationType(AbstractTutorialView.AnimationType mAnimationType)
void	setHasActionBar(boolean hasActionBar) Set true if the application has the activity that hold this view has action bar..
void	setHasStatusBar(boolean hasStatusBar) Set true if the application has status bar.
void	setPositionToSurround(float positionToSurroundX, float positionToSurroundY, int positionToSurroundWidth, int positionToSurroundHeight) Used mostly for the tutorial activity, Instead of passing a view to surround we pass the view coordination and dimensions.
void	setPositionToSurround(float positionToSurroundX, float positionToSurroundY, int positionToSurroundWidth, int positionToSurroundHeight, java.lang.String title) Used mostly for the tutorial activity, Instead of passing a view to surround we pass the view coordination and dimensions.
void	setTutorial(Tutorial tutorial) Set the tutorial data for this view and animate it into the screen.
void	setTutorial(Tutorial tutorial, boolean show) Set the tutorial data for this view and animate it into the screen if wanted.
void	setTutorialBackgroundColor(int mTutorialBackgroundColor) The background color for the tutorial.
void	setTutorialClosedListener(AbstractTutorialView.TutorialClosedListener tutorialClosedListener) Set the listener on the tutorial view, If walk through is used this will be overridden and you should set a WalkThroughListener instead.
void	setTutorialGotItPosition(int gotItPosition)
void	setTutorialInfoLayoutId(int tutorialInfoLayoutId) The Layout id of the view that will be used to show the tutorial text or information.
void	setTutorialInfoTextPosition(int infoTextPosition)
void	setTutorialText(java.lang.String tutorialText) The text that will be used for the mTutorialInfoView.
void	setTutorialTextColor(int mTutorialTextColor)
void	setTutorialTextSize(int mTutorialTextSize) Set the size that will be used for the default info view text view.
void	setTutorialTextTypeFace(java.lang.String tutorialTextTypeFaceName)
void	setViewToSurround(android.view.View mViewToSurround) Surround a given view by a visual tutorial with text.
void	setViewToSurround(android.view.View mViewToSurround, java.lang.String title) Surround a given view by a visual tutorial with text and title.
void	setWalkThroughData(java.util.ArrayList<Tutorial> tutorials) Setting the walk through data.
void	setWalkThroughListener(TutorialLayout.WalkThroughListener walkThroughListener)
void	show()
void	skip() Skipping the rest of the walk through.
void	startWalkThrough() Starting the walk through.

Methods inherited from class android.widget.RelativeLayout

checkLayoutParams, dispatchPopulateAccessibilityEvent, generateDefaultLayoutParams, generateLayoutParams, generateLayoutParams, getBaseline, getGravity, onInitializeAccessibilityEvent, onInitializeAccessibilityNodeInfo, onLayout, onMeasure, requestLayout, setGravity, setHorizontalGravity, setIgnoreGravity, setVerticalGravity, shouldDelayChildPressedState

Methods inherited from class android.view.ViewGroup

addChildrenForAccessibility, addFocusables, addStatesFromChildren, addTouchables, addView, addView, addView, addView, addView, addViewInLayout, addViewInLayout, attachLayoutAnimationParameters, attachViewToParent, bringChildToFront, canAnimate, childDrawableStateChanged, childHasTransientStateChanged, cleanupLayoutState, clearChildFocus, clearDisappearingChildren, clearFocus, debug, detachAllViewsFromParent, detachViewFromParent, detachViewFromParent, detachViewsFromParent, dispatchApplyWindowInsets, dispatchConfigurationChanged, dispatchDisplayHint, dispatchDragEvent, dispatchDraw, dispatchDrawableHotspotChanged, dispatchFreezeSelfOnly, dispatchGenericFocusedEvent, dispatchGenericPointerEvent, dispatchHoverEvent, dispatchKeyEvent, dispatchKeyEventPreIme, dispatchKeyShortcutEvent, dispatchRestoreInstanceState, dispatchSaveInstanceState, dispatchSetActivated, dispatchSetPressed, dispatchSetSelected, dispatchSystemUiVisibilityChanged, dispatchThawSelfOnly, dispatchTouchEvent, dispatchTrackballEvent, dispatchUnhandledMove, dispatchVisibilityChanged, dispatchWindowFocusChanged, dispatchWindowSystemUiVisiblityChanged, dispatchWindowVisibilityChanged, drawableStateChanged, drawChild, endViewTransition, findFocus, findViewsWithText, focusableViewAvailable, focusSearch, gatherTransparentRegion, getChildAt, getChildCount, getChildDrawingOrder, getChildMeasureSpec, getChildStaticTransformation, getChildVisibleRect, getClipChildren, getClipToPadding, getDescendantFocusability, getFocusedChild, getLayoutAnimation, getLayoutAnimationListener, getLayoutMode, getLayoutTransition, getNestedScrollAxes, getOverlay, getPersistentDrawingCache, getTouchscreenBlocksFocus, hasFocus, hasFocusable, hasTransientState, indexOfChild, invalidateChild, invalidateChildInParent, isAlwaysDrawnWithCacheEnabled, isAnimationCacheEnabled, isChildrenDrawingOrderEnabled, isChildrenDrawnWithCacheEnabled, isMotionEventSplittingEnabled, isTransitionGroup, jumpDrawablesToCurrentState, layout, measureChild, measureChildren, measureChildWithMargins, notifySubtreeAccessibilityStateChanged, offsetDescendantRectToMyCoords, offsetRectIntoDescendantCoords, onAnimationEnd, onAnimationStart, onAttachedToWindow, onCreateDrawableState, onDetachedFromWindow, onInterceptHoverEvent, onInterceptTouchEvent, onNestedFling, onNestedPreFling, onNestedPrePerformAccessibilityAction, onNestedPreScroll, onNestedScroll, onNestedScrollAccepted, onRequestFocusInDescendants, onRequestSendAccessibilityEvent, onStartNestedScroll, onStopNestedScroll, recomputeViewAttributes, removeAllViews, removeAllViewsInLayout, removeDetachedView, removeView, removeViewAt, removeViewInLayout, removeViews, removeViewsInLayout, requestChildFocus, requestChildRectangleOnScreen, requestDisallowInterceptTouchEvent, requestFocus, requestSendAccessibilityEvent, requestTransparentRegion, scheduleLayoutAnimation, setAddStatesFromChildren, setAlwaysDrawnWithCacheEnabled, setAnimationCacheEnabled, setChildrenDrawingCacheEnabled, setChildrenDrawingOrderEnabled, setChildrenDrawnWithCacheEnabled, setClipChildren, setClipToPadding, setDescendantFocusability, setLayoutAnimation, setLayoutAnimationListener, setLayoutMode, setLayoutTransition, setMotionEventSplittingEnabled, setOnHierarchyChangeListener, setPersistentDrawingCache, setStaticTransformationsEnabled, setTouchscreenBlocksFocus, setTransitionGroup, showContextMenuForChild, startActionModeForChild, startLayoutAnimation, startViewTransition, updateViewLayout

Methods inherited from class android.view.View

addFocusables, addOnAttachStateChangeListener, addOnLayoutChangeListener, animate, announceForAccessibility, awakenScrollBars, awakenScrollBars, awakenScrollBars, bringToFront, buildDrawingCache, buildDrawingCache, buildLayer, callOnClick, cancelLongPress, cancelPendingInputEvents, canResolveLayoutDirection, canResolveTextAlignment, canResolveTextDirection, canScrollHorizontally, canScrollVertically, checkInputConnectionProxy, clearAnimation, combineMeasuredStates, computeHorizontalScrollExtent, computeHorizontalScrollOffset, computeHorizontalScrollRange, computeScroll, computeSystemWindowInsets, computeVerticalScrollExtent, computeVerticalScrollOffset, computeVerticalScrollRange, createAccessibilityNodeInfo, createContextMenu, destroyDrawingCache, dispatchGenericMotionEvent, dispatchNestedFling, dispatchNestedPreFling, dispatchNestedPrePerformAccessibilityAction, dispatchNestedPreScroll, dispatchNestedScroll, draw, drawableHotspotChanged, findViewById, findViewWithTag, fitSystemWindows, focusSearch, forceLayout, generateViewId, getAccessibilityLiveRegion, getAccessibilityNodeProvider, getAccessibilityTraversalAfter, getAccessibilityTraversalBefore, getAlpha, getAnimation, getApplicationWindowToken, getBackground, getBackgroundTintList, getBackgroundTintMode, getBottom, getBottomFadingEdgeStrength, getBottomPaddingOffset, getCameraDistance, getClipBounds, getClipToOutline, getContentDescription, getContext, getContextMenuInfo, getDefaultSize, getDisplay, getDrawableState, getDrawingCache, getDrawingCache, getDrawingCacheBackgroundColor, getDrawingCacheQuality, getDrawingRect, getDrawingTime, getElevation, getFilterTouchesWhenObscured, getFitsSystemWindows, getFocusables, getFocusedRect, getGlobalVisibleRect, getGlobalVisibleRect, getHandler, getHeight, getHitRect, getHorizontalFadingEdgeLength, getHorizontalScrollbarHeight, getId, getImportantForAccessibility, getKeepScreenOn, getKeyDispatcherState, getLabelFor, getLayerType, getLayoutDirection, getLayoutParams, getLeft, getLeftFadingEdgeStrength, getLeftPaddingOffset, getLocalVisibleRect, getLocationInWindow, getLocationOnScreen, getMatrix, getMeasuredHeight, getMeasuredHeightAndState, getMeasuredState, getMeasuredWidth, getMeasuredWidthAndState, getMinimumHeight, getMinimumWidth, getNextFocusDownId, getNextFocusForwardId, getNextFocusLeftId, getNextFocusRightId, getNextFocusUpId, getOnFocusChangeListener, getOutlineProvider, getOverScrollMode, getPaddingBottom, getPaddingEnd, getPaddingLeft, getPaddingRight, getPaddingStart, getPaddingTop, getParent, getParentForAccessibility, getPivotX, getPivotY, getResources, getRight, getRightFadingEdgeStrength, getRightPaddingOffset, getRootView, getRotation, getRotationX, getRotationY, getScaleX, getScaleY, getScrollBarDefaultDelayBeforeFade, getScrollBarFadeDuration, getScrollBarSize, getScrollBarStyle, getScrollX, getScrollY, getSolidColor, getStateListAnimator, getSuggestedMinimumHeight, getSuggestedMinimumWidth, getSystemUiVisibility, getTag, getTag, getTextAlignment, getTextDirection, getTop, getTopFadingEdgeStrength, getTopPaddingOffset, getTouchables, getTouchDelegate, getTransitionName, getTranslationX, getTranslationY, getTranslationZ, getVerticalFadingEdgeLength, getVerticalScrollbarPosition, getVerticalScrollbarWidth, getViewTreeObserver, getVisibility, getWidth, getWindowAttachCount, getWindowId, getWindowSystemUiVisibility, getWindowToken, getWindowVisibility, getWindowVisibleDisplayFrame, getX, getY, getZ, hasNestedScrollingParent, hasOnClickListeners, hasOverlappingRendering, hasWindowFocus, inflate, invalidate, invalidate, invalidate, invalidateDrawable, invalidateOutline, isAccessibilityFocused, isActivated, isAttachedToWindow, isClickable, isDirty, isDrawingCacheEnabled, isDuplicateParentStateEnabled, isEnabled, isFocusable, isFocusableInTouchMode, isFocused, isHapticFeedbackEnabled, isHardwareAccelerated, isHorizontalFadingEdgeEnabled, isHorizontalScrollBarEnabled, isHovered, isImportantForAccessibility, isInEditMode, isInLayout, isInTouchMode, isLaidOut, isLayoutDirectionResolved, isLayoutRequested, isLongClickable, isNestedScrollingEnabled, isOpaque, isPaddingOffsetRequired, isPaddingRelative, isPressed, isSaveEnabled, isSaveFromParentEnabled, isScrollbarFadingEnabled, isScrollContainer, isSelected, isShown, isSoundEffectsEnabled, isTextAlignmentResolved, isTextDirectionResolved, isVerticalFadingEdgeEnabled, isVerticalScrollBarEnabled, measure, mergeDrawableStates, offsetLeftAndRight, offsetTopAndBottom, onApplyWindowInsets, onCancelPendingInputEvents, onCheckIsTextEditor, onConfigurationChanged, onCreateContextMenu, onCreateInputConnection, onDisplayHint, onDragEvent, onDraw, onDrawScrollBars, onFilterTouchEventForSecurity, onFinishInflate, onFinishTemporaryDetach, onFocusChanged, onGenericMotionEvent, onHoverChanged, onHoverEvent, onKeyDown, onKeyLongPress, onKeyMultiple, onKeyPreIme, onKeyShortcut, onKeyUp, onOverScrolled, onPopulateAccessibilityEvent, onRestoreInstanceState, onRtlPropertiesChanged, onSaveInstanceState, onScreenStateChanged, onScrollChanged, onSetAlpha, onSizeChanged, onStartTemporaryDetach, onTouchEvent, onTrackballEvent, onVisibilityChanged, onWindowFocusChanged, onWindowSystemUiVisibilityChanged, onWindowVisibilityChanged, overScrollBy, performAccessibilityAction, performClick, performHapticFeedback, performHapticFeedback, performLongClick, playSoundEffect, post, postDelayed, postInvalidate, postInvalidate, postInvalidateDelayed, postInvalidateDelayed, postInvalidateOnAnimation, postInvalidateOnAnimation, postOnAnimation, postOnAnimationDelayed, refreshDrawableState, removeCallbacks, removeOnAttachStateChangeListener, removeOnLayoutChangeListener, requestApplyInsets, requestFitSystemWindows, requestFocus, requestFocus, requestFocusFromTouch, requestRectangleOnScreen, requestRectangleOnScreen, requestUnbufferedDispatch, resolveSize, resolveSizeAndState, restoreHierarchyState, saveHierarchyState, scheduleDrawable, scrollBy, scrollTo, sendAccessibilityEvent, sendAccessibilityEventUnchecked, setAccessibilityDelegate, setAccessibilityLiveRegion, setAccessibilityTraversalAfter, setAccessibilityTraversalBefore, setActivated, setAlpha, setAnimation, setBackground, setBackgroundColor, setBackgroundDrawable, setBackgroundResource, setBackgroundTintList, setBackgroundTintMode, setBottom, setCameraDistance, setClickable, setClipBounds, setClipToOutline, setContentDescription, setDrawingCacheBackgroundColor, setDrawingCacheEnabled, setDrawingCacheQuality, setDuplicateParentStateEnabled, setElevation, setEnabled, setFadingEdgeLength, setFilterTouchesWhenObscured, setFitsSystemWindows, setFocusable, setFocusableInTouchMode, setHapticFeedbackEnabled, setHasTransientState, setHorizontalFadingEdgeEnabled, setHorizontalScrollBarEnabled, setHovered, setId, setImportantForAccessibility, setKeepScreenOn, setLabelFor, setLayerPaint, setLayerType, setLayoutDirection, setLayoutParams, setLeft, setLongClickable, setMeasuredDimension, setMinimumHeight, setMinimumWidth, setNestedScrollingEnabled, setNextFocusDownId, setNextFocusForwardId, setNextFocusLeftId, setNextFocusRightId, setNextFocusUpId, setOnApplyWindowInsetsListener, setOnClickListener, setOnCreateContextMenuListener, setOnDragListener, setOnFocusChangeListener, setOnGenericMotionListener, setOnHoverListener, setOnKeyListener, setOnLongClickListener, setOnSystemUiVisibilityChangeListener, setOnTouchListener, setOutlineProvider, setOverScrollMode, setPadding, setPaddingRelative, setPivotX, setPivotY, setPressed, setRight, setRotation, setRotationX, setRotationY, setSaveEnabled, setSaveFromParentEnabled, setScaleX, setScaleY, setScrollBarDefaultDelayBeforeFade, setScrollBarFadeDuration, setScrollbarFadingEnabled, setScrollBarSize, setScrollBarStyle, setScrollContainer, setScrollX, setScrollY, setSelected, setSoundEffectsEnabled, setStateListAnimator, setSystemUiVisibility, setTag, setTag, setTextAlignment, setTextDirection, setTop, setTouchDelegate, setTransitionName, setTranslationX, setTranslationY, setTranslationZ, setVerticalFadingEdgeEnabled, setVerticalScrollBarEnabled, setVerticalScrollbarPosition, setVisibility, setWillNotCacheDrawing, setWillNotDraw, setX, setY, setZ, showContextMenu, startActionMode, startAnimation, startDrag, startNestedScroll, stopNestedScroll, toString, unscheduleDrawable, unscheduleDrawable, verifyDrawable, willNotCacheDrawing, willNotDraw

Methods inherited from class java.lang.Object

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

Methods inherited from interface android.view.ViewParent

canResolveLayoutDirection, canResolveTextAlignment, canResolveTextDirection, createContextMenu, getLayoutDirection, getParent, getParentForAccessibility, getTextAlignment, getTextDirection, isLayoutDirectionResolved, isLayoutRequested, isTextAlignmentResolved, isTextDirectionResolved, requestFitSystemWindows

Field Detail

TAG

public static final java.lang.String TAG

DEBUG

public static final boolean DEBUG

See Also:

Constant Field Values

Constructor Detail

TutorialLayout

public TutorialLayout(android.content.Context context)

TutorialLayout

public TutorialLayout(android.content.Context context,
                      android.util.AttributeSet attrs)

TutorialLayout

public TutorialLayout(android.content.Context context,
                      android.util.AttributeSet attrs,
                      int defStyleAttr)

Method Detail

getTutorialView

public AbstractTutorialView getTutorialView()

setViewToSurround

public void setViewToSurround(android.view.View mViewToSurround)

Description copied from interface: TutorialViewInterface

Surround a given view by a visual tutorial with text.

Specified by:

setViewToSurround in interface TutorialViewInterface

Parameters:

mViewToSurround - - the view that need to be surrounded with the tutorial.

setViewToSurround

public void setViewToSurround(android.view.View mViewToSurround,
                              java.lang.String title)

Description copied from interface: TutorialViewInterface

Surround a given view by a visual tutorial with text and title.

Specified by:

setViewToSurround in interface TutorialViewInterface

Parameters:

mViewToSurround - - the view that need to be surrounded with the tutorial.

title - - the text of the title that will be used for the tutorial, If an action bar is assign the title will be in the action bar title.

setPositionToSurround

public void setPositionToSurround(float positionToSurroundX,
                                  float positionToSurroundY,
                                  int positionToSurroundWidth,
                                  int positionToSurroundHeight)

Description copied from interface: TutorialViewInterface

Used mostly for the tutorial activity, Instead of passing a view to surround we pass the view coordination and dimensions.

Specified by:

setPositionToSurround in interface TutorialViewInterface

Parameters:

positionToSurroundX - - The x position of the area that should be surrounded, This could be obtained by using getX() on the view you want to surround.

positionToSurroundY - - The y position of the area that should be surrounded, This could be obtained by using getY() on the view you want to surround.

positionToSurroundWidth - - The width of the area that should be surrounded, This could be obtained by using getMeasuredWidth() on the view you want to surround.

positionToSurroundHeight - - The height of the area that should be surrounded, This could be obtained by using getMeasuredHeight() on the view you want to surround.

setPositionToSurround

public void setPositionToSurround(float positionToSurroundX,
                                  float positionToSurroundY,
                                  int positionToSurroundWidth,
                                  int positionToSurroundHeight,
                                  java.lang.String title)

Description copied from interface: TutorialViewInterface

Used mostly for the tutorial activity, Instead of passing a view to surround we pass the view coordination and dimensions.

Specified by:

setPositionToSurround in interface TutorialViewInterface

Parameters:

positionToSurroundX - - The x position of the area that should be surrounded, This could be obtained by using getX() on the view you want to surround.

positionToSurroundY - - The y position of the area that should be surrounded, This could be obtained by using getY() on the view you want to surround.

positionToSurroundWidth - - The width of the area that should be surrounded, This could be obtained by using getMeasuredWidth() on the view you want to surround.

positionToSurroundHeight - - The height of the area that should be surrounded, This could be obtained by using getMeasuredHeight() on the view you want to surround.

title - - The title text that will be used for this tutorial.

setTutorial

public void setTutorial(Tutorial tutorial,
                        boolean show)

Description copied from interface: TutorialViewInterface

Set the tutorial data for this view and animate it into the screen if wanted.

Specified by:

setTutorial in interface TutorialViewInterface

Parameters:

tutorial - The tutorial object that hold all the tutorial data.

show - pass true if you want the tutorial to be shown.

setTutorial

public void setTutorial(Tutorial tutorial)

Description copied from interface: TutorialViewInterface

Set the tutorial data for this view and animate it into the screen.

Specified by:

setTutorial in interface TutorialViewInterface

Parameters:

tutorial - The tutorial object that hold all the tutorial data.

setTutorialInfoLayoutId

public void setTutorialInfoLayoutId(int tutorialInfoLayoutId)

Description copied from interface: TutorialInterface

The Layout id of the view that will be used to show the tutorial text or information.

Specified by:

setTutorialInfoLayoutId in interface TutorialInterface

Parameters:

tutorialInfoLayoutId - the id of the layout that should be used for the info text.

getTutorialInfoLayoutId

public int getTutorialInfoLayoutId()

Specified by:

getTutorialInfoLayoutId in interface TutorialInterface

setActionBar

public void setActionBar(android.app.ActionBar actionBar)

Description copied from interface: TutorialViewInterface

Setting the action bar, Used only if you pace the Tutorial view inside your root view. When set the view could change the title and color of the action bar as you pleased.

Specified by:

setActionBar in interface TutorialViewInterface

See Also:

TutorialViewInterface.setActionBarRestoreColor(int), TutorialViewInterface.changeActionBarColor(boolean)

setTutorialClosedListener

public void setTutorialClosedListener(AbstractTutorialView.TutorialClosedListener tutorialClosedListener)

Set the listener on the tutorial view, If walk through is used this will be overridden and you should set a WalkThroughListener instead.

Specified by:

setTutorialClosedListener in interface TutorialViewInterface

See Also:

setWalkThroughListener(com.braunster.tutorialview.view.TutorialLayout.WalkThroughListener)

setTutorialBackgroundColor

public void setTutorialBackgroundColor(int mTutorialBackgroundColor)

Description copied from interface: TutorialInterface

The background color for the tutorial.

Specified by:

setTutorialBackgroundColor in interface TutorialInterface

Parameters:

mTutorialBackgroundColor - the backgrond color to use for the background

getTutorialBackgroundColor

public int getTutorialBackgroundColor()

Specified by:

getTutorialBackgroundColor in interface TutorialInterface

changeActionBarColor

public void changeActionBarColor(boolean mChangeActionBarColor)

Description copied from interface: TutorialViewInterface

If true and an action bar is given to the view the action bar background color will be changed to the tutorial color. You should also set mActionBarRestoreColor so when the tutorial is closed the action bar color will ber restored.

Specified by:

changeActionBarColor in interface TutorialViewInterface

See Also:

AbstractTutorialView.setActionBarRestoreColor(int)

setActionBarRestoreColor

public void setActionBarRestoreColor(int mActionBarColor)

Description copied from interface: TutorialViewInterface

The of the color that will be set as the action bar color when the tutorial view will be closed.

Specified by:

setActionBarRestoreColor in interface TutorialViewInterface

See Also:

AbstractTutorialView.changeActionBarColor(boolean)

setHasStatusBar

public void setHasStatusBar(boolean hasStatusBar)

Description copied from interface: TutorialViewInterface

Set true if the application has status bar.

Specified by:

setHasStatusBar in interface TutorialViewInterface

setHasActionBar

public void setHasActionBar(boolean hasActionBar)

Description copied from interface: TutorialViewInterface

Set true if the application has the activity that hold this view has action bar..

Specified by:

setHasActionBar in interface TutorialViewInterface

setTutorialText

public void setTutorialText(java.lang.String tutorialText)

Description copied from interface: TutorialInterface

The text that will be used for the mTutorialInfoView. Only if the layout that is used is the default layout com.braunster.tutorialview.R.layout#tutorial_text.

Specified by:

setTutorialText in interface TutorialInterface

Parameters:

tutorialText - The explenation text about the view.

See Also:

AbstractTutorialView.setTutorialTextTypeFace(String), AbstractTutorialView.setTutorialTextColor(int), AbstractTutorialView.setTutorialTextSize(int)

getTutorialText

public java.lang.String getTutorialText()

Specified by:

getTutorialText in interface TutorialInterface

setTutorialTextSize

public void setTutorialTextSize(int mTutorialTextSize)

Description copied from interface: TutorialInterface

Set the size that will be used for the default info view text view. The size of the title and other button won't be changed.

Specified by:

setTutorialTextSize in interface TutorialInterface

Parameters:

mTutorialTextSize - the size that would be used for the info text.

See Also:

AbstractTutorialView.setTutorialText(String), AbstractTutorialView.setTutorialTextColor(int), AbstractTutorialView.setTutorialTextTypeFace(String)

getTutorialTextSize

public int getTutorialTextSize()

Specified by:

getTutorialTextSize in interface TutorialInterface

setTutorialTextColor

public void setTutorialTextColor(int mTutorialTextColor)

Specified by:

setTutorialTextColor in interface TutorialInterface

Parameters:

mTutorialTextColor - the color that will be used for the default info view text view. This color will also be used for the "Got It" button.

See Also:

AbstractTutorialView.setTutorialTextSize(int), AbstractTutorialView.setTutorialText(String), AbstractTutorialView.setTutorialTextTypeFace(String)

getTutorialTextColor

public int getTutorialTextColor()

Specified by:

getTutorialTextColor in interface TutorialInterface

setTutorialTextTypeFace

public void setTutorialTextTypeFace(java.lang.String tutorialTextTypeFaceName)

Specified by:

setTutorialTextTypeFace in interface TutorialInterface

Parameters:

tutorialTextTypeFaceName - the typeface name that will be used for the default info view text view.

See Also:

AbstractTutorialView.setTutorialTextSize(int), AbstractTutorialView.setTutorialText(String), AbstractTutorialView.setTutorialTextColor(int)

getTutorialTextTypeFace

public java.lang.String getTutorialTextTypeFace()

Specified by:

getTutorialTextTypeFace in interface TutorialInterface

setAnimationType

public void setAnimationType(AbstractTutorialView.AnimationType mAnimationType)

Specified by:

setAnimationType in interface TutorialInterface

Parameters:

mAnimationType - the animation type that will be used to show and hide the tutorial.

getAnimationType

public AbstractTutorialView.AnimationType getAnimationType()

Specified by:

getAnimationType in interface TutorialInterface

setAnimationDuration

public void setAnimationDuration(long duration)

Specified by:

setAnimationDuration in interface TutorialInterface

Parameters:

duration - the time that will be used for the animation

getAnimationDuration

public long getAnimationDuration()

Specified by:

getAnimationDuration in interface TutorialInterface

setTutorialInfoTextPosition

public void setTutorialInfoTextPosition(int infoTextPosition)

Specified by:

setTutorialInfoTextPosition in interface TutorialInterface

getTutorialInfoTextPosition

public int getTutorialInfoTextPosition()

Specified by:

getTutorialInfoTextPosition in interface TutorialInterface

setTutorialGotItPosition

public void setTutorialGotItPosition(int gotItPosition)

Specified by:

setTutorialGotItPosition in interface TutorialInterface

getTutorialGotItPosition

public int getTutorialGotItPosition()

Specified by:

getTutorialGotItPosition in interface TutorialInterface

isShowing

public boolean isShowing()

Specified by:

isShowing in interface TutorialViewInterface

Returns:

true if the tutorial is now showing it will remain true until the tutorial is fully animated out.

closeTutorial

public void closeTutorial()

setWalkThroughListener

public void setWalkThroughListener(TutorialLayout.WalkThroughListener walkThroughListener)

nextTutorial

public void nextTutorial(Tutorial tutorial)

Description copied from interface: WalkThroughInterface

Moving to the next tutorial in the walk through.

Specified by:

nextTutorial in interface WalkThroughInterface

skip

public void skip()

Description copied from interface: WalkThroughInterface

Skipping the rest of the walk through.

Specified by:

skip in interface WalkThroughInterface

setWalkThroughData

public void setWalkThroughData(java.util.ArrayList<Tutorial> tutorials)

Description copied from interface: WalkThroughInterface

Setting the walk through data.

Specified by:

setWalkThroughData in interface WalkThroughInterface

isWalkThrough

public boolean isWalkThrough()

Specified by:

isWalkThrough in interface TutorialViewInterface

Returns:

true if the view is in walk through mode.

show

public void show()

Specified by:

show in interface TutorialViewInterface

hide

public void hide()

Specified by:

hide in interface TutorialViewInterface

startWalkThrough

public void startWalkThrough()

Description copied from interface: WalkThroughInterface

Starting the walk through.

Specified by:

startWalkThrough in interface WalkThroughInterface