code
stringlengths
25
201k
docstring
stringlengths
19
96.2k
func_name
stringlengths
0
235
language
stringclasses
1 value
repo
stringlengths
8
51
path
stringlengths
11
314
url
stringlengths
62
377
license
stringclasses
7 values
void cleanUpAnimation() { if (mAnimationCurrent != null) { mAnimationCurrent.removeAllUpdateListeners(); mAnimationCurrent.removeAllListeners(); mAnimationCurrent.cancel(); mAnimationCurrent = null; } if (mAnimationFocalRipple != null) { mAnimationFocalRipple.removeAllUpdateListeners(); mAnimationFocalRipple.cancel(); mAnimationFocalRipple = null; } if (mAnimationFocalBreathing != null) { mAnimationFocalBreathing.removeAllUpdateListeners(); mAnimationFocalBreathing.cancel(); mAnimationFocalBreathing = null; } }
Stops any current animation and removes references to it.
cleanUpAnimation
java
sjwall/MaterialTapTargetPrompt
library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/MaterialTapTargetPrompt.java
https://github.com/sjwall/MaterialTapTargetPrompt/blob/master/library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/MaterialTapTargetPrompt.java
Apache-2.0
void updateAnimation(final float revealModifier, final float alphaModifier) { if (mView.getParent() == null) { return; } mView.mPromptOptions.getPromptText().update(mView.mPromptOptions, revealModifier, alphaModifier); if (mView.mIconDrawable != null) { mView.mIconDrawable.setAlpha((int) (255f * alphaModifier)); } mView.mPromptOptions.getPromptFocal().update(mView.mPromptOptions, revealModifier, alphaModifier); mView.mPromptOptions.getPromptBackground().update(mView.mPromptOptions, revealModifier, alphaModifier); mView.invalidate(); }
Updates the positioning and alpha values using the animation values. @param revealModifier The amount to modify the reveal size, between 0 and 1. @param alphaModifier The amount to modify the alpha value, between 0 and 1.
updateAnimation
java
sjwall/MaterialTapTargetPrompt
library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/MaterialTapTargetPrompt.java
https://github.com/sjwall/MaterialTapTargetPrompt/blob/master/library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/MaterialTapTargetPrompt.java
Apache-2.0
void prepare() { final View targetRenderView = mView.mPromptOptions.getTargetRenderView(); if (targetRenderView == null) { mView.mTargetRenderView = mView.mPromptOptions.getTargetView(); } else { mView.mTargetRenderView = targetRenderView; } updateClipBounds(); final View targetView = mView.mPromptOptions.getTargetView(); if (targetView != null) { final int[] viewPosition = new int[2]; mView.getLocationInWindow(viewPosition); mView.mPromptOptions.getPromptFocal().prepare(mView.mPromptOptions, targetView, viewPosition); } else { final PointF targetPosition = mView.mPromptOptions.getTargetPosition(); mView.mPromptOptions.getPromptFocal().prepare(mView.mPromptOptions, targetPosition.x, targetPosition.y); } mView.mPromptOptions.getPromptText().prepare(mView.mPromptOptions, mView.mClipToBounds, mView.mClipBounds); mView.mPromptOptions.getPromptBackground().prepare(mView.mPromptOptions, mView.mClipToBounds, mView.mClipBounds); updateIconPosition(); }
Update the focal and text positioning.
prepare
java
sjwall/MaterialTapTargetPrompt
library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/MaterialTapTargetPrompt.java
https://github.com/sjwall/MaterialTapTargetPrompt/blob/master/library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/MaterialTapTargetPrompt.java
Apache-2.0
void updateIconPosition() { mView.mIconDrawable = mView.mPromptOptions.getIconDrawable(); if (mView.mIconDrawable != null) { final RectF mFocalBounds = mView.mPromptOptions.getPromptFocal().getBounds(); mView.mIconDrawableLeft = mFocalBounds.centerX() - (mView.mIconDrawable.getIntrinsicWidth() / 2); mView.mIconDrawableTop = mFocalBounds.centerY() - (mView.mIconDrawable.getIntrinsicHeight() / 2); } else if (mView.mTargetRenderView != null) { final int[] viewPosition = new int[2]; mView.getLocationInWindow(viewPosition); final int[] targetPosition = new int[2]; mView.mTargetRenderView.getLocationInWindow(targetPosition); mView.mIconDrawableLeft = targetPosition[0] - viewPosition[0] - mView.mTargetRenderView.getScrollX(); mView.mIconDrawableTop = targetPosition[1] - viewPosition[1] - mView.mTargetRenderView.getScrollY(); } }
Update the icon drawable position or target render view position.
updateIconPosition
java
sjwall/MaterialTapTargetPrompt
library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/MaterialTapTargetPrompt.java
https://github.com/sjwall/MaterialTapTargetPrompt/blob/master/library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/MaterialTapTargetPrompt.java
Apache-2.0
void updateClipBounds() { final View clipToView = mView.mPromptOptions.getClipToView(); if (clipToView != null) { mView.mClipToBounds = true; //Reset the top to 0 mView.mClipBounds.set(0, 0, 0, 0); //Find the location of the clip view on the screen final Point offset = new Point(); clipToView.getGlobalVisibleRect(mView.mClipBounds, offset); if (offset.y == 0) { mView.mClipBounds.top += mStatusBarHeight; } } else { mView.mPromptOptions.getResourceFinder().getPromptParentView().getGlobalVisibleRect(mView.mClipBounds, new Point()); mView.mClipToBounds = false; } }
Update the bounds that the prompt is clip to.
updateClipBounds
java
sjwall/MaterialTapTargetPrompt
library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/MaterialTapTargetPrompt.java
https://github.com/sjwall/MaterialTapTargetPrompt/blob/master/library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/MaterialTapTargetPrompt.java
Apache-2.0
@NonNull public static MaterialTapTargetPrompt createDefault(@NonNull final PromptOptions promptOptions) { return new MaterialTapTargetPrompt(promptOptions); }
Creates a prompt with the supplied options. @param promptOptions The options to use to create the prompt. @return The created prompt.
createDefault
java
sjwall/MaterialTapTargetPrompt
library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/MaterialTapTargetPrompt.java
https://github.com/sjwall/MaterialTapTargetPrompt/blob/master/library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/MaterialTapTargetPrompt.java
Apache-2.0
private void setupAccessibilityClickListener() { setClickable(true); setOnClickListener(view -> { if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.ICE_CREAM_SANDWICH_MR1) { final View targetView = mPromptOptions.getTargetView(); if (targetView != null) { targetView.callOnClick(); } } mPrompt.finish(); }); }
When AccessibilityManager is enabled, the prompt view can be dismissed by double-tap. The event is also passed as onClick() to the target view, when available.
setupAccessibilityClickListener
java
sjwall/MaterialTapTargetPrompt
library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/MaterialTapTargetPrompt.java
https://github.com/sjwall/MaterialTapTargetPrompt/blob/master/library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/MaterialTapTargetPrompt.java
Apache-2.0
@Override public void onSequenceComplete() { // Cleanup current prompt final SequenceItem currentItem = items.get(nextPromptIndex); currentItem.setSequenceListener(null); final MaterialTapTargetPrompt prompt = currentItem.getState().getPrompt(); if (prompt != null) { prompt.mView.mPromptOptions.setSequenceListener(null); } nextPromptIndex++; // Check if there is another prompt to show if (items.size() > nextPromptIndex) { show(nextPromptIndex); } else if (mOnCompleteListener != null) { mOnCompleteListener.onSequenceComplete(); nextPromptIndex = -1; } }
Listener added to a sequence item for it completing.
onSequenceComplete
java
sjwall/MaterialTapTargetPrompt
library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/MaterialTapTargetSequence.java
https://github.com/sjwall/MaterialTapTargetPrompt/blob/master/library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/MaterialTapTargetSequence.java
Apache-2.0
@NonNull public MaterialTapTargetSequence setSequenceCompleteListener(@Nullable SequenceCompleteListener listener) { mOnCompleteListener = listener; return this; }
Set the listener to listen with the action to call when the sequence ends @param listener the listener with the action to execute
setSequenceCompleteListener
java
sjwall/MaterialTapTargetPrompt
library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/MaterialTapTargetSequence.java
https://github.com/sjwall/MaterialTapTargetPrompt/blob/master/library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/MaterialTapTargetSequence.java
Apache-2.0
@NonNull public MaterialTapTargetSequence addPrompt(@Nullable MaterialTapTargetPrompt prompt) { this.addItem(new SequenceItem(new SequenceState(prompt))); return this; }
Add a prompt to the end of the sequence. @param prompt The prompt to add.
addPrompt
java
sjwall/MaterialTapTargetPrompt
library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/MaterialTapTargetSequence.java
https://github.com/sjwall/MaterialTapTargetPrompt/blob/master/library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/MaterialTapTargetSequence.java
Apache-2.0
@NonNull public MaterialTapTargetSequence addPrompt(@Nullable MaterialTapTargetPrompt prompt, final long milliseconds) { this.addItem(new SequenceItemShowFor(new SequenceState(prompt), milliseconds)); return this; }
Add a show for time prompt to the end of the sequence. @param prompt The prompt to add. @param milliseconds The number of milliseconds to show the prompt for. @return This.
addPrompt
java
sjwall/MaterialTapTargetPrompt
library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/MaterialTapTargetSequence.java
https://github.com/sjwall/MaterialTapTargetPrompt/blob/master/library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/MaterialTapTargetSequence.java
Apache-2.0
@NonNull public MaterialTapTargetSequence addPrompt(@NonNull PromptOptions promptOptions) { this.addItem(new SequenceItem(new SequenceStatePromptOptions(promptOptions))); return this; }
Add a prompt to the end of the sequence. @param promptOptions The prompt to add. @return This.
addPrompt
java
sjwall/MaterialTapTargetPrompt
library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/MaterialTapTargetSequence.java
https://github.com/sjwall/MaterialTapTargetPrompt/blob/master/library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/MaterialTapTargetSequence.java
Apache-2.0
@NonNull public MaterialTapTargetSequence addPrompt(@NonNull PromptOptions promptOptions, final long milliseconds) { this.addItem(new SequenceItemShowFor(new SequenceStatePromptOptions(promptOptions), milliseconds)); return this; }
Add a show for time prompt to the end of the sequence. @param promptOptions The prompt to add. @param milliseconds The number of milliseconds to show the prompt for. @return This.
addPrompt
java
sjwall/MaterialTapTargetPrompt
library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/MaterialTapTargetSequence.java
https://github.com/sjwall/MaterialTapTargetPrompt/blob/master/library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/MaterialTapTargetSequence.java
Apache-2.0
@NonNull public MaterialTapTargetSequence addPrompt(@NonNull final SequenceItem item) { this.items.add(item); return this; }
Adds a sequence item to the end of the sequence. This sequence item must have state changers added to it by calling {@link SequenceItem#addStateChanger(int)}. @param item The already created sequence item to add. @return This.
addPrompt
java
sjwall/MaterialTapTargetPrompt
library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/MaterialTapTargetSequence.java
https://github.com/sjwall/MaterialTapTargetPrompt/blob/master/library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/MaterialTapTargetSequence.java
Apache-2.0
private void addItem(@NonNull final SequenceItem sequenceItem) { sequenceItem.addStateChanger(MaterialTapTargetPrompt.STATE_FINISHED); sequenceItem.addStateChanger(MaterialTapTargetPrompt.STATE_DISMISSED); this.items.add(sequenceItem); }
Adds common state changers and adds the item to the list. @param sequenceItem The item to add the state changers to and adds it to the item list.
addItem
java
sjwall/MaterialTapTargetPrompt
library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/MaterialTapTargetSequence.java
https://github.com/sjwall/MaterialTapTargetPrompt/blob/master/library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/MaterialTapTargetSequence.java
Apache-2.0
public int size() { return this.items.size(); }
Get the number of prompts in this sequence. @return The number of prompts in this sequence.
size
java
sjwall/MaterialTapTargetPrompt
library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/MaterialTapTargetSequence.java
https://github.com/sjwall/MaterialTapTargetPrompt/blob/master/library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/MaterialTapTargetSequence.java
Apache-2.0
@NonNull public SequenceItem get(final int index) { return this.items.get(index); }
Gets a prompt at a position in this sequence. @param index The prompt 0 based index. @return The prompt at the specified position in this sequence.
get
java
sjwall/MaterialTapTargetPrompt
library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/MaterialTapTargetSequence.java
https://github.com/sjwall/MaterialTapTargetPrompt/blob/master/library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/MaterialTapTargetSequence.java
Apache-2.0
@NonNull public MaterialTapTargetSequence show() { this.nextPromptIndex = 0; if (!this.items.isEmpty()) { this.show(0); } else if (mOnCompleteListener != null) { mOnCompleteListener.onSequenceComplete(); } return this; }
Start the sequence by showing the first prompt. @return This.
show
java
sjwall/MaterialTapTargetPrompt
library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/MaterialTapTargetSequence.java
https://github.com/sjwall/MaterialTapTargetPrompt/blob/master/library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/MaterialTapTargetSequence.java
Apache-2.0
private void show(final int index) { final SequenceItem sequenceItem = this.items.get(index); sequenceItem.setSequenceListener(this.itemListener); final MaterialTapTargetPrompt prompt = sequenceItem.getState().getPrompt(); if (prompt != null) { // add the listener to trigger the next in the sequence prompt.mView.mPromptOptions.setSequenceListener(sequenceItem); } sequenceItem.show(); }
Shows a prompt from a sequence item at the supplied index. @param index The 0 based index for the sequence item to show.
show
java
sjwall/MaterialTapTargetPrompt
library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/MaterialTapTargetSequence.java
https://github.com/sjwall/MaterialTapTargetPrompt/blob/master/library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/MaterialTapTargetSequence.java
Apache-2.0
@NonNull public MaterialTapTargetSequence finish() { if (this.nextPromptIndex > -1 && this.nextPromptIndex < this.items.size()) { final SequenceItem sequenceItem = this.items.get(nextPromptIndex); sequenceItem.setSequenceListener(null); final MaterialTapTargetPrompt prompt = sequenceItem.getState().getPrompt(); if (prompt != null) { prompt.mView.mPromptOptions.setSequenceListener(null); } sequenceItem.finish(); } return this; }
Removes the currently displayed prompt in the sequence from view using the finish action and stops the sequence from continuing. @return This.
finish
java
sjwall/MaterialTapTargetPrompt
library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/MaterialTapTargetSequence.java
https://github.com/sjwall/MaterialTapTargetPrompt/blob/master/library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/MaterialTapTargetSequence.java
Apache-2.0
@NonNull public MaterialTapTargetSequence dismiss() { if (this.nextPromptIndex > -1 && this.nextPromptIndex < this.items.size()) { final SequenceItem sequenceItem = this.items.get(nextPromptIndex); sequenceItem.setSequenceListener(null); final MaterialTapTargetPrompt prompt = sequenceItem.getState().getPrompt(); if (prompt != null) { prompt.mView.mPromptOptions.setSequenceListener(null); } sequenceItem.dismiss(); } return this; }
Removes the currently displayed prompt in the sequence from view using the dismiss action and stops the sequence from continuing. @return This.
dismiss
java
sjwall/MaterialTapTargetPrompt
library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/MaterialTapTargetSequence.java
https://github.com/sjwall/MaterialTapTargetPrompt/blob/master/library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/MaterialTapTargetSequence.java
Apache-2.0
@NonNull public MaterialTapTargetSequence showFromIndex(final int index) { this.dismiss(); this.nextPromptIndex = index; this.show(index); return this; }
Shows or continues to show this sequence from the prompt at the index supplied. @param index The index to show from. @return This.
showFromIndex
java
sjwall/MaterialTapTargetPrompt
library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/MaterialTapTargetSequence.java
https://github.com/sjwall/MaterialTapTargetPrompt/blob/master/library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/MaterialTapTargetSequence.java
Apache-2.0
@Override public void updateDrawState(@NonNull TextPaint paint) { paint.setAlpha((int) (paint.getAlpha() * mValue)); paint.bgColor = Color.argb((int) (Color.alpha(paint.bgColor) * mValue), Color.red(paint.bgColor), Color.green(paint.bgColor), Color.blue(paint.bgColor)); }
Constructor. @param value The alpha modification value between 1 and 0.
updateDrawState
java
sjwall/MaterialTapTargetPrompt
library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/AlphaSpan.java
https://github.com/sjwall/MaterialTapTargetPrompt/blob/master/library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/AlphaSpan.java
Apache-2.0
public Path getPath() { return null; }
@return The path of the current background, useful for clipping content
getPath
java
sjwall/MaterialTapTargetPrompt
library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptBackground.java
https://github.com/sjwall/MaterialTapTargetPrompt/blob/master/library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptBackground.java
Apache-2.0
public void setDrawRipple(final boolean drawRipple) { mDrawRipple = drawRipple; }
Sets whether the ripple is drawn around the focal. @param drawRipple True to draw the ripple.
setDrawRipple
java
sjwall/MaterialTapTargetPrompt
library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptFocal.java
https://github.com/sjwall/MaterialTapTargetPrompt/blob/master/library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptFocal.java
Apache-2.0
public void setRippleAlpha(final @IntRange(from = 0, to = 255) int rippleAlpha) { mBaseRippleAlpha = rippleAlpha; }
Sets the alpha value to use for the ripple colour. @param rippleAlpha The ripple alpha value between 0 - 255
setRippleAlpha
java
sjwall/MaterialTapTargetPrompt
library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptFocal.java
https://github.com/sjwall/MaterialTapTargetPrompt/blob/master/library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptFocal.java
Apache-2.0
@NonNull public PointF calculateAngleEdgePoint(float angle, final float padding) { // Calculate the x and y on the focal from the angle calculated final RectF bounds = this.getBounds(); final float angleRadians = (float) Math.toRadians(angle); final float sin = (float) Math.sin(angleRadians); final float cos = (float) Math.cos(angleRadians); final float dx1 = (bounds.width() + padding) / (cos > 0 ? 2 : -2); final float dy1 = (bounds.height() + padding) / (sin > 0 ? 2 : -2); // Could go to part way along the target bounds but risk cutting off corners /*final float dxs = dx1 * sin; final float dyc = dy1 * cos; final float dx = Math.abs(dxs) < Math.abs(dyc) ? dx1 : dyc / sin; final float dy = Math.abs(dxs) < Math.abs(dyc) ? dxs / cos : dy1;*/ return new PointF(bounds.centerX() + dx1, bounds.centerY() + dy1); }
Calculate the point on the focal edge based on the angle. This is called after {@link #prepare(PromptOptions, float, float)} or {@link #prepare(PromptOptions, View, int[])}. Base implementation assumes that focal is a rectangle. @param angle The angle with 0 based on the right. @param padding The padding added to the focal bounds. @return The calculated point
calculateAngleEdgePoint
java
sjwall/MaterialTapTargetPrompt
library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptFocal.java
https://github.com/sjwall/MaterialTapTargetPrompt/blob/master/library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptFocal.java
Apache-2.0
public void load(@StyleRes int themeResId) { //Attempt to load the theme from the activity theme if (themeResId == 0) { final TypedValue outValue = new TypedValue(); mResourceFinder.getTheme().resolveAttribute(R.attr.MaterialTapTargetPromptTheme, outValue, true); themeResId = outValue.resourceId; } final TypedArray a = mResourceFinder.obtainStyledAttributes(themeResId, R.styleable.PromptView); mPrimaryTextColour = a.getColor(R.styleable.PromptView_mttp_primaryTextColour, mPrimaryTextColour); mSecondaryTextColour = a.getColor(R.styleable.PromptView_mttp_secondaryTextColour, mSecondaryTextColour); mPrimaryText = a.getString(R.styleable.PromptView_mttp_primaryText); mSecondaryText = a.getString(R.styleable.PromptView_mttp_secondaryText); mBackgroundColour = a.getColor(R.styleable.PromptView_mttp_backgroundColour, mBackgroundColour); mFocalColour = a.getColor(R.styleable.PromptView_mttp_focalColour, mFocalColour); mFocalRadius = a.getDimension(R.styleable.PromptView_mttp_focalRadius, mFocalRadius); mPrimaryTextSize = a.getDimension(R.styleable.PromptView_mttp_primaryTextSize, mPrimaryTextSize); mSecondaryTextSize = a.getDimension(R.styleable.PromptView_mttp_secondaryTextSize, mSecondaryTextSize); mMaxTextWidth = a.getDimension(R.styleable.PromptView_mttp_maxTextWidth, mMaxTextWidth); mTextPadding = a.getDimension(R.styleable.PromptView_mttp_textPadding, mTextPadding); mFocalPadding = a.getDimension(R.styleable.PromptView_mttp_focalToTextPadding, mFocalPadding); mTextSeparation = a.getDimension(R.styleable.PromptView_mttp_textSeparation, mTextSeparation); mAutoDismiss = a.getBoolean(R.styleable.PromptView_mttp_autoDismiss, mAutoDismiss); mAutoFinish = a.getBoolean(R.styleable.PromptView_mttp_autoFinish, mAutoFinish); mCaptureTouchEventOutsidePrompt = a.getBoolean(R.styleable.PromptView_mttp_captureTouchEventOutsidePrompt, mCaptureTouchEventOutsidePrompt); mCaptureTouchEventOnFocal = a.getBoolean(R.styleable.PromptView_mttp_captureTouchEventOnFocal, mCaptureTouchEventOnFocal); mPrimaryTextTypefaceStyle = a.getInt(R.styleable.PromptView_mttp_primaryTextStyle, mPrimaryTextTypefaceStyle); mSecondaryTextTypefaceStyle = a.getInt(R.styleable.PromptView_mttp_secondaryTextStyle, mSecondaryTextTypefaceStyle); mPrimaryTextTypeface = PromptUtils.setTypefaceFromAttrs(a.getString(R.styleable.PromptView_mttp_primaryTextFontFamily), a.getInt(R.styleable.PromptView_mttp_primaryTextTypeface, 0), mPrimaryTextTypefaceStyle); mSecondaryTextTypeface = PromptUtils.setTypefaceFromAttrs(a.getString(R.styleable.PromptView_mttp_secondaryTextFontFamily), a.getInt(R.styleable.PromptView_mttp_secondaryTextTypeface, 0), mSecondaryTextTypefaceStyle); mContentDescription = a.getString(R.styleable.PromptView_mttp_contentDescription); mIconDrawableColourFilter = a.getColor(R.styleable.PromptView_mttp_iconColourFilter, mBackgroundColour); mIconDrawableTintList = a.getColorStateList(R.styleable.PromptView_mttp_iconTint); mIconDrawableTintMode = PromptUtils.parseTintMode(a.getInt(R.styleable.PromptView_mttp_iconTintMode, -1), mIconDrawableTintMode); mHasIconDrawableTint = true; final int targetId = a.getResourceId(R.styleable.PromptView_mttp_target, 0); a.recycle(); if (targetId != 0) { mTargetView = mResourceFinder.findViewById(targetId); if (mTargetView != null) { mTargetSet = true; } } final View contentView = mResourceFinder.findViewById(android.R.id.content); if (contentView != null) { mClipToView = (View) contentView.getParent(); } }
Loads the supplied theme into the prompt overwriting any previously set values if they are set in the theme. @param themeResId The resource id for the theme.
load
java
sjwall/MaterialTapTargetPrompt
library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
https://github.com/sjwall/MaterialTapTargetPrompt/blob/master/library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
Apache-2.0
@NonNull public ResourceFinder getResourceFinder() { return mResourceFinder; }
Get the resource finder being used. @return The resource finder being used.
getResourceFinder
java
sjwall/MaterialTapTargetPrompt
library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
https://github.com/sjwall/MaterialTapTargetPrompt/blob/master/library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
Apache-2.0
@NonNull public T setTarget(@Nullable final View target) { mTargetView = target; mTargetPosition = null; mTargetSet = mTargetView != null; return (T) this; }
Set the view for the prompt to focus on. @param target The view that the prompt will highlight. @return This Builder object to allow for chaining of calls to set methods
setTarget
java
sjwall/MaterialTapTargetPrompt
library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
https://github.com/sjwall/MaterialTapTargetPrompt/blob/master/library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
Apache-2.0
@NonNull public T setTarget(@IdRes final int target) { mTargetView = mResourceFinder.findViewById(target); mTargetPosition = null; mTargetSet = mTargetView != null; return (T) this; }
Set the view for the prompt to focus on using the given resource id. @param target The view that the prompt will highlight. @return This Builder object to allow for chaining of calls to set methods
setTarget
java
sjwall/MaterialTapTargetPrompt
library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
https://github.com/sjwall/MaterialTapTargetPrompt/blob/master/library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
Apache-2.0
@Nullable public View getTargetView() { return mTargetView; }
Gets the view that the prompt is targeting. @return The target view or null if not set or targeting a position.
getTargetView
java
sjwall/MaterialTapTargetPrompt
library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
https://github.com/sjwall/MaterialTapTargetPrompt/blob/master/library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
Apache-2.0
@NonNull public T setTarget(final float left, final float top) { mTargetView = null; mTargetPosition = new PointF(left, top); mTargetSet = true; return (T) this; }
Set the centre point as a screen position @param left Centre point from screen left @param top Centre point from screen top @return This Builder object to allow for chaining of calls to set methods
setTarget
java
sjwall/MaterialTapTargetPrompt
library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
https://github.com/sjwall/MaterialTapTargetPrompt/blob/master/library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
Apache-2.0
@Nullable public PointF getTargetPosition() { return mTargetPosition; }
Get the position on the screen that is being targeted. @return The target position or null if targeting a view.
getTargetPosition
java
sjwall/MaterialTapTargetPrompt
library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
https://github.com/sjwall/MaterialTapTargetPrompt/blob/master/library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
Apache-2.0
@NonNull public T setTargetRenderView(@Nullable final View view) { mTargetRenderView = view; return (T) this; }
Change the view that is rendered as the target. By default the view from {@link #setTarget(View)} is rendered as the target. @param view The view to use to render the prompt target @return This Builder object to allow for chaining of calls to set methods
setTargetRenderView
java
sjwall/MaterialTapTargetPrompt
library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
https://github.com/sjwall/MaterialTapTargetPrompt/blob/master/library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
Apache-2.0
@Nullable public View getTargetRenderView() { return mTargetRenderView; }
Get the view that is rendered as the target. @return The view used to render the prompt target.
getTargetRenderView
java
sjwall/MaterialTapTargetPrompt
library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
https://github.com/sjwall/MaterialTapTargetPrompt/blob/master/library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
Apache-2.0
public boolean isTargetSet() { return mTargetSet; }
Has the target been set successfully? @return True if set successfully.
isTargetSet
java
sjwall/MaterialTapTargetPrompt
library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
https://github.com/sjwall/MaterialTapTargetPrompt/blob/master/library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
Apache-2.0
@NonNull public T setPrimaryText(@StringRes final int resId) { mPrimaryText = mResourceFinder.getString(resId); return (T) this; }
Set the primary text using the given resource id. @param resId The string resource id for the primary text @return This Builder object to allow for chaining of calls to set methods
setPrimaryText
java
sjwall/MaterialTapTargetPrompt
library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
https://github.com/sjwall/MaterialTapTargetPrompt/blob/master/library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
Apache-2.0
@NonNull public T setPrimaryText(@Nullable final String text) { mPrimaryText = text; return (T) this; }
Set the primary text to the given string @param text The primary text @return This Builder object to allow for chaining of calls to set methods
setPrimaryText
java
sjwall/MaterialTapTargetPrompt
library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
https://github.com/sjwall/MaterialTapTargetPrompt/blob/master/library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
Apache-2.0
@NonNull public T setPrimaryText(@Nullable final CharSequence text) { mPrimaryText = text; return (T) this; }
Set the primary text to the given CharSequence. It is recommended that you don't go crazy with custom Spannables. @param text The primary text as CharSequence @return This Builder object to allow for chaining of calls to set methods
setPrimaryText
java
sjwall/MaterialTapTargetPrompt
library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
https://github.com/sjwall/MaterialTapTargetPrompt/blob/master/library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
Apache-2.0
@Nullable public CharSequence getPrimaryText() { return mPrimaryText; }
Get the text to draw for the primary text. @return The primary text.
getPrimaryText
java
sjwall/MaterialTapTargetPrompt
library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
https://github.com/sjwall/MaterialTapTargetPrompt/blob/master/library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
Apache-2.0
@NonNull public T setPrimaryTextSize(@Dimension final float size) { mPrimaryTextSize = size; return (T) this; }
Set the primary text font size. @param size The primary text font size @return This Builder object to allow for chaining of calls to set methods
setPrimaryTextSize
java
sjwall/MaterialTapTargetPrompt
library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
https://github.com/sjwall/MaterialTapTargetPrompt/blob/master/library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
Apache-2.0
@NonNull public T setPrimaryTextSize(@DimenRes final int resId) { mPrimaryTextSize = mResourceFinder.getResources().getDimension(resId); return (T) this; }
Set the primary text font size using the given resource id. @param resId The resource id for the primary text size @return This Builder object to allow for chaining of calls to set methods
setPrimaryTextSize
java
sjwall/MaterialTapTargetPrompt
library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
https://github.com/sjwall/MaterialTapTargetPrompt/blob/master/library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
Apache-2.0
@Dimension public float getPrimaryTextSize() { return mPrimaryTextSize; }
Get the primary text font size. @return The primary text font size.
getPrimaryTextSize
java
sjwall/MaterialTapTargetPrompt
library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
https://github.com/sjwall/MaterialTapTargetPrompt/blob/master/library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
Apache-2.0
@NonNull public T setPrimaryTextColour(@ColorInt final int colour) { mPrimaryTextColour = colour; return (T) this; }
Set the primary text colour. @param colour The primary text colour resource id @return This Builder object to allow for chaining of calls to set methods
setPrimaryTextColour
java
sjwall/MaterialTapTargetPrompt
library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
https://github.com/sjwall/MaterialTapTargetPrompt/blob/master/library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
Apache-2.0
@ColorInt public int getPrimaryTextColour() { return mPrimaryTextColour; }
Gets the primary text font colour. @return The primary text font colour.
getPrimaryTextColour
java
sjwall/MaterialTapTargetPrompt
library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
https://github.com/sjwall/MaterialTapTargetPrompt/blob/master/library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
Apache-2.0
@NonNull public T setPrimaryTextTypeface(@Nullable final Typeface typeface) { return setPrimaryTextTypeface(typeface, 0); }
Sets the typeface and style used to display the primary text. @param typeface The primary text typeface
setPrimaryTextTypeface
java
sjwall/MaterialTapTargetPrompt
library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
https://github.com/sjwall/MaterialTapTargetPrompt/blob/master/library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
Apache-2.0
@NonNull public T setPrimaryTextTypeface(@Nullable final Typeface typeface, final int style) { mPrimaryTextTypeface = typeface; mPrimaryTextTypefaceStyle = style; return (T) this; }
Sets the typeface used to display the primary text. @param typeface The primary text typeface @param style The typeface style @return This Builder object to allow for chaining of calls to set methods
setPrimaryTextTypeface
java
sjwall/MaterialTapTargetPrompt
library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
https://github.com/sjwall/MaterialTapTargetPrompt/blob/master/library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
Apache-2.0
@Nullable public Typeface getPrimaryTextTypeface() { return mPrimaryTextTypeface; }
Get the typeface for the primary text. @return The primary text typeface.
getPrimaryTextTypeface
java
sjwall/MaterialTapTargetPrompt
library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
https://github.com/sjwall/MaterialTapTargetPrompt/blob/master/library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
Apache-2.0
public int getPrimaryTextTypefaceStyle() { return mPrimaryTextTypefaceStyle; }
Get the primary text typeface style. @return the primary text typeface style.
getPrimaryTextTypefaceStyle
java
sjwall/MaterialTapTargetPrompt
library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
https://github.com/sjwall/MaterialTapTargetPrompt/blob/master/library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
Apache-2.0
@NonNull public T setSecondaryText(@StringRes final int resId) { mSecondaryText = mResourceFinder.getString(resId); return (T) this; }
Set the secondary text using the given resource id. @param resId The secondary text resource id @return This Builder object to allow for chaining of calls to set methods
setSecondaryText
java
sjwall/MaterialTapTargetPrompt
library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
https://github.com/sjwall/MaterialTapTargetPrompt/blob/master/library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
Apache-2.0
@NonNull public T setSecondaryText(@Nullable final String text) { mSecondaryText = text; return (T) this; }
Set the secondary text. @param text The secondary text @return This Builder object to allow for chaining of calls to set methods
setSecondaryText
java
sjwall/MaterialTapTargetPrompt
library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
https://github.com/sjwall/MaterialTapTargetPrompt/blob/master/library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
Apache-2.0
@NonNull public T setSecondaryText(@Nullable final CharSequence text) { mSecondaryText = text; return (T) this; }
Set the secondary text. It is recommended that you don't go crazy with custom Spannables. @param text The secondary text as a CharSequence @return This Builder object to allow for chaining of calls to set methods
setSecondaryText
java
sjwall/MaterialTapTargetPrompt
library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
https://github.com/sjwall/MaterialTapTargetPrompt/blob/master/library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
Apache-2.0
@Nullable public CharSequence getSecondaryText() { return mSecondaryText; }
Get the secondary text. @return The secondary text.
getSecondaryText
java
sjwall/MaterialTapTargetPrompt
library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
https://github.com/sjwall/MaterialTapTargetPrompt/blob/master/library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
Apache-2.0
@NonNull public T setSecondaryTextSize(@DimenRes final int resId) { mSecondaryTextSize = mResourceFinder.getResources().getDimension(resId); return (T) this; }
Set the secondary text font size using the give resource id. @param resId The secondary text string resource id @return This Builder object to allow for chaining of calls to set methods
setSecondaryTextSize
java
sjwall/MaterialTapTargetPrompt
library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
https://github.com/sjwall/MaterialTapTargetPrompt/blob/master/library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
Apache-2.0
@NonNull public T setSecondaryTextSize(@Dimension final float size) { mSecondaryTextSize = size; return (T) this; }
Set the secondary text font size. @param size The secondary text font size @return This Builder object to allow for chaining of calls to set methods
setSecondaryTextSize
java
sjwall/MaterialTapTargetPrompt
library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
https://github.com/sjwall/MaterialTapTargetPrompt/blob/master/library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
Apache-2.0
@Dimension public float getSecondaryTextSize() { return mSecondaryTextSize; }
Get the secondary text size. @return The secondary text size.
getSecondaryTextSize
java
sjwall/MaterialTapTargetPrompt
library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
https://github.com/sjwall/MaterialTapTargetPrompt/blob/master/library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
Apache-2.0
@NonNull public T setSecondaryTextColour(@ColorInt final int colour) { mSecondaryTextColour = colour; return (T) this; }
Set the secondary text colour. @param colour The secondary text colour resource id @return This Builder object to allow for chaining of calls to set methods
setSecondaryTextColour
java
sjwall/MaterialTapTargetPrompt
library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
https://github.com/sjwall/MaterialTapTargetPrompt/blob/master/library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
Apache-2.0
public int getSecondaryTextColour() { return mSecondaryTextColour; }
Get the secondary text colour. @return The secondary text colour.
getSecondaryTextColour
java
sjwall/MaterialTapTargetPrompt
library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
https://github.com/sjwall/MaterialTapTargetPrompt/blob/master/library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
Apache-2.0
@NonNull public T setSecondaryTextTypeface(@Nullable final Typeface typeface) { return setSecondaryTextTypeface(typeface, 0); }
Sets the typeface used to display the secondary text. @param typeface The secondary text typeface
setSecondaryTextTypeface
java
sjwall/MaterialTapTargetPrompt
library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
https://github.com/sjwall/MaterialTapTargetPrompt/blob/master/library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
Apache-2.0
@NonNull public T setSecondaryTextTypeface(@Nullable final Typeface typeface, final int style) { mSecondaryTextTypeface = typeface; mSecondaryTextTypefaceStyle = style; return (T) this; }
Sets the typeface and style used to display the secondary text. @param typeface The secondary text typeface @param style The typeface style @return This Builder object to allow for chaining of calls to set methods
setSecondaryTextTypeface
java
sjwall/MaterialTapTargetPrompt
library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
https://github.com/sjwall/MaterialTapTargetPrompt/blob/master/library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
Apache-2.0
@Nullable public Typeface getSecondaryTextTypeface() { return mSecondaryTextTypeface; }
Get the secondary text typeface. @return The secondary text typeface.
getSecondaryTextTypeface
java
sjwall/MaterialTapTargetPrompt
library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
https://github.com/sjwall/MaterialTapTargetPrompt/blob/master/library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
Apache-2.0
public int getSecondaryTextTypefaceStyle() { return mSecondaryTextTypefaceStyle; }
Get the secondary text typeface style. @return The secondary text typeface style.
getSecondaryTextTypefaceStyle
java
sjwall/MaterialTapTargetPrompt
library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
https://github.com/sjwall/MaterialTapTargetPrompt/blob/master/library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
Apache-2.0
@NonNull public T setContentDescription(@StringRes final int resId) { mContentDescription = mResourceFinder.getString(resId); return (T) this; }
Set the accessibility content description text using the given resource id. @param resId The string resource id for the accessibility content description text @return This Builder object to allow for chaining of calls to set methods
setContentDescription
java
sjwall/MaterialTapTargetPrompt
library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
https://github.com/sjwall/MaterialTapTargetPrompt/blob/master/library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
Apache-2.0
@NonNull public T setContentDescription(@Nullable final String text) { mContentDescription = text; return (T) this; }
Set the accessibility content description text to the given string @param text The accessibility content description text @return This Builder object to allow for chaining of calls to set methods
setContentDescription
java
sjwall/MaterialTapTargetPrompt
library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
https://github.com/sjwall/MaterialTapTargetPrompt/blob/master/library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
Apache-2.0
@Nullable public String getContentDescription() { if (mContentDescription != null) { return mContentDescription; } else { return String.format("%s. %s", mPrimaryText, mSecondaryText); } }
Get the text for the accessibility content description. Defaults to a concatenation of primary and secondary texts. @return The accessibility content description text.
getContentDescription
java
sjwall/MaterialTapTargetPrompt
library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
https://github.com/sjwall/MaterialTapTargetPrompt/blob/master/library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
Apache-2.0
@NonNull public T setTextPadding(@DimenRes final int resId) { mTextPadding = mResourceFinder.getResources().getDimension(resId); return (T) this; }
Set the text left and right padding using the given resource id. @param resId The text padding dimension resource id @return This Builder object to allow for chaining of calls to set methods
setTextPadding
java
sjwall/MaterialTapTargetPrompt
library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
https://github.com/sjwall/MaterialTapTargetPrompt/blob/master/library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
Apache-2.0
@NonNull public T setTextPadding(@Dimension final float padding) { mTextPadding = padding; return (T) this; }
Set the text left and right padding. @param padding The padding on the text left and right @return This Builder object to allow for chaining of calls to set methods
setTextPadding
java
sjwall/MaterialTapTargetPrompt
library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
https://github.com/sjwall/MaterialTapTargetPrompt/blob/master/library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
Apache-2.0
@Dimension public float getTextPadding() { return mTextPadding; }
Get the text left and right padding. @return The text left and right padding.
getTextPadding
java
sjwall/MaterialTapTargetPrompt
library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
https://github.com/sjwall/MaterialTapTargetPrompt/blob/master/library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
Apache-2.0
@NonNull public T setTextSeparation(@DimenRes final int resId) { mTextSeparation = mResourceFinder.getResources().getDimension(resId); return (T) this; }
Set the distance between the primary and secondary text using the given resource id. @param resId The dimension resource id for the text separation @return This Builder object to allow for chaining of calls to set methods
setTextSeparation
java
sjwall/MaterialTapTargetPrompt
library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
https://github.com/sjwall/MaterialTapTargetPrompt/blob/master/library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
Apache-2.0
@NonNull public T setTextSeparation(@Dimension final float separation) { mTextSeparation = separation; return (T) this; }
Set the distance between the primary and secondary text. @param separation The distance separation between the primary and secondary text @return This Builder object to allow for chaining of calls to set methods
setTextSeparation
java
sjwall/MaterialTapTargetPrompt
library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
https://github.com/sjwall/MaterialTapTargetPrompt/blob/master/library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
Apache-2.0
@Dimension public float getTextSeparation() { return mTextSeparation; }
Get the distance between the primary and secondary text. @return the distance between the primary and secondary text.
getTextSeparation
java
sjwall/MaterialTapTargetPrompt
library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
https://github.com/sjwall/MaterialTapTargetPrompt/blob/master/library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
Apache-2.0
@NonNull public T setFocalPadding(@DimenRes final int resId) { mFocalPadding = mResourceFinder.getResources().getDimension(resId); return (T) this; }
Set the padding between the text and the focal point using the given resource id. @param resId The dimension resource id for the focal to text distance @return This Builder object to allow for chaining of calls to set methods
setFocalPadding
java
sjwall/MaterialTapTargetPrompt
library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
https://github.com/sjwall/MaterialTapTargetPrompt/blob/master/library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
Apache-2.0
@NonNull public T setFocalPadding(@Dimension final float padding) { mFocalPadding = padding; return (T) this; }
Set the padding between the text and the focal point. @param padding The distance between the text and focal @return This Builder object to allow for chaining of calls to set methods
setFocalPadding
java
sjwall/MaterialTapTargetPrompt
library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
https://github.com/sjwall/MaterialTapTargetPrompt/blob/master/library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
Apache-2.0
@Dimension public float getFocalPadding() { return mFocalPadding; }
Get the padding between the text and the focal. @return The padding between the text and the focal.
getFocalPadding
java
sjwall/MaterialTapTargetPrompt
library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
https://github.com/sjwall/MaterialTapTargetPrompt/blob/master/library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
Apache-2.0
@NonNull public T setAnimationInterpolator(@Nullable final Interpolator interpolator) { mAnimationInterpolator = interpolator; return (T) this; }
Set the interpolator to use in animations. @param interpolator The animation interpolator to use @return This Builder object to allow for chaining of calls to set methods
setAnimationInterpolator
java
sjwall/MaterialTapTargetPrompt
library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
https://github.com/sjwall/MaterialTapTargetPrompt/blob/master/library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
Apache-2.0
@Nullable public Interpolator getAnimationInterpolator() { return mAnimationInterpolator; }
Get the animation interpolator that is used. @return The animation interpolator that is used.
getAnimationInterpolator
java
sjwall/MaterialTapTargetPrompt
library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
https://github.com/sjwall/MaterialTapTargetPrompt/blob/master/library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
Apache-2.0
@NonNull public T setIdleAnimationEnabled(final boolean enabled) { mIdleAnimationEnabled = enabled; return (T) this; }
Enable/disable focal animation. true by default @param enabled Idle animation enabled @return This Builder object to allow for chaining of calls to set methods
setIdleAnimationEnabled
java
sjwall/MaterialTapTargetPrompt
library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
https://github.com/sjwall/MaterialTapTargetPrompt/blob/master/library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
Apache-2.0
public boolean getIdleAnimationEnabled() { return mIdleAnimationEnabled; }
Is the focal animation enabled. @return True if the idle animation is enabled.
getIdleAnimationEnabled
java
sjwall/MaterialTapTargetPrompt
library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
https://github.com/sjwall/MaterialTapTargetPrompt/blob/master/library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
Apache-2.0
@NonNull public T setIcon(@DrawableRes final int resId) { mIconDrawable = mResourceFinder.getDrawable(resId); return (T) this; }
Set the icon to draw in the focal point using the given resource id. @param resId The drawable resource id for the icon @return This Builder object to allow for chaining of calls to set methods
setIcon
java
sjwall/MaterialTapTargetPrompt
library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
https://github.com/sjwall/MaterialTapTargetPrompt/blob/master/library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
Apache-2.0
@NonNull public T setIconDrawable(@Nullable final Drawable drawable) { mIconDrawable = drawable; return (T) this; }
Set the icon to draw in the focal point. @param drawable The drawable for the icon @return This Builder object to allow for chaining of calls to set methods
setIconDrawable
java
sjwall/MaterialTapTargetPrompt
library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
https://github.com/sjwall/MaterialTapTargetPrompt/blob/master/library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
Apache-2.0
@Nullable public Drawable getIconDrawable() { return mIconDrawable; }
Get the icon drawn as the target. @return The icon drawn as the target.
getIconDrawable
java
sjwall/MaterialTapTargetPrompt
library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
https://github.com/sjwall/MaterialTapTargetPrompt/blob/master/library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
Apache-2.0
@NonNull public T setIconDrawableTintList(@Nullable ColorStateList tint) { mIconDrawableTintList = tint; mHasIconDrawableTint = tint != null; return (T) this; }
Applies a tint to the icon drawable @param tint the tint to apply to the icon drawable, {@code null} will remove the tint. @return This Builder object to allow for chaining of calls to set methods
setIconDrawableTintList
java
sjwall/MaterialTapTargetPrompt
library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
https://github.com/sjwall/MaterialTapTargetPrompt/blob/master/library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
Apache-2.0
@NonNull public T setIconDrawableTintMode(@Nullable PorterDuff.Mode tintMode) { mIconDrawableTintMode = tintMode; if (tintMode == null) { mIconDrawableTintList = null; mHasIconDrawableTint = false; } return (T) this; }
Sets the PorterDuff mode to use to apply the tint. @param tintMode the tint mode to use on the icon drawable, {@code null} will remove the tint. @return This Builder object to allow for chaining of calls to set methods
setIconDrawableTintMode
java
sjwall/MaterialTapTargetPrompt
library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
https://github.com/sjwall/MaterialTapTargetPrompt/blob/master/library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
Apache-2.0
@NonNull public T setIconDrawableColourFilter(@ColorInt final int colour) { mIconDrawableColourFilter = colour; mIconDrawableTintList = null; mHasIconDrawableTint = true; return (T) this; }
Sets the colour to use to tint the icon drawable. @param colour The colour to use to tint the icon drawable, call {@link #setIconDrawableTintList(ColorStateList)} or {@link #setIconDrawableTintMode(PorterDuff.Mode)} with {@code null} to remove the tint. @return This Builder object to allow for chaining of calls to set methods
setIconDrawableColourFilter
java
sjwall/MaterialTapTargetPrompt
library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
https://github.com/sjwall/MaterialTapTargetPrompt/blob/master/library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
Apache-2.0
@NonNull public T setPromptStateChangeListener( @Nullable final MaterialTapTargetPrompt.PromptStateChangeListener listener) { mPromptStateChangeListener = listener; return (T) this; }
Set the listener to listen for when the prompt state changes. @param listener The listener to use @return This Builder object to allow for chaining of calls to set methods
setPromptStateChangeListener
java
sjwall/MaterialTapTargetPrompt
library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
https://github.com/sjwall/MaterialTapTargetPrompt/blob/master/library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
Apache-2.0
public void setSequenceListener( @Nullable final MaterialTapTargetPrompt.PromptStateChangeListener listener) { mSequencePromptStateChangeListener = listener; }
Set the internal listener to listen for when the prompt state changes. This does not return a builder is it's not intended to be user during the creation of Prompts @param listener The listener to use
setSequenceListener
java
sjwall/MaterialTapTargetPrompt
library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
https://github.com/sjwall/MaterialTapTargetPrompt/blob/master/library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
Apache-2.0
@NonNull public T setCaptureTouchEventOnFocal(final boolean captureTouchEvent) { mCaptureTouchEventOnFocal = captureTouchEvent; return (T) this; }
Set if the prompt should stop touch events on the focal point from passing to underlying views. Default is false. @param captureTouchEvent True to capture touch events in the prompt @return This Builder object to allow for chaining of calls to set methods
setCaptureTouchEventOnFocal
java
sjwall/MaterialTapTargetPrompt
library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
https://github.com/sjwall/MaterialTapTargetPrompt/blob/master/library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
Apache-2.0
public boolean getCaptureTouchEventOnFocal() { return mCaptureTouchEventOnFocal; }
Get if the prompt should stop touch events on the focal point from passing to underlying views. @return True to capture touch events in the prompt
getCaptureTouchEventOnFocal
java
sjwall/MaterialTapTargetPrompt
library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
https://github.com/sjwall/MaterialTapTargetPrompt/blob/master/library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
Apache-2.0
@NonNull public T setMaxTextWidth(@DimenRes final int resId) { mMaxTextWidth = mResourceFinder.getResources().getDimension(resId); return (T) this; }
Set the max width that the primary and secondary text can be using the given resource id. @param resId The dimension resource id for the max width that the text can reach @return This Builder object to allow for chaining of calls to set methods
setMaxTextWidth
java
sjwall/MaterialTapTargetPrompt
library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
https://github.com/sjwall/MaterialTapTargetPrompt/blob/master/library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
Apache-2.0
@NonNull public T setMaxTextWidth(@Dimension final float width) { mMaxTextWidth = width; return (T) this; }
Set the max width that the primary and secondary text can be. @param width The max width that the text can reach @return This Builder object to allow for chaining of calls to set methods
setMaxTextWidth
java
sjwall/MaterialTapTargetPrompt
library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
https://github.com/sjwall/MaterialTapTargetPrompt/blob/master/library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
Apache-2.0
@Dimension public float getMaxTextWidth() { return mMaxTextWidth; }
Get the maximum width that the primary and secondary text can be. @return The maximum text width.
getMaxTextWidth
java
sjwall/MaterialTapTargetPrompt
library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
https://github.com/sjwall/MaterialTapTargetPrompt/blob/master/library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
Apache-2.0
@NonNull public T setBackgroundColour(@ColorInt final int colour) { mBackgroundColour = colour; return (T) this; }
Set the background colour. The Material Design Guidelines specify that this should be 244 or hex F4. @param colour The background colour colour resource id @return This Builder object to allow for chaining of calls to set methods
setBackgroundColour
java
sjwall/MaterialTapTargetPrompt
library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
https://github.com/sjwall/MaterialTapTargetPrompt/blob/master/library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
Apache-2.0
@ColorInt public int getBackgroundColour() { return mBackgroundColour; }
Get the background colour. @return The background colour.
getBackgroundColour
java
sjwall/MaterialTapTargetPrompt
library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
https://github.com/sjwall/MaterialTapTargetPrompt/blob/master/library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
Apache-2.0
@NonNull public T setFocalColour(@ColorInt final int colour) { mFocalColour = colour; return (T) this; }
Set the focal point colour. @param colour The focal colour colour resource id @return This Builder object to allow for chaining of calls to set methods
setFocalColour
java
sjwall/MaterialTapTargetPrompt
library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
https://github.com/sjwall/MaterialTapTargetPrompt/blob/master/library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
Apache-2.0
@ColorInt public int getFocalColour() { return mFocalColour; }
Get the focal point colour. @return The focal point colour.
getFocalColour
java
sjwall/MaterialTapTargetPrompt
library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
https://github.com/sjwall/MaterialTapTargetPrompt/blob/master/library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
Apache-2.0
@NonNull public T setFocalRadius(@DimenRes final int resId) { mFocalRadius = mResourceFinder.getResources().getDimension(resId); return (T) this; }
Set the focal point radius using the given resource id. @param resId The focal radius dimension resource id @return This Builder object to allow for chaining of calls to set methods
setFocalRadius
java
sjwall/MaterialTapTargetPrompt
library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
https://github.com/sjwall/MaterialTapTargetPrompt/blob/master/library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
Apache-2.0
@NonNull public T setFocalRadius(@Dimension final float radius) { mFocalRadius = radius; return (T) this; }
Set the focal point radius. @param radius The focal radius @return This Builder object to allow for chaining of calls to set methods
setFocalRadius
java
sjwall/MaterialTapTargetPrompt
library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
https://github.com/sjwall/MaterialTapTargetPrompt/blob/master/library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
Apache-2.0
@Dimension public float getFocalRadius() { return mFocalRadius; }
Get the focal point radius for the circle prompt focal. @return The radius used for the circle prompt focal.
getFocalRadius
java
sjwall/MaterialTapTargetPrompt
library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
https://github.com/sjwall/MaterialTapTargetPrompt/blob/master/library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
Apache-2.0
@NonNull public T setAutoDismiss(final boolean autoDismiss) { mAutoDismiss = autoDismiss; return (T) this; }
Set whether the prompt should dismiss itself when a touch event occurs outside the focal. Default is true. Listen for the {@link MaterialTapTargetPrompt#STATE_NON_FOCAL_PRESSED} event in the {@link #setPromptStateChangeListener(MaterialTapTargetPrompt.PromptStateChangeListener)} to handle the prompt being pressed outside the focal area. @param autoDismiss True - prompt will dismiss when touched outside the focal, false - no action taken. @return This Builder object to allow for chaining of calls to set methods
setAutoDismiss
java
sjwall/MaterialTapTargetPrompt
library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
https://github.com/sjwall/MaterialTapTargetPrompt/blob/master/library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.java
Apache-2.0