From d277f8ee22058034e322cb4aa1d30a43ff204845 Mon Sep 17 00:00:00 2001 From: Sam Wall Date: Fri, 23 Oct 2020 17:49:36 +0100 Subject: [PATCH] chore(release): prepare for release v3.0.1 --- CHANGELOG.md | 10 +- README.md | 4 +- build.gradle | 4 +- docs/javadoc/allclasses-frame.html | 42 - docs/javadoc/allclasses-index.html | 243 + docs/javadoc/allclasses-noframe.html | 42 - docs/javadoc/allpackages-index.html | 112 + docs/javadoc/constant-values.html | 382 +- docs/javadoc/deprecated-list.html | 202 +- docs/javadoc/{package-list => element-list} | 10 +- docs/javadoc/help-doc.html | 403 +- docs/javadoc/index-all.html | 2449 ++++----- docs/javadoc/index.html | 187 +- docs/javadoc/jquery-ui.overrides.css | 34 + docs/javadoc/member-search-index.js | 1 + docs/javadoc/module-search-index.js | 1 + docs/javadoc/overview-frame.html | 25 - docs/javadoc/overview-summary.html | 177 +- docs/javadoc/overview-tree.html | 332 +- docs/javadoc/package-search-index.js | 1 + docs/javadoc/resources/glass.png | Bin 0 -> 499 bytes docs/javadoc/resources/x.png | Bin 0 -> 394 bytes .../images/ui-bg_glass_55_fbf9ee_1x400.png | Bin 0 -> 335 bytes .../images/ui-bg_glass_65_dadada_1x400.png | Bin 0 -> 262 bytes .../images/ui-bg_glass_75_dadada_1x400.png | Bin 0 -> 262 bytes .../images/ui-bg_glass_75_e6e6e6_1x400.png | Bin 0 -> 262 bytes .../images/ui-bg_glass_95_fef1ec_1x400.png | Bin 0 -> 332 bytes .../ui-bg_highlight-soft_75_cccccc_1x100.png | Bin 0 -> 280 bytes .../images/ui-icons_222222_256x240.png | Bin 0 -> 6922 bytes .../images/ui-icons_2e83ff_256x240.png | Bin 0 -> 4549 bytes .../images/ui-icons_454545_256x240.png | Bin 0 -> 6992 bytes .../images/ui-icons_888888_256x240.png | Bin 0 -> 6999 bytes .../images/ui-icons_cd0a0a_256x240.png | Bin 0 -> 4549 bytes docs/javadoc/script-dir/jquery-3.5.1.min.js | 2 + docs/javadoc/script-dir/jquery-ui.min.css | 7 + docs/javadoc/script-dir/jquery-ui.min.js | 6 + .../script-dir/jquery-ui.structure.min.css | 5 + docs/javadoc/script.js | 133 +- docs/javadoc/search.js | 378 ++ docs/javadoc/stylesheet.css | 1366 +++-- docs/javadoc/tag-search-index.js | 1 + docs/javadoc/type-search-index.js | 1 + .../ActivityResourceFinder.html | 896 ++- .../DialogResourceFinder.html | 649 +-- .../MaterialTapTargetPrompt.Builder.html | 722 +-- ...argetPrompt.PromptStateChangeListener.html | 434 +- .../MaterialTapTargetPrompt.html | 1245 ++--- ...rgetSequence.SequenceCompleteListener.html | 408 +- .../MaterialTapTargetSequence.html | 1050 ++-- .../ResourceFinder.html | 738 ++- .../SupportFragmentResourceFinder.html | 892 ++- .../extras/PromptBackground.html | 704 ++- .../extras/PromptFocal.html | 1123 ++-- .../extras/PromptOptions.html | 4860 ++++++++--------- .../extras/PromptText.html | 658 +-- .../extras/PromptUtils.html | 1001 ++-- .../backgrounds/CirclePromptBackground.html | 669 +-- .../FullscreenPromptBackground.html | 753 ++- .../ImmersiveModeCompatPromptBackground.html | 524 +- .../RectanglePromptBackground.html | 719 ++- .../extras/backgrounds/package-frame.html | 23 - .../extras/backgrounds/package-summary.html | 282 +- .../extras/backgrounds/package-tree.html | 248 +- .../extras/focals/CirclePromptFocal.html | 1011 ++-- .../extras/focals/RectanglePromptFocal.html | 1045 ++-- .../extras/focals/package-frame.html | 21 - .../extras/focals/package-summary.html | 258 +- .../extras/focals/package-tree.html | 238 +- .../extras/package-frame.html | 24 - .../extras/package-summary.html | 290 +- .../extras/package-tree.html | 236 +- .../extras/sequence/SequenceItem.html | 938 ++-- .../extras/sequence/SequenceItemShowFor.html | 557 +- .../extras/sequence/SequenceState.html | 528 +- .../sequence/SequenceStatePromptOptions.html | 535 +- .../extras/sequence/package-frame.html | 23 - .../extras/sequence/package-summary.html | 284 +- .../extras/sequence/package-tree.html | 246 +- .../package-frame.html | 31 - .../package-summary.html | 368 +- .../materialtaptargetprompt/package-tree.html | 266 +- 81 files changed, 15269 insertions(+), 16788 deletions(-) delete mode 100644 docs/javadoc/allclasses-frame.html create mode 100644 docs/javadoc/allclasses-index.html delete mode 100644 docs/javadoc/allclasses-noframe.html create mode 100644 docs/javadoc/allpackages-index.html rename docs/javadoc/{package-list => element-list} (98%) create mode 100644 docs/javadoc/jquery-ui.overrides.css create mode 100644 docs/javadoc/member-search-index.js create mode 100644 docs/javadoc/module-search-index.js delete mode 100644 docs/javadoc/overview-frame.html create mode 100644 docs/javadoc/package-search-index.js create mode 100644 docs/javadoc/resources/glass.png create mode 100644 docs/javadoc/resources/x.png create mode 100644 docs/javadoc/script-dir/images/ui-bg_glass_55_fbf9ee_1x400.png create mode 100644 docs/javadoc/script-dir/images/ui-bg_glass_65_dadada_1x400.png create mode 100644 docs/javadoc/script-dir/images/ui-bg_glass_75_dadada_1x400.png create mode 100644 docs/javadoc/script-dir/images/ui-bg_glass_75_e6e6e6_1x400.png create mode 100644 docs/javadoc/script-dir/images/ui-bg_glass_95_fef1ec_1x400.png create mode 100644 docs/javadoc/script-dir/images/ui-bg_highlight-soft_75_cccccc_1x100.png create mode 100644 docs/javadoc/script-dir/images/ui-icons_222222_256x240.png create mode 100644 docs/javadoc/script-dir/images/ui-icons_2e83ff_256x240.png create mode 100644 docs/javadoc/script-dir/images/ui-icons_454545_256x240.png create mode 100644 docs/javadoc/script-dir/images/ui-icons_888888_256x240.png create mode 100644 docs/javadoc/script-dir/images/ui-icons_cd0a0a_256x240.png create mode 100644 docs/javadoc/script-dir/jquery-3.5.1.min.js create mode 100644 docs/javadoc/script-dir/jquery-ui.min.css create mode 100644 docs/javadoc/script-dir/jquery-ui.min.js create mode 100644 docs/javadoc/script-dir/jquery-ui.structure.min.css create mode 100644 docs/javadoc/search.js create mode 100644 docs/javadoc/tag-search-index.js create mode 100644 docs/javadoc/type-search-index.js delete mode 100644 docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/backgrounds/package-frame.html delete mode 100644 docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/focals/package-frame.html delete mode 100644 docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/package-frame.html delete mode 100644 docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/sequence/package-frame.html delete mode 100644 docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/package-frame.html diff --git a/CHANGELOG.md b/CHANGELOG.md index 77d46833..da93a9ca 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,13 +2,21 @@ This project adheres to [Semantic Versioning](http://semver.org/). +## v3.0.1 (2020-10-23) + +* Upgraded dependecies to be not version specific + +### Bug Fixes + +* Fix FragmentContainerView as parent ([#180](https://github.com/sjwall/MaterialTapTargetPrompt/pull/180)) ([@JMavrelos](https://github.com/JMavrelos)) + ## v3.0.0 (2019-08-18) * Migrate to [AndroidX](https://developer.android.com/jetpack/androidx) ([#164](https://github.com/sjwall/MaterialTapTargetPrompt/issues/pull/164)) ([@virengujariya](https://github.com/virengujariya), [@liaowng](https://github.com/liaowng)) ### Removed -* Remove android.app.Fragment and android.app.DialogFragment builder constructors. +* Remove android.app.Fragment and android.app.DialogFragment builder constructors. These Fragments can still be used by passing `getActivity()` and `getDialog()` respectively. ## v2.15.0 (2019-06-23) diff --git a/README.md b/README.md index 950514b1..1a5cee21 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ [![codecov](https://codecov.io/gh/sjwall/MaterialTapTargetPrompt/branch/master/graph/badge.svg)](https://codecov.io/gh/sjwall/MaterialTapTargetPrompt) [![Maintainability](https://api.codeclimate.com/v1/badges/242b94ecd2d181b8298e/maintainability)](https://codeclimate.com/github/sjwall/MaterialTapTargetPrompt/maintainability) [![Download](https://api.bintray.com/packages/sjwall/maven/material-tap-target-prompt/images/download.svg)](https://bintray.com/sjwall/maven/material-tap-target-prompt/_latestVersion) -[![JavaDoc](https://img.shields.io/badge/JavaDoc-3.0.0-brightgreen.svg)][4] +[![JavaDoc](https://img.shields.io/badge/JavaDoc-3.0.1-brightgreen.svg)][4] [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat)](http://makeapullrequest.com) A Tap Target implementation in Android based on Material Design Onboarding guidelines. For more information on tap targets check out the [guidelines][1]. @@ -30,7 +30,7 @@ repositories { } dependencies { -    implementation 'uk.co.samuelwall:material-tap-target-prompt:3.0.0' +    implementation 'uk.co.samuelwall:material-tap-target-prompt:3.0.1' } ``` Supports Android minSdkVersion 14 diff --git a/build.gradle b/build.gradle index 1401cd88..aa706bc1 100644 --- a/build.gradle +++ b/build.gradle @@ -47,6 +47,6 @@ ext { compileSdkVersion = 29 buildToolsVersion = '29.0.2' - versionCode = 59 - versionName = '3.0.0' + versionCode = 60 + versionName = '3.0.1' } diff --git a/docs/javadoc/allclasses-frame.html b/docs/javadoc/allclasses-frame.html deleted file mode 100644 index 0c3280c7..00000000 --- a/docs/javadoc/allclasses-frame.html +++ /dev/null @@ -1,42 +0,0 @@ - - - - - -All Classes (material-tap-target-prompt 3.0.0 API) - - - - - -

All Classes

-
- -
- - diff --git a/docs/javadoc/allclasses-index.html b/docs/javadoc/allclasses-index.html new file mode 100644 index 00000000..a66901cd --- /dev/null +++ b/docs/javadoc/allclasses-index.html @@ -0,0 +1,243 @@ + + + + + +All Classes (material-tap-target-prompt 3.0.1 API) + + + + + + + + + + + + + +
+ +
+
+
+

All Classes

+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ClassDescription
ActivityResourceFinder +
ResourceFinder implementation for Activity.
+
CirclePromptBackground +
PromptBackground implementation that renders the prompt background as a circle.
+
CirclePromptFocal +
Prompt focal implementation to draw the focal as a circle.
+
DialogResourceFinder +
ResourceFinder implementation for Dialog.
+
FullscreenPromptBackground +
PromptBackground implementation that renders the prompt background as a rectangle.
+
ImmersiveModeCompatPromptBackground +
ImmersiveModeCompatPromptBackground implementation that renders the prompt background as a rectangle for supporting immersive mode.
+
MaterialTapTargetPrompt +
A Material Design tap target onboarding implementation.
+
MaterialTapTargetPrompt.Builder +
A builder to create a MaterialTapTargetPrompt instance.
+
MaterialTapTargetPrompt.PromptStateChangeListener +
Interface definition for a callback to be invoked when a prompts state changes.
+
MaterialTapTargetSequence +
A Sequence of prompts to be shown one after another
+
MaterialTapTargetSequence.SequenceCompleteListener +
Interface definition for a callback to be invoked when a sequence completes.
+
PromptBackground +
Used to render the prompt background.
+
PromptFocal +
Used to render the prompt focal.
+
PromptOptions<T extends PromptOptions> +
Contains all the settings for creating a prompt.
+
PromptText 
PromptUtils +
Useful methods for prompts that don't fit else where.
+
RectanglePromptBackground +
PromptBackground implementation that renders the prompt background as a rectangle.
+
RectanglePromptFocal +
Prompt focal implementation to draw the focal as a rectangle.
+
ResourceFinder +
Interface used to find resources required by MaterialTapTargetPrompt.
+
SequenceItem +
Represents a prompt to display in a sequence.
+
SequenceItemShowFor +
Shows a prompt in a sequence for the supplied milliseconds.
+
SequenceState +
Stores a prompt for a SequenceItem in a sequence.
+
SequenceStatePromptOptions +
A SequenceState where the prompt is created the first time that getPrompt() is + called.
+
SupportFragmentResourceFinder +
ResourceFinder implementation for Fragment.
+
+
+
+
+ +
+
+ + diff --git a/docs/javadoc/allclasses-noframe.html b/docs/javadoc/allclasses-noframe.html deleted file mode 100644 index c063fb7b..00000000 --- a/docs/javadoc/allclasses-noframe.html +++ /dev/null @@ -1,42 +0,0 @@ - - - - - -All Classes (material-tap-target-prompt 3.0.0 API) - - - - - -

All Classes

-
- -
- - diff --git a/docs/javadoc/allpackages-index.html b/docs/javadoc/allpackages-index.html new file mode 100644 index 00000000..cd1f7569 --- /dev/null +++ b/docs/javadoc/allpackages-index.html @@ -0,0 +1,112 @@ + + + + + +All Packages (material-tap-target-prompt 3.0.1 API) + + + + + + + + + + + + + +
+ +
+
+
+

All Packages

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Package Summary
PackageDescription
uk.co.samuelwall.materialtaptargetprompt 
uk.co.samuelwall.materialtaptargetprompt.extras 
uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds 
uk.co.samuelwall.materialtaptargetprompt.extras.focals 
uk.co.samuelwall.materialtaptargetprompt.extras.sequence 
+
+
+ +
+
+ + diff --git a/docs/javadoc/constant-values.html b/docs/javadoc/constant-values.html index 346d9565..38c17b26 100644 --- a/docs/javadoc/constant-values.html +++ b/docs/javadoc/constant-values.html @@ -1,221 +1,161 @@ - - - - - -Constant Field Values (material-tap-target-prompt 3.0.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Constant Field Values

-

Contents

- -
-
- - -

uk.co.*

- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- - - + + + + + +Constant Field Values (material-tap-target-prompt 3.0.1 API) + + + + + + + + + + + + + +
+ +
+
+
+

Constant Field Values

+
+

Contents

+ +
+
+
+

uk.co.*

+ +
+
+ +
+
+ + diff --git a/docs/javadoc/deprecated-list.html b/docs/javadoc/deprecated-list.html index fd3d7baf..b5864b72 100644 --- a/docs/javadoc/deprecated-list.html +++ b/docs/javadoc/deprecated-list.html @@ -1,122 +1,80 @@ - - - - - -Deprecated List (material-tap-target-prompt 3.0.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Deprecated API

-

Contents

-
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- - - + + + + + +Deprecated List (material-tap-target-prompt 3.0.1 API) + + + + + + + + + + + + + +
+ +
+
+
+

Deprecated API

+

Contents

+
+
+ +
+
+ + diff --git a/docs/javadoc/package-list b/docs/javadoc/element-list similarity index 98% rename from docs/javadoc/package-list rename to docs/javadoc/element-list index a110d43b..41d925d0 100644 --- a/docs/javadoc/package-list +++ b/docs/javadoc/element-list @@ -1,5 +1,5 @@ -uk.co.samuelwall.materialtaptargetprompt -uk.co.samuelwall.materialtaptargetprompt.extras -uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds -uk.co.samuelwall.materialtaptargetprompt.extras.focals -uk.co.samuelwall.materialtaptargetprompt.extras.sequence +uk.co.samuelwall.materialtaptargetprompt +uk.co.samuelwall.materialtaptargetprompt.extras +uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds +uk.co.samuelwall.materialtaptargetprompt.extras.focals +uk.co.samuelwall.materialtaptargetprompt.extras.sequence diff --git a/docs/javadoc/help-doc.html b/docs/javadoc/help-doc.html index 95aea65d..a24c2ac2 100644 --- a/docs/javadoc/help-doc.html +++ b/docs/javadoc/help-doc.html @@ -1,223 +1,180 @@ - - - - - -API Help (material-tap-target-prompt 3.0.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

How This API Document Is Organized

-
This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.
-
-
- -This help file applies to API documentation generated using the standard doclet.
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- - - + + + + + +API Help (material-tap-target-prompt 3.0.1 API) + + + + + + + + + + + + + +
+ +
+
+
+

How This API Document Is Organized

+
This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.
+
+
+

Overview

+

The Overview page is the front page of this API document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages.

+
+
+

Package

+

Each package has a page that contains a list of its classes and interfaces, with a summary for each. These pages may contain six categories:

+
    +
  • Interfaces
    • +
  • Classes
    • +
  • Enums
    • +
  • Exceptions
    • +
  • Errors
    • +
  • Annotation Types
    • +
+
+
+

Class or Interface

+

Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:

+
    +
  • Class Inheritance Diagram
    • +
  • Direct Subclasses
    • +
  • All Known Subinterfaces
    • +
  • All Known Implementing Classes
    • +
  • Class or Interface Declaration
    • +
  • Class or Interface Description
    • +
+
+
    +
  • Nested Class Summary
    • +
  • Field Summary
    • +
  • Property Summary
    • +
  • Constructor Summary
    • +
  • Method Summary
    • +
+
+
    +
  • Field Details
    • +
  • Property Details
    • +
  • Constructor Details
    • +
  • Method Details
    • +
+

The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.

+
+
+

Annotation Type

+

Each annotation type has its own separate page with the following sections:

+
    +
  • Annotation Type Declaration
    • +
  • Annotation Type Description
    • +
  • Required Element Summary
    • +
  • Optional Element Summary
    • +
  • Element Details
    • +
+
+
+

Enum

+

Each enum has its own separate page with the following sections:

+
    +
  • Enum Declaration
    • +
  • Enum Description
    • +
  • Enum Constant Summary
    • +
  • Enum Constant Details
    • +
+
+
+

Tree (Class Hierarchy)

+

There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. Classes are organized by inheritance structure starting with java.lang.Object. Interfaces do not inherit from java.lang.Object.

+
    +
  • When viewing the Overview page, clicking on "Tree" displays the hierarchy for all packages.
    • +
  • When viewing a particular package, class or interface page, clicking on "Tree" displays the hierarchy for only that package.
    • +
+
+
+

Deprecated API

+

The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to shortcomings, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.

+
+
+

Index

+

The Index contains an alphabetic index of all classes, interfaces, constructors, methods, and fields, as well as lists of all packages and all classes.

+
+
+

Serialized Form

+

Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to those who implement rather than use the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See Also" section of the class description.

+
+
+

Constant Field Values

+

The Constant Field Values page lists the static final fields and their values.

+
+
+

Search

+

You can search for definitions of modules, packages, types, fields, methods, system properties and other terms defined in the API, using some or all of the name, optionally using "camel-case" abbreviations. For example:

+
    +
  • j.l.obj will match "java.lang.Object"
    • +
  • InpStr will match "java.io.InputStream"
    • +
  • HM.cK will match "java.util.HashMap.containsKey(Object)"
    • +
+

Refer to the Javadoc Search Specification for a full description of search features.

+
+
+This help file applies to API documentation generated by the standard doclet.
+ +
+
+ + diff --git a/docs/javadoc/index-all.html b/docs/javadoc/index-all.html index 5041460e..a1d8dbfd 100644 --- a/docs/javadoc/index-all.html +++ b/docs/javadoc/index-all.html @@ -1,1249 +1,1200 @@ - - - - - -Index (material-tap-target-prompt 3.0.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
A B C D F G I L M O P R S U  - - -

A

-
-
ActivityResourceFinder - Class in uk.co.samuelwall.materialtaptargetprompt
-
-
ResourceFinder implementation for Activity.
-
-
ActivityResourceFinder(Activity) - Constructor for class uk.co.samuelwall.materialtaptargetprompt.ActivityResourceFinder
-
 
-
addPrompt(MaterialTapTargetPrompt) - Method in class uk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetSequence
-
-
Add a prompt to the end of the sequence.
-
-
addPrompt(MaterialTapTargetPrompt, long) - Method in class uk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetSequence
-
-
Add a show for time prompt to the end of the sequence.
-
-
addPrompt(PromptOptions) - Method in class uk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetSequence
-
-
Add a prompt to the end of the sequence.
-
-
addPrompt(PromptOptions, long) - Method in class uk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetSequence
-
-
Add a show for time prompt to the end of the sequence.
-
-
addPrompt(SequenceItem) - Method in class uk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetSequence
-
-
Adds a sequence item to the end of the sequence.
-
-
addStateChanger(int) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.sequence.SequenceItem
-
-
Add a state that will trigger the sequence to move on.
-
-
- - - -

B

-
-
Builder(Fragment) - Constructor for class uk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetPrompt.Builder
-
-
Creates a builder for a tap target prompt that uses the default tap target prompt theme.
-
-
Builder(Fragment, int) - Constructor for class uk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetPrompt.Builder
-
-
Creates a builder for a material tap target prompt that uses an explicit theme resource.
-
-
Builder(DialogFragment) - Constructor for class uk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetPrompt.Builder
-
-
Creates a builder for a tap target prompt that uses the default tap target prompt theme.
-
-
Builder(DialogFragment, int) - Constructor for class uk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetPrompt.Builder
-
-
Creates a builder for a material tap target prompt that uses an explicit theme resource.
-
-
- - - -

C

-
-
calculateAngleEdgePoint(float, float) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.focals.CirclePromptFocal
-
 
-
calculateAngleEdgePoint(float, float) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptFocal
-
-
Calculate the point on the focal edge based on the angle.
-
-
calculateMaxTextWidth(Layout) - Static method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptUtils
-
-
Calculates the maximum width line in a text layout.
-
-
calculateMaxWidth(float, Rect, int, float) - Static method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptUtils
-
-
Calculates the maximum width that the prompt can be.
-
-
cancelShowForTimer() - Method in class uk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetPrompt
-
-
Cancel the show for timer if it has been created.
-
-
CirclePromptBackground - Class in uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds
-
-
PromptBackground implementation that renders the prompt background as a circle.
-
-
CirclePromptBackground() - Constructor for class uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds.CirclePromptBackground
-
-
Constructor.
-
-
CirclePromptFocal - Class in uk.co.samuelwall.materialtaptargetprompt.extras.focals
-
-
Prompt focal implementation to draw the focal as a circle.
-
-
CirclePromptFocal() - Constructor for class uk.co.samuelwall.materialtaptargetprompt.extras.focals.CirclePromptFocal
-
-
Constructor.
-
-
clearStateChangers() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.sequence.SequenceItem
-
-
Remove all state changers.
-
-
contains(float, float) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds.CirclePromptBackground
-
 
-
contains(float, float) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds.FullscreenPromptBackground
-
 
-
contains(float, float) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds.RectanglePromptBackground
-
 
-
contains(float, float) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.focals.CirclePromptFocal
-
 
-
contains(float, float) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.focals.RectanglePromptFocal
-
 
-
contains(float, float) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptText
-
 
-
containsInset(Rect, int, int, int) - Static method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptUtils
-
-
Determines if a point is within a rectangle that has been inset.
-
-
create() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
-
-
Creates an MaterialTapTargetPrompt with the arguments supplied to this - builder.
-
-
createDefault(PromptOptions) - Static method in class uk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetPrompt
-
-
Creates a prompt with the supplied options.
-
-
createStaticTextLayout(CharSequence, TextPaint, int, Layout.Alignment, float) - Static method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptUtils
-
-
Creates a static text layout.
-
-
- - - -

D

-
-
DialogResourceFinder - Class in uk.co.samuelwall.materialtaptargetprompt
-
-
ResourceFinder implementation for Dialog.
-
-
DialogResourceFinder(Dialog) - Constructor for class uk.co.samuelwall.materialtaptargetprompt.DialogResourceFinder
-
 
-
dismiss() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.sequence.SequenceItem
-
-
Calls MaterialTapTargetPrompt.dismiss() on this items states prompt.
-
-
dismiss() - Method in class uk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetPrompt
-
-
Removes the prompt from view, using a contract and fade animation.
-
-
dismiss() - Method in class uk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetSequence
-
-
Removes the currently displayed prompt in the sequence from view using the dismiss action and stops the sequence - from continuing.
-
-
draw(Canvas) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds.CirclePromptBackground
-
 
-
draw(Canvas) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds.FullscreenPromptBackground
-
 
-
draw(Canvas) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds.RectanglePromptBackground
-
 
-
draw(Canvas) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.focals.CirclePromptFocal
-
 
-
draw(Canvas) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.focals.RectanglePromptFocal
-
 
-
draw(Canvas) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptText
-
 
-
- - - -

F

-
-
findViewById(int) - Method in class uk.co.samuelwall.materialtaptargetprompt.ActivityResourceFinder
-
 
-
findViewById(int) - Method in class uk.co.samuelwall.materialtaptargetprompt.DialogResourceFinder
-
 
-
findViewById(int) - Method in interface uk.co.samuelwall.materialtaptargetprompt.ResourceFinder
-
-
Finds a child view with the given identifier.
-
-
findViewById(int) - Method in class uk.co.samuelwall.materialtaptargetprompt.SupportFragmentResourceFinder
-
 
-
finish() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.sequence.SequenceItem
-
-
Calls MaterialTapTargetPrompt.finish() on this items states prompt.
-
-
finish() - Method in class uk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetPrompt
-
-
Removes the prompt from view, using a expand and fade animation.
-
-
finish() - Method in class uk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetSequence
-
-
Removes the currently displayed prompt in the sequence from view using the finish action and stops the sequence - from continuing.
-
-
FullscreenPromptBackground - Class in uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds
-
-
PromptBackground implementation that renders the prompt background as a rectangle.
-
-
FullscreenPromptBackground() - Constructor for class uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds.FullscreenPromptBackground
-
-
Constructor.
-
-
- - - -

G

-
-
get(int) - Method in class uk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetSequence
-
-
Gets a prompt at a position in this sequence.
-
-
getAnimationInterpolator() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
-
-
Get the animation interpolator that is used.
-
-
getAutoDismiss() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
-
-
Get whether the prompt should dismiss itself when a touch event occurs outside the focal.
-
-
getAutoFinish() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
-
-
Get if the prompt should finish itself when a touch event occurs inside the focal.
-
-
getBackButtonDismissEnabled() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
-
-
Will the pressing the system back button dismiss the prompt.
-
-
getBackgroundColour() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
-
-
Get the background colour.
-
-
getBounds() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.focals.CirclePromptFocal
-
 
-
getBounds() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.focals.RectanglePromptFocal
-
 
-
getBounds() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptFocal
-
-
Get the focal bounds at scale 1.
-
-
getBounds() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptText
-
-
Get the window position for the prompt text.
-
-
getCaptureTouchEventOnFocal() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
-
-
Get if the prompt should stop touch events on the focal point from passing to underlying - views.
-
-
getCaptureTouchEventOutsidePrompt() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
-
-
Get if the prompt should stop touch events outside the prompt from passing to underlying views.
-
-
getClipToView() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
-
-
Get the view that the prompt canvas is clipped to.
-
-
getContentDescription() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
-
-
Get the text for the accessibility content description.
-
-
getContext() - Method in class uk.co.samuelwall.materialtaptargetprompt.ActivityResourceFinder
-
 
-
getContext() - Method in class uk.co.samuelwall.materialtaptargetprompt.DialogResourceFinder
-
 
-
getContext() - Method in interface uk.co.samuelwall.materialtaptargetprompt.ResourceFinder
-
-
Retrieve the Context that the prompt is running in.
-
-
getContext() - Method in class uk.co.samuelwall.materialtaptargetprompt.SupportFragmentResourceFinder
-
 
-
getDisplayMetrics() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds.FullscreenPromptBackground
-
 
-
getDisplayMetrics() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds.ImmersiveModeCompatPromptBackground
-
 
-
getDrawable(int) - Method in class uk.co.samuelwall.materialtaptargetprompt.ActivityResourceFinder
-
 
-
getDrawable(int) - Method in interface uk.co.samuelwall.materialtaptargetprompt.ResourceFinder
-
-
Returns a drawable object associated with a particular resource ID and - styled for the current theme.
-
-
getDrawable(int) - Method in class uk.co.samuelwall.materialtaptargetprompt.SupportFragmentResourceFinder
-
 
-
getFocalColour() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
-
-
Get the focal point colour.
-
-
getFocalPadding() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
-
-
Get the padding between the text and the focal.
-
-
getFocalRadius() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
-
-
Get the focal point radius for the circle prompt focal.
-
-
getIconDrawable() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
-
-
Get the icon drawn as the target.
-
-
getIdleAnimationEnabled() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
-
-
Is the focal animation enabled.
-
-
getMaxTextWidth() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
-
-
Get the maximum width that the primary and secondary text can be.
-
-
getPath() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.focals.CirclePromptFocal
-
 
-
getPath() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.focals.RectanglePromptFocal
-
 
-
getPath() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptFocal
-
-
Get the focal path to be drawn.
-
-
getPrimaryText() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
-
-
Get the text to draw for the primary text.
-
-
getPrimaryTextColour() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
-
-
Gets the primary text font colour.
-
-
getPrimaryTextGravity() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
-
-
Gets the gravity for the primary text.
-
-
getPrimaryTextSize() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
-
-
Get the primary text font size.
-
-
getPrimaryTextTypeface() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
-
-
Get the typeface for the primary text.
-
-
getPrimaryTextTypefaceStyle() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
-
-
Get the primary text typeface style.
-
-
getPrompt() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.sequence.SequenceState
-
-
Get the stored prompt.
-
-
getPrompt() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.sequence.SequenceStatePromptOptions
-
 
-
getPromptBackground() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
-
-
Get the prompt focal renderer.
-
-
getPromptFocal() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
-
-
Get the prompt focal renderer.
-
-
getPromptParentView() - Method in class uk.co.samuelwall.materialtaptargetprompt.ActivityResourceFinder
-
 
-
getPromptParentView() - Method in class uk.co.samuelwall.materialtaptargetprompt.DialogResourceFinder
-
 
-
getPromptParentView() - Method in interface uk.co.samuelwall.materialtaptargetprompt.ResourceFinder
-
-
Get the view to add the prompt to.
-
-
getPromptParentView() - Method in class uk.co.samuelwall.materialtaptargetprompt.SupportFragmentResourceFinder
-
 
-
getPromptText() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
-
-
Get the PromptText implementation used to render the prompt text.
-
-
getResourceFinder() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
-
-
Get the resource finder being used.
-
-
getResources() - Method in class uk.co.samuelwall.materialtaptargetprompt.ActivityResourceFinder
-
 
-
getResources() - Method in interface uk.co.samuelwall.materialtaptargetprompt.ResourceFinder
-
-
Returns a Resources instance for the application's package.
-
-
getResources() - Method in class uk.co.samuelwall.materialtaptargetprompt.SupportFragmentResourceFinder
-
 
-
getSecondaryText() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
-
-
Get the secondary text.
-
-
getSecondaryTextColour() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
-
-
Get the secondary text colour.
-
-
getSecondaryTextGravity() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
-
-
Gets the gravity for the secondary text.
-
-
getSecondaryTextSize() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
-
-
Get the secondary text size.
-
-
getSecondaryTextTypeface() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
-
-
Get the secondary text typeface.
-
-
getSecondaryTextTypefaceStyle() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
-
-
Get the secondary text typeface style.
-
-
getState() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.sequence.SequenceItem
-
-
Get the prompt state that this sequence item uses.
-
-
getState() - Method in class uk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetPrompt
-
-
Get the current state of the prompt.
-
-
getString(int) - Method in class uk.co.samuelwall.materialtaptargetprompt.ActivityResourceFinder
-
 
-
getString(int) - Method in interface uk.co.samuelwall.materialtaptargetprompt.ResourceFinder
-
-
Returns a localized string from the application's package's - default string table.
-
-
getString(int) - Method in class uk.co.samuelwall.materialtaptargetprompt.SupportFragmentResourceFinder
-
 
-
getTargetPosition() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
-
-
Get the position on the screen that is being targeted.
-
-
getTargetRenderView() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
-
-
Get the view that is rendered as the target.
-
-
getTargetView() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
-
-
Gets the view that the prompt is targeting.
-
-
getTextAlignment(Resources, int, CharSequence) - Static method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptUtils
-
-
Gets the absolute text alignment value based on the supplied gravity and the activities - layout direction.
-
-
getTextPadding() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
-
-
Get the text left and right padding.
-
-
getTextSeparation() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
-
-
Get the distance between the primary and secondary text.
-
-
getTheme() - Method in class uk.co.samuelwall.materialtaptargetprompt.ActivityResourceFinder
-
 
-
getTheme() - Method in interface uk.co.samuelwall.materialtaptargetprompt.ResourceFinder
-
-
Return the Theme object associated with ResourceFinder.getContext().
-
-
getTheme() - Method in class uk.co.samuelwall.materialtaptargetprompt.SupportFragmentResourceFinder
-
 
-
- - - -

I

-
-
ImmersiveModeCompatPromptBackground - Class in uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds
-
-
ImmersiveModeCompatPromptBackground implementation that renders the prompt background as a rectangle for supporting immersive mode.
-
-
ImmersiveModeCompatPromptBackground(WindowManager) - Constructor for class uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds.ImmersiveModeCompatPromptBackground
-
 
-
isPointInCircle(float, float, PointF, float) - Static method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptUtils
-
-
Determines if a point is in the centre of a circle with a radius from the point.
-
-
isRtlText(Layout, Resources) - Static method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptUtils
-
-
Determines if the text in the supplied layout is displayed right to left.
-
-
isTargetSet() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
-
-
Has the target been set successfully?
-
-
- - - -

L

-
-
load(int) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
-
-
Loads the supplied theme into the prompt overwriting any previously set values if they are set in the theme.
-
-
- - - -

M

-
-
MaterialTapTargetPrompt - Class in uk.co.samuelwall.materialtaptargetprompt
-
-
A Material Design tap target onboarding implementation.
-
-
MaterialTapTargetPrompt.Builder - Class in uk.co.samuelwall.materialtaptargetprompt
-
-
A builder to create a MaterialTapTargetPrompt instance.
-
-
MaterialTapTargetPrompt.PromptStateChangeListener - Interface in uk.co.samuelwall.materialtaptargetprompt
-
-
Interface definition for a callback to be invoked when a prompts state changes.
-
-
MaterialTapTargetSequence - Class in uk.co.samuelwall.materialtaptargetprompt
-
-
A Sequence of prompts to be shown one after another
-
-
MaterialTapTargetSequence() - Constructor for class uk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetSequence
-
 
-
MaterialTapTargetSequence.SequenceCompleteListener - Interface in uk.co.samuelwall.materialtaptargetprompt
-
-
Interface definition for a callback to be invoked when a sequence completes.
-
-
mBaseRippleAlpha - Variable in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptFocal
-
-
The alpha value for the ripple.
-
-
mDrawRipple - Variable in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptFocal
-
-
Should the ripple be drawn.
-
-
- - - -

O

-
-
obtainStyledAttributes(int, int[]) - Method in class uk.co.samuelwall.materialtaptargetprompt.ActivityResourceFinder
-
 
-
obtainStyledAttributes(int, int[]) - Method in interface uk.co.samuelwall.materialtaptargetprompt.ResourceFinder
-
-
Retrieve styled attribute information in ResourceFinder.getContext() theme.
-
-
obtainStyledAttributes(int, int[]) - Method in class uk.co.samuelwall.materialtaptargetprompt.SupportFragmentResourceFinder
-
 
-
onExtraPromptStateChanged(MaterialTapTargetPrompt, int) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
-
-
Handles emitting the additional prompt state changed events.
-
-
onItemComplete() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.sequence.SequenceItem
-
-
Emits the MaterialTapTargetSequence.SequenceCompleteListener#onSequenceComplete() event if the listener - is set.
-
-
onPromptStateChanged(MaterialTapTargetPrompt, int) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
-
-
Handles emitting the prompt state changed events.
-
-
onPromptStateChanged(MaterialTapTargetPrompt, int) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.sequence.SequenceItem
-
 
-
onPromptStateChanged(int) - Method in class uk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetPrompt
-
-
Handles emitting the prompt state changed events.
-
-
onPromptStateChanged(MaterialTapTargetPrompt, int) - Method in interface uk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetPrompt.PromptStateChangeListener
-
-
Called when the prompts state changes.
-
-
onSequenceComplete() - Method in interface uk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetSequence.SequenceCompleteListener
-
-
Called after the final prompt is closed
-
-
- - - -

P

-
-
parseTintMode(int, PorterDuff.Mode) - Static method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptUtils
-
-
Based on parseTintMode in android appcompat v7 DrawableUtils, Copyright (C) 2014 The - Android Open Source Project.
-
-
prepare(PromptOptions, boolean, Rect) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds.CirclePromptBackground
-
 
-
prepare(PromptOptions, boolean, Rect) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds.FullscreenPromptBackground
-
 
-
prepare(PromptOptions, boolean, Rect) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds.RectanglePromptBackground
-
 
-
prepare(PromptOptions, View, int[]) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.focals.CirclePromptFocal
-
 
-
prepare(PromptOptions, float, float) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.focals.CirclePromptFocal
-
 
-
prepare(PromptOptions, View, int[]) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.focals.RectanglePromptFocal
-
 
-
prepare(PromptOptions, float, float) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.focals.RectanglePromptFocal
-
 
-
prepare(PromptOptions, boolean, Rect) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptBackground
-
-
Prepares the background for drawing.
-
-
prepare(PromptOptions, View, int[]) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptFocal
-
-
Setup the focal ready for rendering when targeting a view, called prior to first render.
-
-
prepare(PromptOptions, float, float) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptFocal
-
-
Setup the focal ready for rendering when targeting a point on the screen, called prior to first render.
-
-
prepare(PromptOptions, boolean, Rect) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptText
-
-
Recalculates the primary and secondary text positions.
-
-
PromptBackground - Class in uk.co.samuelwall.materialtaptargetprompt.extras
-
-
Used to render the prompt background.
-
-
PromptBackground() - Constructor for class uk.co.samuelwall.materialtaptargetprompt.extras.PromptBackground
-
 
-
PromptFocal - Class in uk.co.samuelwall.materialtaptargetprompt.extras
-
-
Used to render the prompt focal.
-
-
PromptFocal() - Constructor for class uk.co.samuelwall.materialtaptargetprompt.extras.PromptFocal
-
 
-
PromptOptions<T extends PromptOptions> - Class in uk.co.samuelwall.materialtaptargetprompt.extras
-
-
Contains all the settings for creating a prompt.
-
-
PromptOptions(ResourceFinder) - Constructor for class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
-
-
Constructor.
-
-
PromptText - Class in uk.co.samuelwall.materialtaptargetprompt.extras
-
 
-
PromptText() - Constructor for class uk.co.samuelwall.materialtaptargetprompt.extras.PromptText
-
 
-
PromptUtils - Class in uk.co.samuelwall.materialtaptargetprompt.extras
-
-
Useful methods for prompts that don't fit else where.
-
-
- - - -

R

-
-
RectanglePromptBackground - Class in uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds
-
-
PromptBackground implementation that renders the prompt background as a rectangle.
-
-
RectanglePromptBackground() - Constructor for class uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds.RectanglePromptBackground
-
-
Constructor.
-
-
RectanglePromptFocal - Class in uk.co.samuelwall.materialtaptargetprompt.extras.focals
-
-
Prompt focal implementation to draw the focal as a rectangle.
-
-
RectanglePromptFocal() - Constructor for class uk.co.samuelwall.materialtaptargetprompt.extras.focals.RectanglePromptFocal
-
-
Constructor.
-
-
removeStateChanger(int) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.sequence.SequenceItem
-
-
Remove a specific state changer.
-
-
ResourceFinder - Interface in uk.co.samuelwall.materialtaptargetprompt
-
-
Interface used to find resources required by MaterialTapTargetPrompt.
-
-
- - - -

S

-
-
scale(PointF, RectF, RectF, float, boolean) - Static method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptUtils
-
-
Scales a rectangle.
-
-
SequenceItem - Class in uk.co.samuelwall.materialtaptargetprompt.extras.sequence
-
-
Represents a prompt to display in a sequence.
-
-
SequenceItem(SequenceState) - Constructor for class uk.co.samuelwall.materialtaptargetprompt.extras.sequence.SequenceItem
-
-
Constructor.
-
-
SequenceItemShowFor - Class in uk.co.samuelwall.materialtaptargetprompt.extras.sequence
-
-
Shows a prompt in a sequence for the supplied milliseconds.
-
-
SequenceItemShowFor(SequenceState, long) - Constructor for class uk.co.samuelwall.materialtaptargetprompt.extras.sequence.SequenceItemShowFor
-
-
Constructor.
-
-
SequenceState - Class in uk.co.samuelwall.materialtaptargetprompt.extras.sequence
-
-
Stores a prompt for a SequenceItem in a sequence.
-
-
SequenceState(MaterialTapTargetPrompt) - Constructor for class uk.co.samuelwall.materialtaptargetprompt.extras.sequence.SequenceState
-
-
Constructor.
-
-
SequenceStatePromptOptions - Class in uk.co.samuelwall.materialtaptargetprompt.extras.sequence
-
-
A SequenceState where the prompt is created the first time that SequenceStatePromptOptions.getPrompt() is - called.
-
-
SequenceStatePromptOptions(PromptOptions) - Constructor for class uk.co.samuelwall.materialtaptargetprompt.extras.sequence.SequenceStatePromptOptions
-
-
Constructor.
-
-
setAnimationInterpolator(Interpolator) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
-
-
Set the interpolator to use in animations.
-
-
setAutoDismiss(boolean) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
-
-
Set whether the prompt should dismiss itself when a touch event occurs outside the focal.
-
-
setAutoFinish(boolean) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
-
-
Set whether the prompt should finish itself when a touch event occurs inside the focal.
-
-
setBackButtonDismissEnabled(boolean) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
-
-
Back button can be used to dismiss the prompt.
-
-
setBackgroundColour(int) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
-
-
Set the background colour.
-
-
setCaptureTouchEventOnFocal(boolean) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
-
-
Set if the prompt should stop touch events on the focal point from passing to underlying - views.
-
-
setCaptureTouchEventOutsidePrompt(boolean) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
-
-
Set if the prompt should stop touch events outside the prompt from passing to underlying - views.
-
-
setClipToView(View) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
-
-
Set the view to clip the prompt to.
-
-
setColour(int) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds.CirclePromptBackground
-
 
-
setColour(int) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds.FullscreenPromptBackground
-
 
-
setColour(int) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds.RectanglePromptBackground
-
 
-
setColour(int) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.focals.CirclePromptFocal
-
 
-
setColour(int) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.focals.RectanglePromptFocal
-
 
-
setColour(int) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptBackground
-
-
Sets the colour to use for the background.
-
-
setColour(int) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptFocal
-
-
Set the focal colour.
-
-
setContentDescription(int) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
-
-
Set the accessibility content description text using the given resource id.
-
-
setContentDescription(String) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
-
-
Set the accessibility content description text to the given string
-
-
setCornerRadius(float, float) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds.FullscreenPromptBackground
-
-
Set the radius for the rectangle corners.
-
-
setCornerRadius(float, float) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds.RectanglePromptBackground
-
-
Set the radius for the rectangle corners.
-
-
setCornerRadius(float, float) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.focals.RectanglePromptFocal
-
-
Set the radius for the rectangle corners.
-
-
setDrawRipple(boolean) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptFocal
-
-
Sets whether the ripple is drawn around the focal.
-
-
setFocalColour(int) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
-
-
Set the focal point colour.
-
-
setFocalPadding(int) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
-
-
Set the padding between the text and the focal point using the given resource id.
-
-
setFocalPadding(float) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
-
-
Set the padding between the text and the focal point.
-
-
setFocalRadius(int) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
-
-
Set the focal point radius using the given resource id.
-
-
setFocalRadius(float) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
-
-
Set the focal point radius.
-
-
setIcon(int) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
-
-
Set the icon to draw in the focal point using the given resource id.
-
-
setIconDrawable(Drawable) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
-
-
Set the icon to draw in the focal point.
-
-
setIconDrawableColourFilter(int) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
-
-
Sets the colour to use to tint the icon drawable.
-
-
setIconDrawableTintList(ColorStateList) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
-
-
Applies a tint to the icon drawable
-
-
setIconDrawableTintMode(PorterDuff.Mode) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
-
-
Sets the PorterDuff mode to use to apply the tint.
-
-
setIdleAnimationEnabled(boolean) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
-
-
Enable/disable focal animation.
-
-
setMaxTextWidth(int) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
-
-
Set the max width that the primary and secondary text can be using the given resource - id.
-
-
setMaxTextWidth(float) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
-
-
Set the max width that the primary and secondary text can be.
-
-
setPrimaryText(int) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
-
-
Set the primary text using the given resource id.
-
-
setPrimaryText(String) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
-
-
Set the primary text to the given string
-
-
setPrimaryText(CharSequence) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
-
-
Set the primary text to the given CharSequence.
-
-
setPrimaryTextColour(int) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
-
-
Set the primary text colour.
-
-
setPrimaryTextGravity(int) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
-
-
Set the primary text horizontal layout gravity.
-
-
setPrimaryTextSize(float) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
-
-
Set the primary text font size.
-
-
setPrimaryTextSize(int) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
-
-
Set the primary text font size using the given resource id.
-
-
setPrimaryTextTypeface(Typeface) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
-
-
Sets the typeface and style used to display the primary text.
-
-
setPrimaryTextTypeface(Typeface, int) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
-
-
Sets the typeface used to display the primary text.
-
-
setPromptBackground(PromptBackground) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
-
-
Sets the renderer for the prompt background.
-
-
setPromptFocal(PromptFocal) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
-
-
Sets the renderer for the prompt focal.
-
-
setPromptStateChangeListener(MaterialTapTargetPrompt.PromptStateChangeListener) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
-
-
Set the listener to listen for when the prompt state changes.
-
-
setPromptText(PromptText) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
-
-
Set the PromptText implementation to use to render the prompt text.
-
-
setRadius(float) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.focals.CirclePromptFocal
-
-
Set the focal radius.
-
-
setRippleAlpha(int) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptFocal
-
-
Sets the alpha value to use for the ripple colour.
-
-
setSecondaryText(int) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
-
-
Set the secondary text using the given resource id.
-
-
setSecondaryText(String) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
-
-
Set the secondary text.
-
-
setSecondaryText(CharSequence) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
-
-
Set the secondary text.
-
-
setSecondaryTextColour(int) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
-
-
Set the secondary text colour.
-
-
setSecondaryTextGravity(int) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
-
-
Set the secondary text horizontal layout gravity.
-
-
setSecondaryTextSize(int) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
-
-
Set the secondary text font size using the give resource id.
-
-
setSecondaryTextSize(float) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
-
-
Set the secondary text font size.
-
-
setSecondaryTextTypeface(Typeface) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
-
-
Sets the typeface used to display the secondary text.
-
-
setSecondaryTextTypeface(Typeface, int) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
-
-
Sets the typeface and style used to display the secondary text.
-
-
setSequenceCompleteListener(MaterialTapTargetSequence.SequenceCompleteListener) - Method in class uk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetSequence
-
-
Set the listener to listen with the action to call when the sequence ends
-
-
setSequenceListener(MaterialTapTargetPrompt.PromptStateChangeListener) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
-
-
Set the internal listener to listen for when the prompt state changes.
-
-
setSequenceListener(MaterialTapTargetSequence.SequenceCompleteListener) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.sequence.SequenceItem
-
-
Set the listener for this sequence item completing.
-
-
setSize(PointF) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.focals.RectanglePromptFocal
-
-
Sets the focal to a fixed size.
-
-
setTarget(View) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
-
-
Set the view for the prompt to focus on.
-
-
setTarget(int) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
-
-
Set the view for the prompt to focus on using the given resource id.
-
-
setTarget(float, float) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
-
-
Set the centre point as a screen position
-
-
setTargetPadding(float) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.focals.RectanglePromptFocal
-
-
Set the padding between the target bounds and the rectangle edge.
-
-
setTargetRenderView(View) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
-
-
Change the view that is rendered as the target.
-
-
setTextGravity(int) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
-
-
Set the primary and secondary text horizontal layout gravity.
-
-
setTextPadding(int) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
-
-
Set the text left and right padding using the given resource id.
-
-
setTextPadding(float) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
-
-
Set the text left and right padding.
-
-
setTextSeparation(int) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
-
-
Set the distance between the primary and secondary text using the given resource id.
-
-
setTextSeparation(float) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
-
-
Set the distance between the primary and secondary text.
-
-
setTypeface(TextPaint, Typeface, int) - Static method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptUtils
-
-
Based on setTypeface in android TextView, Copyright (C) 2006 The Android Open Source - Project.
-
-
setTypefaceFromAttrs(String, int, int) - Static method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptUtils
-
-
Based on setTypefaceFromAttrs in android TextView, Copyright (C) 2006 The Android Open - Source Project.
-
-
show() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
-
-
Creates a MaterialTapTargetPrompt with the arguments supplied to this - builder and immediately displays the prompt.
-
-
show() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.sequence.SequenceItem
-
-
Show this sequence item.
-
-
show(MaterialTapTargetPrompt) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.sequence.SequenceItem
-
-
Show the created prompt for this sequence item.
-
-
show(MaterialTapTargetPrompt) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.sequence.SequenceItemShowFor
-
 
-
show() - Method in class uk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetPrompt
-
-
Displays the prompt.
-
-
show() - Method in class uk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetSequence
-
-
Start the sequence by showing the first prompt.
-
-
showFor(long) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
-
-
Creates a MaterialTapTargetPrompt with the arguments supplied to this - builder and immediately displays the prompt for the number of milliseconds supplied.
-
-
showFor(long) - Method in class uk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetPrompt
-
-
Displays the prompt for a maximum amount of time.
-
-
showFromIndex(int) - Method in class uk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetSequence
-
-
Shows or continues to show this sequence from the prompt at the index supplied.
-
-
size() - Method in class uk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetSequence
-
-
Get the number of prompts in this sequence.
-
-
STATE_BACK_BUTTON_PRESSED - Static variable in class uk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetPrompt
-
-
The prompt has been dismissed by the system back button being pressed.
-
-
STATE_DISMISSED - Static variable in class uk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetPrompt
-
-
The prompt has been removed from view after the prompt has either been pressed somewhere - other than the prompt target or the system back button has been pressed.
-
-
STATE_DISMISSING - Static variable in class uk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetPrompt
-
-
The MaterialTapTargetPrompt.dismiss() method has been called and the prompt is being removed from view.
-
-
STATE_FINISHED - Static variable in class uk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetPrompt
-
-
The prompt has been removed from view after the prompt has been pressed in the focal area.
-
-
STATE_FINISHING - Static variable in class uk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetPrompt
-
-
The MaterialTapTargetPrompt.finish() method has been called and the prompt is being removed from view.
-
-
STATE_FOCAL_PRESSED - Static variable in class uk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetPrompt
-
-
The prompt target has been pressed in the focal area.
-
-
STATE_NON_FOCAL_PRESSED - Static variable in class uk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetPrompt
-
-
The prompt has been pressed outside the focal area.
-
-
STATE_NOT_SHOWN - Static variable in class uk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetPrompt
-
-
Prompt has yet to be shown.
-
-
STATE_REVEALED - Static variable in class uk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetPrompt
-
-
Prompt reveal animation has finished and the prompt is displayed.
-
-
STATE_REVEALING - Static variable in class uk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetPrompt
-
-
Prompt is reveal animation is running.
-
-
STATE_SHOW_FOR_TIMEOUT - Static variable in class uk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetPrompt
-
-
The prompt has been dismissed by the show for timeout.
-
-
SupportFragmentResourceFinder - Class in uk.co.samuelwall.materialtaptargetprompt
-
-
ResourceFinder implementation for Fragment.
-
-
SupportFragmentResourceFinder(Fragment) - Constructor for class uk.co.samuelwall.materialtaptargetprompt.SupportFragmentResourceFinder
-
-
Constructor.
-
-
- - - -

U

-
-
uk.co.samuelwall.materialtaptargetprompt - package uk.co.samuelwall.materialtaptargetprompt
-
 
-
uk.co.samuelwall.materialtaptargetprompt.extras - package uk.co.samuelwall.materialtaptargetprompt.extras
-
 
-
uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds - package uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds
-
 
-
uk.co.samuelwall.materialtaptargetprompt.extras.focals - package uk.co.samuelwall.materialtaptargetprompt.extras.focals
-
 
-
uk.co.samuelwall.materialtaptargetprompt.extras.sequence - package uk.co.samuelwall.materialtaptargetprompt.extras.sequence
-
 
-
update(PromptOptions, float, float) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds.CirclePromptBackground
-
 
-
update(PromptOptions, float, float) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds.FullscreenPromptBackground
-
 
-
update(PromptOptions, float, float) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds.RectanglePromptBackground
-
 
-
update(PromptOptions, float, float) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.focals.CirclePromptFocal
-
 
-
update(PromptOptions, float, float) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.focals.RectanglePromptFocal
-
 
-
update(PromptOptions, float, float) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptText
-
 
-
updateRipple(float, float) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.focals.CirclePromptFocal
-
 
-
updateRipple(float, float) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.focals.RectanglePromptFocal
-
 
-
updateRipple(float, float) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptFocal
-
-
Update the ripple around the focal.
-
-
-A B C D F G I L M O P R S U 
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- - - + + + + + +Index (material-tap-target-prompt 3.0.1 API) + + + + + + + + + + + + + +
+ +
+
+
+

Index

+
+A B C D F G I L M O P R S U 
All Classes|All Packages +

A

+
+
ActivityResourceFinder - Class in uk.co.samuelwall.materialtaptargetprompt
+
+
ResourceFinder implementation for Activity.
+
+
ActivityResourceFinder(Activity) - Constructor for class uk.co.samuelwall.materialtaptargetprompt.ActivityResourceFinder
+
 
+
addPrompt(PromptOptions) - Method in class uk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetSequence
+
+
Add a prompt to the end of the sequence.
+
+
addPrompt(PromptOptions, long) - Method in class uk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetSequence
+
+
Add a show for time prompt to the end of the sequence.
+
+
addPrompt(SequenceItem) - Method in class uk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetSequence
+
+
Adds a sequence item to the end of the sequence.
+
+
addPrompt(MaterialTapTargetPrompt) - Method in class uk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetSequence
+
+
Add a prompt to the end of the sequence.
+
+
addPrompt(MaterialTapTargetPrompt, long) - Method in class uk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetSequence
+
+
Add a show for time prompt to the end of the sequence.
+
+
addStateChanger(int) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.sequence.SequenceItem
+
+
Add a state that will trigger the sequence to move on.
+
+
+

B

+
+
Builder(Activity) - Constructor for class uk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetPrompt.Builder
+
+
Creates a builder for a tap target prompt that uses the default tap target prompt theme.
+
+
Builder(Activity, int) - Constructor for class uk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetPrompt.Builder
+
+
Creates a builder for a material tap target prompt that uses an explicit theme resource.
+
+
Builder(Dialog) - Constructor for class uk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetPrompt.Builder
+
+
Creates a builder for a tap target prompt that uses the default tap target prompt theme.
+
+
Builder(Dialog, int) - Constructor for class uk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetPrompt.Builder
+
+
Creates a builder for a material tap target prompt that uses an explicit theme resource.
+
+
Builder(DialogFragment) - Constructor for class uk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetPrompt.Builder
+
+
Creates a builder for a tap target prompt that uses the default tap target prompt theme.
+
+
Builder(DialogFragment, int) - Constructor for class uk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetPrompt.Builder
+
+
Creates a builder for a material tap target prompt that uses an explicit theme resource.
+
+
Builder(Fragment) - Constructor for class uk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetPrompt.Builder
+
+
Creates a builder for a tap target prompt that uses the default tap target prompt theme.
+
+
Builder(Fragment, int) - Constructor for class uk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetPrompt.Builder
+
+
Creates a builder for a material tap target prompt that uses an explicit theme resource.
+
+
Builder(ResourceFinder, int) - Constructor for class uk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetPrompt.Builder
+
+
Creates a builder for a material tap target prompt that uses an explicit theme resource.
+
+
+

C

+
+
calculateAngleEdgePoint(float, float) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.focals.CirclePromptFocal
+
 
+
calculateAngleEdgePoint(float, float) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptFocal
+
+
Calculate the point on the focal edge based on the angle.
+
+
calculateMaxTextWidth(Layout) - Static method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptUtils
+
+
Calculates the maximum width line in a text layout.
+
+
calculateMaxWidth(float, Rect, int, float) - Static method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptUtils
+
+
Calculates the maximum width that the prompt can be.
+
+
cancelShowForTimer() - Method in class uk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetPrompt
+
+
Cancel the show for timer if it has been created.
+
+
CirclePromptBackground - Class in uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds
+
+
PromptBackground implementation that renders the prompt background as a circle.
+
+
CirclePromptBackground() - Constructor for class uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds.CirclePromptBackground
+
+
Constructor.
+
+
CirclePromptFocal - Class in uk.co.samuelwall.materialtaptargetprompt.extras.focals
+
+
Prompt focal implementation to draw the focal as a circle.
+
+
CirclePromptFocal() - Constructor for class uk.co.samuelwall.materialtaptargetprompt.extras.focals.CirclePromptFocal
+
+
Constructor.
+
+
clearStateChangers() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.sequence.SequenceItem
+
+
Remove all state changers.
+
+
contains(float, float) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds.CirclePromptBackground
+
 
+
contains(float, float) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds.FullscreenPromptBackground
+
 
+
contains(float, float) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds.RectanglePromptBackground
+
 
+
contains(float, float) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.focals.CirclePromptFocal
+
 
+
contains(float, float) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.focals.RectanglePromptFocal
+
 
+
contains(float, float) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptText
+
 
+
contains(float, float) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptBackground
+
+
Does the element contain the point.
+
+
containsInset(Rect, int, int, int) - Static method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptUtils
+
+
Determines if a point is within a rectangle that has been inset.
+
+
create() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
+
+
Creates an MaterialTapTargetPrompt with the arguments supplied to this + builder.
+
+
createDefault(PromptOptions) - Static method in class uk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetPrompt
+
+
Creates a prompt with the supplied options.
+
+
createStaticTextLayout(CharSequence, TextPaint, int, Layout.Alignment, float) - Static method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptUtils
+
+
Creates a static text layout.
+
+
+

D

+
+
DialogResourceFinder - Class in uk.co.samuelwall.materialtaptargetprompt
+
+
ResourceFinder implementation for Dialog.
+
+
DialogResourceFinder(Dialog) - Constructor for class uk.co.samuelwall.materialtaptargetprompt.DialogResourceFinder
+
 
+
dismiss() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.sequence.SequenceItem
+
+
Calls MaterialTapTargetPrompt.dismiss() on this items states prompt.
+
+
dismiss() - Method in class uk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetPrompt
+
+
Removes the prompt from view, using a contract and fade animation.
+
+
dismiss() - Method in class uk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetSequence
+
+
Removes the currently displayed prompt in the sequence from view using the dismiss action and stops the sequence + from continuing.
+
+
draw(Canvas) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds.CirclePromptBackground
+
 
+
draw(Canvas) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds.FullscreenPromptBackground
+
 
+
draw(Canvas) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds.RectanglePromptBackground
+
 
+
draw(Canvas) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.focals.CirclePromptFocal
+
 
+
draw(Canvas) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.focals.RectanglePromptFocal
+
 
+
draw(Canvas) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptText
+
 
+
draw(Canvas) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptBackground
+
+
Draw the element.
+
+
+

F

+
+
findViewById(int) - Method in class uk.co.samuelwall.materialtaptargetprompt.ActivityResourceFinder
+
 
+
findViewById(int) - Method in class uk.co.samuelwall.materialtaptargetprompt.DialogResourceFinder
+
 
+
findViewById(int) - Method in interface uk.co.samuelwall.materialtaptargetprompt.ResourceFinder
+
+
Finds a child view with the given identifier.
+
+
findViewById(int) - Method in class uk.co.samuelwall.materialtaptargetprompt.SupportFragmentResourceFinder
+
 
+
finish() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.sequence.SequenceItem
+
+
Calls MaterialTapTargetPrompt.finish() on this items states prompt.
+
+
finish() - Method in class uk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetPrompt
+
+
Removes the prompt from view, using a expand and fade animation.
+
+
finish() - Method in class uk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetSequence
+
+
Removes the currently displayed prompt in the sequence from view using the finish action and stops the sequence + from continuing.
+
+
FullscreenPromptBackground - Class in uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds
+
+
PromptBackground implementation that renders the prompt background as a rectangle.
+
+
FullscreenPromptBackground() - Constructor for class uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds.FullscreenPromptBackground
+
+
Constructor.
+
+
+

G

+
+
get(int) - Method in class uk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetSequence
+
+
Gets a prompt at a position in this sequence.
+
+
getAnimationInterpolator() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
+
+
Get the animation interpolator that is used.
+
+
getAutoDismiss() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
+
+
Get whether the prompt should dismiss itself when a touch event occurs outside the focal.
+
+
getAutoFinish() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
+
+
Get if the prompt should finish itself when a touch event occurs inside the focal.
+
+
getBackButtonDismissEnabled() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
+
+
Will the pressing the system back button dismiss the prompt.
+
+
getBackgroundColour() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
+
+
Get the background colour.
+
+
getBounds() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.focals.CirclePromptFocal
+
 
+
getBounds() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.focals.RectanglePromptFocal
+
 
+
getBounds() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptFocal
+
+
Get the focal bounds at scale 1.
+
+
getBounds() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptText
+
+
Get the window position for the prompt text.
+
+
getCaptureTouchEventOnFocal() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
+
+
Get if the prompt should stop touch events on the focal point from passing to underlying + views.
+
+
getCaptureTouchEventOutsidePrompt() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
+
+
Get if the prompt should stop touch events outside the prompt from passing to underlying views.
+
+
getClipToView() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
+
+
Get the view that the prompt canvas is clipped to.
+
+
getContentDescription() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
+
+
Get the text for the accessibility content description.
+
+
getContext() - Method in class uk.co.samuelwall.materialtaptargetprompt.ActivityResourceFinder
+
 
+
getContext() - Method in class uk.co.samuelwall.materialtaptargetprompt.DialogResourceFinder
+
 
+
getContext() - Method in interface uk.co.samuelwall.materialtaptargetprompt.ResourceFinder
+
+
Retrieve the Context that the prompt is running in.
+
+
getContext() - Method in class uk.co.samuelwall.materialtaptargetprompt.SupportFragmentResourceFinder
+
 
+
getDisplayMetrics() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds.FullscreenPromptBackground
+
 
+
getDisplayMetrics() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds.ImmersiveModeCompatPromptBackground
+
 
+
getDrawable(int) - Method in class uk.co.samuelwall.materialtaptargetprompt.ActivityResourceFinder
+
 
+
getDrawable(int) - Method in interface uk.co.samuelwall.materialtaptargetprompt.ResourceFinder
+
+
Returns a drawable object associated with a particular resource ID and + styled for the current theme.
+
+
getDrawable(int) - Method in class uk.co.samuelwall.materialtaptargetprompt.SupportFragmentResourceFinder
+
 
+
getFocalColour() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
+
+
Get the focal point colour.
+
+
getFocalPadding() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
+
+
Get the padding between the text and the focal.
+
+
getFocalRadius() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
+
+
Get the focal point radius for the circle prompt focal.
+
+
getIconDrawable() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
+
+
Get the icon drawn as the target.
+
+
getIdleAnimationEnabled() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
+
+
Is the focal animation enabled.
+
+
getMaxTextWidth() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
+
+
Get the maximum width that the primary and secondary text can be.
+
+
getPath() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.focals.CirclePromptFocal
+
 
+
getPath() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.focals.RectanglePromptFocal
+
 
+
getPath() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptFocal
+
+
Get the focal path to be drawn.
+
+
getPrimaryText() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
+
+
Get the text to draw for the primary text.
+
+
getPrimaryTextColour() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
+
+
Gets the primary text font colour.
+
+
getPrimaryTextGravity() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
+
+
Gets the gravity for the primary text.
+
+
getPrimaryTextSize() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
+
+
Get the primary text font size.
+
+
getPrimaryTextTypeface() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
+
+
Get the typeface for the primary text.
+
+
getPrimaryTextTypefaceStyle() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
+
+
Get the primary text typeface style.
+
+
getPrompt() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.sequence.SequenceState
+
+
Get the stored prompt.
+
+
getPrompt() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.sequence.SequenceStatePromptOptions
+
 
+
getPromptBackground() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
+
+
Get the prompt focal renderer.
+
+
getPromptFocal() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
+
+
Get the prompt focal renderer.
+
+
getPromptParentView() - Method in class uk.co.samuelwall.materialtaptargetprompt.ActivityResourceFinder
+
 
+
getPromptParentView() - Method in class uk.co.samuelwall.materialtaptargetprompt.DialogResourceFinder
+
 
+
getPromptParentView() - Method in interface uk.co.samuelwall.materialtaptargetprompt.ResourceFinder
+
+
Get the view to add the prompt to.
+
+
getPromptParentView() - Method in class uk.co.samuelwall.materialtaptargetprompt.SupportFragmentResourceFinder
+
 
+
getPromptText() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
+
+
Get the PromptText implementation used to render the prompt text.
+
+
getResourceFinder() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
+
+
Get the resource finder being used.
+
+
getResources() - Method in class uk.co.samuelwall.materialtaptargetprompt.ActivityResourceFinder
+
 
+
getResources() - Method in interface uk.co.samuelwall.materialtaptargetprompt.ResourceFinder
+
+
Returns a Resources instance for the application's package.
+
+
getResources() - Method in class uk.co.samuelwall.materialtaptargetprompt.SupportFragmentResourceFinder
+
 
+
getSecondaryText() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
+
+
Get the secondary text.
+
+
getSecondaryTextColour() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
+
+
Get the secondary text colour.
+
+
getSecondaryTextGravity() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
+
+
Gets the gravity for the secondary text.
+
+
getSecondaryTextSize() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
+
+
Get the secondary text size.
+
+
getSecondaryTextTypeface() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
+
+
Get the secondary text typeface.
+
+
getSecondaryTextTypefaceStyle() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
+
+
Get the secondary text typeface style.
+
+
getState() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.sequence.SequenceItem
+
+
Get the prompt state that this sequence item uses.
+
+
getState() - Method in class uk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetPrompt
+
+
Get the current state of the prompt.
+
+
getString(int) - Method in class uk.co.samuelwall.materialtaptargetprompt.ActivityResourceFinder
+
 
+
getString(int) - Method in interface uk.co.samuelwall.materialtaptargetprompt.ResourceFinder
+
+
Returns a localized string from the application's package's + default string table.
+
+
getString(int) - Method in class uk.co.samuelwall.materialtaptargetprompt.SupportFragmentResourceFinder
+
 
+
getTargetPosition() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
+
+
Get the position on the screen that is being targeted.
+
+
getTargetRenderView() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
+
+
Get the view that is rendered as the target.
+
+
getTargetView() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
+
+
Gets the view that the prompt is targeting.
+
+
getTextAlignment(Resources, int, CharSequence) - Static method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptUtils
+
+
Gets the absolute text alignment value based on the supplied gravity and the activities + layout direction.
+
+
getTextPadding() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
+
+
Get the text left and right padding.
+
+
getTextSeparation() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
+
+
Get the distance between the primary and secondary text.
+
+
getTheme() - Method in class uk.co.samuelwall.materialtaptargetprompt.ActivityResourceFinder
+
 
+
getTheme() - Method in interface uk.co.samuelwall.materialtaptargetprompt.ResourceFinder
+
+
Return the Theme object associated with ResourceFinder.getContext().
+
+
getTheme() - Method in class uk.co.samuelwall.materialtaptargetprompt.SupportFragmentResourceFinder
+
 
+
+

I

+
+
ImmersiveModeCompatPromptBackground - Class in uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds
+
+
ImmersiveModeCompatPromptBackground implementation that renders the prompt background as a rectangle for supporting immersive mode.
+
+
ImmersiveModeCompatPromptBackground(WindowManager) - Constructor for class uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds.ImmersiveModeCompatPromptBackground
+
 
+
isPointInCircle(float, float, PointF, float) - Static method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptUtils
+
+
Determines if a point is in the centre of a circle with a radius from the point.
+
+
isRtlText(Layout, Resources) - Static method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptUtils
+
+
Determines if the text in the supplied layout is displayed right to left.
+
+
isTargetSet() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
+
+
Has the target been set successfully?
+
+
+

L

+
+
load(int) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
+
+
Loads the supplied theme into the prompt overwriting any previously set values if they are set in the theme.
+
+
+

M

+
+
MaterialTapTargetPrompt - Class in uk.co.samuelwall.materialtaptargetprompt
+
+
A Material Design tap target onboarding implementation.
+
+
MaterialTapTargetPrompt.Builder - Class in uk.co.samuelwall.materialtaptargetprompt
+
+
A builder to create a MaterialTapTargetPrompt instance.
+
+
MaterialTapTargetPrompt.PromptStateChangeListener - Interface in uk.co.samuelwall.materialtaptargetprompt
+
+
Interface definition for a callback to be invoked when a prompts state changes.
+
+
MaterialTapTargetSequence - Class in uk.co.samuelwall.materialtaptargetprompt
+
+
A Sequence of prompts to be shown one after another
+
+
MaterialTapTargetSequence() - Constructor for class uk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetSequence
+
 
+
MaterialTapTargetSequence.SequenceCompleteListener - Interface in uk.co.samuelwall.materialtaptargetprompt
+
+
Interface definition for a callback to be invoked when a sequence completes.
+
+
mBaseRippleAlpha - Variable in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptFocal
+
+
The alpha value for the ripple.
+
+
mDrawRipple - Variable in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptFocal
+
+
Should the ripple be drawn.
+
+
+

O

+
+
obtainStyledAttributes(int, int[]) - Method in class uk.co.samuelwall.materialtaptargetprompt.ActivityResourceFinder
+
 
+
obtainStyledAttributes(int, int[]) - Method in interface uk.co.samuelwall.materialtaptargetprompt.ResourceFinder
+
+
Retrieve styled attribute information in ResourceFinder.getContext() theme.
+
+
obtainStyledAttributes(int, int[]) - Method in class uk.co.samuelwall.materialtaptargetprompt.SupportFragmentResourceFinder
+
 
+
onExtraPromptStateChanged(MaterialTapTargetPrompt, int) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
+
+
Handles emitting the additional prompt state changed events.
+
+
onItemComplete() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.sequence.SequenceItem
+
+
Emits the MaterialTapTargetSequence.SequenceCompleteListener.onSequenceComplete() event if the listener + is set.
+
+
onPromptStateChanged(int) - Method in class uk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetPrompt
+
+
Handles emitting the prompt state changed events.
+
+
onPromptStateChanged(MaterialTapTargetPrompt, int) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
+
+
Handles emitting the prompt state changed events.
+
+
onPromptStateChanged(MaterialTapTargetPrompt, int) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.sequence.SequenceItem
+
 
+
onPromptStateChanged(MaterialTapTargetPrompt, int) - Method in interface uk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetPrompt.PromptStateChangeListener
+
+
Called when the prompts state changes.
+
+
onSequenceComplete() - Method in interface uk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetSequence.SequenceCompleteListener
+
+
Called after the final prompt is closed
+
+
+

P

+
+
parseTintMode(int, PorterDuff.Mode) - Static method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptUtils
+
+
Based on parseTintMode in android appcompat v7 DrawableUtils, Copyright (C) 2014 The + Android Open Source Project.
+
+
prepare(PromptOptions, boolean, Rect) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds.CirclePromptBackground
+
 
+
prepare(PromptOptions, boolean, Rect) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds.FullscreenPromptBackground
+
 
+
prepare(PromptOptions, boolean, Rect) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds.RectanglePromptBackground
+
 
+
prepare(PromptOptions, boolean, Rect) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptBackground
+
+
Prepares the background for drawing.
+
+
prepare(PromptOptions, boolean, Rect) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptText
+
+
Recalculates the primary and secondary text positions.
+
+
prepare(PromptOptions, float, float) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.focals.CirclePromptFocal
+
 
+
prepare(PromptOptions, float, float) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.focals.RectanglePromptFocal
+
 
+
prepare(PromptOptions, float, float) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptFocal
+
+
Setup the focal ready for rendering when targeting a point on the screen, called prior to first render.
+
+
prepare(PromptOptions, View, int[]) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.focals.CirclePromptFocal
+
 
+
prepare(PromptOptions, View, int[]) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.focals.RectanglePromptFocal
+
 
+
prepare(PromptOptions, View, int[]) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptFocal
+
+
Setup the focal ready for rendering when targeting a view, called prior to first render.
+
+
PromptBackground - Class in uk.co.samuelwall.materialtaptargetprompt.extras
+
+
Used to render the prompt background.
+
+
PromptBackground() - Constructor for class uk.co.samuelwall.materialtaptargetprompt.extras.PromptBackground
+
 
+
PromptFocal - Class in uk.co.samuelwall.materialtaptargetprompt.extras
+
+
Used to render the prompt focal.
+
+
PromptFocal() - Constructor for class uk.co.samuelwall.materialtaptargetprompt.extras.PromptFocal
+
 
+
PromptOptions<T extends PromptOptions> - Class in uk.co.samuelwall.materialtaptargetprompt.extras
+
+
Contains all the settings for creating a prompt.
+
+
PromptOptions(ResourceFinder) - Constructor for class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
+
+
Constructor.
+
+
PromptText - Class in uk.co.samuelwall.materialtaptargetprompt.extras
+
 
+
PromptText() - Constructor for class uk.co.samuelwall.materialtaptargetprompt.extras.PromptText
+
 
+
PromptUtils - Class in uk.co.samuelwall.materialtaptargetprompt.extras
+
+
Useful methods for prompts that don't fit else where.
+
+
+

R

+
+
RectanglePromptBackground - Class in uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds
+
+
PromptBackground implementation that renders the prompt background as a rectangle.
+
+
RectanglePromptBackground() - Constructor for class uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds.RectanglePromptBackground
+
+
Constructor.
+
+
RectanglePromptFocal - Class in uk.co.samuelwall.materialtaptargetprompt.extras.focals
+
+
Prompt focal implementation to draw the focal as a rectangle.
+
+
RectanglePromptFocal() - Constructor for class uk.co.samuelwall.materialtaptargetprompt.extras.focals.RectanglePromptFocal
+
+
Constructor.
+
+
removeStateChanger(int) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.sequence.SequenceItem
+
+
Remove a specific state changer.
+
+
ResourceFinder - Interface in uk.co.samuelwall.materialtaptargetprompt
+
+
Interface used to find resources required by MaterialTapTargetPrompt.
+
+
+

S

+
+
scale(PointF, RectF, RectF, float, boolean) - Static method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptUtils
+
+
Scales a rectangle.
+
+
SequenceItem - Class in uk.co.samuelwall.materialtaptargetprompt.extras.sequence
+
+
Represents a prompt to display in a sequence.
+
+
SequenceItem(SequenceState) - Constructor for class uk.co.samuelwall.materialtaptargetprompt.extras.sequence.SequenceItem
+
+
Constructor.
+
+
SequenceItemShowFor - Class in uk.co.samuelwall.materialtaptargetprompt.extras.sequence
+
+
Shows a prompt in a sequence for the supplied milliseconds.
+
+
SequenceItemShowFor(SequenceState, long) - Constructor for class uk.co.samuelwall.materialtaptargetprompt.extras.sequence.SequenceItemShowFor
+
+
Constructor.
+
+
SequenceState - Class in uk.co.samuelwall.materialtaptargetprompt.extras.sequence
+
+
Stores a prompt for a SequenceItem in a sequence.
+
+
SequenceState(MaterialTapTargetPrompt) - Constructor for class uk.co.samuelwall.materialtaptargetprompt.extras.sequence.SequenceState
+
+
Constructor.
+
+
SequenceStatePromptOptions - Class in uk.co.samuelwall.materialtaptargetprompt.extras.sequence
+
+
A SequenceState where the prompt is created the first time that getPrompt() is + called.
+
+
SequenceStatePromptOptions(PromptOptions) - Constructor for class uk.co.samuelwall.materialtaptargetprompt.extras.sequence.SequenceStatePromptOptions
+
+
Constructor.
+
+
setAnimationInterpolator(Interpolator) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
+
+
Set the interpolator to use in animations.
+
+
setAutoDismiss(boolean) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
+
+
Set whether the prompt should dismiss itself when a touch event occurs outside the focal.
+
+
setAutoFinish(boolean) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
+
+
Set whether the prompt should finish itself when a touch event occurs inside the focal.
+
+
setBackButtonDismissEnabled(boolean) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
+
+
Back button can be used to dismiss the prompt.
+
+
setBackgroundColour(int) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
+
+
Set the background colour.
+
+
setCaptureTouchEventOnFocal(boolean) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
+
+
Set if the prompt should stop touch events on the focal point from passing to underlying + views.
+
+
setCaptureTouchEventOutsidePrompt(boolean) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
+
+
Set if the prompt should stop touch events outside the prompt from passing to underlying + views.
+
+
setClipToView(View) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
+
+
Set the view to clip the prompt to.
+
+
setColour(int) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds.CirclePromptBackground
+
 
+
setColour(int) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds.FullscreenPromptBackground
+
 
+
setColour(int) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds.RectanglePromptBackground
+
 
+
setColour(int) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.focals.CirclePromptFocal
+
 
+
setColour(int) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.focals.RectanglePromptFocal
+
 
+
setColour(int) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptBackground
+
+
Sets the colour to use for the background.
+
+
setColour(int) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptFocal
+
+
Set the focal colour.
+
+
setContentDescription(int) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
+
+
Set the accessibility content description text using the given resource id.
+
+
setContentDescription(String) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
+
+
Set the accessibility content description text to the given string
+
+
setCornerRadius(float, float) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds.FullscreenPromptBackground
+
+
Set the radius for the rectangle corners.
+
+
setCornerRadius(float, float) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds.RectanglePromptBackground
+
+
Set the radius for the rectangle corners.
+
+
setCornerRadius(float, float) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.focals.RectanglePromptFocal
+
+
Set the radius for the rectangle corners.
+
+
setDrawRipple(boolean) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptFocal
+
+
Sets whether the ripple is drawn around the focal.
+
+
setFocalColour(int) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
+
+
Set the focal point colour.
+
+
setFocalPadding(float) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
+
+
Set the padding between the text and the focal point.
+
+
setFocalPadding(int) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
+
+
Set the padding between the text and the focal point using the given resource id.
+
+
setFocalRadius(float) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
+
+
Set the focal point radius.
+
+
setFocalRadius(int) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
+
+
Set the focal point radius using the given resource id.
+
+
setIcon(int) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
+
+
Set the icon to draw in the focal point using the given resource id.
+
+
setIconDrawable(Drawable) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
+
+
Set the icon to draw in the focal point.
+
+
setIconDrawableColourFilter(int) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
+
+
Sets the colour to use to tint the icon drawable.
+
+
setIconDrawableTintList(ColorStateList) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
+
+
Applies a tint to the icon drawable
+
+
setIconDrawableTintMode(PorterDuff.Mode) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
+
+
Sets the PorterDuff mode to use to apply the tint.
+
+
setIdleAnimationEnabled(boolean) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
+
+
Enable/disable focal animation.
+
+
setMaxTextWidth(float) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
+
+
Set the max width that the primary and secondary text can be.
+
+
setMaxTextWidth(int) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
+
+
Set the max width that the primary and secondary text can be using the given resource + id.
+
+
setPrimaryText(int) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
+
+
Set the primary text using the given resource id.
+
+
setPrimaryText(CharSequence) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
+
+
Set the primary text to the given CharSequence.
+
+
setPrimaryText(String) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
+
+
Set the primary text to the given string
+
+
setPrimaryTextColour(int) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
+
+
Set the primary text colour.
+
+
setPrimaryTextGravity(int) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
+
+
Set the primary text horizontal layout gravity.
+
+
setPrimaryTextSize(float) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
+
+
Set the primary text font size.
+
+
setPrimaryTextSize(int) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
+
+
Set the primary text font size using the given resource id.
+
+
setPrimaryTextTypeface(Typeface) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
+
+
Sets the typeface and style used to display the primary text.
+
+
setPrimaryTextTypeface(Typeface, int) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
+
+
Sets the typeface used to display the primary text.
+
+
setPromptBackground(PromptBackground) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
+
+
Sets the renderer for the prompt background.
+
+
setPromptFocal(PromptFocal) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
+
+
Sets the renderer for the prompt focal.
+
+
setPromptStateChangeListener(MaterialTapTargetPrompt.PromptStateChangeListener) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
+
+
Set the listener to listen for when the prompt state changes.
+
+
setPromptText(PromptText) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
+
+
Set the PromptText implementation to use to render the prompt text.
+
+
setRadius(float) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.focals.CirclePromptFocal
+
+
Set the focal radius.
+
+
setRippleAlpha(int) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptFocal
+
+
Sets the alpha value to use for the ripple colour.
+
+
setSecondaryText(int) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
+
+
Set the secondary text using the given resource id.
+
+
setSecondaryText(CharSequence) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
+
+
Set the secondary text.
+
+
setSecondaryText(String) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
+
+
Set the secondary text.
+
+
setSecondaryTextColour(int) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
+
+
Set the secondary text colour.
+
+
setSecondaryTextGravity(int) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
+
+
Set the secondary text horizontal layout gravity.
+
+
setSecondaryTextSize(float) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
+
+
Set the secondary text font size.
+
+
setSecondaryTextSize(int) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
+
+
Set the secondary text font size using the give resource id.
+
+
setSecondaryTextTypeface(Typeface) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
+
+
Sets the typeface used to display the secondary text.
+
+
setSecondaryTextTypeface(Typeface, int) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
+
+
Sets the typeface and style used to display the secondary text.
+
+
setSequenceCompleteListener(MaterialTapTargetSequence.SequenceCompleteListener) - Method in class uk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetSequence
+
+
Set the listener to listen with the action to call when the sequence ends
+
+
setSequenceListener(MaterialTapTargetPrompt.PromptStateChangeListener) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
+
+
Set the internal listener to listen for when the prompt state changes.
+
+
setSequenceListener(MaterialTapTargetSequence.SequenceCompleteListener) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.sequence.SequenceItem
+
+
Set the listener for this sequence item completing.
+
+
setSize(PointF) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.focals.RectanglePromptFocal
+
+
Sets the focal to a fixed size.
+
+
setTarget(float, float) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
+
+
Set the centre point as a screen position
+
+
setTarget(int) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
+
+
Set the view for the prompt to focus on using the given resource id.
+
+
setTarget(View) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
+
+
Set the view for the prompt to focus on.
+
+
setTargetPadding(float) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.focals.RectanglePromptFocal
+
+
Set the padding between the target bounds and the rectangle edge.
+
+
setTargetRenderView(View) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
+
+
Change the view that is rendered as the target.
+
+
setTextGravity(int) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
+
+
Set the primary and secondary text horizontal layout gravity.
+
+
setTextPadding(float) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
+
+
Set the text left and right padding.
+
+
setTextPadding(int) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
+
+
Set the text left and right padding using the given resource id.
+
+
setTextSeparation(float) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
+
+
Set the distance between the primary and secondary text.
+
+
setTextSeparation(int) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
+
+
Set the distance between the primary and secondary text using the given resource id.
+
+
setTypeface(TextPaint, Typeface, int) - Static method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptUtils
+
+
Based on setTypeface in android TextView, Copyright (C) 2006 The Android Open Source + Project.
+
+
setTypefaceFromAttrs(String, int, int) - Static method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptUtils
+
+
Based on setTypefaceFromAttrs in android TextView, Copyright (C) 2006 The Android Open + Source Project.
+
+
show() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
+
+
Creates a MaterialTapTargetPrompt with the arguments supplied to this + builder and immediately displays the prompt.
+
+
show() - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.sequence.SequenceItem
+
+
Show this sequence item.
+
+
show() - Method in class uk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetPrompt
+
+
Displays the prompt.
+
+
show() - Method in class uk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetSequence
+
+
Start the sequence by showing the first prompt.
+
+
show(MaterialTapTargetPrompt) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.sequence.SequenceItem
+
+
Show the created prompt for this sequence item.
+
+
show(MaterialTapTargetPrompt) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.sequence.SequenceItemShowFor
+
 
+
showFor(long) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions
+
+
Creates a MaterialTapTargetPrompt with the arguments supplied to this + builder and immediately displays the prompt for the number of milliseconds supplied.
+
+
showFor(long) - Method in class uk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetPrompt
+
+
Displays the prompt for a maximum amount of time.
+
+
showFromIndex(int) - Method in class uk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetSequence
+
+
Shows or continues to show this sequence from the prompt at the index supplied.
+
+
size() - Method in class uk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetSequence
+
+
Get the number of prompts in this sequence.
+
+
STATE_BACK_BUTTON_PRESSED - Static variable in class uk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetPrompt
+
+
The prompt has been dismissed by the system back button being pressed.
+
+
STATE_DISMISSED - Static variable in class uk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetPrompt
+
+
The prompt has been removed from view after the prompt has either been pressed somewhere + other than the prompt target or the system back button has been pressed.
+
+
STATE_DISMISSING - Static variable in class uk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetPrompt
+
+
The MaterialTapTargetPrompt.dismiss() method has been called and the prompt is being removed from view.
+
+
STATE_FINISHED - Static variable in class uk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetPrompt
+
+
The prompt has been removed from view after the prompt has been pressed in the focal area.
+
+
STATE_FINISHING - Static variable in class uk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetPrompt
+
+
The MaterialTapTargetPrompt.finish() method has been called and the prompt is being removed from view.
+
+
STATE_FOCAL_PRESSED - Static variable in class uk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetPrompt
+
+
The prompt target has been pressed in the focal area.
+
+
STATE_NON_FOCAL_PRESSED - Static variable in class uk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetPrompt
+
+
The prompt has been pressed outside the focal area.
+
+
STATE_NOT_SHOWN - Static variable in class uk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetPrompt
+
+
Prompt has yet to be shown.
+
+
STATE_REVEALED - Static variable in class uk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetPrompt
+
+
Prompt reveal animation has finished and the prompt is displayed.
+
+
STATE_REVEALING - Static variable in class uk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetPrompt
+
+
Prompt is reveal animation is running.
+
+
STATE_SHOW_FOR_TIMEOUT - Static variable in class uk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetPrompt
+
+
The prompt has been dismissed by the show for timeout.
+
+
SupportFragmentResourceFinder - Class in uk.co.samuelwall.materialtaptargetprompt
+
+
ResourceFinder implementation for Fragment.
+
+
SupportFragmentResourceFinder(Fragment) - Constructor for class uk.co.samuelwall.materialtaptargetprompt.SupportFragmentResourceFinder
+
+
Constructor.
+
+
+

U

+
+
uk.co.samuelwall.materialtaptargetprompt - package uk.co.samuelwall.materialtaptargetprompt
+
 
+
uk.co.samuelwall.materialtaptargetprompt.extras - package uk.co.samuelwall.materialtaptargetprompt.extras
+
 
+
uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds - package uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds
+
 
+
uk.co.samuelwall.materialtaptargetprompt.extras.focals - package uk.co.samuelwall.materialtaptargetprompt.extras.focals
+
 
+
uk.co.samuelwall.materialtaptargetprompt.extras.sequence - package uk.co.samuelwall.materialtaptargetprompt.extras.sequence
+
 
+
update(PromptOptions, float, float) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds.CirclePromptBackground
+
 
+
update(PromptOptions, float, float) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds.FullscreenPromptBackground
+
 
+
update(PromptOptions, float, float) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds.RectanglePromptBackground
+
 
+
update(PromptOptions, float, float) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.focals.CirclePromptFocal
+
 
+
update(PromptOptions, float, float) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.focals.RectanglePromptFocal
+
 
+
update(PromptOptions, float, float) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptText
+
 
+
update(PromptOptions, float, float) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptBackground
+
+
Update the current prompt rendering state based on the prompt options and current reveal & alpha scales.
+
+
updateRipple(float, float) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.focals.CirclePromptFocal
+
 
+
updateRipple(float, float) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.focals.RectanglePromptFocal
+
 
+
updateRipple(float, float) - Method in class uk.co.samuelwall.materialtaptargetprompt.extras.PromptFocal
+
+
Update the ripple around the focal.
+
+
+A B C D F G I L M O P R S U 
All Classes|All Packages
+ +
+
+ + diff --git a/docs/javadoc/index.html b/docs/javadoc/index.html index 02d12003..73200069 100644 --- a/docs/javadoc/index.html +++ b/docs/javadoc/index.html @@ -1,75 +1,112 @@ - - - - - -material-tap-target-prompt 3.0.0 API - - - - - - - - - -<noscript> -<div>JavaScript is disabled on your browser.</div> -</noscript> -<h2>Frame Alert</h2> -<p>This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client. Link to <a href="overview-summary.html">Non-frame version</a>.</p> - - - + + + + + +Overview (material-tap-target-prompt 3.0.1 API) + + + + + + + + + + + + + +
+ +
+
+
+

material-tap-target-prompt 3.0.1 API

+
+ +
+ +
+
+ + diff --git a/docs/javadoc/jquery-ui.overrides.css b/docs/javadoc/jquery-ui.overrides.css new file mode 100644 index 00000000..a46bfe7e --- /dev/null +++ b/docs/javadoc/jquery-ui.overrides.css @@ -0,0 +1,34 @@ +/* + * Copyright (c) 2020, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. Oracle designates this + * particular file as subject to the "Classpath" exception as provided + * by Oracle in the LICENSE file that accompanied this code. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + +.ui-state-active, +.ui-widget-content .ui-state-active, +.ui-widget-header .ui-state-active, +a.ui-button:active, +.ui-button:active, +.ui-button.ui-state-active:hover { + /* Overrides the color of selection used in jQuery UI */ + background: #F8981D; +} diff --git a/docs/javadoc/member-search-index.js b/docs/javadoc/member-search-index.js new file mode 100644 index 00000000..2d42e3fb --- /dev/null +++ b/docs/javadoc/member-search-index.js @@ -0,0 +1 @@ +memberSearchIndex = [{"p":"uk.co.samuelwall.materialtaptargetprompt","c":"ActivityResourceFinder","l":"ActivityResourceFinder(Activity)","u":"%3Cinit%3E(android.app.Activity)"},{"p":"uk.co.samuelwall.materialtaptargetprompt","c":"MaterialTapTargetSequence","l":"addPrompt(MaterialTapTargetPrompt)","u":"addPrompt(uk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetPrompt)"},{"p":"uk.co.samuelwall.materialtaptargetprompt","c":"MaterialTapTargetSequence","l":"addPrompt(MaterialTapTargetPrompt, long)","u":"addPrompt(uk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetPrompt,long)"},{"p":"uk.co.samuelwall.materialtaptargetprompt","c":"MaterialTapTargetSequence","l":"addPrompt(PromptOptions)","u":"addPrompt(uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions)"},{"p":"uk.co.samuelwall.materialtaptargetprompt","c":"MaterialTapTargetSequence","l":"addPrompt(PromptOptions, long)","u":"addPrompt(uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions,long)"},{"p":"uk.co.samuelwall.materialtaptargetprompt","c":"MaterialTapTargetSequence","l":"addPrompt(SequenceItem)","u":"addPrompt(uk.co.samuelwall.materialtaptargetprompt.extras.sequence.SequenceItem)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras.sequence","c":"SequenceItem","l":"addStateChanger(int)"},{"p":"uk.co.samuelwall.materialtaptargetprompt","c":"MaterialTapTargetPrompt.Builder","l":"Builder(Activity)","u":"%3Cinit%3E(android.app.Activity)"},{"p":"uk.co.samuelwall.materialtaptargetprompt","c":"MaterialTapTargetPrompt.Builder","l":"Builder(Activity, int)","u":"%3Cinit%3E(android.app.Activity,int)"},{"p":"uk.co.samuelwall.materialtaptargetprompt","c":"MaterialTapTargetPrompt.Builder","l":"Builder(Dialog)","u":"%3Cinit%3E(android.app.Dialog)"},{"p":"uk.co.samuelwall.materialtaptargetprompt","c":"MaterialTapTargetPrompt.Builder","l":"Builder(Dialog, int)","u":"%3Cinit%3E(android.app.Dialog,int)"},{"p":"uk.co.samuelwall.materialtaptargetprompt","c":"MaterialTapTargetPrompt.Builder","l":"Builder(DialogFragment)","u":"%3Cinit%3E(androidx.fragment.app.DialogFragment)"},{"p":"uk.co.samuelwall.materialtaptargetprompt","c":"MaterialTapTargetPrompt.Builder","l":"Builder(DialogFragment, int)","u":"%3Cinit%3E(androidx.fragment.app.DialogFragment,int)"},{"p":"uk.co.samuelwall.materialtaptargetprompt","c":"MaterialTapTargetPrompt.Builder","l":"Builder(Fragment)","u":"%3Cinit%3E(androidx.fragment.app.Fragment)"},{"p":"uk.co.samuelwall.materialtaptargetprompt","c":"MaterialTapTargetPrompt.Builder","l":"Builder(Fragment, int)","u":"%3Cinit%3E(androidx.fragment.app.Fragment,int)"},{"p":"uk.co.samuelwall.materialtaptargetprompt","c":"MaterialTapTargetPrompt.Builder","l":"Builder(ResourceFinder, int)","u":"%3Cinit%3E(uk.co.samuelwall.materialtaptargetprompt.ResourceFinder,int)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptFocal","l":"calculateAngleEdgePoint(float, float)","u":"calculateAngleEdgePoint(float,float)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras.focals","c":"CirclePromptFocal","l":"calculateAngleEdgePoint(float, float)","u":"calculateAngleEdgePoint(float,float)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptUtils","l":"calculateMaxTextWidth(Layout)","u":"calculateMaxTextWidth(android.text.Layout)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptUtils","l":"calculateMaxWidth(float, Rect, int, float)","u":"calculateMaxWidth(float,android.graphics.Rect,int,float)"},{"p":"uk.co.samuelwall.materialtaptargetprompt","c":"MaterialTapTargetPrompt","l":"cancelShowForTimer()"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds","c":"CirclePromptBackground","l":"CirclePromptBackground()","u":"%3Cinit%3E()"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras.focals","c":"CirclePromptFocal","l":"CirclePromptFocal()","u":"%3Cinit%3E()"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras.sequence","c":"SequenceItem","l":"clearStateChangers()"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptBackground","l":"contains(float, float)","u":"contains(float,float)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptText","l":"contains(float, float)","u":"contains(float,float)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds","c":"CirclePromptBackground","l":"contains(float, float)","u":"contains(float,float)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds","c":"FullscreenPromptBackground","l":"contains(float, float)","u":"contains(float,float)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds","c":"RectanglePromptBackground","l":"contains(float, float)","u":"contains(float,float)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras.focals","c":"CirclePromptFocal","l":"contains(float, float)","u":"contains(float,float)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras.focals","c":"RectanglePromptFocal","l":"contains(float, float)","u":"contains(float,float)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptUtils","l":"containsInset(Rect, int, int, int)","u":"containsInset(android.graphics.Rect,int,int,int)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptOptions","l":"create()"},{"p":"uk.co.samuelwall.materialtaptargetprompt","c":"MaterialTapTargetPrompt","l":"createDefault(PromptOptions)","u":"createDefault(uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptUtils","l":"createStaticTextLayout(CharSequence, TextPaint, int, Layout.Alignment, float)","u":"createStaticTextLayout(java.lang.CharSequence,android.text.TextPaint,int,android.text.Layout.Alignment,float)"},{"p":"uk.co.samuelwall.materialtaptargetprompt","c":"DialogResourceFinder","l":"DialogResourceFinder(Dialog)","u":"%3Cinit%3E(android.app.Dialog)"},{"p":"uk.co.samuelwall.materialtaptargetprompt","c":"MaterialTapTargetPrompt","l":"dismiss()"},{"p":"uk.co.samuelwall.materialtaptargetprompt","c":"MaterialTapTargetSequence","l":"dismiss()"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras.sequence","c":"SequenceItem","l":"dismiss()"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptBackground","l":"draw(Canvas)","u":"draw(android.graphics.Canvas)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptText","l":"draw(Canvas)","u":"draw(android.graphics.Canvas)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds","c":"CirclePromptBackground","l":"draw(Canvas)","u":"draw(android.graphics.Canvas)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds","c":"FullscreenPromptBackground","l":"draw(Canvas)","u":"draw(android.graphics.Canvas)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds","c":"RectanglePromptBackground","l":"draw(Canvas)","u":"draw(android.graphics.Canvas)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras.focals","c":"CirclePromptFocal","l":"draw(Canvas)","u":"draw(android.graphics.Canvas)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras.focals","c":"RectanglePromptFocal","l":"draw(Canvas)","u":"draw(android.graphics.Canvas)"},{"p":"uk.co.samuelwall.materialtaptargetprompt","c":"ActivityResourceFinder","l":"findViewById(int)"},{"p":"uk.co.samuelwall.materialtaptargetprompt","c":"DialogResourceFinder","l":"findViewById(int)"},{"p":"uk.co.samuelwall.materialtaptargetprompt","c":"ResourceFinder","l":"findViewById(int)"},{"p":"uk.co.samuelwall.materialtaptargetprompt","c":"SupportFragmentResourceFinder","l":"findViewById(int)"},{"p":"uk.co.samuelwall.materialtaptargetprompt","c":"MaterialTapTargetPrompt","l":"finish()"},{"p":"uk.co.samuelwall.materialtaptargetprompt","c":"MaterialTapTargetSequence","l":"finish()"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras.sequence","c":"SequenceItem","l":"finish()"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds","c":"FullscreenPromptBackground","l":"FullscreenPromptBackground()","u":"%3Cinit%3E()"},{"p":"uk.co.samuelwall.materialtaptargetprompt","c":"MaterialTapTargetSequence","l":"get(int)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptOptions","l":"getAnimationInterpolator()"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptOptions","l":"getAutoDismiss()"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptOptions","l":"getAutoFinish()"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptOptions","l":"getBackButtonDismissEnabled()"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptOptions","l":"getBackgroundColour()"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptFocal","l":"getBounds()"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptText","l":"getBounds()"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras.focals","c":"CirclePromptFocal","l":"getBounds()"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras.focals","c":"RectanglePromptFocal","l":"getBounds()"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptOptions","l":"getCaptureTouchEventOnFocal()"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptOptions","l":"getCaptureTouchEventOutsidePrompt()"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptOptions","l":"getClipToView()"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptOptions","l":"getContentDescription()"},{"p":"uk.co.samuelwall.materialtaptargetprompt","c":"ActivityResourceFinder","l":"getContext()"},{"p":"uk.co.samuelwall.materialtaptargetprompt","c":"DialogResourceFinder","l":"getContext()"},{"p":"uk.co.samuelwall.materialtaptargetprompt","c":"ResourceFinder","l":"getContext()"},{"p":"uk.co.samuelwall.materialtaptargetprompt","c":"SupportFragmentResourceFinder","l":"getContext()"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds","c":"FullscreenPromptBackground","l":"getDisplayMetrics()"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds","c":"ImmersiveModeCompatPromptBackground","l":"getDisplayMetrics()"},{"p":"uk.co.samuelwall.materialtaptargetprompt","c":"ActivityResourceFinder","l":"getDrawable(int)"},{"p":"uk.co.samuelwall.materialtaptargetprompt","c":"ResourceFinder","l":"getDrawable(int)"},{"p":"uk.co.samuelwall.materialtaptargetprompt","c":"SupportFragmentResourceFinder","l":"getDrawable(int)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptOptions","l":"getFocalColour()"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptOptions","l":"getFocalPadding()"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptOptions","l":"getFocalRadius()"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptOptions","l":"getIconDrawable()"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptOptions","l":"getIdleAnimationEnabled()"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptOptions","l":"getMaxTextWidth()"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptFocal","l":"getPath()"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras.focals","c":"CirclePromptFocal","l":"getPath()"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras.focals","c":"RectanglePromptFocal","l":"getPath()"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptOptions","l":"getPrimaryText()"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptOptions","l":"getPrimaryTextColour()"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptOptions","l":"getPrimaryTextGravity()"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptOptions","l":"getPrimaryTextSize()"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptOptions","l":"getPrimaryTextTypeface()"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptOptions","l":"getPrimaryTextTypefaceStyle()"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras.sequence","c":"SequenceState","l":"getPrompt()"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras.sequence","c":"SequenceStatePromptOptions","l":"getPrompt()"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptOptions","l":"getPromptBackground()"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptOptions","l":"getPromptFocal()"},{"p":"uk.co.samuelwall.materialtaptargetprompt","c":"ActivityResourceFinder","l":"getPromptParentView()"},{"p":"uk.co.samuelwall.materialtaptargetprompt","c":"DialogResourceFinder","l":"getPromptParentView()"},{"p":"uk.co.samuelwall.materialtaptargetprompt","c":"ResourceFinder","l":"getPromptParentView()"},{"p":"uk.co.samuelwall.materialtaptargetprompt","c":"SupportFragmentResourceFinder","l":"getPromptParentView()"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptOptions","l":"getPromptText()"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptOptions","l":"getResourceFinder()"},{"p":"uk.co.samuelwall.materialtaptargetprompt","c":"ActivityResourceFinder","l":"getResources()"},{"p":"uk.co.samuelwall.materialtaptargetprompt","c":"ResourceFinder","l":"getResources()"},{"p":"uk.co.samuelwall.materialtaptargetprompt","c":"SupportFragmentResourceFinder","l":"getResources()"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptOptions","l":"getSecondaryText()"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptOptions","l":"getSecondaryTextColour()"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptOptions","l":"getSecondaryTextGravity()"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptOptions","l":"getSecondaryTextSize()"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptOptions","l":"getSecondaryTextTypeface()"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptOptions","l":"getSecondaryTextTypefaceStyle()"},{"p":"uk.co.samuelwall.materialtaptargetprompt","c":"MaterialTapTargetPrompt","l":"getState()"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras.sequence","c":"SequenceItem","l":"getState()"},{"p":"uk.co.samuelwall.materialtaptargetprompt","c":"ActivityResourceFinder","l":"getString(int)"},{"p":"uk.co.samuelwall.materialtaptargetprompt","c":"ResourceFinder","l":"getString(int)"},{"p":"uk.co.samuelwall.materialtaptargetprompt","c":"SupportFragmentResourceFinder","l":"getString(int)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptOptions","l":"getTargetPosition()"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptOptions","l":"getTargetRenderView()"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptOptions","l":"getTargetView()"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptUtils","l":"getTextAlignment(Resources, int, CharSequence)","u":"getTextAlignment(android.content.res.Resources,int,java.lang.CharSequence)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptOptions","l":"getTextPadding()"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptOptions","l":"getTextSeparation()"},{"p":"uk.co.samuelwall.materialtaptargetprompt","c":"ActivityResourceFinder","l":"getTheme()"},{"p":"uk.co.samuelwall.materialtaptargetprompt","c":"ResourceFinder","l":"getTheme()"},{"p":"uk.co.samuelwall.materialtaptargetprompt","c":"SupportFragmentResourceFinder","l":"getTheme()"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds","c":"ImmersiveModeCompatPromptBackground","l":"ImmersiveModeCompatPromptBackground(WindowManager)","u":"%3Cinit%3E(android.view.WindowManager)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptUtils","l":"isPointInCircle(float, float, PointF, float)","u":"isPointInCircle(float,float,android.graphics.PointF,float)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptUtils","l":"isRtlText(Layout, Resources)","u":"isRtlText(android.text.Layout,android.content.res.Resources)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptOptions","l":"isTargetSet()"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptOptions","l":"load(int)"},{"p":"uk.co.samuelwall.materialtaptargetprompt","c":"MaterialTapTargetSequence","l":"MaterialTapTargetSequence()","u":"%3Cinit%3E()"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptFocal","l":"mBaseRippleAlpha"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptFocal","l":"mDrawRipple"},{"p":"uk.co.samuelwall.materialtaptargetprompt","c":"ActivityResourceFinder","l":"obtainStyledAttributes(int, int[])","u":"obtainStyledAttributes(int,int[])"},{"p":"uk.co.samuelwall.materialtaptargetprompt","c":"ResourceFinder","l":"obtainStyledAttributes(int, int[])","u":"obtainStyledAttributes(int,int[])"},{"p":"uk.co.samuelwall.materialtaptargetprompt","c":"SupportFragmentResourceFinder","l":"obtainStyledAttributes(int, int[])","u":"obtainStyledAttributes(int,int[])"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptOptions","l":"onExtraPromptStateChanged(MaterialTapTargetPrompt, int)","u":"onExtraPromptStateChanged(uk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetPrompt,int)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras.sequence","c":"SequenceItem","l":"onItemComplete()"},{"p":"uk.co.samuelwall.materialtaptargetprompt","c":"MaterialTapTargetPrompt","l":"onPromptStateChanged(int)"},{"p":"uk.co.samuelwall.materialtaptargetprompt","c":"MaterialTapTargetPrompt.PromptStateChangeListener","l":"onPromptStateChanged(MaterialTapTargetPrompt, int)","u":"onPromptStateChanged(uk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetPrompt,int)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptOptions","l":"onPromptStateChanged(MaterialTapTargetPrompt, int)","u":"onPromptStateChanged(uk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetPrompt,int)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras.sequence","c":"SequenceItem","l":"onPromptStateChanged(MaterialTapTargetPrompt, int)","u":"onPromptStateChanged(uk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetPrompt,int)"},{"p":"uk.co.samuelwall.materialtaptargetprompt","c":"MaterialTapTargetSequence.SequenceCompleteListener","l":"onSequenceComplete()"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptUtils","l":"parseTintMode(int, PorterDuff.Mode)","u":"parseTintMode(int,android.graphics.PorterDuff.Mode)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptBackground","l":"prepare(PromptOptions, boolean, Rect)","u":"prepare(uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions,boolean,android.graphics.Rect)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptText","l":"prepare(PromptOptions, boolean, Rect)","u":"prepare(uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions,boolean,android.graphics.Rect)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds","c":"CirclePromptBackground","l":"prepare(PromptOptions, boolean, Rect)","u":"prepare(uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions,boolean,android.graphics.Rect)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds","c":"FullscreenPromptBackground","l":"prepare(PromptOptions, boolean, Rect)","u":"prepare(uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions,boolean,android.graphics.Rect)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds","c":"RectanglePromptBackground","l":"prepare(PromptOptions, boolean, Rect)","u":"prepare(uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions,boolean,android.graphics.Rect)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptFocal","l":"prepare(PromptOptions, float, float)","u":"prepare(uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions,float,float)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras.focals","c":"CirclePromptFocal","l":"prepare(PromptOptions, float, float)","u":"prepare(uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions,float,float)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras.focals","c":"RectanglePromptFocal","l":"prepare(PromptOptions, float, float)","u":"prepare(uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions,float,float)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptFocal","l":"prepare(PromptOptions, View, int[])","u":"prepare(uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions,android.view.View,int[])"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras.focals","c":"CirclePromptFocal","l":"prepare(PromptOptions, View, int[])","u":"prepare(uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions,android.view.View,int[])"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras.focals","c":"RectanglePromptFocal","l":"prepare(PromptOptions, View, int[])","u":"prepare(uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions,android.view.View,int[])"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptBackground","l":"PromptBackground()","u":"%3Cinit%3E()"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptFocal","l":"PromptFocal()","u":"%3Cinit%3E()"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptOptions","l":"PromptOptions(ResourceFinder)","u":"%3Cinit%3E(uk.co.samuelwall.materialtaptargetprompt.ResourceFinder)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptText","l":"PromptText()","u":"%3Cinit%3E()"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds","c":"RectanglePromptBackground","l":"RectanglePromptBackground()","u":"%3Cinit%3E()"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras.focals","c":"RectanglePromptFocal","l":"RectanglePromptFocal()","u":"%3Cinit%3E()"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras.sequence","c":"SequenceItem","l":"removeStateChanger(int)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptUtils","l":"scale(PointF, RectF, RectF, float, boolean)","u":"scale(android.graphics.PointF,android.graphics.RectF,android.graphics.RectF,float,boolean)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras.sequence","c":"SequenceItem","l":"SequenceItem(SequenceState)","u":"%3Cinit%3E(uk.co.samuelwall.materialtaptargetprompt.extras.sequence.SequenceState)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras.sequence","c":"SequenceItemShowFor","l":"SequenceItemShowFor(SequenceState, long)","u":"%3Cinit%3E(uk.co.samuelwall.materialtaptargetprompt.extras.sequence.SequenceState,long)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras.sequence","c":"SequenceState","l":"SequenceState(MaterialTapTargetPrompt)","u":"%3Cinit%3E(uk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetPrompt)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras.sequence","c":"SequenceStatePromptOptions","l":"SequenceStatePromptOptions(PromptOptions)","u":"%3Cinit%3E(uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptOptions","l":"setAnimationInterpolator(Interpolator)","u":"setAnimationInterpolator(android.view.animation.Interpolator)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptOptions","l":"setAutoDismiss(boolean)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptOptions","l":"setAutoFinish(boolean)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptOptions","l":"setBackButtonDismissEnabled(boolean)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptOptions","l":"setBackgroundColour(int)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptOptions","l":"setCaptureTouchEventOnFocal(boolean)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptOptions","l":"setCaptureTouchEventOutsidePrompt(boolean)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptOptions","l":"setClipToView(View)","u":"setClipToView(android.view.View)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptBackground","l":"setColour(int)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptFocal","l":"setColour(int)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds","c":"CirclePromptBackground","l":"setColour(int)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds","c":"FullscreenPromptBackground","l":"setColour(int)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds","c":"RectanglePromptBackground","l":"setColour(int)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras.focals","c":"CirclePromptFocal","l":"setColour(int)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras.focals","c":"RectanglePromptFocal","l":"setColour(int)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptOptions","l":"setContentDescription(int)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptOptions","l":"setContentDescription(String)","u":"setContentDescription(java.lang.String)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds","c":"FullscreenPromptBackground","l":"setCornerRadius(float, float)","u":"setCornerRadius(float,float)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds","c":"RectanglePromptBackground","l":"setCornerRadius(float, float)","u":"setCornerRadius(float,float)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras.focals","c":"RectanglePromptFocal","l":"setCornerRadius(float, float)","u":"setCornerRadius(float,float)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptFocal","l":"setDrawRipple(boolean)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptOptions","l":"setFocalColour(int)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptOptions","l":"setFocalPadding(float)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptOptions","l":"setFocalPadding(int)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptOptions","l":"setFocalRadius(float)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptOptions","l":"setFocalRadius(int)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptOptions","l":"setIcon(int)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptOptions","l":"setIconDrawable(Drawable)","u":"setIconDrawable(android.graphics.drawable.Drawable)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptOptions","l":"setIconDrawableColourFilter(int)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptOptions","l":"setIconDrawableTintList(ColorStateList)","u":"setIconDrawableTintList(android.content.res.ColorStateList)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptOptions","l":"setIconDrawableTintMode(PorterDuff.Mode)","u":"setIconDrawableTintMode(android.graphics.PorterDuff.Mode)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptOptions","l":"setIdleAnimationEnabled(boolean)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptOptions","l":"setMaxTextWidth(float)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptOptions","l":"setMaxTextWidth(int)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptOptions","l":"setPrimaryText(CharSequence)","u":"setPrimaryText(java.lang.CharSequence)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptOptions","l":"setPrimaryText(int)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptOptions","l":"setPrimaryText(String)","u":"setPrimaryText(java.lang.String)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptOptions","l":"setPrimaryTextColour(int)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptOptions","l":"setPrimaryTextGravity(int)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptOptions","l":"setPrimaryTextSize(float)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptOptions","l":"setPrimaryTextSize(int)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptOptions","l":"setPrimaryTextTypeface(Typeface)","u":"setPrimaryTextTypeface(android.graphics.Typeface)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptOptions","l":"setPrimaryTextTypeface(Typeface, int)","u":"setPrimaryTextTypeface(android.graphics.Typeface,int)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptOptions","l":"setPromptBackground(PromptBackground)","u":"setPromptBackground(uk.co.samuelwall.materialtaptargetprompt.extras.PromptBackground)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptOptions","l":"setPromptFocal(PromptFocal)","u":"setPromptFocal(uk.co.samuelwall.materialtaptargetprompt.extras.PromptFocal)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptOptions","l":"setPromptStateChangeListener(MaterialTapTargetPrompt.PromptStateChangeListener)","u":"setPromptStateChangeListener(uk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetPrompt.PromptStateChangeListener)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptOptions","l":"setPromptText(PromptText)","u":"setPromptText(uk.co.samuelwall.materialtaptargetprompt.extras.PromptText)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras.focals","c":"CirclePromptFocal","l":"setRadius(float)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptFocal","l":"setRippleAlpha(int)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptOptions","l":"setSecondaryText(CharSequence)","u":"setSecondaryText(java.lang.CharSequence)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptOptions","l":"setSecondaryText(int)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptOptions","l":"setSecondaryText(String)","u":"setSecondaryText(java.lang.String)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptOptions","l":"setSecondaryTextColour(int)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptOptions","l":"setSecondaryTextGravity(int)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptOptions","l":"setSecondaryTextSize(float)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptOptions","l":"setSecondaryTextSize(int)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptOptions","l":"setSecondaryTextTypeface(Typeface)","u":"setSecondaryTextTypeface(android.graphics.Typeface)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptOptions","l":"setSecondaryTextTypeface(Typeface, int)","u":"setSecondaryTextTypeface(android.graphics.Typeface,int)"},{"p":"uk.co.samuelwall.materialtaptargetprompt","c":"MaterialTapTargetSequence","l":"setSequenceCompleteListener(MaterialTapTargetSequence.SequenceCompleteListener)","u":"setSequenceCompleteListener(uk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetSequence.SequenceCompleteListener)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptOptions","l":"setSequenceListener(MaterialTapTargetPrompt.PromptStateChangeListener)","u":"setSequenceListener(uk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetPrompt.PromptStateChangeListener)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras.sequence","c":"SequenceItem","l":"setSequenceListener(MaterialTapTargetSequence.SequenceCompleteListener)","u":"setSequenceListener(uk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetSequence.SequenceCompleteListener)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras.focals","c":"RectanglePromptFocal","l":"setSize(PointF)","u":"setSize(android.graphics.PointF)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptOptions","l":"setTarget(float, float)","u":"setTarget(float,float)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptOptions","l":"setTarget(int)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptOptions","l":"setTarget(View)","u":"setTarget(android.view.View)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras.focals","c":"RectanglePromptFocal","l":"setTargetPadding(float)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptOptions","l":"setTargetRenderView(View)","u":"setTargetRenderView(android.view.View)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptOptions","l":"setTextGravity(int)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptOptions","l":"setTextPadding(float)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptOptions","l":"setTextPadding(int)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptOptions","l":"setTextSeparation(float)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptOptions","l":"setTextSeparation(int)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptUtils","l":"setTypeface(TextPaint, Typeface, int)","u":"setTypeface(android.text.TextPaint,android.graphics.Typeface,int)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptUtils","l":"setTypefaceFromAttrs(String, int, int)","u":"setTypefaceFromAttrs(java.lang.String,int,int)"},{"p":"uk.co.samuelwall.materialtaptargetprompt","c":"MaterialTapTargetPrompt","l":"show()"},{"p":"uk.co.samuelwall.materialtaptargetprompt","c":"MaterialTapTargetSequence","l":"show()"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptOptions","l":"show()"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras.sequence","c":"SequenceItem","l":"show()"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras.sequence","c":"SequenceItem","l":"show(MaterialTapTargetPrompt)","u":"show(uk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetPrompt)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras.sequence","c":"SequenceItemShowFor","l":"show(MaterialTapTargetPrompt)","u":"show(uk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetPrompt)"},{"p":"uk.co.samuelwall.materialtaptargetprompt","c":"MaterialTapTargetPrompt","l":"showFor(long)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptOptions","l":"showFor(long)"},{"p":"uk.co.samuelwall.materialtaptargetprompt","c":"MaterialTapTargetSequence","l":"showFromIndex(int)"},{"p":"uk.co.samuelwall.materialtaptargetprompt","c":"MaterialTapTargetSequence","l":"size()"},{"p":"uk.co.samuelwall.materialtaptargetprompt","c":"MaterialTapTargetPrompt","l":"STATE_BACK_BUTTON_PRESSED"},{"p":"uk.co.samuelwall.materialtaptargetprompt","c":"MaterialTapTargetPrompt","l":"STATE_DISMISSED"},{"p":"uk.co.samuelwall.materialtaptargetprompt","c":"MaterialTapTargetPrompt","l":"STATE_DISMISSING"},{"p":"uk.co.samuelwall.materialtaptargetprompt","c":"MaterialTapTargetPrompt","l":"STATE_FINISHED"},{"p":"uk.co.samuelwall.materialtaptargetprompt","c":"MaterialTapTargetPrompt","l":"STATE_FINISHING"},{"p":"uk.co.samuelwall.materialtaptargetprompt","c":"MaterialTapTargetPrompt","l":"STATE_FOCAL_PRESSED"},{"p":"uk.co.samuelwall.materialtaptargetprompt","c":"MaterialTapTargetPrompt","l":"STATE_NON_FOCAL_PRESSED"},{"p":"uk.co.samuelwall.materialtaptargetprompt","c":"MaterialTapTargetPrompt","l":"STATE_NOT_SHOWN"},{"p":"uk.co.samuelwall.materialtaptargetprompt","c":"MaterialTapTargetPrompt","l":"STATE_REVEALED"},{"p":"uk.co.samuelwall.materialtaptargetprompt","c":"MaterialTapTargetPrompt","l":"STATE_REVEALING"},{"p":"uk.co.samuelwall.materialtaptargetprompt","c":"MaterialTapTargetPrompt","l":"STATE_SHOW_FOR_TIMEOUT"},{"p":"uk.co.samuelwall.materialtaptargetprompt","c":"SupportFragmentResourceFinder","l":"SupportFragmentResourceFinder(Fragment)","u":"%3Cinit%3E(androidx.fragment.app.Fragment)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptBackground","l":"update(PromptOptions, float, float)","u":"update(uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions,float,float)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptText","l":"update(PromptOptions, float, float)","u":"update(uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions,float,float)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds","c":"CirclePromptBackground","l":"update(PromptOptions, float, float)","u":"update(uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions,float,float)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds","c":"FullscreenPromptBackground","l":"update(PromptOptions, float, float)","u":"update(uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions,float,float)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds","c":"RectanglePromptBackground","l":"update(PromptOptions, float, float)","u":"update(uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions,float,float)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras.focals","c":"CirclePromptFocal","l":"update(PromptOptions, float, float)","u":"update(uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions,float,float)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras.focals","c":"RectanglePromptFocal","l":"update(PromptOptions, float, float)","u":"update(uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions,float,float)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","c":"PromptFocal","l":"updateRipple(float, float)","u":"updateRipple(float,float)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras.focals","c":"CirclePromptFocal","l":"updateRipple(float, float)","u":"updateRipple(float,float)"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras.focals","c":"RectanglePromptFocal","l":"updateRipple(float, float)","u":"updateRipple(float,float)"}];updateSearchResults(); \ No newline at end of file diff --git a/docs/javadoc/module-search-index.js b/docs/javadoc/module-search-index.js new file mode 100644 index 00000000..0d59754f --- /dev/null +++ b/docs/javadoc/module-search-index.js @@ -0,0 +1 @@ +moduleSearchIndex = [];updateSearchResults(); \ No newline at end of file diff --git a/docs/javadoc/overview-frame.html b/docs/javadoc/overview-frame.html deleted file mode 100644 index d5d3c261..00000000 --- a/docs/javadoc/overview-frame.html +++ /dev/null @@ -1,25 +0,0 @@ - - - - - -Overview List (material-tap-target-prompt 3.0.0 API) - - - - - -
All Classes
-
-

Packages

- -
-

 

- - diff --git a/docs/javadoc/overview-summary.html b/docs/javadoc/overview-summary.html index ae2e9a6f..62c2d2ad 100644 --- a/docs/javadoc/overview-summary.html +++ b/docs/javadoc/overview-summary.html @@ -1,152 +1,25 @@ - - - - - -Overview (material-tap-target-prompt 3.0.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

material-tap-target-prompt 3.0.0 API

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Packages 
PackageDescription
uk.co.samuelwall.materialtaptargetprompt 
uk.co.samuelwall.materialtaptargetprompt.extras 
uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds 
uk.co.samuelwall.materialtaptargetprompt.extras.focals 
uk.co.samuelwall.materialtaptargetprompt.extras.sequence 
-
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- - - + + + + + +material-tap-target-prompt 3.0.1 API + + + + + + + + + +
+ +

index.html

+
+ + diff --git a/docs/javadoc/overview-tree.html b/docs/javadoc/overview-tree.html index c71372ff..66dac193 100644 --- a/docs/javadoc/overview-tree.html +++ b/docs/javadoc/overview-tree.html @@ -1,186 +1,146 @@ - - - - - -Class Hierarchy (material-tap-target-prompt 3.0.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Hierarchy For All Packages

-Package Hierarchies: - -
-
-

Class Hierarchy

- -

Interface Hierarchy

- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- - - + + + + + +Class Hierarchy (material-tap-target-prompt 3.0.1 API) + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For All Packages

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+
+

Interface Hierarchy

+ +
+
+ +
+
+ + diff --git a/docs/javadoc/package-search-index.js b/docs/javadoc/package-search-index.js new file mode 100644 index 00000000..08bc1273 --- /dev/null +++ b/docs/javadoc/package-search-index.js @@ -0,0 +1 @@ +packageSearchIndex = [{"l":"All Packages","u":"allpackages-index.html"},{"l":"uk.co.samuelwall.materialtaptargetprompt"},{"l":"uk.co.samuelwall.materialtaptargetprompt.extras"},{"l":"uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds"},{"l":"uk.co.samuelwall.materialtaptargetprompt.extras.focals"},{"l":"uk.co.samuelwall.materialtaptargetprompt.extras.sequence"}];updateSearchResults(); \ No newline at end of file diff --git a/docs/javadoc/resources/glass.png b/docs/javadoc/resources/glass.png new file mode 100644 index 0000000000000000000000000000000000000000..a7f591f467a1c0c949bbc510156a0c1afb860a6e GIT binary patch literal 499 zcmVJoRsvExf%rEN>jUL}qZ_~k#FbE+Q;{`;0FZwVNX2n-^JoI; zP;4#$8DIy*Yk-P>VN(DUKmPse7mx+ExD4O|;?E5D0Z5($mjO3`*anwQU^s{ZDK#Lz zj>~{qyaIx5K!t%=G&2IJNzg!ChRpyLkO7}Ry!QaotAHAMpbB3AF(}|_f!G-oI|uK6 z`id_dumai5K%C3Y$;tKS_iqMPHg<*|-@e`liWLAggVM!zAP#@l;=c>S03;{#04Z~5 zN_+ss=Yg6*hTr59mzMwZ@+l~q!+?ft!fF66AXT#wWavHt30bZWFCK%!BNk}LN?0Hg z1VF_nfs`Lm^DjYZ1(1uD0u4CSIr)XAaqW6IT{!St5~1{i=i}zAy76p%_|w8rh@@c0Axr!ns=D-X+|*sY6!@wacG9%)Qn*O zl0sa739kT-&_?#oVxXF6tOnqTD)cZ}2vi$`ZU8RLAlo8=_z#*P3xI~i!lEh+Pdu-L zx{d*wgjtXbnGX_Yf@Tc7Q3YhLhPvc8noGJs2DA~1DySiA&6V{5JzFt ojAY1KXm~va;tU{v7C?Xj0BHw!K;2aXV*mgE07*qoM6N<$f;4TDA^-pY literal 0 HcmV?d00001 diff --git a/docs/javadoc/script-dir/images/ui-bg_glass_55_fbf9ee_1x400.png b/docs/javadoc/script-dir/images/ui-bg_glass_55_fbf9ee_1x400.png new file mode 100644 index 0000000000000000000000000000000000000000..34abd18f32d3a55a297fdcf93409bd033ae573e7 GIT binary patch literal 335 zcmeAS@N?(olHy`uVBq!ia0vp^j6gI&fCnc6a#?2AmP!?*K(O3p^r= zfwTu0yPeFo12TF&T^vI^j=w#x$i?I+((tf;UXnmgbH|3oY>pC!)f}(GR!16S-u+#{ ze6YEqRkW=8vGl=5qArKM<9}TC-}iEvB{zdaTcX5$wyRTK&ALRXUCGx5b?-VBQkUm|IuXOmYJrBRJgj{Vx zMbNnqUkncy+qa2-mWYc>swkcIuvGK#>(0d)B7)5f`@$Ei28nH~0h*~=;u=wsl30>z zm0Xkxq!^403@vmGjdTsnLJUl-Obo4zO|=aStPBhe<(7X!(U6;;l9^VCTf=69^L{`L N44$rjF6*2UngDu&PXPb` literal 0 HcmV?d00001 diff --git a/docs/javadoc/script-dir/images/ui-bg_glass_75_e6e6e6_1x400.png b/docs/javadoc/script-dir/images/ui-bg_glass_75_e6e6e6_1x400.png new file mode 100644 index 0000000000000000000000000000000000000000..a90afb8bf8028404d206114965669b023dcb85ea GIT binary patch literal 262 zcmeAS@N?(olHy`uVBq!ia0vp^j6gI&0LWmFTHNUZq?nSt-Ch3w7g=q17Rci)@Q5r1 z(jH*!b~4)z#PD=+46!(!TrvH)L6@80)r*_cdCvDr%)6ghVL16=s@mbz7H!uRdGeDa z?kzLg)16i!f8fKx84s0>4hES%`s&m5HI1v5B^Uft7(lid2moiiX_$l+3hB+!{pPkNg5^ OVDNPHb6Mw<&;$T*0!_~V literal 0 HcmV?d00001 diff --git a/docs/javadoc/script-dir/images/ui-bg_glass_95_fef1ec_1x400.png b/docs/javadoc/script-dir/images/ui-bg_glass_95_fef1ec_1x400.png new file mode 100644 index 0000000000000000000000000000000000000000..dbe091f6dc036fc1dc11b005738e951e27a43f7a GIT binary patch literal 332 zcmeAS@N?(olHy`uVBq!ia0vp^j6gI&fCnc6a#?2AmP!?*K(O3p^r= zfwTu0yPeFo12VciT^vI^j=w#>k(V)1qW$CZ|6)SVV-&*#dav<$DMuV&n0Dbpw@aE%W-S*bfB&J`pw9sa4-R?IGW?p~6`>jMSP&M+u3 zY@9al)zrvpHlQu4C9V-ADTyViR>?)FK#IZ0z|cb1&`8(7EX2UX%EZvh*hJgFz{Ot{4q9c^pg%OaK6Yqo^RG1puHty#h|2KYM!0=6Ogw z8K9N2ybORL_{i$}QxC&U!O-)`D*V04jXJ#n04P`#Wh8ZcmyUA%?QMqxhsEu>DC;^~ z{8O8G!7ta)D{l)9O_iD5-A{FwUpb*$IVfjou`0AAQAiyPXs{~wzE|2cZ&-acSF5PE zECGBcRRVEnRHOae;6NyU=IDOFj1wfusG0S<3Q6l>z)~KZvoIliF0!*y?O)1|ko7+n z>+zd%4dS;8>iMJUMwP(40V}{-=QZ#}vlkKtjgT?gI8R3`s`{eg^A0iB|9C;N3jtvV z-Ng~;#kXO^6$qh)N`faRB-+@-bRYixX&v+7cZ47thp08jNs?kcf|lu#~em zp9vU17gB)u1qJ$;?70533PMsKum#Eq1WJ#2?+bZ7pACeTd>j>;rVp1okB*+jU>j7I z%j60+UbCER>?m`t-k_0UMwtLk6PNMY=f5dhQ8l$!D_vWBr7CGPcDXr`NYC0uXipIi(5RZ4R25t$~o-$U3fdSZ+t8-MmF==ihWU zps_B2WTuZJSqfEd1jJTJmIrBIIwGFP-`8)$-Iqppx}nZ^1vgyQ|l#q!hDI^2df&H%uZ~e0(cO7rqdczX@s)(9Eo-vb-MZ9T{=?X2emAalsxjR} zDp-RS7ef2fYsNm|W!_~xs+U7sTjX>);xAM$zqqaVh4|Euxo{YB$Ue0yH`R1%LS$R3 z_E+lO@6`C-O(hNK66x`)5glEd?{N3v6k%2iXu|DB7JlD_tIlHzQyL8|YqSl}2YGDC zVO=PpVE0uei+57#cSm-&mw%S6mdRjiXxq5W{LsvhSJ)azPC6$j8(XY|f^_Z&*1)W@ zy3m>x-39!zm0@c~zOZVs=NV_}R#gjtmK1&jPTBe7AFZ@zbRGz_6UwWLFcH!wR&|Kh zZORU;Y=?b=mQgrwQ7Jg5s`cWOAy<{^y4=~BY|8kNP41J6stuM$_oKMaSoT+r{gE=%vLbm}y-G-s!n*{3q^tC?7saRyDEHx#C%bDVlF- zT{dLhAcKm7_JHGWuM**1_IMVdiq^ z7D85%apck0)*q}ipK9LUem#)m&v^B|Widn`=US)y=oK{$PHqJfvPxXB01zn#HFdLP zQ&f?0$}kSU6DYm1#Q#-wfTbj=yH!1g2x|0WP2z>tuyO>41bFp+m<`<8K(}e{bVRRc z;_)`s&>3Igl%b}j4U`xH6cyED;w`@e*RvZRe2WjElbi=jJ?KR2PO|E4(J3bsCK3K3 zO01O90g8f8lG@TKjOF|Rq%J+HV&UYOoY19`zLkp~FG{YsK8Ir~X$|7*;yB&_zla!o zjYA=|t$atYh-F)y4Yz_vl#Mfhr7?c5+w!f^NDNI!Z?A?TFj8jfkyqH$zWRai4c9qe^hVZXz8Ua{_Qt*H|88x@P1f|(u2`*pny^DSvt z0cPlYpbVeN$&S_0igz=*jS?B}QmUqqvPHqKaAx2G>fO4YRa{E>XB6Xs(Qzm?KF6{) zH*UG(7f?FngNv=%+Zmde2NyXUJG!M`!A5Mki?MT(W9PZmXv@ zmep!=;N_2(YH&j9mbmVOT4-HZILhZTNTy1NuR|!sWu45-D4y_D0QqJt{zs;jlrvoW zMFI`6#{NR91Oga_$sPvQT2>*W zRIBmn5wo&P6T=9La7LKS#PfEKzLL;iMp+{1Q`z*5zFAs*0Ls&H`$&3{Kj4$V_i@Y3 zQ5#cDOZZXP4LiO`exN`(4@q9eQ8uV|2&zu8c<`IAi}X>xjQ2rZjo9+7c~B?p(#|;v zer1U!kvAG8TJgQf$Vb%&$$*?mTT^8q!mb=&j!S9)P#ih$wSndg2IQ$5(%D4r5YvN6 zSlmi#A+9~6hT+SJhfNn)&@?dH$60LL#zBHZW2#jikLi?i+d6FT_TdaEj!3q>= zs3B{;qsuhOi~=T+n7bcnD>mKC9SPia&sf-S6=bWBZ&k_0DVVff(=-5WLMn9=GM7-h zI0uf;xB8kYZb^lJ0n~JvuvK$V>}r19I>e+O66f|wPr+;wZh})Gw^&qqYZA}x4c57y`^h7)C>5Z1%3*cW z)cL6g#o{A8TI2pxi@_j)Q_eBD)Y1zWnK6FCJ*Vusx`G!m)?EOSA0act>OlBcw2kno znt+5a_hNxdJ!=)?x{qU|#3A*G_rm|KnYzPYV{szQS;o+Vc_nTJny7jnL?4}g| zq}9Rn^^$O}pD>4Wzz073HN<|S{OaO`3SdI%H!gr$kE|3cZg#S#ZmtN6jU!-W@kLCX2^KjZN_cvo3qAj2yCB?L16iZiG(a`(MHoh@NuA?dUdwAZsu^p~Uhti2ZH!rb9pRfx3K8kW z_?}^DSUvk!SkI1_Ny((_yDi!;g+*N#ElFI*hGVTo^~6evaow^^-a3wu+^vYErC)MU zEPyLe@#)2))oWu=PU`!)g^X7j-n;da0;cWGPIx}|{5}0&Gqw&mh_FTI_8yp+ZyIs# zi~~~V0>b733>{kC2`xluGp9ko+Syq=cLVEdK6dYbAnqPQpJ0yP1^$LT-{4Y$I*shl-3{@hbXlEaQ{OVJr6@vM$U7%VXui z69mW&G~@=wLkd6GC5LthA@FO8P^{E$HP}ph8}5s#;Fxy2?&9$ADS==?cc9DBgZ^BP z_DJ*8;w>hq(8u#n@8pPzhy{cF{4*+k-5}N1fZ&QXpqw@-WKbl7G-h<-fqQ5cUWgtZ ziPTTk*ivA(LV;7lZd*s>eSsM}+`^Lx#d$*#KPXr1pVrK0_^RM)uk}!!5L8>TO42Ru)kIb>l@A`(fi(etM0m#G<>kwwV~O zw(xaW6da4~#^(Y}PMxbp(iU(Th3CZf}3l^;h0r| z=MBo3m?-`p-VaQZT{78zLHSWNm32oJxoy&ks72t34^d!Gj8=dH+swRGn`d&6|j&n&PXLhwd zY?@dYT9b2uRt2;Fk>XXgPObcg`WLnv)u0L7*LN9TQ!dI4(B!mp9~}26atgA|Vl-1g zG1Mt)k?;6P4~*b9-+9z*fz4Xirg8k=gdS5xM_x#bV2|fmb8UMyiN$jH6WDG-k&!?G z7St9U#R|{RkKRcgSQnjdIK`zJd)?yFvD(DPh5-hpASH|!dA=)}N`Sxzdd7x9cr;&x z0?>+V`+=QN8F#cdo=5>iLeFsFc?ywL+hR9-dzt%0?%k)DK`Q zQ)!Pt6Auj>-6d23k2rTJpgSt=6SoV46u@%xuQKC8?cPl+>*s=DEZVpN7$>q1boY5* zW0O0~;UO$-=GT`m&GNYD-B<_TuV1~NR7&M0g7vw8=6o*KiL1c-3(y&pYSCOg_bjc`cG%->f>UT`;z zd<`+z@DhiS8g3Ej`NeU079;}kV+@JEqw=S1M4S)vpZ>f#e9Sb7)?;J*jPQ$o%jcL( z9$^>WxCE2zM$4Kh%Eo-KYvU}3BuuOxw#eC!({l2D6&`xunIoF$i2=Gg0oOH^x|Al; ziE$^IzopsMH;7d|WB#*{?LS*KYZR`8vFpVXe0x7M7(cI?fu)Yy9Qf zJg5w2#h`;t_ksT~YSk0fp6bXA&oHh|`M_xKx|irpxo|F)x82hH58PF|R4t27)9cKqaDz~7a@Ub32?mq5-4r4x9%Iem7Lr&xv>xdzdT4a%LsTjG12W?qN^+ z@!iZ3G`0DLzjcvM4RBD?gd5nN<_J(I18CxC>BNi_)y31reLH!#llOMD_Bg16eH%Z+ zI@5tf6YFG76bE+OR-tMscC-@k{FJTg^1cx>`h^6`{VI4q?#JA4s=KcG>oiD^L_xi+ zB9fNx(}VD&&!0Vp)p;!Sq@biL&x|Y2nRO@szL>_T7f_d^t2f=H1rP6$*dNk9oAK?! zN8kT+^=Y)gvMi3OX~M4qet%`%xvxqm{V^J4{^~Hs3Q6-Ozj$q&l*nDAhHS?*SuBJT z>1JWh2gQ14CnBI6K5U@JQIZuh#0MSj4qreM_!q_$+5dMzf-WI`F#D0l6JQxO0w~nN zN+2rI*O$V^wBuB(e=TPm5fA@tIVG9)#Aa$#3gm`FIbATR^{iB-qf&ubqlbcZ1yjl| zD-G(`AB!|X{kCx~J&%J(tINbfI_uV-SBuuHe1`iI;+Fc-{}H>dI0Y8;hq-TLYGv#= zhtQaY6vT2bzz+NAc&43SvdjlIGFF&@ybK!Fw*HDu_i7fBlm1z0*!SY)u7<9ZY$O+TBqN|FN9Is93lc2hfxq9nTU-D+<)*)73G?0Tbyq-0-Cy$ptt z(t0Hr5qmTCUdNWnmw-k*AjEr&Our;Q8=j1&G=lNvQt&r`N(Za9h0Hi?xKemGQofjwQ6 zEfOUxr~hNrrOY=DeNV)MHAz2xVyBip17X`9g*GZTExdiraYcBBk4MP1N-uBUATzwL z(z076^l1D(WzqG?hXB;P+t~YZT{6!yRk<1RRh#?lrI~d^{5EioHD^r!QsGeT9$#Nb z=cJt4L(J8!Yu(LMHCXyUUA*XMAeb%To(5CqTah||6kx@DMr!X_#1p!dW0fQv&nulS zOv9Nvw>;;%zuZ&z>2W@Ns^9w*v8;KpQHLsLeN%B9pufo^@$Abp1*uxTLE-IYWFj2A zo?eRJCYJFH-lL(A0b6A2icAbemDxEoRkbBCSVS_#pQZc^@503DOu6mquJ*#i`7CSU zMLUE>+8QgcPYL34g1*$KkR6=qQRmqHEk5A1LG#i4S-PJ+D|g(Jh=NHlAfcI&rk`Bg_ySed@e8Hq&)UIEwY_S;&-MbLul^u<^-*}B?;p5!e6 z5#0kXU8Yj~oxOH^gOg$mH;Nk3ap)|~){hGPm0MolJMP^O6W{JFcGSzvT?l;Xk)@<@x=`k3Q*F8qv z;&cbNL}{uYIMz@oRd|#JJSZ&(jm~LzN~q&j#$eMOEX1PL&m{W^W+%XLYMki&Z$kJW z3%K>=u5Y0?M}#F))ibW!sD-!weE{?W7W#FTzQ-*BBc@RDU+x!dFQ4_as9bt?>+JL;8sTYo&@eAiY~+@<*P0<1~jO0P2;5hMtQ<13y0#*{n`AT zj!xOv50?u8TDy6x1^-ynNWte0LY)Htw>Vyb?a?C|D6~gIOy>lWpLKmbHtoGfBOUdN zNTcrHea*|K-6wfOB>G~L9QHlr^�_j6WK+Gj+xJRxVvl#lh7y-4uY);t)n47k4ot z9YsU`HVk7fg4;r{;)FHk7ZHyZJ+W|$aKwj=g&_$VCVFn5%XzSA`|z}+4ItZ|`hB}R z>h-6Be`d>nmv8;kQHJg!HMr^cCGG=T5;3HhZ_JRq0_4a3TsY7Pz{V+}z>;!R^U4*c zJ>wRI59B-)92Vi?b&EWvH(`<(G5A?W)z>EuDMG@VENAb7aHa`I#tKw{0uUc3(#J8& z*_S%A_ZxCIY385{%qN-b1K)TWmCjUA4nWKx_ZnKLSvEf0($&_0@DS~ zN8JOXJXXcaFm^OCYrz(R7N5DQkXKGnnt}yzfw^8s%=A?7hxza;ylJ;XQ&XtC`pM%b z6$5Ff0{(ALcSlTKvIbr@mR`0Z)*iM`2EfO|E5OMk$jQsE!^mat*drqV literal 0 HcmV?d00001 diff --git a/docs/javadoc/script-dir/images/ui-icons_2e83ff_256x240.png b/docs/javadoc/script-dir/images/ui-icons_2e83ff_256x240.png new file mode 100644 index 0000000000000000000000000000000000000000..1f5f49756ca64bd20a1048bd7a3a584457d4bf00 GIT binary patch literal 4549 zcmeHK2U8PFw@yL`geFZ|P@*V;w1D&)N-z*QNarO;QRz)l2oR(yU5bE$@JbZ~M4A){ zMUW<7Xc|gHkY1#>kc)mZ-`x8j?lU`k&hG3pXZP8eGv_=pHoVEqz{dap0GM^r+NJ;i z@XQ5l($k#H6S{hbXB#ZW`sOH!2L%N^&k_wk58Uw#*BX~{9Oe{(!2H)ZKd9X_X#oyfU5m#1Q82_f^tw6O11(<7c zWrG0%qDlJqcA8#ZrRU7cn@;N9VJUYHk^lTY3j(~2xv33^rM-YYTR?r#*8XSqkBCLbg&Z9G zp-dC_BuoqAkc7;MJ$9jCDbZN_FFIp=mvYI8l)OlkJ2GcKGFRh03>eyeeRF`W3VO-< zC@;;5k3f&*z5C#XoxT-q8o(%^R8K&f=k{8C{Y0uqmWi%PaU6jYo(5);yFd`Pn(!El z9h1vEhwlH1Q*|5X!lGvH`BD!7(^?OdAd$XP8=x~O{-Q}sy<2@T8`8IN;o*)L;K1*C zz~`x^5S%i=-8fHXQ{cyPiZj`|pV*e}T1g-QFmGBzZJ}z9t&~LL?-9yqp3x_EMw?h% zR0P^RfsG7yxX`l^uHgxl8V3PJTxM-b@>%bt-xEPCC)WNC4L*~?BL_6;e`XLVLVOkZ zaY1crUf;C9r#r|ebAHIp$KdM#$G60s#+4?*)mH)^4Rrn^&ZPOyOvZQO09veRcnbCX zWQc5fEAPmQd7=aqrZPBYAy;!Ph{cmfC@z-hpTuotqr$Mt? zY7woww1bOdZZNt7uHxGKm9$w8ozW}U!S8~V?{0A^bi{^$t00v7M zy;S7sm>vMCBz+=8TH~>zJ3!E9INJ1E6=!x^{;q9Biu$){2DGEIbB=oh!`QMCEx$ds$)Rc&7P*}`pd3{PqA}tIjp&y&{w{YrsPqhxaO4qerTDpM`WTlW5 zu*{F5ID98N%XU%ltVphxZ4Tra!)bpNih&)&Xx+d#q1{G`5icBuvTfv^7X{W}JXD*B z5!u=L*x{^0TXODlF@ziPt+=ars9OiJOv1hU4sSKFa z=)|j@+%OFH1Oa3f>ffz{O6~wHhDJrN4=)Y|I6DD)9CPw@Ytx6M2-O;{GQTQG&gg?A zr_VPJ&6+f^hXn|7pvwa+o;bXAc{n)lTn{~TF;3#>=AS1_iaGZheU=*xbHD8CUNUCj z^3&DKA#op+3tPQa@eK1RUg%D!n%5J4ICni7xELQIvd$Qz&+%!EZ!S{js)F!S5x>3O zLCB>-TbYHXS1?}__Xfm{r>(wAU3INPvHaWIIYbsxO^Oe0h0xglZWFakn6z+$6`V(< zSimFunLw;GdHMnWx=-GqPeuvo)l|sHaFJ~`DxMN)4Y7U!J8D=^MqeQn$`lS|1%mdN zK^morEND%3ee@_Yb<>IVIW2*6NZ^*QDg@w`H$3}uYsbleFidycDox+uzraGexRKEV z)Wd(JYU$(enZkGJ3{9REQOJppi6EBrWrXU;Ho*EGRUG&RC-ceTd@*C1J$c=Jk~Ty0 zAJE}+ZgP611Nw}-*K%$Od}R)=^6W|sl);faH`l2OA>=zFmy@8vVK$&%4OTWEhnx^< zs6V-c51bUMvJ@`4zcieGu?{L+ z6(ZMYhQND%M5s7uB)($Pv`1e&xPRDwWGD>e&;;;sA;yn_>F>rJH-M!+=wbl1_|+h6ttu(NB3r*FCdU;|1QOB?AGaVz-O zFMj-^FpfDR$apG zp!5Ji|53`FLrz-d>YnYEv6T0wDN8?-+$@_Nk-6nai){TtA=w&Qa=^woXbB~azV{PSFnB7zJF-k|zJbp8E$W1!v#tcX8%TiKFo-n7uCut-v(fLn$6ypSnrZ z$*S34s_(`S1jtESyVuI|{3uW2BhK-{jQp05>-^UGi}#K$%3bE8bM>i8<~MKu=Z4e! zh0A#tX_IOB39o+SdnJzu7<`KoCri$9{I*mr4A2uJr&$q1-r=Lzfussme7r{sQYl;m0a`a^hI)69ux681k(h4* zN9|Ywb^i7xF=uPVr*az7RYlVWPxhKmOE)Fgo>mlB<7pYaz6VsBW7J04%DxENck4rx zgM6#>hT78o;>S1Jt8MqV+4Jng1ERmSoX9dGIW`CC2VaF9CwL8-Bi|83mD2!Dee`Lm zCU-luuD>aLYJU7ZD?3R8tYYSVzoEVM_7n=hEcv1FN{h`Dk*ik1Q)z?ie^&}a1;86B!(s%}s%T_y4o&Ilh~d4DHn(86bo>p-*Ct4!-v)W$h1{J?4IrLKT@^?`26FF*@(2A4^@6og<7ngtWmIBVp>g{gwCG=1WX4srm*>E(6gC>!E~o-<{=AHg;~h zr)4{j`glAMBt_n{+%n8))~tNAyYCizc)D8wlZ8(Mn(svkWSi{A*vq>kCT}fIzl|Cn zy>PR|9cIRx;PBE5*-4+O?~_|$F<}5ur(2S|FAw=N&4pNnTk#=xhxAK3L=6a{X{DRocw%r8utUc^U?}*_ zr(y*T#U}{tCh=GT-ig;Dn~K`ilK*9stV#@EBAC9TOf4ugkA;~Nt2ej0?du%%-=F_m zz_LA$2jOO2Xk0r}zAZwZs7;VwA4S}3#)0t0SXSerLIo`;%;<|0ji~+vl}hOk9i+zx zUuZGWeo-DskUoPx=uJ)C!2Ep5@-PzwsF1^fj6kXJV!gU9L;{+5Gue#|!$uOssQo@K zR+uvJS*YTwuIPpVsz4PRkj93f17`97b|eBhl?7-Z9~n0f6EDor>foo2fPb$h4?A7> zT%r7x%5bpcUlV8+ByvZ7G1za^zhKiWJonD$xaS#k!hAE4p;QgaM*&tH)GI*HnxRE` zKM&1Lk7kAdR0w0M^qbP-LBil+NXKi;ihqCio{6=#|O(C$v0m`Z##4NXD+__-g z(_-U=I?+`IvcD6z77?Nw;fys4D9CFwg)Aldh6fQ?7N5`ui7^y6CC!+Es(Gr9qTHPK z-0ma)tFN+?V$ZP1e1t=yi(Zs8_S&zkh{hmaoulswfZ1Dqa1RNYC-25^Rm!I<>GW3k zjUOHLY78yVOfQ4@4mA&>xohn_3&n{JwbI7c3dEV^o%%0Fv=51+iH6T4?jF;IPPfqw zokxnwN5uxo9?XI&Sz@-f12P;WQ%GNbFK1CCdDhs}sVDCdBr~;?W)WZ)U0iw42JJnB z7i*tnrsnBMBpw^Ay}gobnSM$V#D;&2_@aql^X86vylX4gc?Y;m(y8v2NuB;;wJQoV^z3UpIO6adgOK|rh`I83cQ92vN z*nDrN5bxLa^N8pN&PPh7e;t?O#;^ACf0T)hr9bD^{p0K0aKs6fP=#ZL0@Q)?jH1G4 zmGhC&x$cBzQD~bW$K$+5{ylRuGYJ=lL0%_3KE(evW+WZI`zqmN3H0Yi?*N0(R64#J z>}+>eAmE{uko29IXjycIN3NS#IqY;9$u>caW?(bvKw+_ zgG{F`FVBpFDwJwR~R;O-V!9D+Lphp>2% zCAeJPdrp0I&;9O?nVzZYuAY9Td#2`@Ff|ofJRC|K004j|F9+2C0DzA}z%e%ZV=t5G zEb%Bnri!vqfK1uzM9#CcN_%;z#n=8gA#PS3;tcI;~uofXisxsK~{&;VR#1 z!o>>A2X%jk6mmfdq0-jyMN=cu0=VG)#_Jf_>&KuMX8ti@lH{h`>lhL}=z0k4IB519 z2z+_ZC;46kNd^v6LH`zyWz zc=pCDRd~N_<2su2s8&{(HU!aVC@&H;3-}=D4 zmn4&Xqtz|N;fr4ZX*`x)O>~I#fDAFWbF}%9b@c^V1-YMxSf6U)DQRkB+43Xqb9MFy zjo;f7Zl(+0@U{ZOZ-5LtI^A(gphls-(I>bAO%b)X0%Rr}JgWGZvD+JlsTxN^% zxJBLbH-$q!0L=#%jxX5Vq_FKJ<2w!*===-Y@qzQ*_ z&ov@B+(5Xb?{lf2ViA!OfgI3o#$9BtFq%%7KSq&MDxi7pySJYoi*Mo(W6r!DLSMQT z5R^D?yx*g7)k}}4ziwHEoWI5K%3hPst6voipJkIw?!%9N$K$TWC4VuQM9)7yVq;a$ z=Z;n#4~)-1561t|Pxey=Qu^0P2#JYboJR5co5Ktl*iAC2?$BN>JINDo_+7dptH4MZ z=#a=xrMtj%`CVN()`GKp3RFADpy$xF7~O&&p0-yeG=xW8uhj9Af`YV6uf@~_v;;D#h=*T)D!O`_6(IwY zIw^B!$W|O05eRI*b>Pe%GGlOW`<(mkpbS$G@7HEko`s{=g~2c4kqO2D{R_c$HXzr|(vU9~bVZ9Zw90;2AsK2ig}XTGY6fY#HgGpEaxY zO`D_Z@O8%f#^@5G;myQ5fA(JXK{rgcieDr!{s`~{nU%CRe=1;4og^%^Ts{A8>Sq8@ z7MLFuiJ9lh@TXEbSXQb0;l#nbg^u{Ky;vCuCLR537HT%5FxM^fs5pS1gq3J(Tf!*6 zAc~!aiCB8(;cEmBeX<`V&xqvsk92&%dsXd*G@M$W7!TVsoD%c%!p~lGHEz(ckd{tR z##JAyc1)YR0b@JW|HWX=EIHNMaui<>jUPal5F|-#l#?ar-oHSbCyZG*EuqOC?V5Iz zROd8mBy{ukJ_DuzLTBsPdF^WZ7NW}CWcww?Uwp))_brh+D#JdL%%G}bh zEbmg}yJc_xX1_|6iSomOV4IgTV&UNVe-P4B!*v}&@hLXe=h7%`bcW^Eta_BE?bf*&82)UKj^6nE@ zA$RoKncM;1&!nmY^=yjr6=wgBr%e9BXAxKh^0A1=&iQhn5mfUB$_1N5DJ-DZ4!pLCChW*MHin>-!AX+Twe_SsV%)n#? z9m<01Z}*b;{SU$Rd-`axfZ;y8#-Dau@wD~tukEo#I1b5JhkDp%r;hf2&TH29Y`$=G zCT=}&CU#_(G5)E0y~*>piG@IHnT&WP>Bef5eoMnuRP?tb7aFH_AYy@I!S34oD{g9j zt&5vt`pheqh=GvgZDzlqDuidT)11qC;R35@PC4Z4(p=SICoeHq+3uEqgbmq)}q|_NRzcOHv0J`WLpt+1=j?0A{<5%OLxd!f~^V zfofe-Y;s4+yganmBlRs9L-MCkb@HkcIGzakx6p52sHx;MA}LA_@xo(MP} zDc);OVH(SgwrVlgqy!Vb7cIqe8X$!ECB5e#-)15warssOnkR%x%-o>1T_T=}^z83m z>?c?Vcl|}zH)Gve#!UTymO66c$B^I*%B*@2y23hf5=?aCeBzz7EJe|b9Sex0(wO>7 zRb>P4peOZ<5iwK?l!Imu++&w7Syj6VQ7HaGhAd%tr!?^1W9BpDb9K6w6&K*5X?Mg{ zJ-9!QlR>z>DK+)226mPe<+h_rzFAHI!mzVV#GU?Fzw~_RoaIT4yg6y4BAsT`&lzDE zN8&hg3mPdVnZE*z(B&{cUCbdEZcwCc!M07oJQWk{gQd-> zr9dqLy@o0}77srWq=#f}hD*4;Wr{`XhNy3(QRG7u=})1~*VvvJg7)}?r}&$RlQwv$ zXdGV%bswf)=onk3jFfL;P++Q%v8Zx@HLpgdXD??Rgfd0J7%TheMo&G8Ri zY%xQ58GYjiumJ@R#%;;*4f6=Jqyt;B^WLz4)&y*MwAuEm);Ad)VfKQ8Sr0CY@t@~> zUQjgZ#QB*y&{~9gc(!{BsVt<##<@4;&)IsJD6YtQmo_p%?&3O=8)wZazJdioWa<4X zlrD5`HRzYUVx9XSHNrRMeJbsZXE$L%`CjK>#AvI+17q)*ws2o~m+2h|RXRpuvZ;D* zQY%WR`fzBy@JjoZU*XW8`Fqv?ZRVOCeS4``J028Q{72zS6OggtuOq;?NrF=gLU{T1 z2Ey5bAX2R!_@I`V<&n7vuSD$!&t^oE$C16?6i^2+oXgJEQ^GRtyq7y|3J zjS5W(iH2Od&+O~1mD#qt_V(U2`D~yWIe}Wmh)Pz z`3B*tPj%Q1@@njj!dC^nL67Y3HjBux!~dkMt88TTtEyZ&gy!?kq=hW3X+P_Vrv0a= zk$G`d4jR#UC3q&uVr_NfxeAI|1?9Qb7nKH>x*7HzWEl1J7=Vy~_xZtg^d+=;~q6HX~P<3!HF61g_w>7y^ge1>z>0>CJBlwhy*m zu^e%|FDE`Pg>^K2tw_~`;#;lt;kHE=dWx%}d@{Ep`+}fUYEkRY@7R4z^Gi3a z%p3!^U0{T-%L?kl_g;>HbVbT_)6tT-&YtzE=5CeyU1!c&e8r`X(rWY(&&Hn$;!z<3 z@ZD^M|7w69ux8!!$a=u3Jm9vMnxk@c@;-#Vi;?20XYrZU4{Zg*wkL!!)33(XXlz1R zYdSCxbAF4VGcc|P>jR^>ye$Fvd;}`W;VnrnsgUp09az2h?}6$Hh^S}<)Tc=<&3>*uCLEyR_hY_tr{or zrLSkS#T^|h1|_TSdo$fLueegLlN{0i)^=e2EtbySBh*?saAY}fWW_pZPj89qIdGQG zuxq;}FZf}T8*ZUnyil7Q8o@Dmf8dp6l_IDkJXm0=&ivCe1tvmX*|Y9)KZx>*u)cj!gV3~eOWE0KE$Vd(C$NowTz3Z#GR58MoW7U>(7WibQR7zU zr(M+U)R3#cCD?IbC3MmtR7?nlyi9(d)Z8dBwm5Yv#gE zH~5Y@zD>tVcGN_vSwLt5=jvf;p2JDnXQDL55iWH_(o7-&$C@w1ezEAGF`loMo{^9s z+qL-4cT!g|bS7(^aDM{#4CP=QsdpQhA-B3WQ@8x}1Z~5_L6>yv41-IOKT3S%nn6e5 zjJw+eepy<9mtX+LaCH|?5I*+c*Y9Mnr%8@i5vn4Hu@i=9XtWGol{AM#ixz~m!Q15N zdc*o)e1I~VccQpl$M!|<;DHX$F%un;kJwM!;3X{(+24sQz;UoP+D;pG5OrK;NSpRJ zAoo7h4z`5^2%$YZK@il;j!YY-k-Zk}e^u&AqL*9qyz-Oxo3!(5hwER%GJ1>eeJHnI(0ne%RzAyI5mDgG%|(-4~b=*CY8r|1uLy`6pa z`a`AqLvAMzmPMnOi;v!%;Z#k2RPeMo!UaOYtBz2^Z@;8%ZuCM|L0q-P*6`3fqiw^L zL3`*T0~C5-#Fy`zV$lw~_4mI6WLZS@zu$b)@(M16E0J%hHBZ=3P0gJyo*6+fXZ0|) zB~_}943 z?Lc#&-_51qs+HcN0==Y{;S2E*(c#J}TF1dOq>+oBq7^BO)gtN36`@RskHQ1S3iYcE zdr^>R{%$WSvX(kRE8=0x3WtG3iW!hA)a`Qss{lN*6S62fAT80qpF>~U0K*^ef>uYa zroXwa>=4bE(Me{aSAcQ#S=$1-=uQTg;;=5KvvH5q>2fiJX)f+RsBB9uXVi%6<=o_J z;Fb|nE-|%J+QxjX*FPtOMZ0yTw$HWu++eB$65&pLY_$8rd6A`F5DZM&a@ox>EyZF; zI35+4PUyZ(Fq1PdiWWylndF0L`Bi&mEFQ4%ig#h6sXl- zY}`wuiiW&n92*N#!?nXU?R|&(llg1N@n!AqFF{IZ&>!ujl|0-wU5gGY2E08{lSjF4 zt|sNhwGNVmJc`EVWEc7S%r0=*uWj19qAzg@1=s-H)o&Wz<Lli7-+}2Ha{kq=!XZ~pZc&+Q=0Cr|?#_d2wy>XJyrz^0!NJym zO7^0TjMo8~-}C35db!jXTrFn2nwOg2p{IJ)TMKtnrmOTK9*AKe0{j(&<)*eqt8N!v zpq|U58&sl=USB36p%G@>`5=>n9`TBDZ+p}y$w2uADdGxvcz^~D|-g+X6KZ?b`a6w%sL2=P|o1#BP})wq9P6^I;EBnI=7-f6T*2aKAh(r zXjh?;*}}bE?&sMes#m4`20olUS!0kmkhy2DS0V9I zOVfN+i{L@-)F3v$JA2t)D}TAUs6WZNKJ{$kx`%Omgx%I7Je24zhTUZh(V%L!aHijs zeCcMA`}iNqfj%Fu?+*QOj<}bl1LV*Ss@{fNU5=lL+RyR}X`nw|5$c(I=~X%=VUF8A zjt6XyO6Eiq%OTZ+GJkTSuKVD2LWrlV!?~tMbg?upc?2iFnnE_oJ8?xt5w%`pFE$TSofbGY9Nn%^00N{i~> z!<-d}5xbK}N##I0*iFO8_PIgdMSVO=^HewXRYhMjzGFhagblsyGGu2-wW7GZZ{ zQoU1S*zc%l7-^UdxP0GxT<1fpCrTSsH9D$z?_|R6 z_Vg7Qh~N<#KqCEj{{Z9*u}7$G?~LK>=6PI~v3uf)l@UJV^0t@wG+ak)aZ`yOwUxZ0 ziHYw>>qDBv?tyTN>lry=XZ*IuTz=$P-6wpGW>1{a66PVs?H#@p6~=_6dhZ zQ_C6oC7I*oSKm7UI^y|S@_%pNF_jc0z9XL9|03`HyXxpE1D3c|=~P-|F$QK4)n|(p zysic<{o^^p=+kD)6#_wCVnRh3{vm;FfO(3hp^DhdCadwzK8XzOBXkoPy^at}Pap*v zBU(QN-y|aejaOi@kWw<2H}EDHC;A&JKG2L*Bi1ZUvuMuO9`swC=#*((@P6()>?sWt zSXDf0QV4qoH^Tn-f32+A7sI%V8~ZP)1~6@8g`2`)UUIaRX&f=wzC8&T0D+%B;88ZL z&{X@v#(SwT20&G$4|rq^D~AiK(oG-XF=1UsB7s4^AE5^`5hh(e;#fOR%+1EhfO@H| z^%1^X;6oC2lZX7+_QP$!5C2yH7CdlD4a*frVc;CDYPb|XeSReoPs*JS;SMlZ9?j#N z08l}h{pNsNINt0bkR@G~?a{{%xO{8T{LwZ*OrlaiqT}-+i-P#Wt~zlIz^>o7J46EY zIKG)9Tbm%h6~Cx4ESc-WZhQQJVs@2z?`m%1Y5_5Gws;f(UNDa!Cs>G+hwmK^7{bc~ z5fI@3gCSrr6)-H~KMd?0&220_|EB?11i~u_5#axq0cs?h@X_G;KOQt4EnVGBoGk#7 j=8mQoFXZh_tSmGvOw2u<1}#J%l>qWGD$oikWB>mG5~xOM literal 0 HcmV?d00001 diff --git a/docs/javadoc/script-dir/images/ui-icons_888888_256x240.png b/docs/javadoc/script-dir/images/ui-icons_888888_256x240.png new file mode 100644 index 0000000000000000000000000000000000000000..ee5e33f27235d1b5cf0259f63f3894a6be33c679 GIT binary patch literal 6999 zcmZvBWmsH6vi9I^!4hPU5L^Zs2n2T@2=4Cg4nwd3lHdeFfC<5aTkx4cu%N-+2@Dnp z?w8&DzUSG!cYmByefref{ZyTr&!bfS=cPE{A_)M{_^Qau=myRos0#;zfZ>Q;mcGYRie@({fXRC!lf?(~P}uA5O=^WkN6w$E?Bk(QZ@d56yF zvzCin``<%De?$=3f{5%D%>3Rj1G6Iggn@+A<^UREK7ar#ZuV1uR{tmF0D1KqJXc{A z%xfM%w}%vYbcT&PdfJXWqe{@F-Trf1G!PdObSLjZ_+aq%)c>XFRvZg-spg=oj_&;fOm^QKjzig4q;#%o~svm01A0n%NG{&+6qNHCHpjv5-Fjdm&ppQW@gOQc^ZHpV-IqO+^k-I=s7UxRF z-R`7Yak0kmg&9$h1hga2of%GS5j?9PZP3G8 zY0qVzY1dmU>_646Aaqp@=~(-1S>H3%0EF{C8r?%6R{leTHmW}L4@byn3zD(w<~E9O z=Fn0y) zY}2L1AsRK!Z$gx%=12t}dqV5_&hRH<7OR=c;+t`wxrz(}MSDEjxp{*oahH%kyf6V` zAo0S<{8~I3yH)g{!uPj5<8J|IT@-Tc^VzIyi?Tzb@L}&FlF5%e%5=Qa7^9eVC$*`A z82?nDIx;)K2d}6&TMusbX4q*~w<0H@sgZGE!VEh_&x+dXmDx|3XGE*TVtenrF_d@& zOU1DjvGy|ES4oRGhn5;zFm!vDs_}%x318u~U0qSGUuPr#>uUIi_kw&J*SY-yYi=+Y zSWKOfJiwcNofx>;_vN4L2ROpKgvHuiY9Bx)xB^t%?MF zP?PQuootUA?J1D>+&m*iHdeItn?^Q2;v3DFgbnkz4*vq({R&KBB3%!cV5_LAc2V8- z%u0X{E5>%S@Xqv9^EGx&wLfk}FC%4`U@@CmaTcu!eHJ*GV~aaFP>(5pa6C#n46Fa{ zL)oQX4`ZT>4YUe>7xww~^l$y45w{tA^R6X5E9FWBI~%}{6KQ_uk5|hIXc^T%=0M0<<#BJ0RRd_O;3 zsb-D8O$U4S5BOLl_;#4cj;)2Hw;;O_e`}b{FVzp-3IL54{lXt|va~$t(hFS=qc!L) z-3e~P6-a%iT5Ri_Lr?B+gKG~s+?*f;UVI_B^JO>bs$O@!q-4u7(Ml7m|0^KP0oU)W zKGt(FB7jKjw2q%eJLKSlr6|R_MXbz$Lo%+mpGFNp){u);^4_8Q@dp# z(C`~#{#iw$hiaH|e>D#7J1QrG#1@WlsC!qB+e+0yo@4d=SpTXkr--hWpbISfyP>Mc zYi2kQBa1khy84P)({Me9RIes%E`2#p2KKd*kKN1Q%(M|Y>o1(dB7l}m6tl%M{_Fc- zlLA37rfpNZGi_--$j?kmH>Ao0CMGF~4OIuoyBJeGYckr{@11Tf=O-0{8O!w>=)vwA ztf$Cr5BLRwW%tqR@{BrIoS1n(hReKhl7J@GP8|Zf-XdoS7Rn{}qED97tGi<4k7H9*9qX~33TOxusi*f(HP z&viDOR1te?v8OHDy4Pj1M2(q+$ELZQcTaHtGdXfknhJ2j-5AvL%4v$HRh0~PBL4N+ za)Hyn-KMJqXLDdZLy3~% zQze#I%SMB6QK>s`t`$If5J3%(O9R7zZ9!7WBrhq&sWhXw*%Vp!4Eey}bMe=Y??HU! zb)us6SBE=Ax*ulxk;mrf0T*OMQ8$rfO}qtCpd_?icx1?f8OWKKSv<}E=@$orqgn0$ zf1W(L`+WxsKnJDXJt;lDGWz|}V={IGOp1qeHTB{e($_>WB^Is3CQpnzN7ku-vgWz# zEPgAYrzU=WLN!xAEIf0P`5LphqD6{EC&@YQbIF2r7miQFZ?-~Hd`Wt}`#V!iV{U@T zdV{*T(|fvYAr*(4T`JMaY;~#>68=#ibONi$`qx`kTV0TP^EbTPS{ZF$+S%_Ud)3DO zM466a+aQJA%vb%~h)VOdU8#yO3NRcJo-%(8GI=&pb|Rn3hh9^j9b=-8+s`SuQ&T#C zG`x0elQvoRIyHRm%}r*NmJCMWxu~l#gL1zt92X?FvBzCq(!TY=%}T(M`2fk%*IK;L zBXT~eU|)AqjR&~?Fz|X7o3)jQBygoIaU$uRnV2WVA*`hie6NFj{fSYR$tSf6-H=*d zdg}V*#wU?b6zPJx_?i*)^2ZdWsa5|LJ@!W|k<1z1=y^2{->z_u{ii?p@!+*1 z{h8i=ictpi5|yFmiDrcW;%N!e{dA-3vMkJ6wh__#hsHxo;NDM7S9sqrR*Ea%B8bay z%X~oeF6AiMIIttj{)0rXEtx0%X!)!~g*1q(y!4>GqHs<~ni<`37IN#`5Y=we;sV48 z0^j>rz6pk@HOv9#P1osT_@$Rqji)f6X1^9>Z_zAx7ZYa@{Y<|wF-ZqzZ;N3*tvyWUlgZae9C@OZ_LDT2H`F?q&u z!k&TYj{q-6?lkD3=IGZNqwuV3sEQZglk180ch%^iZfE(@dqorO^(^oR2@#VUjpZ92 z*us5g!F35st14zVf55PT_N3~({Bvd_NP8L)=`w+^BdtEgl=jgASgv%&x1HhxA5DJI zz6c)lWhxJ6F7wU9r|m)ug)F^-AVN@O;4qgQPN2i#$La#d(AxaQE-p)9WvV}$aZXJ# zz)-VGidtmqQHL?Egt@AMsbz!!2?#$6J>2Z_?vp(u*f1Jy86l;U1fr|I&^Aw>lTt-r z<)_$xVFFdc`nS+{OiM!u^4E2?nETPkyl1m2;|2$E+_PRAPnKYr_#g8`WNKaK4F7^` z?Ubvq{W1>s1^7Y{HItAy&8^_JgrpO%s=DZp4tZCbahEi+1%pC0#fCYEu7hL3$tZ50 zXuFu6Yp-chB5r{mj(GFKp_Ly^d~x}|agLYR8*{vMq*5frzoTSB4MIX`VXWcT5J(p$ zvb|v$4c?8v;T!4IdUfGv>>H^7+@>gzX^B|paL3B~Eke}ziUGpPQ}dIn03g4gRNJh8wrgjZppN344yAl%PT>?dXQfM#P!sRwL z;KMIu(ce?sUkiv?!Vy1m=vGTp^K>83Yjo?d$#<=t-KkL}_==YbTSL3tgWR6)-Ro8r zg>cv=%3Rb9yeFBfD78$8J*?6gjy>9c`q1R8Qn(CxX}XM8Mj^JBOyR>=?rRKQXO9*gvJyjfbJrs0U~2168KVOU;jdTE zc^Mh^)?{DY*$cO1{5f&&9Bm`e-;2K6o#q?)^0k*DB`UkBhVcdDfrep|D->3J#MJp+ zXY1nE?S}HFz60zQiVNOD@25Sa*0SK_@r3 zC(tKK+*fXb0BXgdWEt29pxJlcGHzY zJkOun3<4jbr>1T_TTE+(G2fT~#EBMFE0%pmldkXeM2*ccV3jW|Q1%;GkEKr2f0jK$5CC(%my!&suy}Ege*D+mwSTsfwKm{=38iPdckt95#-u`Gvf%NB z;Jh9Y$q!*z#v9yQDy~nPEHhs8Qkw?&{9op;3~$xMQ7^lQ+Vhi5nq!hLeB_uq=fV`i z!E)geaw+Zv{3e01>Ja?YPHdnFy?gNc=tt*_9!=`7Pxa?6vDx7m z-0>Iz7kq>(phWuFYjg~71xPKq{iPwgaFzo`h735{1u|PL&;op4?W}XU z*Zy62q5Zpw>NWW%j9#6bduP-Wx-U7vc>pnX^^HJeuMF)nYzFL z%R|OuztH2Mvi-7KmK*i^jJvfjk^KvfFB=8yB`>Tf2m;=skPWJI`bo3orf~30518bt<-Gc+ep2#?If-gL z;_V5G4bEA`J=zvwI~Q@$Og=!W8uwTmkeO|h{T!d3G}TRwN4S(@6%mj>r>tEd-;I6xK}CyHNR z`W}vjd36p~^P67IHm7n0WplM~-h0G4d(^lQdh*;f$GS9QH}m7A_@SjdB<{Q@lSpks z#9Z>MGSepD!)70Z0=($IJ>f|tC992?O1@XfyaXPp;h$rKrsx6fGn7zu0DK-m%11pb zGs9l*hMI>!-euGLyZpfz$09N2tK7I|b;S-_#kFUjE5M#v)sglMJH-hP9PYzL!(X=C z&l?pTPZ)^!L+CzJldxTEnRX$U#7DonI=OJLC|?k4#%1GNfv4AB1Wnw!xI3XLtci;D z>-ZQ7cE%tm1TrT|p*;#G65?!pEWW|rV?DJVanShnI9f(F!n8!3pJz=ASgeotHM#nQlcCth-Uv8eYLIFq|3 z$8;wJtnCMzOA2y}?03AoxqP{&<<^LHq+AC=(zuu(*k+;i3vxtnzWwUcSRvqT@9p9U z6B$%<@gcw_XUet5{BmU@iP+3ij=x_$z4QHD)k`HvNGXwccALGY(cnw0iuw^T!X3kM zCPp%7p}~l8b7j81O$PF3Yj&4)EbM@*agLVppE|pzn$sS(tEqN45aMSbu8N?*|P}v74M2!K~C@*$2i}SB=KKK-lw5%5K-;( zx7f;>L=##Ydm&d@RA~naR#0%3 z%Jt(5o)V(kBwAXNS$kQ*X>zg{Hz$*p)jQ~CPvPAOXWSlU?UV&`;kEB#yUYYnQYm~( zM{Wz^qIPF1>EY9Qm zs(bJSW9*o|Vh+{F4kmXlq<#GjIhTPKk38K-n5^lF$9s-<)ehAI3h7s(%ZAM}PxI~BVn6$b^R>=qIM4`F$ zHJIDKBpfOts&!OC?+vc@YFza+(}>X6gGd#)^)Y1hg_B@0JN)W{o&aj8uTC07^&Ms0 z+%4m=-h-4rU;#PK3cr=COqN7gJd2o&8|~IR-aaTjI5t4v;163AT%imiB9*B`OHKYd z7NM%=d}-LtFW0pp5c*3wNhme>^b+O=nYY9$&%s0Sj+J~*BL>Kh_`#Nl)sIOAZg z@t&kUUg#t5=ox78pG2wvT1_sF)`xJ~q{34riYgi$4F=znBeG~miClofeMJwEaUBJtDa?9tQBUX0F$_zoU8SmzfCfb$uMED{p)utjDJe)DYI z|CEyh*7Tn9ST3$vSa2?msDZYHy%xc@6F?0j`BW54t!2@(cVeLa`6Iqa(Vt=&R~pre z+kdK%&@j?q&W~Vtepw;nuBC_|N39bWl{VjCMLK`6Dg076ctt`Gz>vl+96WWc@{?M> zSc-4f6T=QQ^XGcPBDe*8N z6p)h91fy@X^D`W}r!QrGa69d*j; z0IVCMHC8T5WH;YpbB8+~JA^kzJs&&r?!uzKV&i7BhyG;ZzAYoGHQ!UkNW2O?$))({W;@58;aMHIOGn@%AJsy8Vz3^2q^tH9}wG*@PwtEx+0T9114@iWE zUr?7HBqqQw1{UQ4fy6){TD17Y{{Xmo*gDw<{W}08DkdN-1{V4k;A9w1`UrUTj~R44 r?0o~QyzKxowjS1Yj4Ezc4tB5YtZak42JFNil>jOVn(|e$mT&$CkHH7} literal 0 HcmV?d00001 diff --git a/docs/javadoc/script-dir/images/ui-icons_cd0a0a_256x240.png b/docs/javadoc/script-dir/images/ui-icons_cd0a0a_256x240.png new file mode 100644 index 0000000000000000000000000000000000000000..7e8ebc180a2d2a74739059799407b8b7b57a9092 GIT binary patch literal 4549 zcmeHK2U8PFw@yL`geFb85=9ZD1*F$df}vOGyaXvKy$K2df>fnT5l|3bse%xZCPhLK zq(s2bG?a)Sy-1T5a?x+*n|uGmeP(CR*`0mn>^?hl=A6f-#y6Q6_!s~H0J9!S#~c6v zp1FW6dYZF&QcwTzY=gzr&=N^tVEF&>Uj<|d!K-Hi*#?;#TL5@jZ-D7d+aKjhUB2ay za7XiT$P6-HQsvS@8Ne>u30;%65Ra9O$98#q8tPF*3bZzTz*N?kB)u+wBUmd+0T!5D z*<^r#Xj1>ZovB|~<30Q0ri+GeWcuAh#6Q2zf&gzD+|&Ui&|W~DEuelV+rTsX$43El z`#jYFfOD>TI+~UbzO6elx{w;!AbqIU%Q;US-y3k0y&ZS`{PXJ9%GKuT? zA=YB~_}-7h}grk~UMM~1{IJu5z36&nH&VPs=tlLlQ$TWf}@j0@_1Mr{7PN}kZ@ zU@9N%V%HL9eSE z*BdLzdW%d9Pf1SA5`lAsx?6C@pGL*pIra&^83Gx%WYG^8aT%R?OG4Ou=0P3R5)KZ5 z2&PGFszDp$u%zsXBYLrEImJ}xFS--_mkY=#l)@OKCnEoMOo8S*eqcoB^(_J&4tmM< zs4&xp4^NNgy&HVP!O(^_6JQclp)V-Ib9=q9aWcaz*Gx~fED_HM%LFsYU%*S)OnQwc zjLYYoLk)hxsCi6qp^!9HRp8G%b|f68yfB?n<^DBz9!E*WgJ2gV*g5_E7alHp*g2_wbc8Pw7*-B9ToxV53c2rO-Vs4Px{7M!NqIXUcMSHv1cqfD&&RnMQs) z8771gCX+j09M{&*+~vB&SSU^b{}8I6?+$$T9I*OL*{LYxAHX;*iW?dX43jc> zp~TZQLjbC#e#FPvV$ou|K+q=`%KR&iGq0m)&%Qcc{(18s?cH)B<=dn&oKq#&CVm$KVlo#Io;OGBX$ckfqw0sl%9n2giktQ~NFXr`I; z@h650el?%I!6y~!d;+G2vdswoOkzni?&A=OT9T`SipWyQFEyIunl_G*e?HE^ zx7hkb*WF(Q-{^pB`|k8FH76TXH6UL4I}2h>bLnbqDDskSJx^zYBqL{y$Sn($8Qire zMAVY2aEEb~T~WwSd>Zm#SF3TtfRem42m@SaPkNC3#AX)UgT%TW=5u7S=dxp|3h~tk+8yZee}?!M9HI@f1WTU?%HqiNq#8O^RmBZ`M8nW z4|fZvl;5BN{Lb=BYDGdiZ)y8 zAJE}UL0VRg6Y7k--*#>qd}SW1`t(XXl);%iKi{ne!56tAR#KrNk#?YdO;$EPr~Ghg zL?F4G51g8yyaYA|gz0Frg48>AICegIAO6!sUwFPVn!UV}NVFIh?iYutyf9vPz5yy( z6DHSbg~R&3N2@w%ro3d+aztG`xPRDrWGn*Y&;syq!6%Nw=lpy*v1>S; zz{fdE9!dF+My~C&wlU5dQQi|liohaCEU{7=clSmk*wsDU+doSXunDD0ppEf~z7_WK zr+{Ip?==2A3sWeggPH~cD#9z$y`Scm$bJE%)>E|H9P>`Q=3WWq&5Gckv?(2+idix- z=}@U*Mw5z1u`6g?w5skq?WtvLzqBse`dg0I`$C5Hc0=;s zkPHED_%Qv>At$X$ZQoAYc=|i@^yMF^9@eeSh=MAFRi5FHuyr-LC*Z!C9W%qiV99!$ z+O4V2zvRN1wsMwg1WGvGv~LqgOA2pQZi~E#pY5Lj`j`sW1jcRidq&GPu(oq7&iz*W zKqyJ$uZ1uC=#zeW>zJF-nx-gt-}Ak+qN{)H+eFKjl(8fvzoS10rN}hbM=2ZHn7&EW z&8^#HYV0+@3zAc}_pVhH22dU+MW5s4HwjodZU|T(EZaZ2D1Vuc&fO1}CSck5&kdJ% zi5gTPGKuKSk8XiGTl>tjIdMWO%>rJ^?&*|Ie1H+ zQLN{pqOrow2FVb%V>X_jBIhzH6s6~oS_oYp;iE>C%Z8w|lf!Ev?jfhYkP?FOAJ=__ zr3Ndn*>IP;iK|Ccxw##$W6H7snuYuHC7o)bP}ir&X4B|!Zd3cDm`a244dW*}1CN%5 zXbw16r3xZMsYF85zpYIaVr} z?@&!YCHZY9Dhmzcwq`}f17^3P{$})GtY|@wRkgs2TGgSwUV|As8%gAY&4}SLTG6V7 zW4_tEA;9}Q!A@(ZaEcrzDlf2bSL%{R)ka6gH9z06;tUEGAxQhi>~Q}sg1^506i46bzM;PHOzX~mY*`jhIiS}ZN2&$pmjO9S=Mj>^wMj=hEu zl~8}2{%}WDK+?okXRZA{H+!LjL{Qw9wi7vK1jiPkap+~_ak9^lCE_h!OeGWGGC-f1 zVRpAm`}*sOCzi+Ga`RF(!KxOX_nSKFZ%-ou%u?^0ue8}s6S?Xo-QGlc{EYuH{+mQ} z>M!OEuy)pxcgz<<{Cz|GC0u}FhbpDfLsov{TnAe9J`HN1 za$1aaKcULuO}iD`>6xOm$wW+_K_~{}#cJyGb!F&r_u_WE*8>}sUhJ6ueSj+chaBTO z_5$EOo-Ic;$S9Ktg;7Yrv0}eqi8w*$7sq2td!fj=Cb#w8?(xBoqj;W#K&Bk`$}tA3 z9AGH_)V?G6ZC=jUdQlN6RDFWODgd0RQQ;0q(jfFwegfKM0~6S+>;@7olQV~&k49?f4c6ReTPQa($S^cob|b_kZ$#iX{C8Kz*x0%0 zo>cBW9N_VWlazSRa?1##MXSou-fxeD!_&QLemU3-p!Hs?V4m6Uct-_K_|&bHnK!W$ zV;63=dGgzIvcKFCOuQk~(75AeyWPI#G+g@N6{x%iJmUeHX;4Zap?8EBjG*?Rg>>ai z2KP;zLI>J)rrvOVNW5NFP3LK%e~$B;2#8-H>%?dKvqQey7_%N$0BA{1=_#M`>JpGj zx^=X=@Ue4rw&8wAx+E@QbDpFk)D;j9<|OP%PJua#2WVcDDKfA63c=(IOQ-ItOLyLj z#xi9OEcg{vTTL1PH0YM4?khk(&TzrkU^aY+ypr5 z{jp4uL+LRby+u5hgmq)J$>w4X_2hrqq;M%gOnCFRl<7qk=J7~NV(r#;uVaI=;k)yH z3s|;iNg&Le8;yH+`qw4sWA#bWtE1?ftr!s26wPW{TB4{eZ7}vcT{CttS+z#yeHZD` z!Dm{7xPVwM1jvxV5cImPfv~WUzB0lD0V?KmAfl1#yl9`E3o(FJ-W+yQ`0C&D)y6G7Fqei&raMZE$9ts7fa z4f4?J_L;XiwLe#tFZPq{Hi=d2HL_a#J6156HfF@TAh; z*?Y}c7mP70lKYjiy#yEAjAE=?L_%I!DCR2DHw8zdS^Oe`Q{pKe%3AToxCN@8lKi~y z{NBUBt1t6X6V9;2e1t)uN}rcE_dBkxip3*do}=#z;&-%u?-?GxK;Dbzs!>Q^*6ptj zm^eD>*BoA?nOOnx9cmrMao0O|mq-wu>SauA6^XMeyN#cZXde*AQjDKU-aV#`nCYM! zK93Mnh)oEUJD3C2u*7fg1Z6u(rIWt=TFIqI@vO6HP*2{$Nfzqqt)jply2Pr`P1<{K zAJze>9Iexn7%VzWXJ<9dI_s1qgpT?U{aFjU?#mtfXwP1}`wno0q-!-Ch4te$o&7NO zv0K{_tOX8j$%GwNi1XUiA4V4r(b+)i-C0MYc`g)V`!_Vllu=)fmSLWy3MWmjV{~>( z2}Qmx;l8gN7vOQhu1Ct|e;v2u<}Z#5f0Ri`pg-r)`~A!ONc0I6kHauS0UE#sMlq4I z%K6CTTyOG<7_>u(<5A(mz`ps}+2ji&AfFQ+KjMEIGm>t=ebp$kBvqJzq Mq_Ix57W&cu0AIB!=l}o! literal 0 HcmV?d00001 diff --git a/docs/javadoc/script-dir/jquery-3.5.1.min.js b/docs/javadoc/script-dir/jquery-3.5.1.min.js new file mode 100644 index 00000000..b0614034 --- /dev/null +++ b/docs/javadoc/script-dir/jquery-3.5.1.min.js @@ -0,0 +1,2 @@ +/*! jQuery v3.5.1 | (c) JS Foundation and other contributors | jquery.org/license */ +!function(e,t){"use strict";"object"==typeof module&&"object"==typeof module.exports?module.exports=e.document?t(e,!0):function(e){if(!e.document)throw new Error("jQuery requires a window with a document");return t(e)}:t(e)}("undefined"!=typeof window?window:this,function(C,e){"use strict";var t=[],r=Object.getPrototypeOf,s=t.slice,g=t.flat?function(e){return t.flat.call(e)}:function(e){return t.concat.apply([],e)},u=t.push,i=t.indexOf,n={},o=n.toString,v=n.hasOwnProperty,a=v.toString,l=a.call(Object),y={},m=function(e){return"function"==typeof e&&"number"!=typeof e.nodeType},x=function(e){return null!=e&&e===e.window},E=C.document,c={type:!0,src:!0,nonce:!0,noModule:!0};function b(e,t,n){var r,i,o=(n=n||E).createElement("script");if(o.text=e,t)for(r in c)(i=t[r]||t.getAttribute&&t.getAttribute(r))&&o.setAttribute(r,i);n.head.appendChild(o).parentNode.removeChild(o)}function w(e){return null==e?e+"":"object"==typeof e||"function"==typeof e?n[o.call(e)]||"object":typeof e}var f="3.5.1",S=function(e,t){return new S.fn.init(e,t)};function p(e){var t=!!e&&"length"in e&&e.length,n=w(e);return!m(e)&&!x(e)&&("array"===n||0===t||"number"==typeof t&&0+~]|"+M+")"+M+"*"),U=new RegExp(M+"|>"),X=new RegExp(F),V=new RegExp("^"+I+"$"),G={ID:new RegExp("^#("+I+")"),CLASS:new RegExp("^\\.("+I+")"),TAG:new RegExp("^("+I+"|[*])"),ATTR:new RegExp("^"+W),PSEUDO:new RegExp("^"+F),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+M+"*(even|odd|(([+-]|)(\\d*)n|)"+M+"*(?:([+-]|)"+M+"*(\\d+)|))"+M+"*\\)|)","i"),bool:new RegExp("^(?:"+R+")$","i"),needsContext:new RegExp("^"+M+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+M+"*((?:-\\d)?\\d*)"+M+"*\\)|)(?=[^-]|$)","i")},Y=/HTML$/i,Q=/^(?:input|select|textarea|button)$/i,J=/^h\d$/i,K=/^[^{]+\{\s*\[native \w/,Z=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,ee=/[+~]/,te=new RegExp("\\\\[\\da-fA-F]{1,6}"+M+"?|\\\\([^\\r\\n\\f])","g"),ne=function(e,t){var n="0x"+e.slice(1)-65536;return t||(n<0?String.fromCharCode(n+65536):String.fromCharCode(n>>10|55296,1023&n|56320))},re=/([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g,ie=function(e,t){return t?"\0"===e?"\ufffd":e.slice(0,-1)+"\\"+e.charCodeAt(e.length-1).toString(16)+" ":"\\"+e},oe=function(){T()},ae=be(function(e){return!0===e.disabled&&"fieldset"===e.nodeName.toLowerCase()},{dir:"parentNode",next:"legend"});try{H.apply(t=O.call(p.childNodes),p.childNodes),t[p.childNodes.length].nodeType}catch(e){H={apply:t.length?function(e,t){L.apply(e,O.call(t))}:function(e,t){var n=e.length,r=0;while(e[n++]=t[r++]);e.length=n-1}}}function se(t,e,n,r){var i,o,a,s,u,l,c,f=e&&e.ownerDocument,p=e?e.nodeType:9;if(n=n||[],"string"!=typeof t||!t||1!==p&&9!==p&&11!==p)return n;if(!r&&(T(e),e=e||C,E)){if(11!==p&&(u=Z.exec(t)))if(i=u[1]){if(9===p){if(!(a=e.getElementById(i)))return n;if(a.id===i)return n.push(a),n}else if(f&&(a=f.getElementById(i))&&y(e,a)&&a.id===i)return n.push(a),n}else{if(u[2])return H.apply(n,e.getElementsByTagName(t)),n;if((i=u[3])&&d.getElementsByClassName&&e.getElementsByClassName)return H.apply(n,e.getElementsByClassName(i)),n}if(d.qsa&&!N[t+" "]&&(!v||!v.test(t))&&(1!==p||"object"!==e.nodeName.toLowerCase())){if(c=t,f=e,1===p&&(U.test(t)||z.test(t))){(f=ee.test(t)&&ye(e.parentNode)||e)===e&&d.scope||((s=e.getAttribute("id"))?s=s.replace(re,ie):e.setAttribute("id",s=S)),o=(l=h(t)).length;while(o--)l[o]=(s?"#"+s:":scope")+" "+xe(l[o]);c=l.join(",")}try{return H.apply(n,f.querySelectorAll(c)),n}catch(e){N(t,!0)}finally{s===S&&e.removeAttribute("id")}}}return g(t.replace($,"$1"),e,n,r)}function ue(){var r=[];return function e(t,n){return r.push(t+" ")>b.cacheLength&&delete e[r.shift()],e[t+" "]=n}}function le(e){return e[S]=!0,e}function ce(e){var t=C.createElement("fieldset");try{return!!e(t)}catch(e){return!1}finally{t.parentNode&&t.parentNode.removeChild(t),t=null}}function fe(e,t){var n=e.split("|"),r=n.length;while(r--)b.attrHandle[n[r]]=t}function pe(e,t){var n=t&&e,r=n&&1===e.nodeType&&1===t.nodeType&&e.sourceIndex-t.sourceIndex;if(r)return r;if(n)while(n=n.nextSibling)if(n===t)return-1;return e?1:-1}function de(t){return function(e){return"input"===e.nodeName.toLowerCase()&&e.type===t}}function he(n){return function(e){var t=e.nodeName.toLowerCase();return("input"===t||"button"===t)&&e.type===n}}function ge(t){return function(e){return"form"in e?e.parentNode&&!1===e.disabled?"label"in e?"label"in e.parentNode?e.parentNode.disabled===t:e.disabled===t:e.isDisabled===t||e.isDisabled!==!t&&ae(e)===t:e.disabled===t:"label"in e&&e.disabled===t}}function ve(a){return le(function(o){return o=+o,le(function(e,t){var n,r=a([],e.length,o),i=r.length;while(i--)e[n=r[i]]&&(e[n]=!(t[n]=e[n]))})})}function ye(e){return e&&"undefined"!=typeof e.getElementsByTagName&&e}for(e in d=se.support={},i=se.isXML=function(e){var t=e.namespaceURI,n=(e.ownerDocument||e).documentElement;return!Y.test(t||n&&n.nodeName||"HTML")},T=se.setDocument=function(e){var t,n,r=e?e.ownerDocument||e:p;return r!=C&&9===r.nodeType&&r.documentElement&&(a=(C=r).documentElement,E=!i(C),p!=C&&(n=C.defaultView)&&n.top!==n&&(n.addEventListener?n.addEventListener("unload",oe,!1):n.attachEvent&&n.attachEvent("onunload",oe)),d.scope=ce(function(e){return a.appendChild(e).appendChild(C.createElement("div")),"undefined"!=typeof e.querySelectorAll&&!e.querySelectorAll(":scope fieldset div").length}),d.attributes=ce(function(e){return e.className="i",!e.getAttribute("className")}),d.getElementsByTagName=ce(function(e){return e.appendChild(C.createComment("")),!e.getElementsByTagName("*").length}),d.getElementsByClassName=K.test(C.getElementsByClassName),d.getById=ce(function(e){return a.appendChild(e).id=S,!C.getElementsByName||!C.getElementsByName(S).length}),d.getById?(b.filter.ID=function(e){var t=e.replace(te,ne);return function(e){return e.getAttribute("id")===t}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n=t.getElementById(e);return n?[n]:[]}}):(b.filter.ID=function(e){var n=e.replace(te,ne);return function(e){var t="undefined"!=typeof e.getAttributeNode&&e.getAttributeNode("id");return t&&t.value===n}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n,r,i,o=t.getElementById(e);if(o){if((n=o.getAttributeNode("id"))&&n.value===e)return[o];i=t.getElementsByName(e),r=0;while(o=i[r++])if((n=o.getAttributeNode("id"))&&n.value===e)return[o]}return[]}}),b.find.TAG=d.getElementsByTagName?function(e,t){return"undefined"!=typeof t.getElementsByTagName?t.getElementsByTagName(e):d.qsa?t.querySelectorAll(e):void 0}:function(e,t){var n,r=[],i=0,o=t.getElementsByTagName(e);if("*"===e){while(n=o[i++])1===n.nodeType&&r.push(n);return r}return o},b.find.CLASS=d.getElementsByClassName&&function(e,t){if("undefined"!=typeof t.getElementsByClassName&&E)return t.getElementsByClassName(e)},s=[],v=[],(d.qsa=K.test(C.querySelectorAll))&&(ce(function(e){var t;a.appendChild(e).innerHTML="",e.querySelectorAll("[msallowcapture^='']").length&&v.push("[*^$]="+M+"*(?:''|\"\")"),e.querySelectorAll("[selected]").length||v.push("\\["+M+"*(?:value|"+R+")"),e.querySelectorAll("[id~="+S+"-]").length||v.push("~="),(t=C.createElement("input")).setAttribute("name",""),e.appendChild(t),e.querySelectorAll("[name='']").length||v.push("\\["+M+"*name"+M+"*="+M+"*(?:''|\"\")"),e.querySelectorAll(":checked").length||v.push(":checked"),e.querySelectorAll("a#"+S+"+*").length||v.push(".#.+[+~]"),e.querySelectorAll("\\\f"),v.push("[\\r\\n\\f]")}),ce(function(e){e.innerHTML="";var t=C.createElement("input");t.setAttribute("type","hidden"),e.appendChild(t).setAttribute("name","D"),e.querySelectorAll("[name=d]").length&&v.push("name"+M+"*[*^$|!~]?="),2!==e.querySelectorAll(":enabled").length&&v.push(":enabled",":disabled"),a.appendChild(e).disabled=!0,2!==e.querySelectorAll(":disabled").length&&v.push(":enabled",":disabled"),e.querySelectorAll("*,:x"),v.push(",.*:")})),(d.matchesSelector=K.test(c=a.matches||a.webkitMatchesSelector||a.mozMatchesSelector||a.oMatchesSelector||a.msMatchesSelector))&&ce(function(e){d.disconnectedMatch=c.call(e,"*"),c.call(e,"[s!='']:x"),s.push("!=",F)}),v=v.length&&new RegExp(v.join("|")),s=s.length&&new RegExp(s.join("|")),t=K.test(a.compareDocumentPosition),y=t||K.test(a.contains)?function(e,t){var n=9===e.nodeType?e.documentElement:e,r=t&&t.parentNode;return e===r||!(!r||1!==r.nodeType||!(n.contains?n.contains(r):e.compareDocumentPosition&&16&e.compareDocumentPosition(r)))}:function(e,t){if(t)while(t=t.parentNode)if(t===e)return!0;return!1},D=t?function(e,t){if(e===t)return l=!0,0;var n=!e.compareDocumentPosition-!t.compareDocumentPosition;return n||(1&(n=(e.ownerDocument||e)==(t.ownerDocument||t)?e.compareDocumentPosition(t):1)||!d.sortDetached&&t.compareDocumentPosition(e)===n?e==C||e.ownerDocument==p&&y(p,e)?-1:t==C||t.ownerDocument==p&&y(p,t)?1:u?P(u,e)-P(u,t):0:4&n?-1:1)}:function(e,t){if(e===t)return l=!0,0;var n,r=0,i=e.parentNode,o=t.parentNode,a=[e],s=[t];if(!i||!o)return e==C?-1:t==C?1:i?-1:o?1:u?P(u,e)-P(u,t):0;if(i===o)return pe(e,t);n=e;while(n=n.parentNode)a.unshift(n);n=t;while(n=n.parentNode)s.unshift(n);while(a[r]===s[r])r++;return r?pe(a[r],s[r]):a[r]==p?-1:s[r]==p?1:0}),C},se.matches=function(e,t){return se(e,null,null,t)},se.matchesSelector=function(e,t){if(T(e),d.matchesSelector&&E&&!N[t+" "]&&(!s||!s.test(t))&&(!v||!v.test(t)))try{var n=c.call(e,t);if(n||d.disconnectedMatch||e.document&&11!==e.document.nodeType)return n}catch(e){N(t,!0)}return 0":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(e){return e[1]=e[1].replace(te,ne),e[3]=(e[3]||e[4]||e[5]||"").replace(te,ne),"~="===e[2]&&(e[3]=" "+e[3]+" "),e.slice(0,4)},CHILD:function(e){return e[1]=e[1].toLowerCase(),"nth"===e[1].slice(0,3)?(e[3]||se.error(e[0]),e[4]=+(e[4]?e[5]+(e[6]||1):2*("even"===e[3]||"odd"===e[3])),e[5]=+(e[7]+e[8]||"odd"===e[3])):e[3]&&se.error(e[0]),e},PSEUDO:function(e){var t,n=!e[6]&&e[2];return G.CHILD.test(e[0])?null:(e[3]?e[2]=e[4]||e[5]||"":n&&X.test(n)&&(t=h(n,!0))&&(t=n.indexOf(")",n.length-t)-n.length)&&(e[0]=e[0].slice(0,t),e[2]=n.slice(0,t)),e.slice(0,3))}},filter:{TAG:function(e){var t=e.replace(te,ne).toLowerCase();return"*"===e?function(){return!0}:function(e){return e.nodeName&&e.nodeName.toLowerCase()===t}},CLASS:function(e){var t=m[e+" "];return t||(t=new RegExp("(^|"+M+")"+e+"("+M+"|$)"))&&m(e,function(e){return t.test("string"==typeof e.className&&e.className||"undefined"!=typeof e.getAttribute&&e.getAttribute("class")||"")})},ATTR:function(n,r,i){return function(e){var t=se.attr(e,n);return null==t?"!="===r:!r||(t+="","="===r?t===i:"!="===r?t!==i:"^="===r?i&&0===t.indexOf(i):"*="===r?i&&-1:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i;function D(e,n,r){return m(n)?S.grep(e,function(e,t){return!!n.call(e,t,e)!==r}):n.nodeType?S.grep(e,function(e){return e===n!==r}):"string"!=typeof n?S.grep(e,function(e){return-1)[^>]*|#([\w-]+))$/;(S.fn.init=function(e,t,n){var r,i;if(!e)return this;if(n=n||j,"string"==typeof e){if(!(r="<"===e[0]&&">"===e[e.length-1]&&3<=e.length?[null,e,null]:q.exec(e))||!r[1]&&t)return!t||t.jquery?(t||n).find(e):this.constructor(t).find(e);if(r[1]){if(t=t instanceof S?t[0]:t,S.merge(this,S.parseHTML(r[1],t&&t.nodeType?t.ownerDocument||t:E,!0)),N.test(r[1])&&S.isPlainObject(t))for(r in t)m(this[r])?this[r](t[r]):this.attr(r,t[r]);return this}return(i=E.getElementById(r[2]))&&(this[0]=i,this.length=1),this}return e.nodeType?(this[0]=e,this.length=1,this):m(e)?void 0!==n.ready?n.ready(e):e(S):S.makeArray(e,this)}).prototype=S.fn,j=S(E);var L=/^(?:parents|prev(?:Until|All))/,H={children:!0,contents:!0,next:!0,prev:!0};function O(e,t){while((e=e[t])&&1!==e.nodeType);return e}S.fn.extend({has:function(e){var t=S(e,this),n=t.length;return this.filter(function(){for(var e=0;e\x20\t\r\n\f]*)/i,he=/^$|^module$|\/(?:java|ecma)script/i;ce=E.createDocumentFragment().appendChild(E.createElement("div")),(fe=E.createElement("input")).setAttribute("type","radio"),fe.setAttribute("checked","checked"),fe.setAttribute("name","t"),ce.appendChild(fe),y.checkClone=ce.cloneNode(!0).cloneNode(!0).lastChild.checked,ce.innerHTML="",y.noCloneChecked=!!ce.cloneNode(!0).lastChild.defaultValue,ce.innerHTML="",y.option=!!ce.lastChild;var ge={thead:[1,"","
"],col:[2,"","
"],tr:[2,"","
"],td:[3,"","
"],_default:[0,"",""]};function ve(e,t){var n;return n="undefined"!=typeof e.getElementsByTagName?e.getElementsByTagName(t||"*"):"undefined"!=typeof e.querySelectorAll?e.querySelectorAll(t||"*"):[],void 0===t||t&&A(e,t)?S.merge([e],n):n}function ye(e,t){for(var n=0,r=e.length;n",""]);var me=/<|&#?\w+;/;function xe(e,t,n,r,i){for(var o,a,s,u,l,c,f=t.createDocumentFragment(),p=[],d=0,h=e.length;d\s*$/g;function qe(e,t){return A(e,"table")&&A(11!==t.nodeType?t:t.firstChild,"tr")&&S(e).children("tbody")[0]||e}function Le(e){return e.type=(null!==e.getAttribute("type"))+"/"+e.type,e}function He(e){return"true/"===(e.type||"").slice(0,5)?e.type=e.type.slice(5):e.removeAttribute("type"),e}function Oe(e,t){var n,r,i,o,a,s;if(1===t.nodeType){if(Y.hasData(e)&&(s=Y.get(e).events))for(i in Y.remove(t,"handle events"),s)for(n=0,r=s[i].length;n").attr(n.scriptAttrs||{}).prop({charset:n.scriptCharset,src:n.url}).on("load error",i=function(e){r.remove(),i=null,e&&t("error"===e.type?404:200,e.type)}),E.head.appendChild(r[0])},abort:function(){i&&i()}}});var Ut,Xt=[],Vt=/(=)\?(?=&|$)|\?\?/;S.ajaxSetup({jsonp:"callback",jsonpCallback:function(){var e=Xt.pop()||S.expando+"_"+Ct.guid++;return this[e]=!0,e}}),S.ajaxPrefilter("json jsonp",function(e,t,n){var r,i,o,a=!1!==e.jsonp&&(Vt.test(e.url)?"url":"string"==typeof e.data&&0===(e.contentType||"").indexOf("application/x-www-form-urlencoded")&&Vt.test(e.data)&&"data");if(a||"jsonp"===e.dataTypes[0])return r=e.jsonpCallback=m(e.jsonpCallback)?e.jsonpCallback():e.jsonpCallback,a?e[a]=e[a].replace(Vt,"$1"+r):!1!==e.jsonp&&(e.url+=(Et.test(e.url)?"&":"?")+e.jsonp+"="+r),e.converters["script json"]=function(){return o||S.error(r+" was not called"),o[0]},e.dataTypes[0]="json",i=C[r],C[r]=function(){o=arguments},n.always(function(){void 0===i?S(C).removeProp(r):C[r]=i,e[r]&&(e.jsonpCallback=t.jsonpCallback,Xt.push(r)),o&&m(i)&&i(o[0]),o=i=void 0}),"script"}),y.createHTMLDocument=((Ut=E.implementation.createHTMLDocument("").body).innerHTML="
",2===Ut.childNodes.length),S.parseHTML=function(e,t,n){return"string"!=typeof e?[]:("boolean"==typeof t&&(n=t,t=!1),t||(y.createHTMLDocument?((r=(t=E.implementation.createHTMLDocument("")).createElement("base")).href=E.location.href,t.head.appendChild(r)):t=E),o=!n&&[],(i=N.exec(e))?[t.createElement(i[1])]:(i=xe([e],t,o),o&&o.length&&S(o).remove(),S.merge([],i.childNodes)));var r,i,o},S.fn.load=function(e,t,n){var r,i,o,a=this,s=e.indexOf(" ");return-1").append(S.parseHTML(e)).find(r):e)}).always(n&&function(e,t){a.each(function(){n.apply(this,o||[e.responseText,t,e])})}),this},S.expr.pseudos.animated=function(t){return S.grep(S.timers,function(e){return t===e.elem}).length},S.offset={setOffset:function(e,t,n){var r,i,o,a,s,u,l=S.css(e,"position"),c=S(e),f={};"static"===l&&(e.style.position="relative"),s=c.offset(),o=S.css(e,"top"),u=S.css(e,"left"),("absolute"===l||"fixed"===l)&&-1<(o+u).indexOf("auto")?(a=(r=c.position()).top,i=r.left):(a=parseFloat(o)||0,i=parseFloat(u)||0),m(t)&&(t=t.call(e,n,S.extend({},s))),null!=t.top&&(f.top=t.top-s.top+a),null!=t.left&&(f.left=t.left-s.left+i),"using"in t?t.using.call(e,f):("number"==typeof f.top&&(f.top+="px"),"number"==typeof f.left&&(f.left+="px"),c.css(f))}},S.fn.extend({offset:function(t){if(arguments.length)return void 0===t?this:this.each(function(e){S.offset.setOffset(this,t,e)});var e,n,r=this[0];return r?r.getClientRects().length?(e=r.getBoundingClientRect(),n=r.ownerDocument.defaultView,{top:e.top+n.pageYOffset,left:e.left+n.pageXOffset}):{top:0,left:0}:void 0},position:function(){if(this[0]){var e,t,n,r=this[0],i={top:0,left:0};if("fixed"===S.css(r,"position"))t=r.getBoundingClientRect();else{t=this.offset(),n=r.ownerDocument,e=r.offsetParent||n.documentElement;while(e&&(e===n.body||e===n.documentElement)&&"static"===S.css(e,"position"))e=e.parentNode;e&&e!==r&&1===e.nodeType&&((i=S(e).offset()).top+=S.css(e,"borderTopWidth",!0),i.left+=S.css(e,"borderLeftWidth",!0))}return{top:t.top-i.top-S.css(r,"marginTop",!0),left:t.left-i.left-S.css(r,"marginLeft",!0)}}},offsetParent:function(){return this.map(function(){var e=this.offsetParent;while(e&&"static"===S.css(e,"position"))e=e.offsetParent;return e||re})}}),S.each({scrollLeft:"pageXOffset",scrollTop:"pageYOffset"},function(t,i){var o="pageYOffset"===i;S.fn[t]=function(e){return $(this,function(e,t,n){var r;if(x(e)?r=e:9===e.nodeType&&(r=e.defaultView),void 0===n)return r?r[i]:e[t];r?r.scrollTo(o?r.pageXOffset:n,o?n:r.pageYOffset):e[t]=n},t,e,arguments.length)}}),S.each(["top","left"],function(e,n){S.cssHooks[n]=$e(y.pixelPosition,function(e,t){if(t)return t=Be(e,n),Me.test(t)?S(e).position()[n]+"px":t})}),S.each({Height:"height",Width:"width"},function(a,s){S.each({padding:"inner"+a,content:s,"":"outer"+a},function(r,o){S.fn[o]=function(e,t){var n=arguments.length&&(r||"boolean"!=typeof e),i=r||(!0===e||!0===t?"margin":"border");return $(this,function(e,t,n){var r;return x(e)?0===o.indexOf("outer")?e["inner"+a]:e.document.documentElement["client"+a]:9===e.nodeType?(r=e.documentElement,Math.max(e.body["scroll"+a],r["scroll"+a],e.body["offset"+a],r["offset"+a],r["client"+a])):void 0===n?S.css(e,t,i):S.style(e,t,n,i)},s,n?e:void 0,n)}})}),S.each(["ajaxStart","ajaxStop","ajaxComplete","ajaxError","ajaxSuccess","ajaxSend"],function(e,t){S.fn[t]=function(e){return this.on(t,e)}}),S.fn.extend({bind:function(e,t,n){return this.on(e,null,t,n)},unbind:function(e,t){return this.off(e,null,t)},delegate:function(e,t,n,r){return this.on(t,e,n,r)},undelegate:function(e,t,n){return 1===arguments.length?this.off(e,"**"):this.off(t,e||"**",n)},hover:function(e,t){return this.mouseenter(e).mouseleave(t||e)}}),S.each("blur focus focusin focusout resize scroll click dblclick mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave change select submit keydown keypress keyup contextmenu".split(" "),function(e,n){S.fn[n]=function(e,t){return 0a;a++)for(s in o[a])n=o[a][s],o[a].hasOwnProperty(s)&&void 0!==n&&(e[s]=t.isPlainObject(n)?t.isPlainObject(e[s])?t.widget.extend({},e[s],n):t.widget.extend({},n):n);return e},t.widget.bridge=function(e,s){var n=s.prototype.widgetFullName||e;t.fn[e]=function(o){var a="string"==typeof o,r=i.call(arguments,1),l=this;return a?this.length||"instance"!==o?this.each(function(){var i,s=t.data(this,n);return"instance"===o?(l=s,!1):s?t.isFunction(s[o])&&"_"!==o.charAt(0)?(i=s[o].apply(s,r),i!==s&&void 0!==i?(l=i&&i.jquery?l.pushStack(i.get()):i,!1):void 0):t.error("no such method '"+o+"' for "+e+" widget instance"):t.error("cannot call methods on "+e+" prior to initialization; "+"attempted to call method '"+o+"'")}):l=void 0:(r.length&&(o=t.widget.extend.apply(null,[o].concat(r))),this.each(function(){var e=t.data(this,n);e?(e.option(o||{}),e._init&&e._init()):t.data(this,n,new s(o,this))})),l}},t.Widget=function(){},t.Widget._childConstructors=[],t.Widget.prototype={widgetName:"widget",widgetEventPrefix:"",defaultElement:"
",options:{classes:{},disabled:!1,create:null},_createWidget:function(i,s){s=t(s||this.defaultElement||this)[0],this.element=t(s),this.uuid=e++,this.eventNamespace="."+this.widgetName+this.uuid,this.bindings=t(),this.hoverable=t(),this.focusable=t(),this.classesElementLookup={},s!==this&&(t.data(s,this.widgetFullName,this),this._on(!0,this.element,{remove:function(t){t.target===s&&this.destroy()}}),this.document=t(s.style?s.ownerDocument:s.document||s),this.window=t(this.document[0].defaultView||this.document[0].parentWindow)),this.options=t.widget.extend({},this.options,this._getCreateOptions(),i),this._create(),this.options.disabled&&this._setOptionDisabled(this.options.disabled),this._trigger("create",null,this._getCreateEventData()),this._init()},_getCreateOptions:function(){return{}},_getCreateEventData:t.noop,_create:t.noop,_init:t.noop,destroy:function(){var e=this;this._destroy(),t.each(this.classesElementLookup,function(t,i){e._removeClass(i,t)}),this.element.off(this.eventNamespace).removeData(this.widgetFullName),this.widget().off(this.eventNamespace).removeAttr("aria-disabled"),this.bindings.off(this.eventNamespace)},_destroy:t.noop,widget:function(){return this.element},option:function(e,i){var s,n,o,a=e;if(0===arguments.length)return t.widget.extend({},this.options);if("string"==typeof e)if(a={},s=e.split("."),e=s.shift(),s.length){for(n=a[e]=t.widget.extend({},this.options[e]),o=0;s.length-1>o;o++)n[s[o]]=n[s[o]]||{},n=n[s[o]];if(e=s.pop(),1===arguments.length)return void 0===n[e]?null:n[e];n[e]=i}else{if(1===arguments.length)return void 0===this.options[e]?null:this.options[e];a[e]=i}return this._setOptions(a),this},_setOptions:function(t){var e;for(e in t)this._setOption(e,t[e]);return this},_setOption:function(t,e){return"classes"===t&&this._setOptionClasses(e),this.options[t]=e,"disabled"===t&&this._setOptionDisabled(e),this},_setOptionClasses:function(e){var i,s,n;for(i in e)n=this.classesElementLookup[i],e[i]!==this.options.classes[i]&&n&&n.length&&(s=t(n.get()),this._removeClass(n,i),s.addClass(this._classes({element:s,keys:i,classes:e,add:!0})))},_setOptionDisabled:function(t){this._toggleClass(this.widget(),this.widgetFullName+"-disabled",null,!!t),t&&(this._removeClass(this.hoverable,null,"ui-state-hover"),this._removeClass(this.focusable,null,"ui-state-focus"))},enable:function(){return this._setOptions({disabled:!1})},disable:function(){return this._setOptions({disabled:!0})},_classes:function(e){function i(i,o){var a,r;for(r=0;i.length>r;r++)a=n.classesElementLookup[i[r]]||t(),a=e.add?t(t.unique(a.get().concat(e.element.get()))):t(a.not(e.element).get()),n.classesElementLookup[i[r]]=a,s.push(i[r]),o&&e.classes[i[r]]&&s.push(e.classes[i[r]])}var s=[],n=this;return e=t.extend({element:this.element,classes:this.options.classes||{}},e),this._on(e.element,{remove:"_untrackClassesElement"}),e.keys&&i(e.keys.match(/\S+/g)||[],!0),e.extra&&i(e.extra.match(/\S+/g)||[]),s.join(" ")},_untrackClassesElement:function(e){var i=this;t.each(i.classesElementLookup,function(s,n){-1!==t.inArray(e.target,n)&&(i.classesElementLookup[s]=t(n.not(e.target).get()))})},_removeClass:function(t,e,i){return this._toggleClass(t,e,i,!1)},_addClass:function(t,e,i){return this._toggleClass(t,e,i,!0)},_toggleClass:function(t,e,i,s){s="boolean"==typeof s?s:i;var n="string"==typeof t||null===t,o={extra:n?e:i,keys:n?t:e,element:n?this.element:t,add:s};return o.element.toggleClass(this._classes(o),s),this},_on:function(e,i,s){var n,o=this;"boolean"!=typeof e&&(s=i,i=e,e=!1),s?(i=n=t(i),this.bindings=this.bindings.add(i)):(s=i,i=this.element,n=this.widget()),t.each(s,function(s,a){function r(){return e||o.options.disabled!==!0&&!t(this).hasClass("ui-state-disabled")?("string"==typeof a?o[a]:a).apply(o,arguments):void 0}"string"!=typeof a&&(r.guid=a.guid=a.guid||r.guid||t.guid++);var l=s.match(/^([\w:-]*)\s*(.*)$/),h=l[1]+o.eventNamespace,c=l[2];c?n.on(h,c,r):i.on(h,r)})},_off:function(e,i){i=(i||"").split(" ").join(this.eventNamespace+" ")+this.eventNamespace,e.off(i).off(i),this.bindings=t(this.bindings.not(e).get()),this.focusable=t(this.focusable.not(e).get()),this.hoverable=t(this.hoverable.not(e).get())},_delay:function(t,e){function i(){return("string"==typeof t?s[t]:t).apply(s,arguments)}var s=this;return setTimeout(i,e||0)},_hoverable:function(e){this.hoverable=this.hoverable.add(e),this._on(e,{mouseenter:function(e){this._addClass(t(e.currentTarget),null,"ui-state-hover")},mouseleave:function(e){this._removeClass(t(e.currentTarget),null,"ui-state-hover")}})},_focusable:function(e){this.focusable=this.focusable.add(e),this._on(e,{focusin:function(e){this._addClass(t(e.currentTarget),null,"ui-state-focus")},focusout:function(e){this._removeClass(t(e.currentTarget),null,"ui-state-focus")}})},_trigger:function(e,i,s){var n,o,a=this.options[e];if(s=s||{},i=t.Event(i),i.type=(e===this.widgetEventPrefix?e:this.widgetEventPrefix+e).toLowerCase(),i.target=this.element[0],o=i.originalEvent)for(n in o)n in i||(i[n]=o[n]);return this.element.trigger(i,s),!(t.isFunction(a)&&a.apply(this.element[0],[i].concat(s))===!1||i.isDefaultPrevented())}},t.each({show:"fadeIn",hide:"fadeOut"},function(e,i){t.Widget.prototype["_"+e]=function(s,n,o){"string"==typeof n&&(n={effect:n});var a,r=n?n===!0||"number"==typeof n?i:n.effect||i:e;n=n||{},"number"==typeof n&&(n={duration:n}),a=!t.isEmptyObject(n),n.complete=o,n.delay&&s.delay(n.delay),a&&t.effects&&t.effects.effect[r]?s[e](n):r!==e&&s[r]?s[r](n.duration,n.easing,o):s.queue(function(i){t(this)[e](),o&&o.call(s[0]),i()})}}),t.widget,function(){function e(t,e,i){return[parseFloat(t[0])*(u.test(t[0])?e/100:1),parseFloat(t[1])*(u.test(t[1])?i/100:1)]}function i(e,i){return parseInt(t.css(e,i),10)||0}function s(e){var i=e[0];return 9===i.nodeType?{width:e.width(),height:e.height(),offset:{top:0,left:0}}:t.isWindow(i)?{width:e.width(),height:e.height(),offset:{top:e.scrollTop(),left:e.scrollLeft()}}:i.preventDefault?{width:0,height:0,offset:{top:i.pageY,left:i.pageX}}:{width:e.outerWidth(),height:e.outerHeight(),offset:e.offset()}}var n,o=Math.max,a=Math.abs,r=/left|center|right/,l=/top|center|bottom/,h=/[\+\-]\d+(\.[\d]+)?%?/,c=/^\w+/,u=/%$/,d=t.fn.position;t.position={scrollbarWidth:function(){if(void 0!==n)return n;var e,i,s=t("
"),o=s.children()[0];return t("body").append(s),e=o.offsetWidth,s.css("overflow","scroll"),i=o.offsetWidth,e===i&&(i=s[0].clientWidth),s.remove(),n=e-i},getScrollInfo:function(e){var i=e.isWindow||e.isDocument?"":e.element.css("overflow-x"),s=e.isWindow||e.isDocument?"":e.element.css("overflow-y"),n="scroll"===i||"auto"===i&&e.widthi?"left":e>0?"right":"center",vertical:0>r?"top":s>0?"bottom":"middle"};h>p&&p>a(e+i)&&(u.horizontal="center"),c>f&&f>a(s+r)&&(u.vertical="middle"),u.important=o(a(e),a(i))>o(a(s),a(r))?"horizontal":"vertical",n.using.call(this,t,u)}),l.offset(t.extend(D,{using:r}))})},t.ui.position={fit:{left:function(t,e){var i,s=e.within,n=s.isWindow?s.scrollLeft:s.offset.left,a=s.width,r=t.left-e.collisionPosition.marginLeft,l=n-r,h=r+e.collisionWidth-a-n;e.collisionWidth>a?l>0&&0>=h?(i=t.left+l+e.collisionWidth-a-n,t.left+=l-i):t.left=h>0&&0>=l?n:l>h?n+a-e.collisionWidth:n:l>0?t.left+=l:h>0?t.left-=h:t.left=o(t.left-r,t.left)},top:function(t,e){var i,s=e.within,n=s.isWindow?s.scrollTop:s.offset.top,a=e.within.height,r=t.top-e.collisionPosition.marginTop,l=n-r,h=r+e.collisionHeight-a-n;e.collisionHeight>a?l>0&&0>=h?(i=t.top+l+e.collisionHeight-a-n,t.top+=l-i):t.top=h>0&&0>=l?n:l>h?n+a-e.collisionHeight:n:l>0?t.top+=l:h>0?t.top-=h:t.top=o(t.top-r,t.top)}},flip:{left:function(t,e){var i,s,n=e.within,o=n.offset.left+n.scrollLeft,r=n.width,l=n.isWindow?n.scrollLeft:n.offset.left,h=t.left-e.collisionPosition.marginLeft,c=h-l,u=h+e.collisionWidth-r-l,d="left"===e.my[0]?-e.elemWidth:"right"===e.my[0]?e.elemWidth:0,p="left"===e.at[0]?e.targetWidth:"right"===e.at[0]?-e.targetWidth:0,f=-2*e.offset[0];0>c?(i=t.left+d+p+f+e.collisionWidth-r-o,(0>i||a(c)>i)&&(t.left+=d+p+f)):u>0&&(s=t.left-e.collisionPosition.marginLeft+d+p+f-l,(s>0||u>a(s))&&(t.left+=d+p+f))},top:function(t,e){var i,s,n=e.within,o=n.offset.top+n.scrollTop,r=n.height,l=n.isWindow?n.scrollTop:n.offset.top,h=t.top-e.collisionPosition.marginTop,c=h-l,u=h+e.collisionHeight-r-l,d="top"===e.my[1],p=d?-e.elemHeight:"bottom"===e.my[1]?e.elemHeight:0,f="top"===e.at[1]?e.targetHeight:"bottom"===e.at[1]?-e.targetHeight:0,g=-2*e.offset[1];0>c?(s=t.top+p+f+g+e.collisionHeight-r-o,(0>s||a(c)>s)&&(t.top+=p+f+g)):u>0&&(i=t.top-e.collisionPosition.marginTop+p+f+g-l,(i>0||u>a(i))&&(t.top+=p+f+g))}},flipfit:{left:function(){t.ui.position.flip.left.apply(this,arguments),t.ui.position.fit.left.apply(this,arguments)},top:function(){t.ui.position.flip.top.apply(this,arguments),t.ui.position.fit.top.apply(this,arguments)}}}}(),t.ui.position,t.ui.keyCode={BACKSPACE:8,COMMA:188,DELETE:46,DOWN:40,END:35,ENTER:13,ESCAPE:27,HOME:36,LEFT:37,PAGE_DOWN:34,PAGE_UP:33,PERIOD:190,RIGHT:39,SPACE:32,TAB:9,UP:38},t.fn.extend({uniqueId:function(){var t=0;return function(){return this.each(function(){this.id||(this.id="ui-id-"+ ++t)})}}(),removeUniqueId:function(){return this.each(function(){/^ui-id-\d+$/.test(this.id)&&t(this).removeAttr("id")})}}),t.ui.safeActiveElement=function(t){var e;try{e=t.activeElement}catch(i){e=t.body}return e||(e=t.body),e.nodeName||(e=t.body),e},t.widget("ui.menu",{version:"1.12.1",defaultElement:"
    ",delay:300,options:{icons:{submenu:"ui-icon-caret-1-e"},items:"> *",menus:"ul",position:{my:"left top",at:"right top"},role:"menu",blur:null,focus:null,select:null},_create:function(){this.activeMenu=this.element,this.mouseHandled=!1,this.element.uniqueId().attr({role:this.options.role,tabIndex:0}),this._addClass("ui-menu","ui-widget ui-widget-content"),this._on({"mousedown .ui-menu-item":function(t){t.preventDefault()},"click .ui-menu-item":function(e){var i=t(e.target),s=t(t.ui.safeActiveElement(this.document[0]));!this.mouseHandled&&i.not(".ui-state-disabled").length&&(this.select(e),e.isPropagationStopped()||(this.mouseHandled=!0),i.has(".ui-menu").length?this.expand(e):!this.element.is(":focus")&&s.closest(".ui-menu").length&&(this.element.trigger("focus",[!0]),this.active&&1===this.active.parents(".ui-menu").length&&clearTimeout(this.timer)))},"mouseenter .ui-menu-item":function(e){if(!this.previousFilter){var i=t(e.target).closest(".ui-menu-item"),s=t(e.currentTarget);i[0]===s[0]&&(this._removeClass(s.siblings().children(".ui-state-active"),null,"ui-state-active"),this.focus(e,s))}},mouseleave:"collapseAll","mouseleave .ui-menu":"collapseAll",focus:function(t,e){var i=this.active||this.element.find(this.options.items).eq(0);e||this.focus(t,i)},blur:function(e){this._delay(function(){var i=!t.contains(this.element[0],t.ui.safeActiveElement(this.document[0]));i&&this.collapseAll(e)})},keydown:"_keydown"}),this.refresh(),this._on(this.document,{click:function(t){this._closeOnDocumentClick(t)&&this.collapseAll(t),this.mouseHandled=!1}})},_destroy:function(){var e=this.element.find(".ui-menu-item").removeAttr("role aria-disabled"),i=e.children(".ui-menu-item-wrapper").removeUniqueId().removeAttr("tabIndex role aria-haspopup");this.element.removeAttr("aria-activedescendant").find(".ui-menu").addBack().removeAttr("role aria-labelledby aria-expanded aria-hidden aria-disabled tabIndex").removeUniqueId().show(),i.children().each(function(){var e=t(this);e.data("ui-menu-submenu-caret")&&e.remove()})},_keydown:function(e){var i,s,n,o,a=!0;switch(e.keyCode){case t.ui.keyCode.PAGE_UP:this.previousPage(e);break;case t.ui.keyCode.PAGE_DOWN:this.nextPage(e);break;case t.ui.keyCode.HOME:this._move("first","first",e);break;case t.ui.keyCode.END:this._move("last","last",e);break;case t.ui.keyCode.UP:this.previous(e);break;case t.ui.keyCode.DOWN:this.next(e);break;case t.ui.keyCode.LEFT:this.collapse(e);break;case t.ui.keyCode.RIGHT:this.active&&!this.active.is(".ui-state-disabled")&&this.expand(e);break;case t.ui.keyCode.ENTER:case t.ui.keyCode.SPACE:this._activate(e);break;case t.ui.keyCode.ESCAPE:this.collapse(e);break;default:a=!1,s=this.previousFilter||"",o=!1,n=e.keyCode>=96&&105>=e.keyCode?""+(e.keyCode-96):String.fromCharCode(e.keyCode),clearTimeout(this.filterTimer),n===s?o=!0:n=s+n,i=this._filterMenuItems(n),i=o&&-1!==i.index(this.active.next())?this.active.nextAll(".ui-menu-item"):i,i.length||(n=String.fromCharCode(e.keyCode),i=this._filterMenuItems(n)),i.length?(this.focus(e,i),this.previousFilter=n,this.filterTimer=this._delay(function(){delete this.previousFilter},1e3)):delete this.previousFilter}a&&e.preventDefault()},_activate:function(t){this.active&&!this.active.is(".ui-state-disabled")&&(this.active.children("[aria-haspopup='true']").length?this.expand(t):this.select(t))},refresh:function(){var e,i,s,n,o,a=this,r=this.options.icons.submenu,l=this.element.find(this.options.menus);this._toggleClass("ui-menu-icons",null,!!this.element.find(".ui-icon").length),s=l.filter(":not(.ui-menu)").hide().attr({role:this.options.role,"aria-hidden":"true","aria-expanded":"false"}).each(function(){var e=t(this),i=e.prev(),s=t("").data("ui-menu-submenu-caret",!0);a._addClass(s,"ui-menu-icon","ui-icon "+r),i.attr("aria-haspopup","true").prepend(s),e.attr("aria-labelledby",i.attr("id"))}),this._addClass(s,"ui-menu","ui-widget ui-widget-content ui-front"),e=l.add(this.element),i=e.find(this.options.items),i.not(".ui-menu-item").each(function(){var e=t(this);a._isDivider(e)&&a._addClass(e,"ui-menu-divider","ui-widget-content")}),n=i.not(".ui-menu-item, .ui-menu-divider"),o=n.children().not(".ui-menu").uniqueId().attr({tabIndex:-1,role:this._itemRole()}),this._addClass(n,"ui-menu-item")._addClass(o,"ui-menu-item-wrapper"),i.filter(".ui-state-disabled").attr("aria-disabled","true"),this.active&&!t.contains(this.element[0],this.active[0])&&this.blur()},_itemRole:function(){return{menu:"menuitem",listbox:"option"}[this.options.role]},_setOption:function(t,e){if("icons"===t){var i=this.element.find(".ui-menu-icon");this._removeClass(i,null,this.options.icons.submenu)._addClass(i,null,e.submenu)}this._super(t,e)},_setOptionDisabled:function(t){this._super(t),this.element.attr("aria-disabled",t+""),this._toggleClass(null,"ui-state-disabled",!!t)},focus:function(t,e){var i,s,n;this.blur(t,t&&"focus"===t.type),this._scrollIntoView(e),this.active=e.first(),s=this.active.children(".ui-menu-item-wrapper"),this._addClass(s,null,"ui-state-active"),this.options.role&&this.element.attr("aria-activedescendant",s.attr("id")),n=this.active.parent().closest(".ui-menu-item").children(".ui-menu-item-wrapper"),this._addClass(n,null,"ui-state-active"),t&&"keydown"===t.type?this._close():this.timer=this._delay(function(){this._close()},this.delay),i=e.children(".ui-menu"),i.length&&t&&/^mouse/.test(t.type)&&this._startOpening(i),this.activeMenu=e.parent(),this._trigger("focus",t,{item:e})},_scrollIntoView:function(e){var i,s,n,o,a,r;this._hasScroll()&&(i=parseFloat(t.css(this.activeMenu[0],"borderTopWidth"))||0,s=parseFloat(t.css(this.activeMenu[0],"paddingTop"))||0,n=e.offset().top-this.activeMenu.offset().top-i-s,o=this.activeMenu.scrollTop(),a=this.activeMenu.height(),r=e.outerHeight(),0>n?this.activeMenu.scrollTop(o+n):n+r>a&&this.activeMenu.scrollTop(o+n-a+r))},blur:function(t,e){e||clearTimeout(this.timer),this.active&&(this._removeClass(this.active.children(".ui-menu-item-wrapper"),null,"ui-state-active"),this._trigger("blur",t,{item:this.active}),this.active=null)},_startOpening:function(t){clearTimeout(this.timer),"true"===t.attr("aria-hidden")&&(this.timer=this._delay(function(){this._close(),this._open(t)},this.delay))},_open:function(e){var i=t.extend({of:this.active},this.options.position);clearTimeout(this.timer),this.element.find(".ui-menu").not(e.parents(".ui-menu")).hide().attr("aria-hidden","true"),e.show().removeAttr("aria-hidden").attr("aria-expanded","true").position(i)},collapseAll:function(e,i){clearTimeout(this.timer),this.timer=this._delay(function(){var s=i?this.element:t(e&&e.target).closest(this.element.find(".ui-menu"));s.length||(s=this.element),this._close(s),this.blur(e),this._removeClass(s.find(".ui-state-active"),null,"ui-state-active"),this.activeMenu=s},this.delay)},_close:function(t){t||(t=this.active?this.active.parent():this.element),t.find(".ui-menu").hide().attr("aria-hidden","true").attr("aria-expanded","false")},_closeOnDocumentClick:function(e){return!t(e.target).closest(".ui-menu").length},_isDivider:function(t){return!/[^\-\u2014\u2013\s]/.test(t.text())},collapse:function(t){var e=this.active&&this.active.parent().closest(".ui-menu-item",this.element);e&&e.length&&(this._close(),this.focus(t,e))},expand:function(t){var e=this.active&&this.active.children(".ui-menu ").find(this.options.items).first();e&&e.length&&(this._open(e.parent()),this._delay(function(){this.focus(t,e)}))},next:function(t){this._move("next","first",t)},previous:function(t){this._move("prev","last",t)},isFirstItem:function(){return this.active&&!this.active.prevAll(".ui-menu-item").length},isLastItem:function(){return this.active&&!this.active.nextAll(".ui-menu-item").length},_move:function(t,e,i){var s;this.active&&(s="first"===t||"last"===t?this.active["first"===t?"prevAll":"nextAll"](".ui-menu-item").eq(-1):this.active[t+"All"](".ui-menu-item").eq(0)),s&&s.length&&this.active||(s=this.activeMenu.find(this.options.items)[e]()),this.focus(i,s)},nextPage:function(e){var i,s,n;return this.active?(this.isLastItem()||(this._hasScroll()?(s=this.active.offset().top,n=this.element.height(),this.active.nextAll(".ui-menu-item").each(function(){return i=t(this),0>i.offset().top-s-n}),this.focus(e,i)):this.focus(e,this.activeMenu.find(this.options.items)[this.active?"last":"first"]())),void 0):(this.next(e),void 0)},previousPage:function(e){var i,s,n;return this.active?(this.isFirstItem()||(this._hasScroll()?(s=this.active.offset().top,n=this.element.height(),this.active.prevAll(".ui-menu-item").each(function(){return i=t(this),i.offset().top-s+n>0}),this.focus(e,i)):this.focus(e,this.activeMenu.find(this.options.items).first())),void 0):(this.next(e),void 0)},_hasScroll:function(){return this.element.outerHeight()",options:{appendTo:null,autoFocus:!1,delay:300,minLength:1,position:{my:"left top",at:"left bottom",collision:"none"},source:null,change:null,close:null,focus:null,open:null,response:null,search:null,select:null},requestIndex:0,pending:0,_create:function(){var e,i,s,n=this.element[0].nodeName.toLowerCase(),o="textarea"===n,a="input"===n;this.isMultiLine=o||!a&&this._isContentEditable(this.element),this.valueMethod=this.element[o||a?"val":"text"],this.isNewMenu=!0,this._addClass("ui-autocomplete-input"),this.element.attr("autocomplete","off"),this._on(this.element,{keydown:function(n){if(this.element.prop("readOnly"))return e=!0,s=!0,i=!0,void 0;e=!1,s=!1,i=!1;var o=t.ui.keyCode;switch(n.keyCode){case o.PAGE_UP:e=!0,this._move("previousPage",n);break;case o.PAGE_DOWN:e=!0,this._move("nextPage",n);break;case o.UP:e=!0,this._keyEvent("previous",n);break;case o.DOWN:e=!0,this._keyEvent("next",n);break;case o.ENTER:this.menu.active&&(e=!0,n.preventDefault(),this.menu.select(n));break;case o.TAB:this.menu.active&&this.menu.select(n);break;case o.ESCAPE:this.menu.element.is(":visible")&&(this.isMultiLine||this._value(this.term),this.close(n),n.preventDefault());break;default:i=!0,this._searchTimeout(n)}},keypress:function(s){if(e)return e=!1,(!this.isMultiLine||this.menu.element.is(":visible"))&&s.preventDefault(),void 0;if(!i){var n=t.ui.keyCode;switch(s.keyCode){case n.PAGE_UP:this._move("previousPage",s);break;case n.PAGE_DOWN:this._move("nextPage",s);break;case n.UP:this._keyEvent("previous",s);break;case n.DOWN:this._keyEvent("next",s)}}},input:function(t){return s?(s=!1,t.preventDefault(),void 0):(this._searchTimeout(t),void 0)},focus:function(){this.selectedItem=null,this.previous=this._value()},blur:function(t){return this.cancelBlur?(delete this.cancelBlur,void 0):(clearTimeout(this.searching),this.close(t),this._change(t),void 0)}}),this._initSource(),this.menu=t("
      ").appendTo(this._appendTo()).menu({role:null}).hide().menu("instance"),this._addClass(this.menu.element,"ui-autocomplete","ui-front"),this._on(this.menu.element,{mousedown:function(e){e.preventDefault(),this.cancelBlur=!0,this._delay(function(){delete this.cancelBlur,this.element[0]!==t.ui.safeActiveElement(this.document[0])&&this.element.trigger("focus")})},menufocus:function(e,i){var s,n;return this.isNewMenu&&(this.isNewMenu=!1,e.originalEvent&&/^mouse/.test(e.originalEvent.type))?(this.menu.blur(),this.document.one("mousemove",function(){t(e.target).trigger(e.originalEvent)}),void 0):(n=i.item.data("ui-autocomplete-item"),!1!==this._trigger("focus",e,{item:n})&&e.originalEvent&&/^key/.test(e.originalEvent.type)&&this._value(n.value),s=i.item.attr("aria-label")||n.value,s&&t.trim(s).length&&(this.liveRegion.children().hide(),t("
      ").text(s).appendTo(this.liveRegion)),void 0)},menuselect:function(e,i){var s=i.item.data("ui-autocomplete-item"),n=this.previous;this.element[0]!==t.ui.safeActiveElement(this.document[0])&&(this.element.trigger("focus"),this.previous=n,this._delay(function(){this.previous=n,this.selectedItem=s})),!1!==this._trigger("select",e,{item:s})&&this._value(s.value),this.term=this._value(),this.close(e),this.selectedItem=s}}),this.liveRegion=t("
      ",{role:"status","aria-live":"assertive","aria-relevant":"additions"}).appendTo(this.document[0].body),this._addClass(this.liveRegion,null,"ui-helper-hidden-accessible"),this._on(this.window,{beforeunload:function(){this.element.removeAttr("autocomplete")}})},_destroy:function(){clearTimeout(this.searching),this.element.removeAttr("autocomplete"),this.menu.element.remove(),this.liveRegion.remove()},_setOption:function(t,e){this._super(t,e),"source"===t&&this._initSource(),"appendTo"===t&&this.menu.element.appendTo(this._appendTo()),"disabled"===t&&e&&this.xhr&&this.xhr.abort()},_isEventTargetInWidget:function(e){var i=this.menu.element[0];return e.target===this.element[0]||e.target===i||t.contains(i,e.target)},_closeOnClickOutside:function(t){this._isEventTargetInWidget(t)||this.close()},_appendTo:function(){var e=this.options.appendTo;return e&&(e=e.jquery||e.nodeType?t(e):this.document.find(e).eq(0)),e&&e[0]||(e=this.element.closest(".ui-front, dialog")),e.length||(e=this.document[0].body),e},_initSource:function(){var e,i,s=this;t.isArray(this.options.source)?(e=this.options.source,this.source=function(i,s){s(t.ui.autocomplete.filter(e,i.term))}):"string"==typeof this.options.source?(i=this.options.source,this.source=function(e,n){s.xhr&&s.xhr.abort(),s.xhr=t.ajax({url:i,data:e,dataType:"json",success:function(t){n(t)},error:function(){n([])}})}):this.source=this.options.source},_searchTimeout:function(t){clearTimeout(this.searching),this.searching=this._delay(function(){var e=this.term===this._value(),i=this.menu.element.is(":visible"),s=t.altKey||t.ctrlKey||t.metaKey||t.shiftKey;(!e||e&&!i&&!s)&&(this.selectedItem=null,this.search(null,t))},this.options.delay)},search:function(t,e){return t=null!=t?t:this._value(),this.term=this._value(),t.length").append(t("
      ").text(i.label)).appendTo(e)},_move:function(t,e){return this.menu.element.is(":visible")?this.menu.isFirstItem()&&/^previous/.test(t)||this.menu.isLastItem()&&/^next/.test(t)?(this.isMultiLine||this._value(this.term),this.menu.blur(),void 0):(this.menu[t](e),void 0):(this.search(null,e),void 0)},widget:function(){return this.menu.element},_value:function(){return this.valueMethod.apply(this.element,arguments)},_keyEvent:function(t,e){(!this.isMultiLine||this.menu.element.is(":visible"))&&(this._move(t,e),e.preventDefault())},_isContentEditable:function(t){if(!t.length)return!1;var e=t.prop("contentEditable");return"inherit"===e?this._isContentEditable(t.parent()):"true"===e}}),t.extend(t.ui.autocomplete,{escapeRegex:function(t){return t.replace(/[\-\[\]{}()*+?.,\\\^$|#\s]/g,"\\$&")},filter:function(e,i){var s=RegExp(t.ui.autocomplete.escapeRegex(i),"i");return t.grep(e,function(t){return s.test(t.label||t.value||t)})}}),t.widget("ui.autocomplete",t.ui.autocomplete,{options:{messages:{noResults:"No search results.",results:function(t){return t+(t>1?" results are":" result is")+" available, use up and down arrow keys to navigate."}}},__response:function(e){var i;this._superApply(arguments),this.options.disabled||this.cancelSearch||(i=e&&e.length?this.options.messages.results(e.length):this.options.messages.noResults,this.liveRegion.children().hide(),t("
      ").text(i).appendTo(this.liveRegion))}}),t.ui.autocomplete}); \ No newline at end of file diff --git a/docs/javadoc/script-dir/jquery-ui.structure.min.css b/docs/javadoc/script-dir/jquery-ui.structure.min.css new file mode 100644 index 00000000..e8808927 --- /dev/null +++ b/docs/javadoc/script-dir/jquery-ui.structure.min.css @@ -0,0 +1,5 @@ +/*! jQuery UI - v1.12.1 - 2018-12-06 +* http://jqueryui.com +* Copyright jQuery Foundation and other contributors; Licensed MIT */ + +.ui-helper-hidden{display:none}.ui-helper-hidden-accessible{border:0;clip:rect(0 0 0 0);height:1px;margin:-1px;overflow:hidden;padding:0;position:absolute;width:1px}.ui-helper-reset{margin:0;padding:0;border:0;outline:0;line-height:1.3;text-decoration:none;font-size:100%;list-style:none}.ui-helper-clearfix:before,.ui-helper-clearfix:after{content:"";display:table;border-collapse:collapse}.ui-helper-clearfix:after{clear:both}.ui-helper-zfix{width:100%;height:100%;top:0;left:0;position:absolute;opacity:0;filter:Alpha(Opacity=0)}.ui-front{z-index:100}.ui-state-disabled{cursor:default!important;pointer-events:none}.ui-icon{display:inline-block;vertical-align:middle;margin-top:-.25em;position:relative;text-indent:-99999px;overflow:hidden;background-repeat:no-repeat}.ui-widget-icon-block{left:50%;margin-left:-8px;display:block}.ui-widget-overlay{position:fixed;top:0;left:0;width:100%;height:100%}.ui-autocomplete{position:absolute;top:0;left:0;cursor:default}.ui-menu{list-style:none;padding:0;margin:0;display:block;outline:0}.ui-menu .ui-menu{position:absolute}.ui-menu .ui-menu-item{margin:0;cursor:pointer;list-style-image:url("data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7")}.ui-menu .ui-menu-item-wrapper{position:relative;padding:3px 1em 3px .4em}.ui-menu .ui-menu-divider{margin:5px 0;height:0;font-size:0;line-height:0;border-width:1px 0 0 0}.ui-menu .ui-state-focus,.ui-menu .ui-state-active{margin:-1px}.ui-menu-icons{position:relative}.ui-menu-icons .ui-menu-item-wrapper{padding-left:2em}.ui-menu .ui-icon{position:absolute;top:0;bottom:0;left:.2em;margin:auto 0}.ui-menu .ui-menu-icon{left:auto;right:0} \ No newline at end of file diff --git a/docs/javadoc/script.js b/docs/javadoc/script.js index b3463569..ccdc1d75 100644 --- a/docs/javadoc/script.js +++ b/docs/javadoc/script.js @@ -1,30 +1,103 @@ -function show(type) -{ - count = 0; - for (var key in methods) { - var row = document.getElementById(key); - if ((methods[key] & type) != 0) { - row.style.display = ''; - row.className = (count++ % 2) ? rowColor : altColor; - } - else - row.style.display = 'none'; - } - updateTabs(type); -} - -function updateTabs(type) -{ - for (var value in tabs) { - var sNode = document.getElementById(tabs[value][0]); - var spanNode = sNode.firstChild; - if (value == type) { - sNode.className = activeTableTab; - spanNode.innerHTML = tabs[value][1]; - } - else { - sNode.className = tableTab; - spanNode.innerHTML = "" + tabs[value][1] + ""; - } - } -} +/* + * Copyright (c) 2013, 2020, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. Oracle designates this + * particular file as subject to the "Classpath" exception as provided + * by Oracle in the LICENSE file that accompanied this code. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + +var moduleSearchIndex; +var packageSearchIndex; +var typeSearchIndex; +var memberSearchIndex; +var tagSearchIndex; +function loadScripts(doc, tag) { + createElem(doc, tag, 'search.js'); + + createElem(doc, tag, 'module-search-index.js'); + createElem(doc, tag, 'package-search-index.js'); + createElem(doc, tag, 'type-search-index.js'); + createElem(doc, tag, 'member-search-index.js'); + createElem(doc, tag, 'tag-search-index.js'); +} + +function createElem(doc, tag, path) { + var script = doc.createElement(tag); + var scriptElement = doc.getElementsByTagName(tag)[0]; + script.src = pathtoroot + path; + scriptElement.parentNode.insertBefore(script, scriptElement); +} + +function show(type) { + count = 0; + for (var key in data) { + var row = document.getElementById(key); + if ((data[key] & type) !== 0) { + row.style.display = ''; + row.className = (count++ % 2) ? rowColor : altColor; + } + else + row.style.display = 'none'; + } + updateTabs(type); +} + +function updateTabs(type) { + var firstRow = document.getElementById(Object.keys(data)[0]); + var table = firstRow.closest('table'); + for (var value in tabs) { + var tab = document.getElementById(tabs[value][0]); + if (value == type) { + tab.className = activeTableTab; + tab.innerHTML = tabs[value][1]; + tab.setAttribute('aria-selected', true); + tab.setAttribute('tabindex',0); + table.setAttribute('aria-labelledby', tabs[value][0]); + } + else { + tab.className = tableTab; + tab.setAttribute('aria-selected', false); + tab.setAttribute('tabindex',-1); + tab.setAttribute('onclick', "show("+ value + ")"); + tab.innerHTML = tabs[value][1]; + } + } +} + +function switchTab(e) { + if (e.keyCode == 37 || e.keyCode == 38) { + $("[aria-selected=true]").prev().click().focus(); + e.preventDefault(); + } + if (e.keyCode == 39 || e.keyCode == 40) { + $("[aria-selected=true]").next().click().focus(); + e.preventDefault(); + } +} + +var updateSearchResults = function() {}; + +function indexFilesLoaded() { + return moduleSearchIndex + && packageSearchIndex + && typeSearchIndex + && memberSearchIndex + && tagSearchIndex; +} diff --git a/docs/javadoc/search.js b/docs/javadoc/search.js new file mode 100644 index 00000000..85fcd6dc --- /dev/null +++ b/docs/javadoc/search.js @@ -0,0 +1,378 @@ +/* + * Copyright (c) 2015, 2020, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. Oracle designates this + * particular file as subject to the "Classpath" exception as provided + * by Oracle in the LICENSE file that accompanied this code. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + +var noResult = {l: "No results found"}; +var loading = {l: "Loading search index..."}; +var catModules = "Modules"; +var catPackages = "Packages"; +var catTypes = "Types"; +var catMembers = "Members"; +var catSearchTags = "SearchTags"; +var highlight = "$&"; +var searchPattern = ""; +var RANKING_THRESHOLD = 2; +var NO_MATCH = 0xffff; +var MAX_RESULTS_PER_CATEGORY = 500; +var UNNAMED = ""; +function escapeHtml(str) { + return str.replace(//g, ">"); +} +function getHighlightedText(item, matcher) { + var escapedItem = escapeHtml(item); + return escapedItem.replace(matcher, highlight); +} +function getURLPrefix(ui) { + var urlPrefix=""; + var slash = "/"; + if (ui.item.category === catModules) { + return ui.item.l + slash; + } else if (ui.item.category === catPackages && ui.item.m) { + return ui.item.m + slash; + } else if (ui.item.category === catTypes || ui.item.category === catMembers) { + if (ui.item.m) { + urlPrefix = ui.item.m + slash; + } else { + $.each(packageSearchIndex, function(index, item) { + if (item.m && ui.item.p === item.l) { + urlPrefix = item.m + slash; + } + }); + } + return urlPrefix; + } + return urlPrefix; +} +function makeCamelCaseRegex(term) { + var pattern = ""; + var isWordToken = false; + term.replace(/,\s*/g, ", ").trim().split(/\s+/).forEach(function(w, index) { + if (index > 0) { + // whitespace between identifiers is significant + pattern += (isWordToken && /^\w/.test(w)) ? "\\s+" : "\\s*"; + } + var tokens = w.split(/(?=[A-Z,.()<>[\/])/); + for (var i = 0; i < tokens.length; i++) { + var s = tokens[i]; + if (s === "") { + continue; + } + pattern += $.ui.autocomplete.escapeRegex(s); + isWordToken = /\w$/.test(s); + if (isWordToken) { + pattern += "([a-z0-9_$<>\\[\\]]*?)"; + } + } + }); + return pattern; +} +function createMatcher(pattern, flags) { + var isCamelCase = /[A-Z]/.test(pattern); + return new RegExp(pattern, flags + (isCamelCase ? "" : "i")); +} +var watermark = 'Search'; +$(function() { + $("#search").val(''); + $("#search").prop("disabled", false); + $("#reset").prop("disabled", false); + $("#search").val(watermark).addClass('watermark'); + $("#search").blur(function() { + if ($(this).val().length == 0) { + $(this).val(watermark).addClass('watermark'); + } + }); + $("#search").on('click keydown paste', function() { + if ($(this).val() == watermark) { + $(this).val('').removeClass('watermark'); + } + }); + $("#reset").click(function() { + $("#search").val(''); + $("#search").focus(); + }); + $("#search").focus(); + $("#search")[0].setSelectionRange(0, 0); +}); +$.widget("custom.catcomplete", $.ui.autocomplete, { + _create: function() { + this._super(); + this.widget().menu("option", "items", "> :not(.ui-autocomplete-category)"); + }, + _renderMenu: function(ul, items) { + var rMenu = this; + var currentCategory = ""; + rMenu.menu.bindings = $(); + $.each(items, function(index, item) { + var li; + if (item.category && item.category !== currentCategory) { + ul.append("
    • " + item.category + "
      • "); + currentCategory = item.category; + } + li = rMenu._renderItemData(ul, item); + if (item.category) { + li.attr("aria-label", item.category + " : " + item.l); + li.attr("class", "result-item"); + } else { + li.attr("aria-label", item.l); + li.attr("class", "result-item"); + } + }); + }, + _renderItem: function(ul, item) { + var label = ""; + var matcher = createMatcher(escapeHtml(searchPattern), "g"); + if (item.category === catModules) { + label = getHighlightedText(item.l, matcher); + } else if (item.category === catPackages) { + label = getHighlightedText(item.l, matcher); + } else if (item.category === catTypes) { + label = (item.p && item.p !== UNNAMED) + ? getHighlightedText(item.p + "." + item.l, matcher) + : getHighlightedText(item.l, matcher); + } else if (item.category === catMembers) { + label = (item.p && item.p !== UNNAMED) + ? getHighlightedText(item.p + "." + item.c + "." + item.l, matcher) + : getHighlightedText(item.c + "." + item.l, matcher); + } else if (item.category === catSearchTags) { + label = getHighlightedText(item.l, matcher); + } else { + label = item.l; + } + var li = $("
    • ").appendTo(ul); + var div = $("
      ").appendTo(li); + if (item.category === catSearchTags) { + if (item.d) { + div.html(label + " (" + item.h + ")
      " + + item.d + "
      "); + } else { + div.html(label + " (" + item.h + ")"); + } + } else { + if (item.m) { + div.html(item.m + "/" + label); + } else { + div.html(label); + } + } + return li; + } +}); +function rankMatch(match, category) { + if (!match) { + return NO_MATCH; + } + var index = match.index; + var input = match.input; + var leftBoundaryMatch = 2; + var periferalMatch = 0; + var delta = 0; + // make sure match is anchored on a left word boundary + if (index === 0 || /\W/.test(input[index - 1]) || "_" === input[index - 1] || "_" === input[index]) { + leftBoundaryMatch = 0; + } else if (input[index] === input[index].toUpperCase() && !/^[A-Z0-9_$]+$/.test(input)) { + leftBoundaryMatch = 1; + } + var matchEnd = index + match[0].length; + var leftParen = input.indexOf("("); + // exclude peripheral matches + if (category !== catModules && category !== catSearchTags) { + var endOfName = leftParen > -1 ? leftParen : input.length; + var delim = category === catPackages ? "/" : "."; + if (leftParen > -1 && leftParen < index) { + periferalMatch += 2; + } else if (input.lastIndexOf(delim, endOfName) >= matchEnd) { + periferalMatch += 2; + } + } + for (var i = 1; i < match.length; i++) { + // lower ranking if parts of the name are missing + if (match[i]) + delta += match[i].length; + } + if (category === catTypes) { + // lower ranking if a type name contains unmatched camel-case parts + if (/[A-Z]/.test(input.substring(matchEnd))) + delta += 5; + if (/[A-Z]/.test(input.substring(0, index))) + delta += 5; + } + return leftBoundaryMatch + periferalMatch + (delta / 200); + +} +function doSearch(request, response) { + var result = []; + var newResults = []; + + searchPattern = makeCamelCaseRegex(request.term); + if (searchPattern === "") { + return this.close(); + } + var camelCaseMatcher = createMatcher(searchPattern, ""); + var boundaryMatcher = createMatcher("\\b" + searchPattern, ""); + + function concatResults(a1, a2) { + a2.sort(function(e1, e2) { + return e1.ranking - e2.ranking; + }); + a1 = a1.concat(a2.map(function(e) { return e.item; })); + a2.length = 0; + return a1; + } + + if (moduleSearchIndex) { + $.each(moduleSearchIndex, function(index, item) { + item.category = catModules; + var ranking = rankMatch(boundaryMatcher.exec(item.l), catModules); + if (ranking < RANKING_THRESHOLD) { + newResults.push({ ranking: ranking, item: item }); + } + return newResults.length < MAX_RESULTS_PER_CATEGORY; + }); + result = concatResults(result, newResults); + } + if (packageSearchIndex) { + $.each(packageSearchIndex, function(index, item) { + item.category = catPackages; + var name = (item.m && request.term.indexOf("/") > -1) + ? (item.m + "/" + item.l) + : item.l; + var ranking = rankMatch(boundaryMatcher.exec(name), catPackages); + if (ranking < RANKING_THRESHOLD) { + newResults.push({ ranking: ranking, item: item }); + } + return newResults.length < MAX_RESULTS_PER_CATEGORY; + }); + result = concatResults(result, newResults); + } + if (typeSearchIndex) { + $.each(typeSearchIndex, function(index, item) { + item.category = catTypes; + var name = request.term.indexOf(".") > -1 + ? item.p + "." + item.l + : item.l; + var ranking = rankMatch(camelCaseMatcher.exec(name), catTypes); + if (ranking < RANKING_THRESHOLD) { + newResults.push({ ranking: ranking, item: item }); + } + return newResults.length < MAX_RESULTS_PER_CATEGORY; + }); + result = concatResults(result, newResults); + } + if (memberSearchIndex) { + $.each(memberSearchIndex, function(index, item) { + item.category = catMembers; + var name = request.term.indexOf(".") > -1 + ? item.p + "." + item.c + "." + item.l + : item.l; + var ranking = rankMatch(camelCaseMatcher.exec(name), catMembers); + if (ranking < RANKING_THRESHOLD) { + newResults.push({ ranking: ranking, item: item }); + } + return newResults.length < MAX_RESULTS_PER_CATEGORY; + }); + result = concatResults(result, newResults); + } + if (tagSearchIndex) { + $.each(tagSearchIndex, function(index, item) { + item.category = catSearchTags; + var ranking = rankMatch(boundaryMatcher.exec(item.l), catSearchTags); + if (ranking < RANKING_THRESHOLD) { + newResults.push({ ranking: ranking, item: item }); + } + return newResults.length < MAX_RESULTS_PER_CATEGORY; + }); + result = concatResults(result, newResults); + } + if (!indexFilesLoaded()) { + updateSearchResults = function() { + doSearch(request, response); + } + result.unshift(loading); + } else { + updateSearchResults = function() {}; + } + response(result); +} +$(function() { + $("#search").catcomplete({ + minLength: 1, + delay: 300, + source: doSearch, + response: function(event, ui) { + if (!ui.content.length) { + ui.content.push(noResult); + } else { + $("#search").empty(); + } + }, + autoFocus: true, + focus: function(event, ui) { + return false; + }, + position: { + collision: "flip" + }, + select: function(event, ui) { + if (ui.item.category) { + var url = getURLPrefix(ui); + if (ui.item.category === catModules) { + url += "module-summary.html"; + } else if (ui.item.category === catPackages) { + if (ui.item.u) { + url = ui.item.u; + } else { + url += ui.item.l.replace(/\./g, '/') + "/package-summary.html"; + } + } else if (ui.item.category === catTypes) { + if (ui.item.u) { + url = ui.item.u; + } else if (ui.item.p === UNNAMED) { + url += ui.item.l + ".html"; + } else { + url += ui.item.p.replace(/\./g, '/') + "/" + ui.item.l + ".html"; + } + } else if (ui.item.category === catMembers) { + if (ui.item.p === UNNAMED) { + url += ui.item.c + ".html" + "#"; + } else { + url += ui.item.p.replace(/\./g, '/') + "/" + ui.item.c + ".html" + "#"; + } + if (ui.item.u) { + url += ui.item.u; + } else { + url += ui.item.l; + } + } else if (ui.item.category === catSearchTags) { + url += ui.item.u; + } + if (top !== window) { + parent.classFrame.location = pathtoroot + url; + } else { + window.location.href = pathtoroot + url; + } + $("#search").focus(); + } + } + }); +}); diff --git a/docs/javadoc/stylesheet.css b/docs/javadoc/stylesheet.css index 98055b22..0aa4b2ae 100644 --- a/docs/javadoc/stylesheet.css +++ b/docs/javadoc/stylesheet.css @@ -1,574 +1,792 @@ -/* Javadoc style sheet */ -/* -Overall document style -*/ - -@import url('resources/fonts/dejavu.css'); - -body { - background-color:#ffffff; - color:#353833; - font-family:'DejaVu Sans', Arial, Helvetica, sans-serif; - font-size:14px; - margin:0; -} -a:link, a:visited { - text-decoration:none; - color:#4A6782; -} -a:hover, a:focus { - text-decoration:none; - color:#bb7a2a; -} -a:active { - text-decoration:none; - color:#4A6782; -} -a[name] { - color:#353833; -} -a[name]:hover { - text-decoration:none; - color:#353833; -} -pre { - font-family:'DejaVu Sans Mono', monospace; - font-size:14px; -} -h1 { - font-size:20px; -} -h2 { - font-size:18px; -} -h3 { - font-size:16px; - font-style:italic; -} -h4 { - font-size:13px; -} -h5 { - font-size:12px; -} -h6 { - font-size:11px; -} -ul { - list-style-type:disc; -} -code, tt { - font-family:'DejaVu Sans Mono', monospace; - font-size:14px; - padding-top:4px; - margin-top:8px; - line-height:1.4em; -} -dt code { - font-family:'DejaVu Sans Mono', monospace; - font-size:14px; - padding-top:4px; -} -table tr td dt code { - font-family:'DejaVu Sans Mono', monospace; - font-size:14px; - vertical-align:top; - padding-top:4px; -} -sup { - font-size:8px; -} -/* -Document title and Copyright styles -*/ -.clear { - clear:both; - height:0px; - overflow:hidden; -} -.aboutLanguage { - float:right; - padding:0px 21px; - font-size:11px; - z-index:200; - margin-top:-9px; -} -.legalCopy { - margin-left:.5em; -} -.bar a, .bar a:link, .bar a:visited, .bar a:active { - color:#FFFFFF; - text-decoration:none; -} -.bar a:hover, .bar a:focus { - color:#bb7a2a; -} -.tab { - background-color:#0066FF; - color:#ffffff; - padding:8px; - width:5em; - font-weight:bold; -} -/* -Navigation bar styles -*/ -.bar { - background-color:#4D7A97; - color:#FFFFFF; - padding:.8em .5em .4em .8em; - height:auto;/*height:1.8em;*/ - font-size:11px; - margin:0; -} -.topNav { - background-color:#4D7A97; - color:#FFFFFF; - float:left; - padding:0; - width:100%; - clear:right; - height:2.8em; - padding-top:10px; - overflow:hidden; - font-size:12px; -} -.bottomNav { - margin-top:10px; - background-color:#4D7A97; - color:#FFFFFF; - float:left; - padding:0; - width:100%; - clear:right; - height:2.8em; - padding-top:10px; - overflow:hidden; - font-size:12px; -} -.subNav { - background-color:#dee3e9; - float:left; - width:100%; - overflow:hidden; - font-size:12px; -} -.subNav div { - clear:left; - float:left; - padding:0 0 5px 6px; - text-transform:uppercase; -} -ul.navList, ul.subNavList { - float:left; - margin:0 25px 0 0; - padding:0; -} -ul.navList li{ - list-style:none; - float:left; - padding: 5px 6px; - text-transform:uppercase; -} -ul.subNavList li{ - list-style:none; - float:left; -} -.topNav a:link, .topNav a:active, .topNav a:visited, .bottomNav a:link, .bottomNav a:active, .bottomNav a:visited { - color:#FFFFFF; - text-decoration:none; - text-transform:uppercase; -} -.topNav a:hover, .bottomNav a:hover { - text-decoration:none; - color:#bb7a2a; - text-transform:uppercase; -} -.navBarCell1Rev { - background-color:#F8981D; - color:#253441; - margin: auto 5px; -} -.skipNav { - position:absolute; - top:auto; - left:-9999px; - overflow:hidden; -} -/* -Page header and footer styles -*/ -.header, .footer { - clear:both; - margin:0 20px; - padding:5px 0 0 0; -} -.indexHeader { - margin:10px; - position:relative; -} -.indexHeader span{ - margin-right:15px; -} -.indexHeader h1 { - font-size:13px; -} -.title { - color:#2c4557; - margin:10px 0; -} -.subTitle { - margin:5px 0 0 0; -} -.header ul { - margin:0 0 15px 0; - padding:0; -} -.footer ul { - margin:20px 0 5px 0; -} -.header ul li, .footer ul li { - list-style:none; - font-size:13px; -} -/* -Heading styles -*/ -div.details ul.blockList ul.blockList ul.blockList li.blockList h4, div.details ul.blockList ul.blockList ul.blockListLast li.blockList h4 { - background-color:#dee3e9; - border:1px solid #d0d9e0; - margin:0 0 6px -8px; - padding:7px 5px; -} -ul.blockList ul.blockList ul.blockList li.blockList h3 { - background-color:#dee3e9; - border:1px solid #d0d9e0; - margin:0 0 6px -8px; - padding:7px 5px; -} -ul.blockList ul.blockList li.blockList h3 { - padding:0; - margin:15px 0; -} -ul.blockList li.blockList h2 { - padding:0px 0 20px 0; -} -/* -Page layout container styles -*/ -.contentContainer, .sourceContainer, .classUseContainer, .serializedFormContainer, .constantValuesContainer { - clear:both; - padding:10px 20px; - position:relative; -} -.indexContainer { - margin:10px; - position:relative; - font-size:12px; -} -.indexContainer h2 { - font-size:13px; - padding:0 0 3px 0; -} -.indexContainer ul { - margin:0; - padding:0; -} -.indexContainer ul li { - list-style:none; - padding-top:2px; -} -.contentContainer .description dl dt, .contentContainer .details dl dt, .serializedFormContainer dl dt { - font-size:12px; - font-weight:bold; - margin:10px 0 0 0; - color:#4E4E4E; -} -.contentContainer .description dl dd, .contentContainer .details dl dd, .serializedFormContainer dl dd { - margin:5px 0 10px 0px; - font-size:14px; - font-family:'DejaVu Sans Mono',monospace; -} -.serializedFormContainer dl.nameValue dt { - margin-left:1px; - font-size:1.1em; - display:inline; - font-weight:bold; -} -.serializedFormContainer dl.nameValue dd { - margin:0 0 0 1px; - font-size:1.1em; - display:inline; -} -/* -List styles -*/ -ul.horizontal li { - display:inline; - font-size:0.9em; -} -ul.inheritance { - margin:0; - padding:0; -} -ul.inheritance li { - display:inline; - list-style:none; -} -ul.inheritance li ul.inheritance { - margin-left:15px; - padding-left:15px; - padding-top:1px; -} -ul.blockList, ul.blockListLast { - margin:10px 0 10px 0; - padding:0; -} -ul.blockList li.blockList, ul.blockListLast li.blockList { - list-style:none; - margin-bottom:15px; - line-height:1.4; -} -ul.blockList ul.blockList li.blockList, ul.blockList ul.blockListLast li.blockList { - padding:0px 20px 5px 10px; - border:1px solid #ededed; - background-color:#f8f8f8; -} -ul.blockList ul.blockList ul.blockList li.blockList, ul.blockList ul.blockList ul.blockListLast li.blockList { - padding:0 0 5px 8px; - background-color:#ffffff; - border:none; -} -ul.blockList ul.blockList ul.blockList ul.blockList li.blockList { - margin-left:0; - padding-left:0; - padding-bottom:15px; - border:none; -} -ul.blockList ul.blockList ul.blockList ul.blockList li.blockListLast { - list-style:none; - border-bottom:none; - padding-bottom:0; -} -table tr td dl, table tr td dl dt, table tr td dl dd { - margin-top:0; - margin-bottom:1px; -} -/* -Table styles -*/ -.overviewSummary, .memberSummary, .typeSummary, .useSummary, .constantsSummary, .deprecatedSummary { - width:100%; - border-left:1px solid #EEE; - border-right:1px solid #EEE; - border-bottom:1px solid #EEE; -} -.overviewSummary, .memberSummary { - padding:0px; -} -.overviewSummary caption, .memberSummary caption, .typeSummary caption, -.useSummary caption, .constantsSummary caption, .deprecatedSummary caption { - position:relative; - text-align:left; - background-repeat:no-repeat; - color:#253441; - font-weight:bold; - clear:none; - overflow:hidden; - padding:0px; - padding-top:10px; - padding-left:1px; - margin:0px; - white-space:pre; -} -.overviewSummary caption a:link, .memberSummary caption a:link, .typeSummary caption a:link, -.useSummary caption a:link, .constantsSummary caption a:link, .deprecatedSummary caption a:link, -.overviewSummary caption a:hover, .memberSummary caption a:hover, .typeSummary caption a:hover, -.useSummary caption a:hover, .constantsSummary caption a:hover, .deprecatedSummary caption a:hover, -.overviewSummary caption a:active, .memberSummary caption a:active, .typeSummary caption a:active, -.useSummary caption a:active, .constantsSummary caption a:active, .deprecatedSummary caption a:active, -.overviewSummary caption a:visited, .memberSummary caption a:visited, .typeSummary caption a:visited, -.useSummary caption a:visited, .constantsSummary caption a:visited, .deprecatedSummary caption a:visited { - color:#FFFFFF; -} -.overviewSummary caption span, .memberSummary caption span, .typeSummary caption span, -.useSummary caption span, .constantsSummary caption span, .deprecatedSummary caption span { - white-space:nowrap; - padding-top:5px; - padding-left:12px; - padding-right:12px; - padding-bottom:7px; - display:inline-block; - float:left; - background-color:#F8981D; - border: none; - height:16px; -} -.memberSummary caption span.activeTableTab span { - white-space:nowrap; - padding-top:5px; - padding-left:12px; - padding-right:12px; - margin-right:3px; - display:inline-block; - float:left; - background-color:#F8981D; - height:16px; -} -.memberSummary caption span.tableTab span { - white-space:nowrap; - padding-top:5px; - padding-left:12px; - padding-right:12px; - margin-right:3px; - display:inline-block; - float:left; - background-color:#4D7A97; - height:16px; -} -.memberSummary caption span.tableTab, .memberSummary caption span.activeTableTab { - padding-top:0px; - padding-left:0px; - padding-right:0px; - background-image:none; - float:none; - display:inline; -} -.overviewSummary .tabEnd, .memberSummary .tabEnd, .typeSummary .tabEnd, -.useSummary .tabEnd, .constantsSummary .tabEnd, .deprecatedSummary .tabEnd { - display:none; - width:5px; - position:relative; - float:left; - background-color:#F8981D; -} -.memberSummary .activeTableTab .tabEnd { - display:none; - width:5px; - margin-right:3px; - position:relative; - float:left; - background-color:#F8981D; -} -.memberSummary .tableTab .tabEnd { - display:none; - width:5px; - margin-right:3px; - position:relative; - background-color:#4D7A97; - float:left; - -} -.overviewSummary td, .memberSummary td, .typeSummary td, -.useSummary td, .constantsSummary td, .deprecatedSummary td { - text-align:left; - padding:0px 0px 12px 10px; -} -th.colOne, th.colFirst, th.colLast, .useSummary th, .constantsSummary th, -td.colOne, td.colFirst, td.colLast, .useSummary td, .constantsSummary td{ - vertical-align:top; - padding-right:0px; - padding-top:8px; - padding-bottom:3px; -} -th.colFirst, th.colLast, th.colOne, .constantsSummary th { - background:#dee3e9; - text-align:left; - padding:8px 3px 3px 7px; -} -td.colFirst, th.colFirst { - white-space:nowrap; - font-size:13px; -} -td.colLast, th.colLast { - font-size:13px; -} -td.colOne, th.colOne { - font-size:13px; -} -.overviewSummary td.colFirst, .overviewSummary th.colFirst, -.useSummary td.colFirst, .useSummary th.colFirst, -.overviewSummary td.colOne, .overviewSummary th.colOne, -.memberSummary td.colFirst, .memberSummary th.colFirst, -.memberSummary td.colOne, .memberSummary th.colOne, -.typeSummary td.colFirst{ - width:25%; - vertical-align:top; -} -td.colOne a:link, td.colOne a:active, td.colOne a:visited, td.colOne a:hover, td.colFirst a:link, td.colFirst a:active, td.colFirst a:visited, td.colFirst a:hover, td.colLast a:link, td.colLast a:active, td.colLast a:visited, td.colLast a:hover, .constantValuesContainer td a:link, .constantValuesContainer td a:active, .constantValuesContainer td a:visited, .constantValuesContainer td a:hover { - font-weight:bold; -} -.tableSubHeadingColor { - background-color:#EEEEFF; -} -.altColor { - background-color:#FFFFFF; -} -.rowColor { - background-color:#EEEEEF; -} -/* -Content styles -*/ -.description pre { - margin-top:0; -} -.deprecatedContent { - margin:0; - padding:10px 0; -} -.docSummary { - padding:0; -} - -ul.blockList ul.blockList ul.blockList li.blockList h3 { - font-style:normal; -} - -div.block { - font-size:14px; - font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif; -} - -td.colLast div { - padding-top:0px; -} - - -td.colLast a { - padding-bottom:3px; -} -/* -Formatting effect styles -*/ -.sourceLineNo { - color:green; - padding:0 30px 0 0; -} -h1.hidden { - visibility:hidden; - overflow:hidden; - font-size:10px; -} -.block { - display:block; - margin:3px 10px 2px 0px; - color:#474747; -} -.deprecatedLabel, .descfrmTypeLabel, .memberNameLabel, .memberNameLink, -.overrideSpecifyLabel, .packageHierarchyLabel, .paramLabel, .returnLabel, -.seeLabel, .simpleTagLabel, .throwsLabel, .typeNameLabel, .typeNameLink { - font-weight:bold; -} -.deprecationComment, .emphasizedPhrase, .interfaceName { - font-style:italic; -} - -div.block div.block span.deprecationComment, div.block div.block span.emphasizedPhrase, -div.block div.block span.interfaceName { - font-style:normal; -} - -div.contentContainer ul.blockList li.blockList h2{ - padding-bottom:0px; -} +/* + * Javadoc style sheet + */ + +@import url('resources/fonts/dejavu.css'); + +/* + * Styles for individual HTML elements. + * + * These are styles that are specific to individual HTML elements. Changing them affects the style of a particular + * HTML element throughout the page. + */ + +body { + background-color:#ffffff; + color:#353833; + font-family:'DejaVu Sans', Arial, Helvetica, sans-serif; + font-size:14px; + margin:0; + padding:0; + height:100%; + width:100%; +} +iframe { + margin:0; + padding:0; + height:100%; + width:100%; + overflow-y:scroll; + border:none; +} +a:link, a:visited { + text-decoration:none; + color:#4A6782; +} +a[href]:hover, a[href]:focus { + text-decoration:none; + color:#bb7a2a; +} +a[name] { + color:#353833; +} +pre { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; +} +h1 { + font-size:20px; +} +h2 { + font-size:18px; +} +h3 { + font-size:16px; +} +h4 { + font-size:13px; +} +h5 { + font-size:12px; +} +h6 { + font-size:11px; +} +ul { + list-style-type:disc; +} +code, tt { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + padding-top:4px; + margin-top:8px; + line-height:1.4em; +} +dt code { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + padding-top:4px; +} +table tr td dt code { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + vertical-align:top; + padding-top:4px; +} +sup { + font-size:8px; +} +button { + font-family: 'DejaVu Sans', Arial, Helvetica, sans-serif; + font-size: 14px; +} +/* + * Styles for HTML generated by javadoc. + * + * These are style classes that are used by the standard doclet to generate HTML documentation. + */ + +/* + * Styles for document title and copyright. + */ +.clear { + clear:both; + height:0px; + overflow:hidden; +} +.about-language { + float:right; + padding:0px 21px; + font-size:11px; + z-index:200; + margin-top:-9px; +} +.legal-copy { + margin-left:.5em; +} +.tab { + background-color:#0066FF; + color:#ffffff; + padding:8px; + width:5em; + font-weight:bold; +} +/* + * Styles for navigation bar. + */ +@media screen { + .flex-box { + position:fixed; + display:flex; + flex-direction:column; + height: 100%; + width: 100%; + } + .flex-header { + flex: 0 0 auto; + } + .flex-content { + flex: 1 1 auto; + overflow-y: auto; + } +} +.top-nav { + background-color:#4D7A97; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; + font-size:12px; +} +.bottom-nav { + margin-top:10px; + background-color:#4D7A97; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; + font-size:12px; +} +.sub-nav { + background-color:#dee3e9; + float:left; + width:100%; + overflow:hidden; + font-size:12px; +} +.sub-nav div { + clear:left; + float:left; + padding:0 0 5px 6px; + text-transform:uppercase; +} +.sub-nav .nav-list { + padding-top:5px; +} +ul.nav-list, ul.sub-nav-list { + float:left; + margin:0 25px 0 0; + padding:0; +} +ul.nav-list li{ + list-style:none; + float:left; + padding: 5px 6px; + text-transform:uppercase; +} +.sub-nav .nav-list-search { + float:right; + margin:0 0 0 0; + padding:5px 6px; + clear:none; +} +.nav-list-search label { + position:relative; + right:-16px; +} +ul.sub-nav-list li { + list-style:none; + float:left; + padding-top:10px; +} +.top-nav a:link, .top-nav a:active, .top-nav a:visited, .bottom-nav a:link, .bottom-nav a:active, .bottom-nav a:visited { + color:#FFFFFF; + text-decoration:none; + text-transform:uppercase; +} +.top-nav a:hover, .bottom-nav a:hover { + text-decoration:none; + color:#bb7a2a; + text-transform:uppercase; +} +.nav-bar-cell1-rev { + background-color:#F8981D; + color:#253441; + margin: auto 5px; +} +.skip-nav { + position:absolute; + top:auto; + left:-9999px; + overflow:hidden; +} +/* + * Hide navigation links and search box in print layout + */ +@media print { + ul.nav-list, div.sub-nav { + display:none; + } +} +/* + * Styles for page header and footer. + */ +.title { + color:#2c4557; + margin:10px 0; +} +.sub-title { + margin:5px 0 0 0; +} +.header ul { + margin:0 0 15px 0; + padding:0; +} +.header ul li, .footer ul li { + list-style:none; + font-size:13px; +} +/* + * Styles for headings. + */ +body.class-declaration-page .summary h2, +body.class-declaration-page .details h2, +body.class-use-page h2, +body.module-declaration-page .block-list h2 { + font-style: italic; + padding:0; + margin:15px 0; +} +body.class-declaration-page .summary h3, +body.class-declaration-page .details h3, +body.class-declaration-page .summary .inherited-list h2 { + background-color:#dee3e9; + border:1px solid #d0d9e0; + margin:0 0 6px -8px; + padding:7px 5px; +} +/* + * Styles for page layout containers. + */ +main { + clear:both; + padding:10px 20px; + position:relative; +} +dl.notes > dt { + font-family: 'DejaVu Sans', Arial, Helvetica, sans-serif; + font-size:12px; + font-weight:bold; + margin:10px 0 0 0; + color:#4E4E4E; +} +dl.notes > dd { + margin:5px 0 10px 0px; + font-size:14px; + font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif; +} +dl.name-value > dt { + margin-left:1px; + font-size:1.1em; + display:inline; + font-weight:bold; +} +dl.name-value > dd { + margin:0 0 0 1px; + font-size:1.1em; + display:inline; +} +/* + * Styles for lists. + */ +li.circle { + list-style:circle; +} +ul.horizontal li { + display:inline; + font-size:0.9em; +} +div.inheritance { + margin:0; + padding:0; +} +div.inheritance div.inheritance { + margin-left:2em; +} +ul.block-list, +ul.details-list, +ul.member-list, +ul.summary-list { + margin:10px 0 10px 0; + padding:0; +} +ul.block-list > li, +ul.details-list > li, +ul.member-list > li, +ul.summary-list > li { + list-style:none; + margin-bottom:15px; + line-height:1.4; +} +table tr td dl, table tr td dl dt, table tr td dl dd { + margin-top:0; + margin-bottom:1px; +} +/* + * Styles for tables. + */ +.overview-summary table, .member-summary table, .type-summary table, .use-summary table, .constants-summary table, .deprecated-summary table, +.requires-summary table, .packages-summary table, .provides-summary table, .uses-summary table, .system-properties-summary table { + width:100%; + border-spacing:0; + border-left:1px solid #EEE; + border-right:1px solid #EEE; + border-bottom:1px solid #EEE; +} +.overview-summary table, .member-summary table, .requires-summary table, .packages-summary table, +.provides-summary table, .uses-summary table, .system-properties-summary table { + padding:0px; +} +.overview-summary caption, .member-summary caption, .type-summary caption, +.use-summary caption, .constants-summary caption, .deprecated-summary caption, +.requires-summary caption, .packages-summary caption, .provides-summary caption, +.uses-summary caption, .system-properties-summary caption { + position:relative; + text-align:left; + background-repeat:no-repeat; + color:#253441; + font-weight:bold; + clear:none; + overflow:hidden; + padding:0px; + padding-top:10px; + padding-left:1px; + margin:0px; + white-space:pre; +} +.constants-summary caption a:link, .constants-summary caption a:visited, +.use-summary caption a:link, .use-summary caption a:visited { + color:#1f389c; +} +.overview-summary caption a:link, .member-summary caption a:link, .type-summary caption a:link, +.deprecated-summary caption a:link, +.requires-summary caption a:link, .packages-summary caption a:link, .provides-summary caption a:link, +.uses-summary caption a:link, +.overview-summary caption a:hover, .member-summary caption a:hover, .type-summary caption a:hover, +.use-summary caption a:hover, .constants-summary caption a:hover, .deprecated-summary caption a:hover, +.requires-summary caption a:hover, .packages-summary caption a:hover, .provides-summary caption a:hover, +.uses-summary caption a:hover, +.overview-summary caption a:active, .member-summary caption a:active, .type-summary caption a:active, +.use-summary caption a:active, .constants-summary caption a:active, .deprecated-summary caption a:active, +.requires-summary caption a:active, .packages-summary caption a:active, .provides-summary caption a:active, +.uses-summary caption a:active, +.overview-summary caption a:visited, .member-summary caption a:visited, .type-summary caption a:visited, +.deprecated-summary caption a:visited, +.requires-summary caption a:visited, .packages-summary caption a:visited, .provides-summary caption a:visited, +.uses-summary caption a:visited { + color:#FFFFFF; +} +.overview-summary caption span, .member-summary caption span, .type-summary caption span, +.use-summary caption span, .constants-summary caption span, .deprecated-summary caption span, +.requires-summary caption span, .packages-summary caption span, .provides-summary caption span, +.uses-summary caption span, .system-properties-summary caption span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + padding-bottom:7px; + display:inline-block; + float:left; + background-color:#F8981D; + border: none; + height:16px; +} + +div.table-tabs > button { + border: none; + cursor: pointer; + padding: 5px 12px 7px 12px; + font-weight: bold; + margin-right: 3px; +} +div.table-tabs > button.active-table-tab { + background: #F8981D; + color: #253441; +} +div.table-tabs > button.table-tab { + background: #4D7A97; + color: #FFFFFF; +} + +.row-color th, +.alt-color th { + font-weight:normal; +} +.overview-summary td, .member-summary td, .type-summary td, +.use-summary td, .constants-summary td, .deprecated-summary td, +.requires-summary td, .packages-summary td, .provides-summary td, +.uses-summary td, .system-properties-summary td { + text-align:left; + padding:0px 0px 12px 10px; +} +th.col-first, th.col-second, th.col-last, th.col-constructor-name, th.col-deprecated-item-name, .use-summary th, +.constants-summary th, .packages-summary th, td.col-first, td.col-second, td.col-last, .use-summary td, +.constants-summary td, .system-properties-summary th { + vertical-align:top; + padding-right:0px; + padding-top:8px; + padding-bottom:3px; +} +th.col-first, th.col-second, th.col-last, th.col-constructor-name, th.col-deprecated-item-name, .constants-summary th, +.packages-summary th { + background:#dee3e9; + text-align:left; + padding:8px 3px 3px 7px; +} +td.col-first, th.col-first { + font-size:13px; +} +td.col-second, th.col-second, td.col-last, th.col-constructor-name, th.col-deprecated-item-name, th.col-last { + font-size:13px; +} +.constants-summary th, .packages-summary th { + font-size:13px; +} +.provides-summary th.col-first, .provides-summary th.col-last, .provides-summary td.col-first, +.provides-summary td.col-last { + white-space:normal; + font-size:13px; +} +.overview-summary td.col-first, .overview-summary th.col-first, +.requires-summary td.col-first, .requires-summary th.col-first, +.packages-summary td.col-first, .packages-summary td.col-second, .packages-summary th.col-first, .packages-summary th, +.uses-summary td.col-first, .uses-summary th.col-first, +.provides-summary td.col-first, .provides-summary th.col-first, +.member-summary td.col-first, .member-summary th.col-first, +.member-summary td.col-second, .member-summary th.col-second, .member-summary th.col-constructor-name, +.type-summary td.col-first, .type-summary th.col-first { + vertical-align:top; +} +.packages-summary th.col-last, .packages-summary td.col-last { + white-space:normal; +} +td.col-first a:link, td.col-first a:visited, +td.col-second a:link, td.col-second a:visited, +th.col-first a:link, th.col-first a:visited, +th.col-second a:link, th.col-second a:visited, +th.col-constructor-name a:link, th.col-constructor-name a:visited, +th.col-deprecated-item-name a:link, th.col-deprecated-item-name a:visited, +.constant-values-container td a:link, .constant-values-container td a:visited, +.all-classes-container td a:link, .all-classes-container td a:visited, +.all-packages-container td a:link, .all-packages-container td a:visited { + font-weight:bold; +} +.table-sub-heading-color { + background-color:#EEEEFF; +} +.alt-color, .alt-color th { + background-color:#FFFFFF; +} +.row-color, .row-color th { + background-color:#EEEEEF; +} +/* + * Styles for contents. + */ +.description pre { + margin-top:0; +} +.deprecated-content { + margin:0; + padding:10px 0; +} +div.block { + font-size:14px; + font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif; +} +td.col-last div { + padding-top:0px; +} +td.col-last a { + padding-bottom:3px; +} +div.member-signature { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + margin:14px 0; + white-space: pre-wrap; +} +div.member-signature span.annotations { + white-space: pre-wrap; +} +div.member-signature span.type-parameters-long, +div.member-signature span.parameters, +div.member-signature span.exceptions { + display: inline-block; + vertical-align: top; + white-space: pre; +} +div.member-signature span.type-parameters { + white-space: normal; +} +/* + * Styles for formatting effect. + */ +.source-line-no { + color:green; + padding:0 30px 0 0; +} +h1.hidden { + visibility:hidden; + overflow:hidden; + font-size:10px; +} +.block { + display:block; + margin:0 10px 5px 0; + color:#474747; +} +.deprecated-label, .descfrm-type-label, .implementation-label, .member-name-label, .member-name-link, +.module-label-in-package, .module-label-in-type, .override-specify-label, .package-label-in-type, +.package-hierarchy-label, .type-name-label, .type-name-link, .search-tag-link { + font-weight:bold; +} +.deprecation-comment, .help-footnote, .interface-name { + font-style:italic; +} +.deprecation-block { + font-size:14px; + font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif; + border-style:solid; + border-width:thin; + border-radius:10px; + padding:10px; + margin-bottom:10px; + margin-right:10px; + display:inline-block; +} +div.block div.deprecation-comment, div.block div.block span.emphasized-phrase, +div.block div.block span.interface-name { + font-style:normal; +} +/* + * Styles specific to HTML5 elements. + */ +main, nav, header, footer, section { + display:block; +} +/* + * Styles for javadoc search. + */ +.ui-autocomplete-category { + font-weight:bold; + font-size:15px; + padding:7px 0 7px 3px; + background-color:#4D7A97; + color:#FFFFFF; +} +.result-item { + font-size:13px; +} +.ui-autocomplete { + max-height:85%; + max-width:65%; + overflow-y:scroll; + overflow-x:scroll; + white-space:nowrap; + box-shadow: 0 3px 6px rgba(0,0,0,0.16), 0 3px 6px rgba(0,0,0,0.23); +} +ul.ui-autocomplete { + position:fixed; + z-index:999999; +} +ul.ui-autocomplete li { + float:left; + clear:both; + width:100%; +} +.result-highlight { + font-weight:bold; +} +#search { + background-image:url('resources/glass.png'); + background-size:13px; + background-repeat:no-repeat; + background-position:2px 3px; + padding-left:20px; + position:relative; + right:-18px; + width:400px; +} +#reset { + background-color: rgb(255,255,255); + background-image:url('resources/x.png'); + background-position:center; + background-repeat:no-repeat; + background-size:12px; + border:0 none; + width:16px; + height:16px; + position:relative; + left:-4px; + top:-4px; + font-size:0px; +} +.watermark { + color:#545454; +} +.search-tag-desc-result { + font-style:italic; + font-size:11px; +} +.search-tag-holder-result { + font-style:italic; + font-size:12px; +} +.search-tag-result:target { + background-color:yellow; +} +.module-graph span { + display:none; + position:absolute; +} +.module-graph:hover span { + display:block; + margin: -100px 0 0 100px; + z-index: 1; +} +.inherited-list { + margin: 10px 0 10px 0; +} +section.description { + line-height: 1.4; +} +.summary section[class$="-summary"], .details section[class$="-details"], +.class-uses .detail, .serialized-class-details { + padding: 0px 20px 5px 10px; + border: 1px solid #ededed; + background-color: #f8f8f8; +} +.inherited-list, section[class$="-details"] .detail { + padding:0 0 5px 8px; + background-color:#ffffff; + border:none; +} +.vertical-separator { + padding: 0 5px; +} +ul.help-section-list { + margin: 0; +} +/* + * Indicator icon for external links. + */ +main a[href*="://"]::after { + content:""; + display:inline-block; + background-image:url('data:image/svg+xml; utf8, \ + \ + \ + '); + background-size:100% 100%; + width:7px; + height:7px; + margin-left:2px; + margin-bottom:4px; +} +main a[href*="://"]:hover::after, +main a[href*="://"]:focus::after { + background-image:url('data:image/svg+xml; utf8, \ + \ + \ + '); +} + +/* + * Styles for user-provided tables. + * + * borderless: + * No borders, vertical margins, styled caption. + * This style is provided for use with existing doc comments. + * In general, borderless tables should not be used for layout purposes. + * + * plain: + * Plain borders around table and cells, vertical margins, styled caption. + * Best for small tables or for complex tables for tables with cells that span + * rows and columns, when the "striped" style does not work well. + * + * striped: + * Borders around the table and vertical borders between cells, striped rows, + * vertical margins, styled caption. + * Best for tables that have a header row, and a body containing a series of simple rows. + */ + +table.borderless, +table.plain, +table.striped { + margin-top: 10px; + margin-bottom: 10px; +} +table.borderless > caption, +table.plain > caption, +table.striped > caption { + font-weight: bold; + font-size: smaller; +} +table.borderless th, table.borderless td, +table.plain th, table.plain td, +table.striped th, table.striped td { + padding: 2px 5px; +} +table.borderless, +table.borderless > thead > tr > th, table.borderless > tbody > tr > th, table.borderless > tr > th, +table.borderless > thead > tr > td, table.borderless > tbody > tr > td, table.borderless > tr > td { + border: none; +} +table.borderless > thead > tr, table.borderless > tbody > tr, table.borderless > tr { + background-color: transparent; +} +table.plain { + border-collapse: collapse; + border: 1px solid black; +} +table.plain > thead > tr, table.plain > tbody tr, table.plain > tr { + background-color: transparent; +} +table.plain > thead > tr > th, table.plain > tbody > tr > th, table.plain > tr > th, +table.plain > thead > tr > td, table.plain > tbody > tr > td, table.plain > tr > td { + border: 1px solid black; +} +table.striped { + border-collapse: collapse; + border: 1px solid black; +} +table.striped > thead { + background-color: #E3E3E3; +} +table.striped > thead > tr > th, table.striped > thead > tr > td { + border: 1px solid black; +} +table.striped > tbody > tr:nth-child(even) { + background-color: #EEE +} +table.striped > tbody > tr:nth-child(odd) { + background-color: #FFF +} +table.striped > tbody > tr > th, table.striped > tbody > tr > td { + border-left: 1px solid black; + border-right: 1px solid black; +} +table.striped > tbody > tr > th { + font-weight: normal; +} diff --git a/docs/javadoc/tag-search-index.js b/docs/javadoc/tag-search-index.js new file mode 100644 index 00000000..0367dae6 --- /dev/null +++ b/docs/javadoc/tag-search-index.js @@ -0,0 +1 @@ +tagSearchIndex = [];updateSearchResults(); \ No newline at end of file diff --git a/docs/javadoc/type-search-index.js b/docs/javadoc/type-search-index.js new file mode 100644 index 00000000..9a50fa26 --- /dev/null +++ b/docs/javadoc/type-search-index.js @@ -0,0 +1 @@ +typeSearchIndex = [{"p":"uk.co.samuelwall.materialtaptargetprompt","l":"ActivityResourceFinder"},{"l":"All Classes","u":"allclasses-index.html"},{"p":"uk.co.samuelwall.materialtaptargetprompt","l":"MaterialTapTargetPrompt.Builder"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds","l":"CirclePromptBackground"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras.focals","l":"CirclePromptFocal"},{"p":"uk.co.samuelwall.materialtaptargetprompt","l":"DialogResourceFinder"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds","l":"FullscreenPromptBackground"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds","l":"ImmersiveModeCompatPromptBackground"},{"p":"uk.co.samuelwall.materialtaptargetprompt","l":"MaterialTapTargetPrompt"},{"p":"uk.co.samuelwall.materialtaptargetprompt","l":"MaterialTapTargetSequence"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","l":"PromptBackground"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","l":"PromptFocal"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","l":"PromptOptions"},{"p":"uk.co.samuelwall.materialtaptargetprompt","l":"MaterialTapTargetPrompt.PromptStateChangeListener"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","l":"PromptText"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras","l":"PromptUtils"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds","l":"RectanglePromptBackground"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras.focals","l":"RectanglePromptFocal"},{"p":"uk.co.samuelwall.materialtaptargetprompt","l":"ResourceFinder"},{"p":"uk.co.samuelwall.materialtaptargetprompt","l":"MaterialTapTargetSequence.SequenceCompleteListener"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras.sequence","l":"SequenceItem"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras.sequence","l":"SequenceItemShowFor"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras.sequence","l":"SequenceState"},{"p":"uk.co.samuelwall.materialtaptargetprompt.extras.sequence","l":"SequenceStatePromptOptions"},{"p":"uk.co.samuelwall.materialtaptargetprompt","l":"SupportFragmentResourceFinder"}];updateSearchResults(); \ No newline at end of file diff --git a/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/ActivityResourceFinder.html b/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/ActivityResourceFinder.html index 92ea5a7e..6537fd31 100644 --- a/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/ActivityResourceFinder.html +++ b/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/ActivityResourceFinder.html @@ -1,481 +1,415 @@ - - - - - -ActivityResourceFinder (material-tap-target-prompt 3.0.0 API) - - - - - - - - -
      - - -
      Skip navigation links
      - - - - -
      -
      - - - -
      - -
      -
      -
        -
      • Summary: 
        • -
      • Nested | 
        • -
      • Field | 
        • -
      • Constr | 
        • -
      • Method
        • -
      - -
      - - -
      - - -
      -
      uk.co.samuelwall.materialtaptargetprompt
      -

      Class ActivityResourceFinder

      -
      -
      -
        -
      • java.lang.Object
        • -
      • -
          -
        • uk.co.samuelwall.materialtaptargetprompt.ActivityResourceFinder
          • -
        -
        • -
      -
      - -
      -
      -
        -
      • - -
          -
        • - - -

          Constructor Summary

          - - - - - - - - -
          Constructors 
          Constructor and Description
          ActivityResourceFinder(android.app.Activity activity) 
          -
          • -
        - -
          -
        • - - -

          Method Summary

          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
          All Methods Instance Methods Concrete Methods 
          Modifier and TypeMethod and Description
          android.view.ViewfindViewById(int resId) -
          Finds a child view with the given identifier.
          -
          android.content.ContextgetContext() -
          Retrieve the Context that the prompt is running in.
          -
          android.graphics.drawable.DrawablegetDrawable(int resId) -
          Returns a drawable object associated with a particular resource ID and - styled for the current theme.
          -
          android.view.ViewGroupgetPromptParentView() -
          Get the view to add the prompt to.
          -
          android.content.res.ResourcesgetResources() -
          Returns a Resources instance for the application's package.
          -
          java.lang.StringgetString(int resId) -
          Returns a localized string from the application's package's - default string table.
          -
          android.content.res.Resources.ThemegetTheme() -
          Return the Theme object associated with ResourceFinder.getContext().
          -
          android.content.res.TypedArrayobtainStyledAttributes(int resId, - int[] attrs) -
          Retrieve styled attribute information in ResourceFinder.getContext() theme.
          -
          -
            -
          • - - -

            Methods inherited from class java.lang.Object

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

          Constructor Detail

          - - - -
            -
          • -

            ActivityResourceFinder

            -
            public ActivityResourceFinder(@NonNull
-                              android.app.Activity activity)
            -
            • -
          -
          • -
        - -
          -
        • - - -

          Method Detail

          - - - -
            -
          • -

            findViewById

            -
            @Nullable
-public android.view.View findViewById(@IdRes
-                                                int resId)
            -
            Description copied from interface: ResourceFinder
            -
            Finds a child view with the given identifier. Returns null if the - specified child view does not exist.
            -
            -
            Specified by:
            -
            findViewById in interface ResourceFinder
            -
            Parameters:
            -
            resId - the identifier of the view to find
            -
            Returns:
            -
            The view with the given id or null.
            -
            -
            • -
          - - - -
            -
          • -

            getPromptParentView

            -
            @NonNull
-public android.view.ViewGroup getPromptParentView()
            -
            Description copied from interface: ResourceFinder
            -
            Get the view to add the prompt to.
            -
            -
            Specified by:
            -
            getPromptParentView in interface ResourceFinder
            -
            Returns:
            -
            The view to add the prompt to.
            -
            -
            • -
          - - - -
            -
          • -

            getContext

            -
            @NonNull
-public android.content.Context getContext()
            -
            Description copied from interface: ResourceFinder
            -
            Retrieve the Context that the prompt is running in.
            -
            -
            Specified by:
            -
            getContext in interface ResourceFinder
            -
            Returns:
            -
            Context The Context used by the prompt.
            -
            -
            • -
          - - - -
            -
          • -

            getResources

            -
            @NonNull
-public android.content.res.Resources getResources()
            -
            Description copied from interface: ResourceFinder
            -
            Returns a Resources instance for the application's package.
            -
            -
            Specified by:
            -
            getResources in interface ResourceFinder
            -
            Returns:
            -
            a Resources instance for the application's package
            -
            -
            • -
          - - - - - - - -
            -
          • -

            getString

            -
            @NonNull
-public java.lang.String getString(@StringRes
-                                           int resId)
            -
            Description copied from interface: ResourceFinder
            -
            Returns a localized string from the application's package's - default string table.
            -
            -
            Specified by:
            -
            getString in interface ResourceFinder
            -
            Parameters:
            -
            resId - Resource id for the string
            -
            Returns:
            -
            The string data associated with the resource, stripped of styled - text information.
            -
            -
            • -
          - - - -
            -
          • -

            obtainStyledAttributes

            -
            @NonNull
-public android.content.res.TypedArray obtainStyledAttributes(@StyleRes
-                                                                      int resId,
-                                                                      @StyleableRes
-                                                                      int[] attrs)
            -
            Description copied from interface: ResourceFinder
            -
            Retrieve styled attribute information in ResourceFinder.getContext() theme. See - Resources.Theme.obtainStyledAttributes(int, int[]) - for more information.
            -
            -
            Specified by:
            -
            obtainStyledAttributes in interface ResourceFinder
            -
            See Also:
            -
            Resources.Theme.obtainStyledAttributes(int, int[])
            -
            -
            • -
          - - - -
            -
          • -

            getDrawable

            -
            @Nullable
-public android.graphics.drawable.Drawable getDrawable(@DrawableRes
-                                                                int resId)
            -
            Description copied from interface: ResourceFinder
            -
            Returns a drawable object associated with a particular resource ID and - styled for the current theme.
            -
            -
            Specified by:
            -
            getDrawable in interface ResourceFinder
            -
            Parameters:
            -
            resId - The desired resource identifier, as generated by the aapt - tool. This integer encodes the package, type, and resource - entry. The value 0 is an invalid identifier.
            -
            Returns:
            -
            An object that can be used to draw this resource, or - null if the resource could not be resolved.
            -
            -
            • -
          -
          • -
        -
        • -
      -
      -
      - - -
      - - -
      Skip navigation links
      - - - - -
      -
      - - - -
      - -
      -
      -
        -
      • Summary: 
        • -
      • Nested | 
        • -
      • Field | 
        • -
      • Constr | 
        • -
      • Method
        • -
      - -
      - - -
      - - - + + + + + +ActivityResourceFinder (material-tap-target-prompt 3.0.1 API) + + + + + + + + + + + + + +
      + +
      +
      + +
      +
      Package uk.co.samuelwall.materialtaptargetprompt
      +

      Class ActivityResourceFinder

      +
      +
      java.lang.Object +
      uk.co.samuelwall.materialtaptargetprompt.ActivityResourceFinder
      +
      +
      +
      +
      All Implemented Interfaces:
      +
      ResourceFinder
      +
      +
      +
      Direct Known Subclasses:
      +
      DialogResourceFinder
      +
      +
      +
      public class ActivityResourceFinder
+extends java.lang.Object
+implements ResourceFinder
      +
      ResourceFinder implementation for Activity.
      +
      +
      +
        + +
      • +
        +

        Constructor Summary

        +
        + + + + + + + + + + + + + + +
        Constructors
        ConstructorDescription
        ActivityResourceFinder​(android.app.Activity activity) 
        +
        +
        +
        • + +
      • +
        +

        Method Summary

        +
        +
        +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        Modifier and TypeMethodDescription
        android.view.ViewfindViewById​(int resId) +
        Finds a child view with the given identifier.
        +
        android.content.ContextgetContext() +
        Retrieve the Context that the prompt is running in.
        +
        android.graphics.drawable.DrawablegetDrawable​(int resId) +
        Returns a drawable object associated with a particular resource ID and + styled for the current theme.
        +
        android.view.ViewGroupgetPromptParentView() +
        Get the view to add the prompt to.
        +
        android.content.res.ResourcesgetResources() +
        Returns a Resources instance for the application's package.
        +
        java.lang.StringgetString​(int resId) +
        Returns a localized string from the application's package's + default string table.
        +
        android.content.res.Resources.ThemegetTheme() +
        Return the Theme object associated with ResourceFinder.getContext().
        +
        android.content.res.TypedArrayobtainStyledAttributes​(int resId, +int[] attrs) +
        Retrieve styled attribute information in ResourceFinder.getContext() theme.
        +
        +
        +
        +
        +

        Methods inherited from class java.lang.Object

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

        Constructor Details

        +
          +
        • +
          +

          ActivityResourceFinder

          +
          public ActivityResourceFinder​(@NonNull +android.app.Activity activity)
          +
          +
          • +
        +
        +
        • + +
      • +
        +

        Method Details

        +
          +
        • +
          +

          findViewById

          +
          @Nullable +public android.view.View findViewById​(@IdRes +int resId)
          +
          Description copied from interface: ResourceFinder
          +
          Finds a child view with the given identifier. Returns null if the + specified child view does not exist.
          +
          +
          Specified by:
          +
          findViewById in interface ResourceFinder
          +
          Parameters:
          +
          resId - the identifier of the view to find
          +
          Returns:
          +
          The view with the given id or null.
          +
          +
          +
          • +
        • +
          +

          getPromptParentView

          +
          @NonNull +public android.view.ViewGroup getPromptParentView()
          +
          Description copied from interface: ResourceFinder
          +
          Get the view to add the prompt to.
          +
          +
          Specified by:
          +
          getPromptParentView in interface ResourceFinder
          +
          Returns:
          +
          The view to add the prompt to.
          +
          +
          +
          • +
        • +
          +

          getContext

          +
          @NonNull +public android.content.Context getContext()
          +
          Description copied from interface: ResourceFinder
          +
          Retrieve the Context that the prompt is running in.
          +
          +
          Specified by:
          +
          getContext in interface ResourceFinder
          +
          Returns:
          +
          Context The Context used by the prompt.
          +
          +
          +
          • +
        • +
          +

          getResources

          +
          @NonNull +public android.content.res.Resources getResources()
          +
          Description copied from interface: ResourceFinder
          +
          Returns a Resources instance for the application's package.
          +
          +
          Specified by:
          +
          getResources in interface ResourceFinder
          +
          Returns:
          +
          a Resources instance for the application's package
          +
          +
          +
          • +
        • +
          +

          getTheme

          +
          @NonNull +public android.content.res.Resources.Theme getTheme()
          +
          Description copied from interface: ResourceFinder
          +
          Return the Theme object associated with ResourceFinder.getContext().
          +
          +
          Specified by:
          +
          getTheme in interface ResourceFinder
          +
          +
          +
          • +
        • +
          +

          getString

          +
          @NonNull +public java.lang.String getString​(@StringRes +int resId)
          +
          Description copied from interface: ResourceFinder
          +
          Returns a localized string from the application's package's + default string table.
          +
          +
          Specified by:
          +
          getString in interface ResourceFinder
          +
          Parameters:
          +
          resId - Resource id for the string
          +
          Returns:
          +
          The string data associated with the resource, stripped of styled + text information.
          +
          +
          +
          • +
        • +
          +

          obtainStyledAttributes

          +
          @NonNull +public android.content.res.TypedArray obtainStyledAttributes​(@StyleRes +int resId, +@StyleableRes +int[] attrs)
          +
          Description copied from interface: ResourceFinder
          +
          Retrieve styled attribute information in ResourceFinder.getContext() theme. See + Resources.Theme.obtainStyledAttributes(int, int[]) + for more information.
          +
          +
          Specified by:
          +
          obtainStyledAttributes in interface ResourceFinder
          +
          See Also:
          +
          Resources.Theme.obtainStyledAttributes(int, int[])
          +
          +
          +
          • +
        • +
          +

          getDrawable

          +
          @Nullable +public android.graphics.drawable.Drawable getDrawable​(@DrawableRes +int resId)
          +
          Description copied from interface: ResourceFinder
          +
          Returns a drawable object associated with a particular resource ID and + styled for the current theme.
          +
          +
          Specified by:
          +
          getDrawable in interface ResourceFinder
          +
          Parameters:
          +
          resId - The desired resource identifier, as generated by the aapt + tool. This integer encodes the package, type, and resource + entry. The value 0 is an invalid identifier.
          +
          Returns:
          +
          An object that can be used to draw this resource, or + null if the resource could not be resolved.
          +
          +
          +
          • +
        +
        +
        • +
      +
      + +
      + +
      +
      + + diff --git a/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/DialogResourceFinder.html b/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/DialogResourceFinder.html index 6996ecae..c2e33615 100644 --- a/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/DialogResourceFinder.html +++ b/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/DialogResourceFinder.html @@ -1,356 +1,293 @@ - - - - - -DialogResourceFinder (material-tap-target-prompt 3.0.0 API) - - - - - - - - -
      - - -
      Skip navigation links
      - - - - -
      -
      - - - -
      - -
      -
      -
        -
      • Summary: 
        • -
      • Nested | 
        • -
      • Field | 
        • -
      • Constr | 
        • -
      • Method
        • -
      - -
      - - -
      - - -
      -
      uk.co.samuelwall.materialtaptargetprompt
      -

      Class DialogResourceFinder

      -
      -
      - -
      - -
      -
      - -
      -
      -
        -
      • - -
          -
        • - - -

          Constructor Detail

          - - - -
            -
          • -

            DialogResourceFinder

            -
            public DialogResourceFinder(@NonNull
-                            android.app.Dialog dialog)
            -
            • -
          -
          • -
        - - -
        • -
      -
      -
      - - -
      - - -
      Skip navigation links
      - - - - -
      -
      - - - -
      - -
      -
      -
        -
      • Summary: 
        • -
      • Nested | 
        • -
      • Field | 
        • -
      • Constr | 
        • -
      • Method
        • -
      - -
      - - -
      - - - + + + + + +DialogResourceFinder (material-tap-target-prompt 3.0.1 API) + + + + + + + + + + + + + +
      + +
      +
      + +
      +
      Package uk.co.samuelwall.materialtaptargetprompt
      +

      Class DialogResourceFinder

      +
      +
      java.lang.Object +
      uk.co.samuelwall.materialtaptargetprompt.ActivityResourceFinder +
      uk.co.samuelwall.materialtaptargetprompt.DialogResourceFinder
      +
      +
      +
      +
      +
      All Implemented Interfaces:
      +
      ResourceFinder
      +
      +
      +
      public class DialogResourceFinder
+extends ActivityResourceFinder
      +
      ResourceFinder implementation for Dialog.
      +
      +
      +
        + +
      • +
        +

        Constructor Summary

        +
        + + + + + + + + + + + + + + +
        Constructors
        ConstructorDescription
        DialogResourceFinder​(android.app.Dialog dialog) 
        +
        +
        +
        • + +
      • +
        +

        Method Summary

        +
        +
        +
        + + + + + + + + + + + + + + + + + + + + + + + + + +
        Modifier and TypeMethodDescription
        android.view.ViewfindViewById​(int resId) +
        Finds a child view with the given identifier.
        +
        android.content.ContextgetContext() +
        Retrieve the Context that the prompt is running in.
        +
        android.view.ViewGroupgetPromptParentView() +
        Get the view to add the prompt to.
        +
        +
        +
        +
        +

        Methods inherited from class uk.co.samuelwall.materialtaptargetprompt.ActivityResourceFinder

        +getDrawable, getResources, getString, getTheme, obtainStyledAttributes
        +
        +

        Methods inherited from class java.lang.Object

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

        Constructor Details

        +
          +
        • +
          +

          DialogResourceFinder

          +
          public DialogResourceFinder​(@NonNull +android.app.Dialog dialog)
          +
          +
          • +
        +
        +
        • + +
      • +
        +

        Method Details

        +
          +
        • +
          +

          findViewById

          +
          @Nullable +public android.view.View findViewById​(@IdRes +int resId)
          +
          Description copied from interface: ResourceFinder
          +
          Finds a child view with the given identifier. Returns null if the + specified child view does not exist.
          +
          +
          Specified by:
          +
          findViewById in interface ResourceFinder
          +
          Overrides:
          +
          findViewById in class ActivityResourceFinder
          +
          Parameters:
          +
          resId - the identifier of the view to find
          +
          Returns:
          +
          The view with the given id or null.
          +
          +
          +
          • +
        • +
          +

          getPromptParentView

          +
          @NonNull +public android.view.ViewGroup getPromptParentView()
          +
          Description copied from interface: ResourceFinder
          +
          Get the view to add the prompt to.
          +
          +
          Specified by:
          +
          getPromptParentView in interface ResourceFinder
          +
          Overrides:
          +
          getPromptParentView in class ActivityResourceFinder
          +
          Returns:
          +
          The view to add the prompt to.
          +
          +
          +
          • +
        • +
          +

          getContext

          +
          @NonNull +public android.content.Context getContext()
          +
          Description copied from interface: ResourceFinder
          +
          Retrieve the Context that the prompt is running in.
          +
          +
          Specified by:
          +
          getContext in interface ResourceFinder
          +
          Overrides:
          +
          getContext in class ActivityResourceFinder
          +
          Returns:
          +
          Context The Context used by the prompt.
          +
          +
          +
          • +
        +
        +
        • +
      +
      + +
      + +
      +
      + + diff --git a/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/MaterialTapTargetPrompt.Builder.html b/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/MaterialTapTargetPrompt.Builder.html index b5398f4c..a4203609 100644 --- a/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/MaterialTapTargetPrompt.Builder.html +++ b/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/MaterialTapTargetPrompt.Builder.html @@ -1,340 +1,382 @@ - - - - - -MaterialTapTargetPrompt.Builder (material-tap-target-prompt 3.0.0 API) - - - - - - - - -
      - - -
      Skip navigation links
      - - - - -
      -
      - - - -
      - -
      -
      -
        -
      • Summary: 
        • -
      • Nested | 
        • -
      • Field | 
        • -
      • Constr | 
        • -
      • Method
        • -
      -
        -
      • Detail: 
        • -
      • Field | 
        • -
      • Constr | 
        • -
      • Method
        • -
      -
      - - -
      - - -
      -
      uk.co.samuelwall.materialtaptargetprompt
      -

      Class MaterialTapTargetPrompt.Builder

      -
      -
      - -
      - -
      -
      - -
      -
      -
        -
      • - -
          -
        • - - -

          Constructor Detail

          - - - -
            -
          • -

            Builder

            -
            public Builder(@NonNull
-               Fragment fragment)
            -
            Creates a builder for a tap target prompt that uses the default tap target prompt theme.
            -
            -
            Parameters:
            -
            fragment - the fragment to show the prompt within.
            -
            See Also:
            -
            #Builder(Fragment, int)
            -
            -
            • -
          - - - -
            -
          • -

            Builder

            -
            public Builder(@NonNull
-               Fragment fragment,
-               int themeResId)
            -
            Creates a builder for a material tap target prompt that uses an explicit theme resource. -

            - The themeResId may be specified as 0 to use the parent context's - resolved value for uk.co.samuelwall.materialtaptargetprompt.R.attr#MaterialTapTargetPromptTheme.

            -
            -
            Parameters:
            -
            fragment - the fragment to show the prompt within.
            -
            themeResId - the resource ID of the theme against which to inflate this dialog, or - 0 to use the parent context's default material tap - target prompt theme
            -
            -
            • -
          - - - -
            -
          • -

            Builder

            -
            public Builder(@NonNull
-               DialogFragment dialogFragment)
            -
            Creates a builder for a tap target prompt that uses the default tap target prompt theme.
            -
            -
            Parameters:
            -
            dialogFragment - the dialog fragment to show the prompt within.
            -
            See Also:
            -
            #Builder(DialogFragment, int)
            -
            -
            • -
          - - - -
            -
          • -

            Builder

            -
            public Builder(@NonNull
-               DialogFragment dialogFragment,
-               int themeResId)
            -
            Creates a builder for a material tap target prompt that uses an explicit theme resource. -

            - The themeResId may be specified as 0 to use the parent context's - resolved value for uk.co.samuelwall.materialtaptargetprompt.R.attr#MaterialTapTargetPromptTheme.

            -
            -
            Parameters:
            -
            dialogFragment - the dialog fragment to show the prompt within.
            -
            themeResId - the resource ID of the theme against which to inflate this dialog, - or 0 to use the parent context's default material - tap target prompt theme
            -
            -
            • -
          -
          • -
        -
        • -
      -
      -
      - - -
      - - -
      Skip navigation links
      - - - - -
      -
      - - - -
      - -
      -
      -
        -
      • Summary: 
        • -
      • Nested | 
        • -
      • Field | 
        • -
      • Constr | 
        • -
      • Method
        • -
      -
        -
      • Detail: 
        • -
      • Field | 
        • -
      • Constr | 
        • -
      • Method
        • -
      -
      - - -
      - - - + + + + + +MaterialTapTargetPrompt.Builder (material-tap-target-prompt 3.0.1 API) + + + + + + + + + + + + + +
      + +
      +
      + +
      +
      Package uk.co.samuelwall.materialtaptargetprompt
      +

      Class MaterialTapTargetPrompt.Builder

      +
      +
      java.lang.Object +
      uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions<MaterialTapTargetPrompt.Builder> +
      uk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetPrompt.Builder
      +
      +
      +
      +
      +
      Enclosing class:
      +
      MaterialTapTargetPrompt
      +
      +
      +
      public static class MaterialTapTargetPrompt.Builder
+extends PromptOptions<MaterialTapTargetPrompt.Builder>
      +
      A builder to create a MaterialTapTargetPrompt instance.
      +
      +
      + +
      +
      +
        + +
      • +
        +

        Constructor Details

        +
          +
        • +
          +

          Builder

          +
          public Builder​(@NonNull +androidx.fragment.app.Fragment fragment)
          +
          Creates a builder for a tap target prompt that uses the default tap target prompt theme.
          +
          +
          Parameters:
          +
          fragment - the fragment to show the prompt within.
          +
          See Also:
          +
          Builder(Fragment, int)
          +
          +
          +
          • +
        • +
          +

          Builder

          +
          public Builder​(@NonNull +androidx.fragment.app.Fragment fragment, +int themeResId)
          +
          Creates a builder for a material tap target prompt that uses an explicit theme resource. +

          + The themeResId may be specified as 0 to use the parent context's + resolved value for R.attr.MaterialTapTargetPromptTheme.

          +
          +
          Parameters:
          +
          fragment - the fragment to show the prompt within.
          +
          themeResId - the resource ID of the theme against which to inflate this dialog, or + 0 to use the parent context's default material tap + target prompt theme
          +
          +
          +
          • +
        • +
          +

          Builder

          +
          public Builder​(@NonNull +androidx.fragment.app.DialogFragment dialogFragment)
          +
          Creates a builder for a tap target prompt that uses the default tap target prompt theme.
          +
          +
          Parameters:
          +
          dialogFragment - the dialog fragment to show the prompt within.
          +
          See Also:
          +
          Builder(DialogFragment, int)
          +
          +
          +
          • +
        • +
          +

          Builder

          +
          public Builder​(@NonNull +androidx.fragment.app.DialogFragment dialogFragment, +int themeResId)
          +
          Creates a builder for a material tap target prompt that uses an explicit theme resource. +

          + The themeResId may be specified as 0 to use the parent context's + resolved value for R.attr.MaterialTapTargetPromptTheme.

          +
          +
          Parameters:
          +
          dialogFragment - the dialog fragment to show the prompt within.
          +
          themeResId - the resource ID of the theme against which to inflate this dialog, + or 0 to use the parent context's default material + tap target prompt theme
          +
          +
          +
          • +
        • +
          +

          Builder

          +
          public Builder​(@NonNull +android.app.Dialog dialog)
          +
          Creates a builder for a tap target prompt that uses the default tap target prompt theme.
          +
          +
          Parameters:
          +
          dialog - the dialog to show the prompt within.
          +
          +
          +
          • +
        • +
          +

          Builder

          +
          public Builder​(@NonNull +android.app.Dialog dialog, +int themeResId)
          +
          Creates a builder for a material tap target prompt that uses an explicit theme resource. +

          + The themeResId may be specified as 0 to use the parent context's + resolved value for R.attr.MaterialTapTargetPromptTheme.

          +
          +
          Parameters:
          +
          dialog - the dialog to show the prompt within.
          +
          themeResId - the resource ID of the theme against which to inflate this dialog, or + 0 to use the parent context's default material tap + target prompt theme
          +
          +
          +
          • +
        • +
          +

          Builder

          +
          public Builder​(@NonNull +android.app.Activity activity)
          +
          Creates a builder for a tap target prompt that uses the default tap target prompt theme.
          +
          +
          Parameters:
          +
          activity - the activity to show the prompt within.
          +
          +
          +
          • +
        • +
          +

          Builder

          +
          public Builder​(@NonNull +android.app.Activity activity, +int themeResId)
          +
          Creates a builder for a material tap target prompt that uses an explicit theme resource. +

          + The themeResId may be specified as 0 to use the parent context's + resolved value for R.attr.MaterialTapTargetPromptTheme.

          +
          +
          Parameters:
          +
          activity - the activity to show the prompt within.
          +
          themeResId - the resource ID of the theme against which to inflate this dialog, or + 0 to use the parent context's default material tap + target prompt theme
          +
          +
          +
          • +
        • +
          +

          Builder

          +
          public Builder​(@NonNull +ResourceFinder resourceFinder, +int themeResId)
          +
          Creates a builder for a material tap target prompt that uses an explicit theme resource. +

          + The themeResId may be specified as 0 to use the parent context's + resolved value for R.attr.MaterialTapTargetPromptTheme.

          +
          +
          Parameters:
          +
          resourceFinder - The ResourceFinder used to find views and resources.
          +
          themeResId - the resource ID of the theme against which to inflate this dialog, + or 0 to use the parent context's default material + tap target prompt theme
          +
          +
          +
          • +
        +
        +
        • +
      +
      + +
      + +
      +
      + + diff --git a/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/MaterialTapTargetPrompt.PromptStateChangeListener.html b/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/MaterialTapTargetPrompt.PromptStateChangeListener.html index e92f27ef..7e53d360 100644 --- a/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/MaterialTapTargetPrompt.PromptStateChangeListener.html +++ b/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/MaterialTapTargetPrompt.PromptStateChangeListener.html @@ -1,240 +1,194 @@ - - - - - -MaterialTapTargetPrompt.PromptStateChangeListener (material-tap-target-prompt 3.0.0 API) - - - - - - - - -
      - - -
      Skip navigation links
      - - - - -
      -
      - - - -
      - -
      -
      -
        -
      • Summary: 
        • -
      • Nested | 
        • -
      • Field | 
        • -
      • Constr | 
        • -
      • Method
        • -
      -
        -
      • Detail: 
        • -
      • Field | 
        • -
      • Constr | 
        • -
      • Method
        • -
      -
      - - -
      - - -
      -
      uk.co.samuelwall.materialtaptargetprompt
      -

      Interface MaterialTapTargetPrompt.PromptStateChangeListener

      -
      -
      -
      -
        -
      • -
        -
        All Known Implementing Classes:
        -
        SequenceItem, SequenceItemShowFor
        -
        -
        -
        Enclosing class:
        -
        MaterialTapTargetPrompt
        -
        -
        -
        -
        public static interface MaterialTapTargetPrompt.PromptStateChangeListener
        -
        Interface definition for a callback to be invoked when a prompts state changes.
        -
        • -
      -
      -
      - -
      -
      - -
      -
      - - -
      - - -
      Skip navigation links
      - - - - -
      -
      - - - -
      - -
      -
      -
        -
      • Summary: 
        • -
      • Nested | 
        • -
      • Field | 
        • -
      • Constr | 
        • -
      • Method
        • -
      -
        -
      • Detail: 
        • -
      • Field | 
        • -
      • Constr | 
        • -
      • Method
        • -
      -
      - - -
      - - - + + + + + +MaterialTapTargetPrompt.PromptStateChangeListener (material-tap-target-prompt 3.0.1 API) + + + + + + + + + + + + + +
      + +
      +
      + +
      +
      Package uk.co.samuelwall.materialtaptargetprompt
      +

      Interface MaterialTapTargetPrompt.PromptStateChangeListener

      +
      +
      +
      +
      All Known Implementing Classes:
      +
      SequenceItem, SequenceItemShowFor
      +
      +
      +
      Enclosing class:
      +
      MaterialTapTargetPrompt
      +
      +
      +
      public static interface MaterialTapTargetPrompt.PromptStateChangeListener
      +
      Interface definition for a callback to be invoked when a prompts state changes.
      +
      +
      +
        + +
      • +
        +

        Method Summary

        +
        +
        +
        + + + + + + + + + + + + + + + +
        Modifier and TypeMethodDescription
        voidonPromptStateChanged​(MaterialTapTargetPrompt prompt, +int state) +
        Called when the prompts state changes.
        +
        +
        +
        +
        +
        • +
      +
      +
      + +
      + +
      + +
      +
      + + diff --git a/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/MaterialTapTargetPrompt.html b/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/MaterialTapTargetPrompt.html index 905cf8fe..22065683 100644 --- a/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/MaterialTapTargetPrompt.html +++ b/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/MaterialTapTargetPrompt.html @@ -1,663 +1,582 @@ - - - - - -MaterialTapTargetPrompt (material-tap-target-prompt 3.0.0 API) - - - - - - - - -
      - - -
      Skip navigation links
      - - - - -
      -
      - - - -
      - -
      -
      - - -
      - - -
      - - -
      -
      uk.co.samuelwall.materialtaptargetprompt
      -

      Class MaterialTapTargetPrompt

      -
      -
      -
        -
      • java.lang.Object
        • -
      • -
          -
        • uk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetPrompt
          • -
        -
        • -
      -
      -
        -
      • -
        -
        -
        public class MaterialTapTargetPrompt
-extends java.lang.Object
        -
        A Material Design tap target onboarding implementation. -

        -

        -

        Onboarding

        -

        For more information about onboarding and tap targets, read the - Onboarding - Material Design guidelines.

        -
        -
        • -
      -
      -
      -
        -
      • - - - -
          -
        • - - -

          Field Summary

          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
          Fields 
          Modifier and TypeField and Description
          static intSTATE_BACK_BUTTON_PRESSED -
          The prompt has been dismissed by the system back button being pressed.
          -
          static intSTATE_DISMISSED -
          The prompt has been removed from view after the prompt has either been pressed somewhere - other than the prompt target or the system back button has been pressed.
          -
          static intSTATE_DISMISSING -
          The dismiss() method has been called and the prompt is being removed from view.
          -
          static intSTATE_FINISHED -
          The prompt has been removed from view after the prompt has been pressed in the focal area.
          -
          static intSTATE_FINISHING -
          The finish() method has been called and the prompt is being removed from view.
          -
          static intSTATE_FOCAL_PRESSED -
          The prompt target has been pressed in the focal area.
          -
          static intSTATE_NON_FOCAL_PRESSED -
          The prompt has been pressed outside the focal area.
          -
          static intSTATE_NOT_SHOWN -
          Prompt has yet to be shown.
          -
          static intSTATE_REVEALED -
          Prompt reveal animation has finished and the prompt is displayed.
          -
          static intSTATE_REVEALING -
          Prompt is reveal animation is running.
          -
          static intSTATE_SHOW_FOR_TIMEOUT -
          The prompt has been dismissed by the show for timeout.
          -
          -
          • -
        - -
          -
        • - - -

          Method Summary

          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
          All Methods Static Methods Instance Methods Concrete Methods 
          Modifier and TypeMethod and Description
          voidcancelShowForTimer() -
          Cancel the show for timer if it has been created.
          -
          static MaterialTapTargetPromptcreateDefault(PromptOptions promptOptions) -
          Creates a prompt with the supplied options.
          -
          voiddismiss() -
          Removes the prompt from view, using a contract and fade animation.
          -
          voidfinish() -
          Removes the prompt from view, using a expand and fade animation.
          -
          intgetState() -
          Get the current state of the prompt.
          -
          protected voidonPromptStateChanged(int state) -
          Handles emitting the prompt state changed events.
          -
          voidshow() -
          Displays the prompt.
          -
          voidshowFor(long millis) -
          Displays the prompt for a maximum amount of time.
          -
          -
            -
          • - - -

            Methods inherited from class java.lang.Object

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

          Field Detail

          - - - -
            -
          • -

            STATE_NOT_SHOWN

            -
            public static final int STATE_NOT_SHOWN
            -
            Prompt has yet to be shown.
            -
            -
            See Also:
            -
            Constant Field Values
            -
            -
            • -
          - - - -
            -
          • -

            STATE_REVEALING

            -
            public static final int STATE_REVEALING
            -
            Prompt is reveal animation is running.
            -
            -
            See Also:
            -
            Constant Field Values
            -
            -
            • -
          - - - -
            -
          • -

            STATE_REVEALED

            -
            public static final int STATE_REVEALED
            -
            Prompt reveal animation has finished and the prompt is displayed.
            -
            -
            See Also:
            -
            Constant Field Values
            -
            -
            • -
          - - - -
            -
          • -

            STATE_FOCAL_PRESSED

            -
            public static final int STATE_FOCAL_PRESSED
            -
            The prompt target has been pressed in the focal area.
            -
            -
            See Also:
            -
            Constant Field Values
            -
            -
            • -
          - - - -
            -
          • -

            STATE_FINISHED

            -
            public static final int STATE_FINISHED
            -
            The prompt has been removed from view after the prompt has been pressed in the focal area.
            -
            -
            See Also:
            -
            Constant Field Values
            -
            -
            • -
          - - - -
            -
          • -

            STATE_DISMISSING

            -
            public static final int STATE_DISMISSING
            -
            The dismiss() method has been called and the prompt is being removed from view.
            -
            -
            See Also:
            -
            Constant Field Values
            -
            -
            • -
          - - - -
            -
          • -

            STATE_DISMISSED

            -
            public static final int STATE_DISMISSED
            -
            The prompt has been removed from view after the prompt has either been pressed somewhere - other than the prompt target or the system back button has been pressed.
            -
            -
            See Also:
            -
            Constant Field Values
            -
            -
            • -
          - - - -
            -
          • -

            STATE_FINISHING

            -
            public static final int STATE_FINISHING
            -
            The finish() method has been called and the prompt is being removed from view.
            -
            -
            See Also:
            -
            Constant Field Values
            -
            -
            • -
          - - - -
            -
          • -

            STATE_NON_FOCAL_PRESSED

            -
            public static final int STATE_NON_FOCAL_PRESSED
            -
            The prompt has been pressed outside the focal area.
            -
            -
            See Also:
            -
            Constant Field Values
            -
            -
            • -
          - - - -
            -
          • -

            STATE_SHOW_FOR_TIMEOUT

            -
            public static final int STATE_SHOW_FOR_TIMEOUT
            -
            The prompt has been dismissed by the show for timeout.
            -
            -
            See Also:
            -
            Constant Field Values
            -
            -
            • -
          - - - -
            -
          • -

            STATE_BACK_BUTTON_PRESSED

            -
            public static final int STATE_BACK_BUTTON_PRESSED
            -
            The prompt has been dismissed by the system back button being pressed.
            -
            -
            See Also:
            -
            Constant Field Values
            -
            -
            • -
          -
          • -
        - -
          -
        • - - -

          Method Detail

          - - - -
            -
          • -

            show

            -
            public void show()
            -
            Displays the prompt.
            -
            • -
          - - - -
            -
          • -

            showFor

            -
            public void showFor(long millis)
            -
            Displays the prompt for a maximum amount of time.
            -
            -
            Parameters:
            -
            millis - The number of milliseconds to show the prompt for.
            -
            -
            • -
          - - - -
            -
          • -

            cancelShowForTimer

            -
            public void cancelShowForTimer()
            -
            Cancel the show for timer if it has been created.
            -
            • -
          - - - - - - - -
            -
          • -

            finish

            -
            public void finish()
            -
            Removes the prompt from view, using a expand and fade animation. -

            - This is treated as if the user has touched the target focal point.

            -
            • -
          - - - -
            -
          • -

            dismiss

            -
            public void dismiss()
            -
            Removes the prompt from view, using a contract and fade animation. -

            - This is treated as if the user has touched outside the target focal point.

            -
            • -
          - - - -
            -
          • -

            onPromptStateChanged

            -
            protected void onPromptStateChanged(int state)
            -
            Handles emitting the prompt state changed events.
            -
            -
            Parameters:
            -
            state - The state that the prompt is now in.
            -
            -
            • -
          - - - -
            -
          • -

            createDefault

            -
            @NonNull
-public static MaterialTapTargetPrompt createDefault(@NonNull
-                                                             PromptOptions promptOptions)
            -
            Creates a prompt with the supplied options.
            -
            -
            Parameters:
            -
            promptOptions - The options to use to create the prompt.
            -
            Returns:
            -
            The created prompt.
            -
            -
            • -
          -
          • -
        -
        • -
      -
      -
      - - -
      - - -
      Skip navigation links
      - - - - -
      -
      - - - -
      - -
      -
      - - -
      - - -
      - - - + + + + + +MaterialTapTargetPrompt (material-tap-target-prompt 3.0.1 API) + + + + + + + + + + + + + +
      + +
      +
      + +
      +
      Package uk.co.samuelwall.materialtaptargetprompt
      +

      Class MaterialTapTargetPrompt

      +
      +
      java.lang.Object +
      uk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetPrompt
      +
      +
      +
      +
      public class MaterialTapTargetPrompt
+extends java.lang.Object
      +
      A Material Design tap target onboarding implementation. +
      +

      For more information about onboarding and tap targets, read the + Onboarding + Material Design guidelines.

      +
      +
      +
      +
        + +
      • +
        +

        Nested Class Summary

        +
        + + + + + + + + + + + + + + + + + + + + + +
        Nested Classes
        Modifier and TypeClassDescription
        static class MaterialTapTargetPrompt.Builder +
        A builder to create a MaterialTapTargetPrompt instance.
        +
        static interface MaterialTapTargetPrompt.PromptStateChangeListener +
        Interface definition for a callback to be invoked when a prompts state changes.
        +
        +
        +
        +
        • + +
      • +
        +

        Field Summary

        +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        Fields
        Modifier and TypeFieldDescription
        static intSTATE_BACK_BUTTON_PRESSED +
        The prompt has been dismissed by the system back button being pressed.
        +
        static intSTATE_DISMISSED +
        The prompt has been removed from view after the prompt has either been pressed somewhere + other than the prompt target or the system back button has been pressed.
        +
        static intSTATE_DISMISSING +
        The dismiss() method has been called and the prompt is being removed from view.
        +
        static intSTATE_FINISHED +
        The prompt has been removed from view after the prompt has been pressed in the focal area.
        +
        static intSTATE_FINISHING +
        The finish() method has been called and the prompt is being removed from view.
        +
        static intSTATE_FOCAL_PRESSED +
        The prompt target has been pressed in the focal area.
        +
        static intSTATE_NON_FOCAL_PRESSED +
        The prompt has been pressed outside the focal area.
        +
        static intSTATE_NOT_SHOWN +
        Prompt has yet to be shown.
        +
        static intSTATE_REVEALED +
        Prompt reveal animation has finished and the prompt is displayed.
        +
        static intSTATE_REVEALING +
        Prompt is reveal animation is running.
        +
        static intSTATE_SHOW_FOR_TIMEOUT +
        The prompt has been dismissed by the show for timeout.
        +
        +
        +
        +
        • + +
      • +
        +

        Method Summary

        +
        +
        +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        Modifier and TypeMethodDescription
        voidcancelShowForTimer() +
        Cancel the show for timer if it has been created.
        +
        static MaterialTapTargetPromptcreateDefault​(PromptOptions promptOptions) +
        Creates a prompt with the supplied options.
        +
        voiddismiss() +
        Removes the prompt from view, using a contract and fade animation.
        +
        voidfinish() +
        Removes the prompt from view, using a expand and fade animation.
        +
        intgetState() +
        Get the current state of the prompt.
        +
        protected voidonPromptStateChanged​(int state) +
        Handles emitting the prompt state changed events.
        +
        voidshow() +
        Displays the prompt.
        +
        voidshowFor​(long millis) +
        Displays the prompt for a maximum amount of time.
        +
        +
        +
        +
        +

        Methods inherited from class java.lang.Object

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

        Field Details

        +
          +
        • +
          +

          STATE_NOT_SHOWN

          +
          public static final int STATE_NOT_SHOWN
          +
          Prompt has yet to be shown.
          +
          +
          See Also:
          +
          Constant Field Values
          +
          +
          +
          • +
        • +
          +

          STATE_REVEALING

          +
          public static final int STATE_REVEALING
          +
          Prompt is reveal animation is running.
          +
          +
          See Also:
          +
          Constant Field Values
          +
          +
          +
          • +
        • +
          +

          STATE_REVEALED

          +
          public static final int STATE_REVEALED
          +
          Prompt reveal animation has finished and the prompt is displayed.
          +
          +
          See Also:
          +
          Constant Field Values
          +
          +
          +
          • +
        • +
          +

          STATE_FOCAL_PRESSED

          +
          public static final int STATE_FOCAL_PRESSED
          +
          The prompt target has been pressed in the focal area.
          +
          +
          See Also:
          +
          Constant Field Values
          +
          +
          +
          • +
        • +
          +

          STATE_FINISHED

          +
          public static final int STATE_FINISHED
          +
          The prompt has been removed from view after the prompt has been pressed in the focal area.
          +
          +
          See Also:
          +
          Constant Field Values
          +
          +
          +
          • +
        • +
          +

          STATE_DISMISSING

          +
          public static final int STATE_DISMISSING
          +
          The dismiss() method has been called and the prompt is being removed from view.
          +
          +
          See Also:
          +
          Constant Field Values
          +
          +
          +
          • +
        • +
          +

          STATE_DISMISSED

          +
          public static final int STATE_DISMISSED
          +
          The prompt has been removed from view after the prompt has either been pressed somewhere + other than the prompt target or the system back button has been pressed.
          +
          +
          See Also:
          +
          Constant Field Values
          +
          +
          +
          • +
        • +
          +

          STATE_FINISHING

          +
          public static final int STATE_FINISHING
          +
          The finish() method has been called and the prompt is being removed from view.
          +
          +
          See Also:
          +
          Constant Field Values
          +
          +
          +
          • +
        • +
          +

          STATE_NON_FOCAL_PRESSED

          +
          public static final int STATE_NON_FOCAL_PRESSED
          +
          The prompt has been pressed outside the focal area.
          +
          +
          See Also:
          +
          Constant Field Values
          +
          +
          +
          • +
        • +
          +

          STATE_SHOW_FOR_TIMEOUT

          +
          public static final int STATE_SHOW_FOR_TIMEOUT
          +
          The prompt has been dismissed by the show for timeout.
          +
          +
          See Also:
          +
          Constant Field Values
          +
          +
          +
          • +
        • +
          +

          STATE_BACK_BUTTON_PRESSED

          +
          public static final int STATE_BACK_BUTTON_PRESSED
          +
          The prompt has been dismissed by the system back button being pressed.
          +
          +
          See Also:
          +
          Constant Field Values
          +
          +
          +
          • +
        +
        +
        • + +
      • +
        +

        Method Details

        +
          +
        • +
          +

          show

          +
          public void show()
          +
          Displays the prompt.
          +
          +
          • +
        • +
          +

          showFor

          +
          public void showFor​(long millis)
          +
          Displays the prompt for a maximum amount of time.
          +
          +
          Parameters:
          +
          millis - The number of milliseconds to show the prompt for.
          +
          +
          +
          • +
        • +
          +

          cancelShowForTimer

          +
          public void cancelShowForTimer()
          +
          Cancel the show for timer if it has been created.
          +
          +
          • +
        • +
          +

          getState

          +
          public int getState()
          +
          Get the current state of the prompt.
          +
          +
          See Also:
          +
          STATE_NOT_SHOWN, +STATE_REVEALING, +STATE_REVEALED, +STATE_FOCAL_PRESSED, +STATE_NON_FOCAL_PRESSED, +STATE_BACK_BUTTON_PRESSED, +STATE_FINISHING, +STATE_FINISHED, +STATE_DISMISSING, +STATE_DISMISSED
          +
          +
          +
          • +
        • +
          +

          finish

          +
          public void finish()
          +
          Removes the prompt from view, using a expand and fade animation. +

          + This is treated as if the user has touched the target focal point.

          +
          +
          • +
        • +
          +

          dismiss

          +
          public void dismiss()
          +
          Removes the prompt from view, using a contract and fade animation. +

          + This is treated as if the user has touched outside the target focal point.

          +
          +
          • +
        • +
          +

          onPromptStateChanged

          +
          protected void onPromptStateChanged​(int state)
          +
          Handles emitting the prompt state changed events.
          +
          +
          Parameters:
          +
          state - The state that the prompt is now in.
          +
          +
          +
          • +
        • +
          +

          createDefault

          +
          @NonNull +public static MaterialTapTargetPrompt createDefault​(@NonNull +PromptOptions promptOptions)
          +
          Creates a prompt with the supplied options.
          +
          +
          Parameters:
          +
          promptOptions - The options to use to create the prompt.
          +
          Returns:
          +
          The created prompt.
          +
          +
          +
          • +
        +
        +
        • +
      +
      + +
      + +
      +
      + + diff --git a/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/MaterialTapTargetSequence.SequenceCompleteListener.html b/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/MaterialTapTargetSequence.SequenceCompleteListener.html index fc3b7df1..cf8468b3 100644 --- a/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/MaterialTapTargetSequence.SequenceCompleteListener.html +++ b/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/MaterialTapTargetSequence.SequenceCompleteListener.html @@ -1,227 +1,181 @@ - - - - - -MaterialTapTargetSequence.SequenceCompleteListener (material-tap-target-prompt 3.0.0 API) - - - - - - - - -
      - - -
      Skip navigation links
      - - - - -
      -
      - - - -
      - -
      -
      -
        -
      • Summary: 
        • -
      • Nested | 
        • -
      • Field | 
        • -
      • Constr | 
        • -
      • Method
        • -
      -
        -
      • Detail: 
        • -
      • Field | 
        • -
      • Constr | 
        • -
      • Method
        • -
      -
      - - -
      - - -
      -
      uk.co.samuelwall.materialtaptargetprompt
      -

      Interface MaterialTapTargetSequence.SequenceCompleteListener

      -
      -
      -
      -
        -
      • -
        -
        Enclosing class:
        -
        MaterialTapTargetSequence
        -
        -
        -
        -
        public static interface MaterialTapTargetSequence.SequenceCompleteListener
        -
        Interface definition for a callback to be invoked when a sequence completes.
        -
        • -
      -
      -
      - -
      -
      -
        -
      • - -
          -
        • - - -

          Method Detail

          - - - -
            -
          • -

            onSequenceComplete

            -
            void onSequenceComplete()
            -
            Called after the final prompt is closed
            -
            • -
          -
          • -
        -
        • -
      -
      -
      - - -
      - - -
      Skip navigation links
      - - - - -
      -
      - - - -
      - -
      -
      -
        -
      • Summary: 
        • -
      • Nested | 
        • -
      • Field | 
        • -
      • Constr | 
        • -
      • Method
        • -
      -
        -
      • Detail: 
        • -
      • Field | 
        • -
      • Constr | 
        • -
      • Method
        • -
      -
      - - -
      - - - + + + + + +MaterialTapTargetSequence.SequenceCompleteListener (material-tap-target-prompt 3.0.1 API) + + + + + + + + + + + + + +
      + +
      +
      + +
      +
      Package uk.co.samuelwall.materialtaptargetprompt
      +

      Interface MaterialTapTargetSequence.SequenceCompleteListener

      +
      +
      +
      +
      Enclosing class:
      +
      MaterialTapTargetSequence
      +
      +
      +
      public static interface MaterialTapTargetSequence.SequenceCompleteListener
      +
      Interface definition for a callback to be invoked when a sequence completes.
      +
      +
      +
        + +
      • +
        +

        Method Summary

        +
        +
        +
        + + + + + + + + + + + + + + + +
        Modifier and TypeMethodDescription
        voidonSequenceComplete() +
        Called after the final prompt is closed
        +
        +
        +
        +
        +
        • +
      +
      +
      +
        + +
      • +
        +

        Method Details

        +
          +
        • +
          +

          onSequenceComplete

          +
          void onSequenceComplete()
          +
          Called after the final prompt is closed
          +
          +
          • +
        +
        +
        • +
      +
      + +
      + +
      +
      + + diff --git a/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/MaterialTapTargetSequence.html b/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/MaterialTapTargetSequence.html index 4f2c8569..c1227d21 100644 --- a/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/MaterialTapTargetSequence.html +++ b/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/MaterialTapTargetSequence.html @@ -1,559 +1,491 @@ - - - - - -MaterialTapTargetSequence (material-tap-target-prompt 3.0.0 API) - - - - - - - - -
      - - -
      Skip navigation links
      - - - - -
      -
      - - - -
      - -
      -
      - - -
      - - -
      - - -
      -
      uk.co.samuelwall.materialtaptargetprompt
      -

      Class MaterialTapTargetSequence

      -
      -
      -
        -
      • java.lang.Object
        • -
      • -
          -
        • uk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetSequence
          • -
        -
        • -
      -
      -
        -
      • -
        -
        -
        public class MaterialTapTargetSequence
-extends java.lang.Object
        -
        A Sequence of prompts to be shown one after another
        -
        • -
      -
      -
      - -
      -
      -
        -
      • - -
          -
        • - - -

          Constructor Detail

          - - - -
            -
          • -

            MaterialTapTargetSequence

            -
            public MaterialTapTargetSequence()
            -
            • -
          -
          • -
        - -
          -
        • - - -

          Method Detail

          - - - - - - - - - - - -
            -
          • -

            addPrompt

            -
            @NonNull
-public MaterialTapTargetSequence addPrompt(@Nullable
-                                                    MaterialTapTargetPrompt prompt,
-                                                    long milliseconds)
            -
            Add a show for time prompt to the end of the sequence.
            -
            -
            Parameters:
            -
            prompt - The prompt to add.
            -
            milliseconds - The number of milliseconds to show the prompt for.
            -
            Returns:
            -
            This.
            -
            -
            • -
          - - - -
            -
          • -

            addPrompt

            -
            @NonNull
-public MaterialTapTargetSequence addPrompt(@NonNull
-                                                    PromptOptions promptOptions)
            -
            Add a prompt to the end of the sequence.
            -
            -
            Parameters:
            -
            promptOptions - The prompt to add.
            -
            Returns:
            -
            This.
            -
            -
            • -
          - - - -
            -
          • -

            addPrompt

            -
            @NonNull
-public MaterialTapTargetSequence addPrompt(@NonNull
-                                                    PromptOptions promptOptions,
-                                                    long milliseconds)
            -
            Add a show for time prompt to the end of the sequence.
            -
            -
            Parameters:
            -
            promptOptions - The prompt to add.
            -
            milliseconds - The number of milliseconds to show the prompt for.
            -
            Returns:
            -
            This.
            -
            -
            • -
          - - - - - - - -
            -
          • -

            size

            -
            public int size()
            -
            Get the number of prompts in this sequence.
            -
            -
            Returns:
            -
            The number of prompts in this sequence.
            -
            -
            • -
          - - - -
            -
          • -

            get

            -
            @NonNull
-public SequenceItem get(int index)
            -
            Gets a prompt at a position in this sequence.
            -
            -
            Parameters:
            -
            index - The prompt 0 based index.
            -
            Returns:
            -
            The prompt at the specified position in this sequence.
            -
            -
            • -
          - - - -
            -
          • -

            show

            -
            @NonNull
-public MaterialTapTargetSequence show()
            -
            Start the sequence by showing the first prompt.
            -
            -
            Returns:
            -
            This.
            -
            -
            • -
          - - - -
            -
          • -

            finish

            -
            @NonNull
-public MaterialTapTargetSequence finish()
            -
            Removes the currently displayed prompt in the sequence from view using the finish action and stops the sequence - from continuing.
            -
            -
            Returns:
            -
            This.
            -
            -
            • -
          - - - -
            -
          • -

            dismiss

            -
            @NonNull
-public MaterialTapTargetSequence dismiss()
            -
            Removes the currently displayed prompt in the sequence from view using the dismiss action and stops the sequence - from continuing.
            -
            -
            Returns:
            -
            This.
            -
            -
            • -
          - - - -
            -
          • -

            showFromIndex

            -
            @NonNull
-public MaterialTapTargetSequence showFromIndex(int index)
            -
            Shows or continues to show this sequence from the prompt at the index supplied.
            -
            -
            Parameters:
            -
            index - The index to show from.
            -
            Returns:
            -
            This.
            -
            -
            • -
          -
          • -
        -
        • -
      -
      -
      - - -
      - - -
      Skip navigation links
      - - - - -
      -
      - - - -
      - -
      -
      - - -
      - - -
      - - - + + + + + +MaterialTapTargetSequence (material-tap-target-prompt 3.0.1 API) + + + + + + + + + + + + + +
      + +
      +
      + +
      +
      Package uk.co.samuelwall.materialtaptargetprompt
      +

      Class MaterialTapTargetSequence

      +
      +
      java.lang.Object +
      uk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetSequence
      +
      +
      +
      +
      public class MaterialTapTargetSequence
+extends java.lang.Object
      +
      A Sequence of prompts to be shown one after another
      +
      +
      + +
      +
      +
        + +
      • +
        +

        Constructor Details

        +
          +
        • +
          +

          MaterialTapTargetSequence

          +
          public MaterialTapTargetSequence()
          +
          +
          • +
        +
        +
        • + +
      • +
        +

        Method Details

        +
          +
        • +
          +

          setSequenceCompleteListener

          +
          @NonNull +public MaterialTapTargetSequence setSequenceCompleteListener​(@Nullable +MaterialTapTargetSequence.SequenceCompleteListener listener)
          +
          Set the listener to listen with the action to call when the sequence ends
          +
          +
          Parameters:
          +
          listener - the listener with the action to execute
          +
          +
          +
          • +
        • +
          +

          addPrompt

          +
          @NonNull +public MaterialTapTargetSequence addPrompt​(@Nullable +MaterialTapTargetPrompt prompt)
          +
          Add a prompt to the end of the sequence.
          +
          +
          Parameters:
          +
          prompt - The prompt to add.
          +
          +
          +
          • +
        • +
          +

          addPrompt

          +
          @NonNull +public MaterialTapTargetSequence addPrompt​(@Nullable +MaterialTapTargetPrompt prompt, +long milliseconds)
          +
          Add a show for time prompt to the end of the sequence.
          +
          +
          Parameters:
          +
          prompt - The prompt to add.
          +
          milliseconds - The number of milliseconds to show the prompt for.
          +
          Returns:
          +
          This.
          +
          +
          +
          • +
        • +
          +

          addPrompt

          +
          @NonNull +public MaterialTapTargetSequence addPrompt​(@NonNull +PromptOptions promptOptions)
          +
          Add a prompt to the end of the sequence.
          +
          +
          Parameters:
          +
          promptOptions - The prompt to add.
          +
          Returns:
          +
          This.
          +
          +
          +
          • +
        • +
          +

          addPrompt

          +
          @NonNull +public MaterialTapTargetSequence addPrompt​(@NonNull +PromptOptions promptOptions, +long milliseconds)
          +
          Add a show for time prompt to the end of the sequence.
          +
          +
          Parameters:
          +
          promptOptions - The prompt to add.
          +
          milliseconds - The number of milliseconds to show the prompt for.
          +
          Returns:
          +
          This.
          +
          +
          +
          • +
        • +
          +

          addPrompt

          +
          @NonNull +public MaterialTapTargetSequence addPrompt​(@NonNull +SequenceItem item)
          +
          Adds a sequence item to the end of the sequence. + This sequence item must have state changers added to it by calling + SequenceItem.addStateChanger(int).
          +
          +
          Parameters:
          +
          item - The already created sequence item to add.
          +
          Returns:
          +
          This.
          +
          +
          +
          • +
        • +
          +

          size

          +
          public int size()
          +
          Get the number of prompts in this sequence.
          +
          +
          Returns:
          +
          The number of prompts in this sequence.
          +
          +
          +
          • +
        • +
          +

          get

          +
          @NonNull +public SequenceItem get​(int index)
          +
          Gets a prompt at a position in this sequence.
          +
          +
          Parameters:
          +
          index - The prompt 0 based index.
          +
          Returns:
          +
          The prompt at the specified position in this sequence.
          +
          +
          +
          • +
        • +
          +

          show

          +
          @NonNull +public MaterialTapTargetSequence show()
          +
          Start the sequence by showing the first prompt.
          +
          +
          Returns:
          +
          This.
          +
          +
          +
          • +
        • +
          +

          finish

          +
          @NonNull +public MaterialTapTargetSequence finish()
          +
          Removes the currently displayed prompt in the sequence from view using the finish action and stops the sequence + from continuing.
          +
          +
          Returns:
          +
          This.
          +
          +
          +
          • +
        • +
          +

          dismiss

          +
          @NonNull +public MaterialTapTargetSequence dismiss()
          +
          Removes the currently displayed prompt in the sequence from view using the dismiss action and stops the sequence + from continuing.
          +
          +
          Returns:
          +
          This.
          +
          +
          +
          • +
        • +
          +

          showFromIndex

          +
          @NonNull +public MaterialTapTargetSequence showFromIndex​(int index)
          +
          Shows or continues to show this sequence from the prompt at the index supplied.
          +
          +
          Parameters:
          +
          index - The index to show from.
          +
          Returns:
          +
          This.
          +
          +
          +
          • +
        +
        +
        • +
      +
      + +
      + +
      +
      + + diff --git a/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/ResourceFinder.html b/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/ResourceFinder.html index 2aef3928..8330e101 100644 --- a/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/ResourceFinder.html +++ b/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/ResourceFinder.html @@ -1,399 +1,339 @@ - - - - - -ResourceFinder (material-tap-target-prompt 3.0.0 API) - - - - - - - - -
      - - -
      Skip navigation links
      - - - - -
      -
      - - - -
      - -
      -
      -
        -
      • Summary: 
        • -
      • Nested | 
        • -
      • Field | 
        • -
      • Constr | 
        • -
      • Method
        • -
      -
        -
      • Detail: 
        • -
      • Field | 
        • -
      • Constr | 
        • -
      • Method
        • -
      -
      - - -
      - - -
      -
      uk.co.samuelwall.materialtaptargetprompt
      -

      Interface ResourceFinder

      -
      -
      -
      - -
      -
      -
        -
      • - -
          -
        • - - -

          Method Summary

          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
          All Methods Instance Methods Abstract Methods 
          Modifier and TypeMethod and Description
          android.view.ViewfindViewById(int resId) -
          Finds a child view with the given identifier.
          -
          android.content.ContextgetContext() -
          Retrieve the Context that the prompt is running in.
          -
          android.graphics.drawable.DrawablegetDrawable(int resId) -
          Returns a drawable object associated with a particular resource ID and - styled for the current theme.
          -
          android.view.ViewGroupgetPromptParentView() -
          Get the view to add the prompt to.
          -
          android.content.res.ResourcesgetResources() -
          Returns a Resources instance for the application's package.
          -
          java.lang.StringgetString(int resId) -
          Returns a localized string from the application's package's - default string table.
          -
          android.content.res.Resources.ThemegetTheme() -
          Return the Theme object associated with getContext().
          -
          android.content.res.TypedArrayobtainStyledAttributes(int resId, - int[] attrs) -
          Retrieve styled attribute information in getContext() theme.
          -
          -
          • -
        -
        • -
      -
      -
      -
        -
      • - -
          -
        • - - -

          Method Detail

          - - - -
            -
          • -

            findViewById

            -
            @Nullable
-android.view.View findViewById(@IdRes
-                                         int resId)
            -
            Finds a child view with the given identifier. Returns null if the - specified child view does not exist.
            -
            -
            Parameters:
            -
            resId - the identifier of the view to find
            -
            Returns:
            -
            The view with the given id or null.
            -
            -
            • -
          - - - -
            -
          • -

            getPromptParentView

            -
            @NonNull
-android.view.ViewGroup getPromptParentView()
            -
            Get the view to add the prompt to.
            -
            -
            Returns:
            -
            The view to add the prompt to.
            -
            -
            • -
          - - - -
            -
          • -

            getContext

            -
            @NonNull
-android.content.Context getContext()
            -
            Retrieve the Context that the prompt is running in.
            -
            -
            Returns:
            -
            Context The Context used by the prompt.
            -
            -
            • -
          - - - -
            -
          • -

            getResources

            -
            @NonNull
-android.content.res.Resources getResources()
            -
            Returns a Resources instance for the application's package.
            -
            -
            Returns:
            -
            a Resources instance for the application's package
            -
            -
            • -
          - - - -
            -
          • -

            getTheme

            -
            @NonNull
-android.content.res.Resources.Theme getTheme()
            -
            Return the Theme object associated with getContext().
            -
            • -
          - - - -
            -
          • -

            getString

            -
            @NonNull
-java.lang.String getString(@StringRes
-                                    int resId)
            -
            Returns a localized string from the application's package's - default string table.
            -
            -
            Parameters:
            -
            resId - Resource id for the string
            -
            Returns:
            -
            The string data associated with the resource, stripped of styled - text information.
            -
            -
            • -
          - - - -
            -
          • -

            obtainStyledAttributes

            -
            @NonNull
-android.content.res.TypedArray obtainStyledAttributes(@StyleRes
-                                                               int resId,
-                                                               @StyleableRes
-                                                               int[] attrs)
            -
            Retrieve styled attribute information in getContext() theme. See - Resources.Theme.obtainStyledAttributes(int, int[]) - for more information.
            -
            -
            See Also:
            -
            Resources.Theme.obtainStyledAttributes(int, int[])
            -
            -
            • -
          - - - -
            -
          • -

            getDrawable

            -
            @Nullable
-android.graphics.drawable.Drawable getDrawable(@DrawableRes
-                                                         int resId)
            -
            Returns a drawable object associated with a particular resource ID and - styled for the current theme.
            -
            -
            Parameters:
            -
            resId - The desired resource identifier, as generated by the aapt - tool. This integer encodes the package, type, and resource - entry. The value 0 is an invalid identifier.
            -
            Returns:
            -
            An object that can be used to draw this resource, or - null if the resource could not be resolved.
            -
            -
            • -
          -
          • -
        -
        • -
      -
      -
      - - -
      - - -
      Skip navigation links
      - - - - -
      -
      - - - -
      - -
      -
      -
        -
      • Summary: 
        • -
      • Nested | 
        • -
      • Field | 
        • -
      • Constr | 
        • -
      • Method
        • -
      -
        -
      • Detail: 
        • -
      • Field | 
        • -
      • Constr | 
        • -
      • Method
        • -
      -
      - - -
      - - - + + + + + +ResourceFinder (material-tap-target-prompt 3.0.1 API) + + + + + + + + + + + + + +
      + +
      +
      + +
      +
      Package uk.co.samuelwall.materialtaptargetprompt
      +

      Interface ResourceFinder

      +
      +
      +
      +
      All Known Implementing Classes:
      +
      ActivityResourceFinder, DialogResourceFinder, SupportFragmentResourceFinder
      +
      +
      +
      public interface ResourceFinder
      +
      Interface used to find resources required by MaterialTapTargetPrompt.
      +
      +
      +
        + +
      • +
        +

        Method Summary

        +
        +
        +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        Modifier and TypeMethodDescription
        android.view.ViewfindViewById​(int resId) +
        Finds a child view with the given identifier.
        +
        android.content.ContextgetContext() +
        Retrieve the Context that the prompt is running in.
        +
        android.graphics.drawable.DrawablegetDrawable​(int resId) +
        Returns a drawable object associated with a particular resource ID and + styled for the current theme.
        +
        android.view.ViewGroupgetPromptParentView() +
        Get the view to add the prompt to.
        +
        android.content.res.ResourcesgetResources() +
        Returns a Resources instance for the application's package.
        +
        java.lang.StringgetString​(int resId) +
        Returns a localized string from the application's package's + default string table.
        +
        android.content.res.Resources.ThemegetTheme() +
        Return the Theme object associated with getContext().
        +
        android.content.res.TypedArrayobtainStyledAttributes​(int resId, +int[] attrs) +
        Retrieve styled attribute information in getContext() theme.
        +
        +
        +
        +
        +
        • +
      +
      +
      +
        + +
      • +
        +

        Method Details

        +
          +
        • +
          +

          findViewById

          +
          @Nullable +android.view.View findViewById​(@IdRes +int resId)
          +
          Finds a child view with the given identifier. Returns null if the + specified child view does not exist.
          +
          +
          Parameters:
          +
          resId - the identifier of the view to find
          +
          Returns:
          +
          The view with the given id or null.
          +
          +
          +
          • +
        • +
          +

          getPromptParentView

          +
          @NonNull +android.view.ViewGroup getPromptParentView()
          +
          Get the view to add the prompt to.
          +
          +
          Returns:
          +
          The view to add the prompt to.
          +
          +
          +
          • +
        • +
          +

          getContext

          +
          @NonNull +android.content.Context getContext()
          +
          Retrieve the Context that the prompt is running in.
          +
          +
          Returns:
          +
          Context The Context used by the prompt.
          +
          +
          +
          • +
        • +
          +

          getResources

          +
          @NonNull +android.content.res.Resources getResources()
          +
          Returns a Resources instance for the application's package.
          +
          +
          Returns:
          +
          a Resources instance for the application's package
          +
          +
          +
          • +
        • +
          +

          getTheme

          +
          @NonNull +android.content.res.Resources.Theme getTheme()
          +
          Return the Theme object associated with getContext().
          +
          +
          • +
        • +
          +

          getString

          +
          @NonNull +java.lang.String getString​(@StringRes +int resId)
          +
          Returns a localized string from the application's package's + default string table.
          +
          +
          Parameters:
          +
          resId - Resource id for the string
          +
          Returns:
          +
          The string data associated with the resource, stripped of styled + text information.
          +
          +
          +
          • +
        • +
          +

          obtainStyledAttributes

          +
          @NonNull +android.content.res.TypedArray obtainStyledAttributes​(@StyleRes +int resId, +@StyleableRes +int[] attrs)
          +
          Retrieve styled attribute information in getContext() theme. See + Resources.Theme.obtainStyledAttributes(int, int[]) + for more information.
          +
          +
          See Also:
          +
          Resources.Theme.obtainStyledAttributes(int, int[])
          +
          +
          +
          • +
        • +
          +

          getDrawable

          +
          @Nullable +android.graphics.drawable.Drawable getDrawable​(@DrawableRes +int resId)
          +
          Returns a drawable object associated with a particular resource ID and + styled for the current theme.
          +
          +
          Parameters:
          +
          resId - The desired resource identifier, as generated by the aapt + tool. This integer encodes the package, type, and resource + entry. The value 0 is an invalid identifier.
          +
          Returns:
          +
          An object that can be used to draw this resource, or + null if the resource could not be resolved.
          +
          +
          +
          • +
        +
        +
        • +
      +
      + +
      + +
      +
      + + diff --git a/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/SupportFragmentResourceFinder.html b/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/SupportFragmentResourceFinder.html index 7979a10d..3e004e3c 100644 --- a/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/SupportFragmentResourceFinder.html +++ b/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/SupportFragmentResourceFinder.html @@ -1,479 +1,413 @@ - - - - - -SupportFragmentResourceFinder (material-tap-target-prompt 3.0.0 API) - - - - - - - - -
      - - -
      Skip navigation links
      - - - - -
      -
      - - - -
      - -
      -
      -
        -
      • Summary: 
        • -
      • Nested | 
        • -
      • Field | 
        • -
      • Constr | 
        • -
      • Method
        • -
      - -
      - - -
      - - -
      -
      uk.co.samuelwall.materialtaptargetprompt
      -

      Class SupportFragmentResourceFinder

      -
      -
      -
        -
      • java.lang.Object
        • -
      • -
          -
        • uk.co.samuelwall.materialtaptargetprompt.SupportFragmentResourceFinder
          • -
        -
        • -
      -
      - -
      -
      -
        -
      • - - - -
          -
        • - - -

          Method Summary

          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
          All Methods Instance Methods Concrete Methods 
          Modifier and TypeMethod and Description
          android.view.ViewfindViewById(int resId) -
          Finds a child view with the given identifier.
          -
          android.content.ContextgetContext() -
          Retrieve the Context that the prompt is running in.
          -
          android.graphics.drawable.DrawablegetDrawable(int resId) -
          Returns a drawable object associated with a particular resource ID and - styled for the current theme.
          -
          android.view.ViewGroupgetPromptParentView() -
          Get the view to add the prompt to.
          -
          android.content.res.ResourcesgetResources() -
          Returns a Resources instance for the application's package.
          -
          java.lang.StringgetString(int resId) -
          Returns a localized string from the application's package's - default string table.
          -
          android.content.res.Resources.ThemegetTheme() -
          Return the Theme object associated with ResourceFinder.getContext().
          -
          android.content.res.TypedArrayobtainStyledAttributes(int resId, - int[] attrs) -
          Retrieve styled attribute information in ResourceFinder.getContext() theme.
          -
          -
            -
          • - - -

            Methods inherited from class java.lang.Object

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

          Constructor Detail

          - - - -
            -
          • -

            SupportFragmentResourceFinder

            -
            public SupportFragmentResourceFinder(@NonNull
-                                     Fragment fragment)
            -
            Constructor.
            -
            -
            Parameters:
            -
            fragment - Fragment to get the resources from.
            -
            -
            • -
          -
          • -
        - -
          -
        • - - -

          Method Detail

          - - - -
            -
          • -

            findViewById

            -
            @Nullable
-public android.view.View findViewById(int resId)
            -
            Description copied from interface: ResourceFinder
            -
            Finds a child view with the given identifier. Returns null if the - specified child view does not exist.
            -
            -
            Specified by:
            -
            findViewById in interface ResourceFinder
            -
            Parameters:
            -
            resId - the identifier of the view to find
            -
            Returns:
            -
            The view with the given id or null.
            -
            -
            • -
          - - - -
            -
          • -

            getPromptParentView

            -
            @NonNull
-public android.view.ViewGroup getPromptParentView()
            -
            Description copied from interface: ResourceFinder
            -
            Get the view to add the prompt to.
            -
            -
            Specified by:
            -
            getPromptParentView in interface ResourceFinder
            -
            Returns:
            -
            The view to add the prompt to.
            -
            -
            • -
          - - - -
            -
          • -

            getContext

            -
            @NonNull
-public android.content.Context getContext()
            -
            Description copied from interface: ResourceFinder
            -
            Retrieve the Context that the prompt is running in.
            -
            -
            Specified by:
            -
            getContext in interface ResourceFinder
            -
            Returns:
            -
            Context The Context used by the prompt.
            -
            -
            • -
          - - - -
            -
          • -

            getResources

            -
            @NonNull
-public android.content.res.Resources getResources()
            -
            Description copied from interface: ResourceFinder
            -
            Returns a Resources instance for the application's package.
            -
            -
            Specified by:
            -
            getResources in interface ResourceFinder
            -
            Returns:
            -
            a Resources instance for the application's package
            -
            -
            • -
          - - - - - - - -
            -
          • -

            getString

            -
            @NonNull
-public java.lang.String getString(int resId)
            -
            Description copied from interface: ResourceFinder
            -
            Returns a localized string from the application's package's - default string table.
            -
            -
            Specified by:
            -
            getString in interface ResourceFinder
            -
            Parameters:
            -
            resId - Resource id for the string
            -
            Returns:
            -
            The string data associated with the resource, stripped of styled - text information.
            -
            -
            • -
          - - - -
            -
          • -

            obtainStyledAttributes

            -
            @NonNull
-public android.content.res.TypedArray obtainStyledAttributes(int resId,
-                                                                      int[] attrs)
            -
            Description copied from interface: ResourceFinder
            -
            Retrieve styled attribute information in ResourceFinder.getContext() theme. See - Resources.Theme.obtainStyledAttributes(int, int[]) - for more information.
            -
            -
            Specified by:
            -
            obtainStyledAttributes in interface ResourceFinder
            -
            See Also:
            -
            Resources.Theme.obtainStyledAttributes(int, int[])
            -
            -
            • -
          - - - -
            -
          • -

            getDrawable

            -
            @Nullable
-public android.graphics.drawable.Drawable getDrawable(int resId)
            -
            Description copied from interface: ResourceFinder
            -
            Returns a drawable object associated with a particular resource ID and - styled for the current theme.
            -
            -
            Specified by:
            -
            getDrawable in interface ResourceFinder
            -
            Parameters:
            -
            resId - The desired resource identifier, as generated by the aapt - tool. This integer encodes the package, type, and resource - entry. The value 0 is an invalid identifier.
            -
            Returns:
            -
            An object that can be used to draw this resource, or - null if the resource could not be resolved.
            -
            -
            • -
          -
          • -
        -
        • -
      -
      -
      - - -
      - - -
      Skip navigation links
      - - - - -
      -
      - - - -
      - -
      -
      -
        -
      • Summary: 
        • -
      • Nested | 
        • -
      • Field | 
        • -
      • Constr | 
        • -
      • Method
        • -
      - -
      - - -
      - - - + + + + + +SupportFragmentResourceFinder (material-tap-target-prompt 3.0.1 API) + + + + + + + + + + + + + +
      + +
      +
      + +
      +
      Package uk.co.samuelwall.materialtaptargetprompt
      +

      Class SupportFragmentResourceFinder

      +
      +
      java.lang.Object +
      uk.co.samuelwall.materialtaptargetprompt.SupportFragmentResourceFinder
      +
      +
      +
      +
      All Implemented Interfaces:
      +
      ResourceFinder
      +
      +
      +
      public class SupportFragmentResourceFinder
+extends java.lang.Object
+implements ResourceFinder
      +
      ResourceFinder implementation for Fragment.
      +
      +
      +
        + +
      • +
        +

        Constructor Summary

        +
        + + + + + + + + + + + + + + +
        Constructors
        ConstructorDescription
        SupportFragmentResourceFinder​(androidx.fragment.app.Fragment fragment) +
        Constructor.
        +
        +
        +
        +
        • + +
      • +
        +

        Method Summary

        +
        +
        +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        Modifier and TypeMethodDescription
        android.view.ViewfindViewById​(int resId) +
        Finds a child view with the given identifier.
        +
        android.content.ContextgetContext() +
        Retrieve the Context that the prompt is running in.
        +
        android.graphics.drawable.DrawablegetDrawable​(int resId) +
        Returns a drawable object associated with a particular resource ID and + styled for the current theme.
        +
        android.view.ViewGroupgetPromptParentView() +
        Get the view to add the prompt to.
        +
        android.content.res.ResourcesgetResources() +
        Returns a Resources instance for the application's package.
        +
        java.lang.StringgetString​(int resId) +
        Returns a localized string from the application's package's + default string table.
        +
        android.content.res.Resources.ThemegetTheme() +
        Return the Theme object associated with ResourceFinder.getContext().
        +
        android.content.res.TypedArrayobtainStyledAttributes​(int resId, +int[] attrs) +
        Retrieve styled attribute information in ResourceFinder.getContext() theme.
        +
        +
        +
        +
        +

        Methods inherited from class java.lang.Object

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

        Constructor Details

        +
          +
        • +
          +

          SupportFragmentResourceFinder

          +
          public SupportFragmentResourceFinder​(@NonNull +androidx.fragment.app.Fragment fragment)
          +
          Constructor.
          +
          +
          Parameters:
          +
          fragment - Fragment to get the resources from.
          +
          +
          +
          • +
        +
        +
        • + +
      • +
        +

        Method Details

        +
          +
        • +
          +

          findViewById

          +
          @Nullable +public android.view.View findViewById​(int resId)
          +
          Description copied from interface: ResourceFinder
          +
          Finds a child view with the given identifier. Returns null if the + specified child view does not exist.
          +
          +
          Specified by:
          +
          findViewById in interface ResourceFinder
          +
          Parameters:
          +
          resId - the identifier of the view to find
          +
          Returns:
          +
          The view with the given id or null.
          +
          +
          +
          • +
        • +
          +

          getPromptParentView

          +
          @NonNull +public android.view.ViewGroup getPromptParentView()
          +
          Description copied from interface: ResourceFinder
          +
          Get the view to add the prompt to.
          +
          +
          Specified by:
          +
          getPromptParentView in interface ResourceFinder
          +
          Returns:
          +
          The view to add the prompt to.
          +
          +
          +
          • +
        • +
          +

          getContext

          +
          @NonNull +public android.content.Context getContext()
          +
          Description copied from interface: ResourceFinder
          +
          Retrieve the Context that the prompt is running in.
          +
          +
          Specified by:
          +
          getContext in interface ResourceFinder
          +
          Returns:
          +
          Context The Context used by the prompt.
          +
          +
          +
          • +
        • +
          +

          getResources

          +
          @NonNull +public android.content.res.Resources getResources()
          +
          Description copied from interface: ResourceFinder
          +
          Returns a Resources instance for the application's package.
          +
          +
          Specified by:
          +
          getResources in interface ResourceFinder
          +
          Returns:
          +
          a Resources instance for the application's package
          +
          +
          +
          • +
        • +
          +

          getTheme

          +
          @NonNull +public android.content.res.Resources.Theme getTheme()
          +
          Description copied from interface: ResourceFinder
          +
          Return the Theme object associated with ResourceFinder.getContext().
          +
          +
          Specified by:
          +
          getTheme in interface ResourceFinder
          +
          +
          +
          • +
        • +
          +

          getString

          +
          @NonNull +public java.lang.String getString​(int resId)
          +
          Description copied from interface: ResourceFinder
          +
          Returns a localized string from the application's package's + default string table.
          +
          +
          Specified by:
          +
          getString in interface ResourceFinder
          +
          Parameters:
          +
          resId - Resource id for the string
          +
          Returns:
          +
          The string data associated with the resource, stripped of styled + text information.
          +
          +
          +
          • +
        • +
          +

          obtainStyledAttributes

          +
          @NonNull +public android.content.res.TypedArray obtainStyledAttributes​(int resId, +int[] attrs)
          +
          Description copied from interface: ResourceFinder
          +
          Retrieve styled attribute information in ResourceFinder.getContext() theme. See + Resources.Theme.obtainStyledAttributes(int, int[]) + for more information.
          +
          +
          Specified by:
          +
          obtainStyledAttributes in interface ResourceFinder
          +
          See Also:
          +
          Resources.Theme.obtainStyledAttributes(int, int[])
          +
          +
          +
          • +
        • +
          +

          getDrawable

          +
          @Nullable +public android.graphics.drawable.Drawable getDrawable​(int resId)
          +
          Description copied from interface: ResourceFinder
          +
          Returns a drawable object associated with a particular resource ID and + styled for the current theme.
          +
          +
          Specified by:
          +
          getDrawable in interface ResourceFinder
          +
          Parameters:
          +
          resId - The desired resource identifier, as generated by the aapt + tool. This integer encodes the package, type, and resource + entry. The value 0 is an invalid identifier.
          +
          Returns:
          +
          An object that can be used to draw this resource, or + null if the resource could not be resolved.
          +
          +
          +
          • +
        +
        +
        • +
      +
      + +
      + +
      +
      + + diff --git a/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/PromptBackground.html b/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/PromptBackground.html index e6e2a5a5..173a8b27 100644 --- a/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/PromptBackground.html +++ b/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/PromptBackground.html @@ -1,382 +1,322 @@ - - - - - -PromptBackground (material-tap-target-prompt 3.0.0 API) - - - - - - - - -
      - - -
      Skip navigation links
      - - - - -
      -
      - - - -
      - -
      -
      -
        -
      • Summary: 
        • -
      • Nested | 
        • -
      • Field | 
        • -
      • Constr | 
        • -
      • Method
        • -
      - -
      - - -
      - - -
      -
      uk.co.samuelwall.materialtaptargetprompt.extras
      -

      Class PromptBackground

      -
      -
      -
        -
      • java.lang.Object
        • -
      • -
          -
        • uk.co.samuelwall.materialtaptargetprompt.extras.PromptBackground
          • -
        -
        • -
      -
      - -
      -
      -
        -
      • - -
          -
        • - - -

          Constructor Summary

          - - - - - - - - -
          Constructors 
          Constructor and Description
          PromptBackground() 
          -
          • -
        - -
          -
        • - - -

          Method Summary

          - - - - - - - - - - - - - - - - - - - - - - - - - - -
          All Methods Instance Methods Abstract Methods 
          Modifier and TypeMethod and Description
          booleancontains(float x, - float y) -
          Does the element contain the point.
          -
          voiddraw(android.graphics.Canvas canvas) -
          Draw the element.
          -
          abstract voidprepare(PromptOptions options, - boolean clipToBounds, - android.graphics.Rect clipBounds) -
          Prepares the background for drawing.
          -
          abstract voidsetColour(int colour) -
          Sets the colour to use for the background.
          -
          voidupdate(PromptOptions options, - float revealModifier, - float alphaModifier) -
          Update the current prompt rendering state based on the prompt options and current reveal & alpha scales.
          -
          -
            -
          • - - -

            Methods inherited from class java.lang.Object

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

          Constructor Detail

          - - - -
            -
          • -

            PromptBackground

            -
            public PromptBackground()
            -
            • -
          -
          • -
        - -
          -
        • - - -

          Method Detail

          - - - -
            -
          • -

            setColour

            -
            public abstract void setColour(int colour)
            -
            Sets the colour to use for the background.
            -
            -
            Parameters:
            -
            colour - Colour integer representing the colour.
            -
            -
            • -
          - - - -
            -
          • -

            prepare

            -
            public abstract void prepare(@NonNull
-                             PromptOptions options,
-                             boolean clipToBounds,
-                             @NonNull
-                             android.graphics.Rect clipBounds)
            -
            Prepares the background for drawing.
            -
            -
            Parameters:
            -
            options - The options from which the prompt was created.
            -
            clipToBounds - Should the prompt be clipped to the supplied clipBounds.
            -
            clipBounds - The bounds to clip the drawing to.
            -
            -
            • -
          - - - -
            -
          • -

            update

            -
            public void update(@NonNull
-                   PromptOptions options,
-                   float revealModifier,
-                   float alphaModifier)
            -
            Update the current prompt rendering state based on the prompt options and current reveal & alpha scales.
            -
            -
            Parameters:
            -
            options - The options used to create the prompt.
            -
            revealModifier - The current size/revealed scale from 0 - 1.
            -
            alphaModifier - The current colour alpha scale from 0 - 1.
            -
            -
            • -
          - - - -
            -
          • -

            draw

            -
            public void draw(@NonNull
-                 android.graphics.Canvas canvas)
            -
            Draw the element.
            -
            -
            Parameters:
            -
            canvas - The canvas to draw to.
            -
            -
            • -
          - - - -
            -
          • -

            contains

            -
            public boolean contains(float x,
-                        float y)
            -
            Does the element contain the point.
            -
            -
            Parameters:
            -
            x - x coordinate.
            -
            y - y coordinate.
            -
            Returns:
            -
            True if the element contains the point, false otherwise.
            -
            -
            • -
          -
          • -
        -
        • -
      -
      -
      - - -
      - - -
      Skip navigation links
      - - - - -
      -
      - - - -
      - -
      -
      -
        -
      • Summary: 
        • -
      • Nested | 
        • -
      • Field | 
        • -
      • Constr | 
        • -
      • Method
        • -
      - -
      - - -
      - - - + + + + + +PromptBackground (material-tap-target-prompt 3.0.1 API) + + + + + + + + + + + + + +
      + +
      +
      + +
      +
      Package uk.co.samuelwall.materialtaptargetprompt.extras
      +

      Class PromptBackground

      +
      +
      java.lang.Object +
      uk.co.samuelwall.materialtaptargetprompt.extras.PromptBackground
      +
      +
      +
      +
      Direct Known Subclasses:
      +
      CirclePromptBackground, FullscreenPromptBackground, RectanglePromptBackground
      +
      +
      +
      public abstract class PromptBackground
+extends java.lang.Object
      +
      Used to render the prompt background.
      +
      +
      +
        + +
      • +
        +

        Constructor Summary

        +
        + + + + + + + + + + + + + + +
        Constructors
        ConstructorDescription
        PromptBackground() 
        +
        +
        +
        • + +
      • +
        +

        Method Summary

        +
        +
        +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        Modifier and TypeMethodDescription
        booleancontains​(float x, +float y) +
        Does the element contain the point.
        +
        voiddraw​(android.graphics.Canvas canvas) +
        Draw the element.
        +
        abstract voidprepare​(PromptOptions options, +boolean clipToBounds, +android.graphics.Rect clipBounds) +
        Prepares the background for drawing.
        +
        abstract voidsetColour​(int colour) +
        Sets the colour to use for the background.
        +
        voidupdate​(PromptOptions options, +float revealModifier, +float alphaModifier) +
        Update the current prompt rendering state based on the prompt options and current reveal & alpha scales.
        +
        +
        +
        +
        +

        Methods inherited from class java.lang.Object

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

        Constructor Details

        +
          +
        • +
          +

          PromptBackground

          +
          public PromptBackground()
          +
          +
          • +
        +
        +
        • + +
      • +
        +

        Method Details

        +
          +
        • +
          +

          setColour

          +
          public abstract void setColour​(int colour)
          +
          Sets the colour to use for the background.
          +
          +
          Parameters:
          +
          colour - Colour integer representing the colour.
          +
          +
          +
          • +
        • +
          +

          prepare

          +
          public abstract void prepare​(@NonNull +PromptOptions options, +boolean clipToBounds, +@NonNull +android.graphics.Rect clipBounds)
          +
          Prepares the background for drawing.
          +
          +
          Parameters:
          +
          options - The options from which the prompt was created.
          +
          clipToBounds - Should the prompt be clipped to the supplied clipBounds.
          +
          clipBounds - The bounds to clip the drawing to.
          +
          +
          +
          • +
        • +
          +

          update

          +
          void update​(@NonNull +PromptOptions options, +float revealModifier, +float alphaModifier)
          +
          Update the current prompt rendering state based on the prompt options and current reveal & alpha scales.
          +
          +
          Parameters:
          +
          options - The options used to create the prompt.
          +
          revealModifier - The current size/revealed scale from 0 - 1.
          +
          alphaModifier - The current colour alpha scale from 0 - 1.
          +
          +
          +
          • +
        • +
          +

          draw

          +
          void draw​(@NonNull +android.graphics.Canvas canvas)
          +
          Draw the element.
          +
          +
          Parameters:
          +
          canvas - The canvas to draw to.
          +
          +
          +
          • +
        • +
          +

          contains

          +
          boolean contains​(float x, +float y)
          +
          Does the element contain the point.
          +
          +
          Parameters:
          +
          x - x coordinate.
          +
          y - y coordinate.
          +
          Returns:
          +
          True if the element contains the point, false otherwise.
          +
          +
          +
          • +
        +
        +
        • +
      +
      + +
      + +
      +
      + + diff --git a/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/PromptFocal.html b/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/PromptFocal.html index 41d0b3f2..f50e6b21 100644 --- a/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/PromptFocal.html +++ b/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/PromptFocal.html @@ -1,598 +1,525 @@ - - - - - -PromptFocal (material-tap-target-prompt 3.0.0 API) - - - - - - - - -
      - - -
      Skip navigation links
      - - - - -
      -
      - - - -
      - -
      -
      - - -
      - - -
      - - -
      -
      uk.co.samuelwall.materialtaptargetprompt.extras
      -

      Class PromptFocal

      -
      -
      -
        -
      • java.lang.Object
        • -
      • -
          -
        • uk.co.samuelwall.materialtaptargetprompt.extras.PromptFocal
          • -
        -
        • -
      -
      - -
      -
      -
        -
      • - -
          -
        • - - -

          Field Summary

          - - - - - - - - - - - - - - -
          Fields 
          Modifier and TypeField and Description
          protected intmBaseRippleAlpha -
          The alpha value for the ripple.
          -
          protected booleanmDrawRipple -
          Should the ripple be drawn.
          -
          -
          • -
        - -
          -
        • - - -

          Constructor Summary

          - - - - - - - - -
          Constructors 
          Constructor and Description
          PromptFocal() 
          -
          • -
        - -
          -
        • - - -

          Method Summary

          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
          All Methods Instance Methods Abstract Methods Concrete Methods 
          Modifier and TypeMethod and Description
          android.graphics.PointFcalculateAngleEdgePoint(float angle, - float padding) -
          Calculate the point on the focal edge based on the angle.
          -
          booleancontains(float x, - float y) -
          Does the element contain the point.
          -
          voiddraw(android.graphics.Canvas canvas) -
          Draw the element.
          -
          abstract android.graphics.RectFgetBounds() -
          Get the focal bounds at scale 1.
          -
          android.graphics.PathgetPath() -
          Get the focal path to be drawn.
          -
          abstract voidprepare(PromptOptions options, - float targetX, - float targetY) -
          Setup the focal ready for rendering when targeting a point on the screen, called prior to first render.
          -
          abstract voidprepare(PromptOptions options, - android.view.View target, - int[] promptViewPosition) -
          Setup the focal ready for rendering when targeting a view, called prior to first render.
          -
          abstract voidsetColour(int colour) -
          Set the focal colour.
          -
          voidsetDrawRipple(boolean drawRipple) -
          Sets whether the ripple is drawn around the focal.
          -
          voidsetRippleAlpha(int rippleAlpha) -
          Sets the alpha value to use for the ripple colour.
          -
          voidupdate(PromptOptions options, - float revealModifier, - float alphaModifier) -
          Update the current prompt rendering state based on the prompt options and current reveal & alpha scales.
          -
          abstract voidupdateRipple(float revealModifier, - float alphaModifier) -
          Update the ripple around the focal.
          -
          -
            -
          • - - -

            Methods inherited from class java.lang.Object

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

          Field Detail

          - - - -
            -
          • -

            mDrawRipple

            -
            protected boolean mDrawRipple
            -
            Should the ripple be drawn.
            -
            • -
          - - - -
            -
          • -

            mBaseRippleAlpha

            -
            protected int mBaseRippleAlpha
            -
            The alpha value for the ripple.
            -
            • -
          -
          • -
        - -
          -
        • - - -

          Constructor Detail

          - - - -
            -
          • -

            PromptFocal

            -
            public PromptFocal()
            -
            • -
          -
          • -
        - -
          -
        • - - -

          Method Detail

          - - - -
            -
          • -

            setDrawRipple

            -
            public void setDrawRipple(boolean drawRipple)
            -
            Sets whether the ripple is drawn around the focal.
            -
            -
            Parameters:
            -
            drawRipple - True to draw the ripple.
            -
            -
            • -
          - - - -
            -
          • -

            setRippleAlpha

            -
            public void setRippleAlpha(int rippleAlpha)
            -
            Sets the alpha value to use for the ripple colour.
            -
            -
            Parameters:
            -
            rippleAlpha - The ripple alpha value between 0 - 255
            -
            -
            • -
          - - - -
            -
          • -

            getPath

            -
            public android.graphics.Path getPath()
            -
            Get the focal path to be drawn. Override this to support a transparent focal colour.
            -
            -
            Returns:
            -
            The path used to draw the focal
            -
            -
            • -
          - - - -
            -
          • -

            calculateAngleEdgePoint

            -
            @NonNull
-public android.graphics.PointF calculateAngleEdgePoint(float angle,
-                                                                float padding)
            -
            Calculate the point on the focal edge based on the angle. - This is called after prepare(PromptOptions, float, float) or - prepare(PromptOptions, View, int[]). - - Base implementation assumes that focal is a rectangle.
            -
            -
            Parameters:
            -
            angle - The angle with 0 based on the right.
            -
            padding - The padding added to the focal bounds.
            -
            Returns:
            -
            The calculated point
            -
            -
            • -
          - - - -
            -
          • -

            setColour

            -
            public abstract void setColour(int colour)
            -
            Set the focal colour.
            -
            -
            Parameters:
            -
            colour - Int colour.
            -
            -
            • -
          - - - -
            -
          • -

            getBounds

            -
            @NonNull
-public abstract android.graphics.RectF getBounds()
            -
            Get the focal bounds at scale 1.
            -
            -
            Returns:
            -
            The screen area that the focal is drawn in at scale 1.
            -
            -
            • -
          - - - -
            -
          • -

            prepare

            -
            public abstract void prepare(@NonNull
-                             PromptOptions options,
-                             @NonNull
-                             android.view.View target,
-                             int[] promptViewPosition)
            -
            Setup the focal ready for rendering when targeting a view, called prior to first render.
            -
            -
            Parameters:
            -
            options - The option that the prompt was built from.
            -
            target - The prompt target view.
            -
            promptViewPosition - The prompt views screen position.
            -
            -
            • -
          - - - -
            -
          • -

            prepare

            -
            public abstract void prepare(@NonNull
-                             PromptOptions options,
-                             float targetX,
-                             float targetY)
            -
            Setup the focal ready for rendering when targeting a point on the screen, called prior to first render.
            -
            -
            Parameters:
            -
            options - The option that the prompt was built from.
            -
            targetX - The target screen x position.
            -
            targetY - The target screen y position.
            -
            -
            • -
          - - - -
            -
          • -

            updateRipple

            -
            public abstract void updateRipple(float revealModifier,
-                                  float alphaModifier)
            -
            Update the ripple around the focal.
            -
            -
            Parameters:
            -
            revealModifier - The amount to scale the ripple by where a 1 value is the same size as the focal.
            -
            alphaModifier - The amount to modify the ripple alpha by.
            -
            -
            • -
          - - - -
            -
          • -

            update

            -
            public void update(@NonNull
-                   PromptOptions options,
-                   float revealModifier,
-                   float alphaModifier)
            -
            Update the current prompt rendering state based on the prompt options and current reveal & alpha scales.
            -
            -
            Parameters:
            -
            options - The options used to create the prompt.
            -
            revealModifier - The current size/revealed scale from 0 - 1.
            -
            alphaModifier - The current colour alpha scale from 0 - 1.
            -
            -
            • -
          - - - -
            -
          • -

            draw

            -
            public void draw(@NonNull
-                 android.graphics.Canvas canvas)
            -
            Draw the element.
            -
            -
            Parameters:
            -
            canvas - The canvas to draw to.
            -
            -
            • -
          - - - -
            -
          • -

            contains

            -
            public boolean contains(float x,
-                        float y)
            -
            Does the element contain the point.
            -
            -
            Parameters:
            -
            x - x coordinate.
            -
            y - y coordinate.
            -
            Returns:
            -
            True if the element contains the point, false otherwise.
            -
            -
            • -
          -
          • -
        -
        • -
      -
      -
      - - -
      - - -
      Skip navigation links
      - - - - -
      -
      - - - -
      - -
      -
      - - -
      - - -
      - - - + + + + + +PromptFocal (material-tap-target-prompt 3.0.1 API) + + + + + + + + + + + + + +
      + +
      +
      + +
      +
      Package uk.co.samuelwall.materialtaptargetprompt.extras
      +

      Class PromptFocal

      +
      +
      java.lang.Object +
      uk.co.samuelwall.materialtaptargetprompt.extras.PromptFocal
      +
      +
      +
      +
      Direct Known Subclasses:
      +
      CirclePromptFocal, RectanglePromptFocal
      +
      +
      +
      public abstract class PromptFocal
+extends java.lang.Object
      +
      Used to render the prompt focal.
      +
      +
      +
        + +
      • +
        +

        Field Summary

        +
        + + + + + + + + + + + + + + + + + + + + + +
        Fields
        Modifier and TypeFieldDescription
        protected intmBaseRippleAlpha +
        The alpha value for the ripple.
        +
        protected booleanmDrawRipple +
        Should the ripple be drawn.
        +
        +
        +
        +
        • + +
      • +
        +

        Constructor Summary

        +
        + + + + + + + + + + + + + + +
        Constructors
        ConstructorDescription
        PromptFocal() 
        +
        +
        +
        • + +
      • +
        +

        Method Summary

        +
        +
        +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        Modifier and TypeMethodDescription
        android.graphics.PointFcalculateAngleEdgePoint​(float angle, +float padding) +
        Calculate the point on the focal edge based on the angle.
        +
        booleancontains​(float x, +float y) +
        Does the element contain the point.
        +
        voiddraw​(android.graphics.Canvas canvas) +
        Draw the element.
        +
        abstract android.graphics.RectFgetBounds() +
        Get the focal bounds at scale 1.
        +
        android.graphics.PathgetPath() +
        Get the focal path to be drawn.
        +
        abstract voidprepare​(PromptOptions options, +float targetX, +float targetY) +
        Setup the focal ready for rendering when targeting a point on the screen, called prior to first render.
        +
        abstract voidprepare​(PromptOptions options, +android.view.View target, +int[] promptViewPosition) +
        Setup the focal ready for rendering when targeting a view, called prior to first render.
        +
        abstract voidsetColour​(int colour) +
        Set the focal colour.
        +
        voidsetDrawRipple​(boolean drawRipple) +
        Sets whether the ripple is drawn around the focal.
        +
        voidsetRippleAlpha​(int rippleAlpha) +
        Sets the alpha value to use for the ripple colour.
        +
        voidupdate​(PromptOptions options, +float revealModifier, +float alphaModifier) +
        Update the current prompt rendering state based on the prompt options and current reveal & alpha scales.
        +
        abstract voidupdateRipple​(float revealModifier, +float alphaModifier) +
        Update the ripple around the focal.
        +
        +
        +
        +
        +

        Methods inherited from class java.lang.Object

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

        Field Details

        +
          +
        • +
          +

          mDrawRipple

          +
          protected boolean mDrawRipple
          +
          Should the ripple be drawn.
          +
          +
          • +
        • +
          +

          mBaseRippleAlpha

          +
          protected int mBaseRippleAlpha
          +
          The alpha value for the ripple.
          +
          +
          • +
        +
        +
        • + +
      • +
        +

        Constructor Details

        +
          +
        • +
          +

          PromptFocal

          +
          public PromptFocal()
          +
          +
          • +
        +
        +
        • + +
      • +
        +

        Method Details

        +
          +
        • +
          +

          setDrawRipple

          +
          public void setDrawRipple​(boolean drawRipple)
          +
          Sets whether the ripple is drawn around the focal.
          +
          +
          Parameters:
          +
          drawRipple - True to draw the ripple.
          +
          +
          +
          • +
        • +
          +

          setRippleAlpha

          +
          public void setRippleAlpha​(int rippleAlpha)
          +
          Sets the alpha value to use for the ripple colour.
          +
          +
          Parameters:
          +
          rippleAlpha - The ripple alpha value between 0 - 255
          +
          +
          +
          • +
        • +
          +

          getPath

          +
          public android.graphics.Path getPath()
          +
          Get the focal path to be drawn. Override this to support a transparent focal colour.
          +
          +
          Returns:
          +
          The path used to draw the focal
          +
          +
          +
          • +
        • +
          +

          calculateAngleEdgePoint

          +
          @NonNull +public android.graphics.PointF calculateAngleEdgePoint​(float angle, +float padding)
          +
          Calculate the point on the focal edge based on the angle. + This is called after prepare(PromptOptions, float, float) or + prepare(PromptOptions, View, int[]). + + Base implementation assumes that focal is a rectangle.
          +
          +
          Parameters:
          +
          angle - The angle with 0 based on the right.
          +
          padding - The padding added to the focal bounds.
          +
          Returns:
          +
          The calculated point
          +
          +
          +
          • +
        • +
          +

          setColour

          +
          public abstract void setColour​(int colour)
          +
          Set the focal colour.
          +
          +
          Parameters:
          +
          colour - Int colour.
          +
          +
          +
          • +
        • +
          +

          getBounds

          +
          @NonNull +public abstract android.graphics.RectF getBounds()
          +
          Get the focal bounds at scale 1.
          +
          +
          Returns:
          +
          The screen area that the focal is drawn in at scale 1.
          +
          +
          +
          • +
        • +
          +

          prepare

          +
          public abstract void prepare​(@NonNull +PromptOptions options, +@NonNull +android.view.View target, +int[] promptViewPosition)
          +
          Setup the focal ready for rendering when targeting a view, called prior to first render.
          +
          +
          Parameters:
          +
          options - The option that the prompt was built from.
          +
          target - The prompt target view.
          +
          promptViewPosition - The prompt views screen position.
          +
          +
          +
          • +
        • +
          +

          prepare

          +
          public abstract void prepare​(@NonNull +PromptOptions options, +float targetX, +float targetY)
          +
          Setup the focal ready for rendering when targeting a point on the screen, called prior to first render.
          +
          +
          Parameters:
          +
          options - The option that the prompt was built from.
          +
          targetX - The target screen x position.
          +
          targetY - The target screen y position.
          +
          +
          +
          • +
        • +
          +

          updateRipple

          +
          public abstract void updateRipple​(float revealModifier, +float alphaModifier)
          +
          Update the ripple around the focal.
          +
          +
          Parameters:
          +
          revealModifier - The amount to scale the ripple by where a 1 value is the same size as the focal.
          +
          alphaModifier - The amount to modify the ripple alpha by.
          +
          +
          +
          • +
        • +
          +

          update

          +
          void update​(@NonNull +PromptOptions options, +float revealModifier, +float alphaModifier)
          +
          Update the current prompt rendering state based on the prompt options and current reveal & alpha scales.
          +
          +
          Parameters:
          +
          options - The options used to create the prompt.
          +
          revealModifier - The current size/revealed scale from 0 - 1.
          +
          alphaModifier - The current colour alpha scale from 0 - 1.
          +
          +
          +
          • +
        • +
          +

          draw

          +
          void draw​(@NonNull +android.graphics.Canvas canvas)
          +
          Draw the element.
          +
          +
          Parameters:
          +
          canvas - The canvas to draw to.
          +
          +
          +
          • +
        • +
          +

          contains

          +
          boolean contains​(float x, +float y)
          +
          Does the element contain the point.
          +
          +
          Parameters:
          +
          x - x coordinate.
          +
          y - y coordinate.
          +
          Returns:
          +
          True if the element contains the point, false otherwise.
          +
          +
          +
          • +
        +
        +
        • +
      +
      + +
      + +
      +
      + + diff --git a/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.html b/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.html index 90e5ef93..bbc052e1 100644 --- a/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.html +++ b/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/PromptOptions.html @@ -1,2553 +1,2307 @@ - - - - - -PromptOptions (material-tap-target-prompt 3.0.0 API) - - - - - - - - -
      - - -
      Skip navigation links
      - - - - -
      -
      - - - -
      - -
      -
      -
        -
      • Summary: 
        • -
      • Nested | 
        • -
      • Field | 
        • -
      • Constr | 
        • -
      • Method
        • -
      - -
      - - -
      - - -
      -
      uk.co.samuelwall.materialtaptargetprompt.extras
      -

      Class PromptOptions<T extends PromptOptions>

      -
      -
      -
        -
      • java.lang.Object
        • -
      • -
          -
        • uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions<T>
          • -
        -
        • -
      -
      -
        -
      • -
        -
        Type Parameters:
        -
        T - The subclass that extends this.
        -
        -
        -
        Direct Known Subclasses:
        -
        MaterialTapTargetPrompt.Builder
        -
        -
        -
        -
        public class PromptOptions<T extends PromptOptions>
-extends java.lang.Object
        -
        Contains all the settings for creating a prompt.
        -
        • -
      -
      -
      - -
      -
      -
        -
      • - -
          -
        • - - -

          Constructor Detail

          - - - -
            -
          • -

            PromptOptions

            -
            public PromptOptions(@NonNull
-                     ResourceFinder resourceFinder)
            -
            Constructor.
            -
            -
            Parameters:
            -
            resourceFinder - The resource finder implementation to use to find resources.
            -
            -
            • -
          -
          • -
        - -
          -
        • - - -

          Method Detail

          - - - -
            -
          • -

            load

            -
            public void load(@StyleRes
-                 int themeResId)
            -
            Loads the supplied theme into the prompt overwriting any previously set values if they are set in the theme.
            -
            -
            Parameters:
            -
            themeResId - The resource id for the theme.
            -
            -
            • -
          - - - -
            -
          • -

            getResourceFinder

            -
            @NonNull
-public ResourceFinder getResourceFinder()
            -
            Get the resource finder being used.
            -
            -
            Returns:
            -
            The resource finder being used.
            -
            -
            • -
          - - - -
            -
          • -

            setTarget

            -
            @NonNull
-public T setTarget(@Nullable
-                            android.view.View target)
            -
            Set the view for the prompt to focus on.
            -
            -
            Parameters:
            -
            target - The view that the prompt will highlight.
            -
            Returns:
            -
            This Builder object to allow for chaining of calls to set methods
            -
            -
            • -
          - - - -
            -
          • -

            setTarget

            -
            @NonNull
-public T setTarget(@IdRes
-                            int target)
            -
            Set the view for the prompt to focus on using the given resource id.
            -
            -
            Parameters:
            -
            target - The view that the prompt will highlight.
            -
            Returns:
            -
            This Builder object to allow for chaining of calls to set methods
            -
            -
            • -
          - - - -
            -
          • -

            getTargetView

            -
            @Nullable
-public android.view.View getTargetView()
            -
            Gets the view that the prompt is targeting.
            -
            -
            Returns:
            -
            The target view or null if not set or targeting a position.
            -
            -
            • -
          - - - -
            -
          • -

            setTarget

            -
            @NonNull
-public T setTarget(float left,
-                            float top)
            -
            Set the centre point as a screen position
            -
            -
            Parameters:
            -
            left - Centre point from screen left
            -
            top - Centre point from screen top
            -
            Returns:
            -
            This Builder object to allow for chaining of calls to set methods
            -
            -
            • -
          - - - -
            -
          • -

            getTargetPosition

            -
            @Nullable
-public android.graphics.PointF getTargetPosition()
            -
            Get the position on the screen that is being targeted.
            -
            -
            Returns:
            -
            The target position or null if targeting a view.
            -
            -
            • -
          - - - -
            -
          • -

            setTargetRenderView

            -
            @NonNull
-public T setTargetRenderView(@Nullable
-                                      android.view.View view)
            -
            Change the view that is rendered as the target. - By default the view from setTarget(View) is rendered as the target.
            -
            -
            Parameters:
            -
            view - The view to use to render the prompt target
            -
            Returns:
            -
            This Builder object to allow for chaining of calls to set methods
            -
            -
            • -
          - - - -
            -
          • -

            getTargetRenderView

            -
            @Nullable
-public android.view.View getTargetRenderView()
            -
            Get the view that is rendered as the target.
            -
            -
            Returns:
            -
            The view used to render the prompt target.
            -
            -
            • -
          - - - -
            -
          • -

            isTargetSet

            -
            public boolean isTargetSet()
            -
            Has the target been set successfully?
            -
            -
            Returns:
            -
            True if set successfully.
            -
            -
            • -
          - - - -
            -
          • -

            setPrimaryText

            -
            @NonNull
-public T setPrimaryText(@StringRes
-                                 int resId)
            -
            Set the primary text using the given resource id.
            -
            -
            Parameters:
            -
            resId - The string resource id for the primary text
            -
            Returns:
            -
            This Builder object to allow for chaining of calls to set methods
            -
            -
            • -
          - - - -
            -
          • -

            setPrimaryText

            -
            @NonNull
-public T setPrimaryText(@Nullable
-                                 java.lang.String text)
            -
            Set the primary text to the given string
            -
            -
            Parameters:
            -
            text - The primary text
            -
            Returns:
            -
            This Builder object to allow for chaining of calls to set methods
            -
            -
            • -
          - - - -
            -
          • -

            setPrimaryText

            -
            @NonNull
-public T setPrimaryText(@Nullable
-                                 java.lang.CharSequence text)
            -
            Set the primary text to the given CharSequence. - It is recommended that you don't go crazy with custom Spannables.
            -
            -
            Parameters:
            -
            text - The primary text as CharSequence
            -
            Returns:
            -
            This Builder object to allow for chaining of calls to set methods
            -
            -
            • -
          - - - -
            -
          • -

            getPrimaryText

            -
            @Nullable
-public java.lang.CharSequence getPrimaryText()
            -
            Get the text to draw for the primary text.
            -
            -
            Returns:
            -
            The primary text.
            -
            -
            • -
          - - - -
            -
          • -

            setPrimaryTextSize

            -
            @NonNull
-public T setPrimaryTextSize(@Dimension
-                                     float size)
            -
            Set the primary text font size.
            -
            -
            Parameters:
            -
            size - The primary text font size
            -
            Returns:
            -
            This Builder object to allow for chaining of calls to set methods
            -
            -
            • -
          - - - -
            -
          • -

            setPrimaryTextSize

            -
            @NonNull
-public T setPrimaryTextSize(@DimenRes
-                                     int resId)
            -
            Set the primary text font size using the given resource id.
            -
            -
            Parameters:
            -
            resId - The resource id for the primary text size
            -
            Returns:
            -
            This Builder object to allow for chaining of calls to set methods
            -
            -
            • -
          - - - -
            -
          • -

            getPrimaryTextSize

            -
            @Dimension
-public float getPrimaryTextSize()
            -
            Get the primary text font size.
            -
            -
            Returns:
            -
            The primary text font size.
            -
            -
            • -
          - - - -
            -
          • -

            setPrimaryTextColour

            -
            @NonNull
-public T setPrimaryTextColour(int colour)
            -
            Set the primary text colour.
            -
            -
            Parameters:
            -
            colour - The primary text colour resource id
            -
            Returns:
            -
            This Builder object to allow for chaining of calls to set methods
            -
            -
            • -
          - - - -
            -
          • -

            getPrimaryTextColour

            -
            public int getPrimaryTextColour()
            -
            Gets the primary text font colour.
            -
            -
            Returns:
            -
            The primary text font colour.
            -
            -
            • -
          - - - -
            -
          • -

            setPrimaryTextTypeface

            -
            @NonNull
-public T setPrimaryTextTypeface(@Nullable
-                                         android.graphics.Typeface typeface)
            -
            Sets the typeface and style used to display the primary text.
            -
            -
            Parameters:
            -
            typeface - The primary text typeface
            -
            -
            • -
          - - - -
            -
          • -

            setPrimaryTextTypeface

            -
            @NonNull
-public T setPrimaryTextTypeface(@Nullable
-                                         android.graphics.Typeface typeface,
-                                         int style)
            -
            Sets the typeface used to display the primary text.
            -
            -
            Parameters:
            -
            typeface - The primary text typeface
            -
            style - The typeface style
            -
            Returns:
            -
            This Builder object to allow for chaining of calls to set methods
            -
            -
            • -
          - - - -
            -
          • -

            getPrimaryTextTypeface

            -
            @Nullable
-public android.graphics.Typeface getPrimaryTextTypeface()
            -
            Get the typeface for the primary text.
            -
            -
            Returns:
            -
            The primary text typeface.
            -
            -
            • -
          - - - -
            -
          • -

            getPrimaryTextTypefaceStyle

            -
            public int getPrimaryTextTypefaceStyle()
            -
            Get the primary text typeface style.
            -
            -
            Returns:
            -
            the primary text typeface style.
            -
            -
            • -
          - - - -
            -
          • -

            setSecondaryText

            -
            @NonNull
-public T setSecondaryText(@StringRes
-                                   int resId)
            -
            Set the secondary text using the given resource id.
            -
            -
            Parameters:
            -
            resId - The secondary text resource id
            -
            Returns:
            -
            This Builder object to allow for chaining of calls to set methods
            -
            -
            • -
          - - - -
            -
          • -

            setSecondaryText

            -
            @NonNull
-public T setSecondaryText(@Nullable
-                                   java.lang.String text)
            -
            Set the secondary text.
            -
            -
            Parameters:
            -
            text - The secondary text
            -
            Returns:
            -
            This Builder object to allow for chaining of calls to set methods
            -
            -
            • -
          - - - -
            -
          • -

            setSecondaryText

            -
            @NonNull
-public T setSecondaryText(@Nullable
-                                   java.lang.CharSequence text)
            -
            Set the secondary text. - It is recommended that you don't go crazy with custom Spannables.
            -
            -
            Parameters:
            -
            text - The secondary text as a CharSequence
            -
            Returns:
            -
            This Builder object to allow for chaining of calls to set methods
            -
            -
            • -
          - - - -
            -
          • -

            getSecondaryText

            -
            @Nullable
-public java.lang.CharSequence getSecondaryText()
            -
            Get the secondary text.
            -
            -
            Returns:
            -
            The secondary text.
            -
            -
            • -
          - - - -
            -
          • -

            setSecondaryTextSize

            -
            @NonNull
-public T setSecondaryTextSize(@DimenRes
-                                       int resId)
            -
            Set the secondary text font size using the give resource id.
            -
            -
            Parameters:
            -
            resId - The secondary text string resource id
            -
            Returns:
            -
            This Builder object to allow for chaining of calls to set methods
            -
            -
            • -
          - - - -
            -
          • -

            setSecondaryTextSize

            -
            @NonNull
-public T setSecondaryTextSize(@Dimension
-                                       float size)
            -
            Set the secondary text font size.
            -
            -
            Parameters:
            -
            size - The secondary text font size
            -
            Returns:
            -
            This Builder object to allow for chaining of calls to set methods
            -
            -
            • -
          - - - -
            -
          • -

            getSecondaryTextSize

            -
            @Dimension
-public float getSecondaryTextSize()
            -
            Get the secondary text size.
            -
            -
            Returns:
            -
            The secondary text size.
            -
            -
            • -
          - - - -
            -
          • -

            setSecondaryTextColour

            -
            @NonNull
-public T setSecondaryTextColour(int colour)
            -
            Set the secondary text colour.
            -
            -
            Parameters:
            -
            colour - The secondary text colour resource id
            -
            Returns:
            -
            This Builder object to allow for chaining of calls to set methods
            -
            -
            • -
          - - - -
            -
          • -

            getSecondaryTextColour

            -
            public int getSecondaryTextColour()
            -
            Get the secondary text colour.
            -
            -
            Returns:
            -
            The secondary text colour.
            -
            -
            • -
          - - - -
            -
          • -

            setSecondaryTextTypeface

            -
            @NonNull
-public T setSecondaryTextTypeface(@Nullable
-                                           android.graphics.Typeface typeface)
            -
            Sets the typeface used to display the secondary text.
            -
            -
            Parameters:
            -
            typeface - The secondary text typeface
            -
            -
            • -
          - - - -
            -
          • -

            setSecondaryTextTypeface

            -
            @NonNull
-public T setSecondaryTextTypeface(@Nullable
-                                           android.graphics.Typeface typeface,
-                                           int style)
            -
            Sets the typeface and style used to display the secondary text.
            -
            -
            Parameters:
            -
            typeface - The secondary text typeface
            -
            style - The typeface style
            -
            Returns:
            -
            This Builder object to allow for chaining of calls to set methods
            -
            -
            • -
          - - - -
            -
          • -

            getSecondaryTextTypeface

            -
            @Nullable
-public android.graphics.Typeface getSecondaryTextTypeface()
            -
            Get the secondary text typeface.
            -
            -
            Returns:
            -
            The secondary text typeface.
            -
            -
            • -
          - - - -
            -
          • -

            getSecondaryTextTypefaceStyle

            -
            public int getSecondaryTextTypefaceStyle()
            -
            Get the secondary text typeface style.
            -
            -
            Returns:
            -
            The secondary text typeface style.
            -
            -
            • -
          - - - -
            -
          • -

            setContentDescription

            -
            @NonNull
-public T setContentDescription(@StringRes
-                                        int resId)
            -
            Set the accessibility content description text using the given resource id.
            -
            -
            Parameters:
            -
            resId - The string resource id for the accessibility content description text
            -
            Returns:
            -
            This Builder object to allow for chaining of calls to set methods
            -
            -
            • -
          - - - -
            -
          • -

            setContentDescription

            -
            @NonNull
-public T setContentDescription(@Nullable
-                                        java.lang.String text)
            -
            Set the accessibility content description text to the given string
            -
            -
            Parameters:
            -
            text - The accessibility content description text
            -
            Returns:
            -
            This Builder object to allow for chaining of calls to set methods
            -
            -
            • -
          - - - -
            -
          • -

            getContentDescription

            -
            @Nullable
-public java.lang.String getContentDescription()
            -
            Get the text for the accessibility content description. - Defaults to a concatenation of primary and secondary texts.
            -
            -
            Returns:
            -
            The accessibility content description text.
            -
            -
            • -
          - - - -
            -
          • -

            setTextPadding

            -
            @NonNull
-public T setTextPadding(@DimenRes
-                                 int resId)
            -
            Set the text left and right padding using the given resource id.
            -
            -
            Parameters:
            -
            resId - The text padding dimension resource id
            -
            Returns:
            -
            This Builder object to allow for chaining of calls to set methods
            -
            -
            • -
          - - - -
            -
          • -

            setTextPadding

            -
            @NonNull
-public T setTextPadding(@Dimension
-                                 float padding)
            -
            Set the text left and right padding.
            -
            -
            Parameters:
            -
            padding - The padding on the text left and right
            -
            Returns:
            -
            This Builder object to allow for chaining of calls to set methods
            -
            -
            • -
          - - - -
            -
          • -

            getTextPadding

            -
            @Dimension
-public float getTextPadding()
            -
            Get the text left and right padding.
            -
            -
            Returns:
            -
            The text left and right padding.
            -
            -
            • -
          - - - -
            -
          • -

            setTextSeparation

            -
            @NonNull
-public T setTextSeparation(@DimenRes
-                                    int resId)
            -
            Set the distance between the primary and secondary text using the given resource id.
            -
            -
            Parameters:
            -
            resId - The dimension resource id for the text separation
            -
            Returns:
            -
            This Builder object to allow for chaining of calls to set methods
            -
            -
            • -
          - - - -
            -
          • -

            setTextSeparation

            -
            @NonNull
-public T setTextSeparation(@Dimension
-                                    float separation)
            -
            Set the distance between the primary and secondary text.
            -
            -
            Parameters:
            -
            separation - The distance separation between the primary and secondary text
            -
            Returns:
            -
            This Builder object to allow for chaining of calls to set methods
            -
            -
            • -
          - - - -
            -
          • -

            getTextSeparation

            -
            @Dimension
-public float getTextSeparation()
            -
            Get the distance between the primary and secondary text.
            -
            -
            Returns:
            -
            the distance between the primary and secondary text.
            -
            -
            • -
          - - - -
            -
          • -

            setFocalPadding

            -
            @NonNull
-public T setFocalPadding(@DimenRes
-                                  int resId)
            -
            Set the padding between the text and the focal point using the given resource id.
            -
            -
            Parameters:
            -
            resId - The dimension resource id for the focal to text distance
            -
            Returns:
            -
            This Builder object to allow for chaining of calls to set methods
            -
            -
            • -
          - - - -
            -
          • -

            setFocalPadding

            -
            @NonNull
-public T setFocalPadding(@Dimension
-                                  float padding)
            -
            Set the padding between the text and the focal point.
            -
            -
            Parameters:
            -
            padding - The distance between the text and focal
            -
            Returns:
            -
            This Builder object to allow for chaining of calls to set methods
            -
            -
            • -
          - - - -
            -
          • -

            getFocalPadding

            -
            @Dimension
-public float getFocalPadding()
            -
            Get the padding between the text and the focal.
            -
            -
            Returns:
            -
            The padding between the text and the focal.
            -
            -
            • -
          - - - -
            -
          • -

            setAnimationInterpolator

            -
            @NonNull
-public T setAnimationInterpolator(@Nullable
-                                           android.view.animation.Interpolator interpolator)
            -
            Set the interpolator to use in animations.
            -
            -
            Parameters:
            -
            interpolator - The animation interpolator to use
            -
            Returns:
            -
            This Builder object to allow for chaining of calls to set methods
            -
            -
            • -
          - - - -
            -
          • -

            getAnimationInterpolator

            -
            @Nullable
-public android.view.animation.Interpolator getAnimationInterpolator()
            -
            Get the animation interpolator that is used.
            -
            -
            Returns:
            -
            The animation interpolator that is used.
            -
            -
            • -
          - - - -
            -
          • -

            setIdleAnimationEnabled

            -
            @NonNull
-public T setIdleAnimationEnabled(boolean enabled)
            -
            Enable/disable focal animation. - true by default
            -
            -
            Parameters:
            -
            enabled - Idle animation enabled
            -
            Returns:
            -
            This Builder object to allow for chaining of calls to set methods
            -
            -
            • -
          - - - -
            -
          • -

            getIdleAnimationEnabled

            -
            public boolean getIdleAnimationEnabled()
            -
            Is the focal animation enabled.
            -
            -
            Returns:
            -
            True if the idle animation is enabled.
            -
            -
            • -
          - - - -
            -
          • -

            setIcon

            -
            @NonNull
-public T setIcon(@DrawableRes
-                          int resId)
            -
            Set the icon to draw in the focal point using the given resource id.
            -
            -
            Parameters:
            -
            resId - The drawable resource id for the icon
            -
            Returns:
            -
            This Builder object to allow for chaining of calls to set methods
            -
            -
            • -
          - - - -
            -
          • -

            setIconDrawable

            -
            @NonNull
-public T setIconDrawable(@Nullable
-                                  android.graphics.drawable.Drawable drawable)
            -
            Set the icon to draw in the focal point.
            -
            -
            Parameters:
            -
            drawable - The drawable for the icon
            -
            Returns:
            -
            This Builder object to allow for chaining of calls to set methods
            -
            -
            • -
          - - - -
            -
          • -

            getIconDrawable

            -
            @Nullable
-public android.graphics.drawable.Drawable getIconDrawable()
            -
            Get the icon drawn as the target.
            -
            -
            Returns:
            -
            The icon drawn as the target.
            -
            -
            • -
          - - - -
            -
          • -

            setIconDrawableTintList

            -
            @NonNull
-public T setIconDrawableTintList(@Nullable
-                                          android.content.res.ColorStateList tint)
            -
            Applies a tint to the icon drawable
            -
            -
            Parameters:
            -
            tint - the tint to apply to the icon drawable, null will remove the tint.
            -
            Returns:
            -
            This Builder object to allow for chaining of calls to set methods
            -
            -
            • -
          - - - -
            -
          • -

            setIconDrawableTintMode

            -
            @NonNull
-public T setIconDrawableTintMode(@Nullable
-                                          android.graphics.PorterDuff.Mode tintMode)
            -
            Sets the PorterDuff mode to use to apply the tint.
            -
            -
            Parameters:
            -
            tintMode - the tint mode to use on the icon drawable, null will remove the - tint.
            -
            Returns:
            -
            This Builder object to allow for chaining of calls to set methods
            -
            -
            • -
          - - - -
            -
          • -

            setIconDrawableColourFilter

            -
            @NonNull
-public T setIconDrawableColourFilter(int colour)
            -
            Sets the colour to use to tint the icon drawable.
            -
            -
            Parameters:
            -
            colour - The colour to use to tint the icon drawable, call setIconDrawableTintList(ColorStateList) or setIconDrawableTintMode(PorterDuff.Mode) with null to remove the - tint.
            -
            Returns:
            -
            This Builder object to allow for chaining of calls to set methods
            -
            -
            • -
          - - - -
            -
          • -

            setPromptStateChangeListener

            -
            @NonNull
-public T setPromptStateChangeListener(@Nullable
-                                               MaterialTapTargetPrompt.PromptStateChangeListener listener)
            -
            Set the listener to listen for when the prompt state changes.
            -
            -
            Parameters:
            -
            listener - The listener to use
            -
            Returns:
            -
            This Builder object to allow for chaining of calls to set methods
            -
            -
            • -
          - - - -
            -
          • -

            setSequenceListener

            -
            public void setSequenceListener(@Nullable
-                                MaterialTapTargetPrompt.PromptStateChangeListener 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
            -
            -
            Parameters:
            -
            listener - The listener to use
            -
            -
            • -
          - - - -
            -
          • -

            onPromptStateChanged

            -
            public void onPromptStateChanged(@NonNull
-                                 MaterialTapTargetPrompt prompt,
-                                 int state)
            -
            Handles emitting the prompt state changed events.
            -
            -
            Parameters:
            -
            state - The state that the prompt is now in.
            -
            -
            • -
          - - - -
            -
          • -

            onExtraPromptStateChanged

            -
            public void onExtraPromptStateChanged(@NonNull
-                                      MaterialTapTargetPrompt prompt,
-                                      int state)
            -
            Handles emitting the additional prompt state changed events.
            -
            -
            Parameters:
            -
            state - The state that the prompt is now in.
            -
            -
            • -
          - - - -
            -
          • -

            setCaptureTouchEventOnFocal

            -
            @NonNull
-public T setCaptureTouchEventOnFocal(boolean captureTouchEvent)
            -
            Set if the prompt should stop touch events on the focal point from passing to underlying - views. Default is false.
            -
            -
            Parameters:
            -
            captureTouchEvent - True to capture touch events in the prompt
            -
            Returns:
            -
            This Builder object to allow for chaining of calls to set methods
            -
            -
            • -
          - - - -
            -
          • -

            getCaptureTouchEventOnFocal

            -
            public boolean getCaptureTouchEventOnFocal()
            -
            Get if the prompt should stop touch events on the focal point from passing to underlying - views.
            -
            -
            Returns:
            -
            True to capture touch events in the prompt
            -
            -
            • -
          - - - -
            -
          • -

            setMaxTextWidth

            -
            @NonNull
-public T setMaxTextWidth(@DimenRes
-                                  int resId)
            -
            Set the max width that the primary and secondary text can be using the given resource - id.
            -
            -
            Parameters:
            -
            resId - The dimension resource id for the max width that the text can reach
            -
            Returns:
            -
            This Builder object to allow for chaining of calls to set methods
            -
            -
            • -
          - - - -
            -
          • -

            setMaxTextWidth

            -
            @NonNull
-public T setMaxTextWidth(@Dimension
-                                  float width)
            -
            Set the max width that the primary and secondary text can be.
            -
            -
            Parameters:
            -
            width - The max width that the text can reach
            -
            Returns:
            -
            This Builder object to allow for chaining of calls to set methods
            -
            -
            • -
          - - - -
            -
          • -

            getMaxTextWidth

            -
            @Dimension
-public float getMaxTextWidth()
            -
            Get the maximum width that the primary and secondary text can be.
            -
            -
            Returns:
            -
            The maximum text width.
            -
            -
            • -
          - - - -
            -
          • -

            setBackgroundColour

            -
            @NonNull
-public T setBackgroundColour(int colour)
            -
            Set the background colour. - The Material Design Guidelines specify that this should be 244 or hex F4.
            -
            -
            Parameters:
            -
            colour - The background colour colour resource id
            -
            Returns:
            -
            This Builder object to allow for chaining of calls to set methods
            -
            -
            • -
          - - - -
            -
          • -

            getBackgroundColour

            -
            public int getBackgroundColour()
            -
            Get the background colour.
            -
            -
            Returns:
            -
            The background colour.
            -
            -
            • -
          - - - -
            -
          • -

            setFocalColour

            -
            @NonNull
-public T setFocalColour(int colour)
            -
            Set the focal point colour.
            -
            -
            Parameters:
            -
            colour - The focal colour colour resource id
            -
            Returns:
            -
            This Builder object to allow for chaining of calls to set methods
            -
            -
            • -
          - - - -
            -
          • -

            getFocalColour

            -
            public int getFocalColour()
            -
            Get the focal point colour.
            -
            -
            Returns:
            -
            The focal point colour.
            -
            -
            • -
          - - - -
            -
          • -

            setFocalRadius

            -
            @NonNull
-public T setFocalRadius(@DimenRes
-                                 int resId)
            -
            Set the focal point radius using the given resource id.
            -
            -
            Parameters:
            -
            resId - The focal radius dimension resource id
            -
            Returns:
            -
            This Builder object to allow for chaining of calls to set methods
            -
            -
            • -
          - - - -
            -
          • -

            setFocalRadius

            -
            @NonNull
-public T setFocalRadius(@Dimension
-                                 float radius)
            -
            Set the focal point radius.
            -
            -
            Parameters:
            -
            radius - The focal radius
            -
            Returns:
            -
            This Builder object to allow for chaining of calls to set methods
            -
            -
            • -
          - - - -
            -
          • -

            getFocalRadius

            -
            @Dimension
-public float getFocalRadius()
            -
            Get the focal point radius for the circle prompt focal.
            -
            -
            Returns:
            -
            The radius used for the circle prompt focal.
            -
            -
            • -
          - - - - - - - -
            -
          • -

            getAutoDismiss

            -
            public boolean getAutoDismiss()
            -
            Get whether the prompt should dismiss itself when a touch event occurs outside the focal.
            -
            -
            Returns:
            -
            True - prompt will dismiss when touched outside the focal, false - no - action taken.
            -
            -
            • -
          - - - - - - - -
            -
          • -

            getAutoFinish

            -
            public boolean getAutoFinish()
            -
            Get if the prompt should finish itself when a touch event occurs inside the focal.
            -
            -
            Returns:
            -
            True if the prompt should finish itself when a touch event occurs inside the focal.
            -
            -
            • -
          - - - -
            -
          • -

            setCaptureTouchEventOutsidePrompt

            -
            @NonNull
-public T setCaptureTouchEventOutsidePrompt(boolean captureTouchEventOutsidePrompt)
            -
            Set if the prompt should stop touch events outside the prompt from passing to underlying - views. Default is false.
            -
            -
            Parameters:
            -
            captureTouchEventOutsidePrompt - True to capture touch events out side the prompt
            -
            Returns:
            -
            This Builder object to allow for chaining of calls to set methods
            -
            -
            • -
          - - - -
            -
          • -

            getCaptureTouchEventOutsidePrompt

            -
            public boolean getCaptureTouchEventOutsidePrompt()
            -
            Get if the prompt should stop touch events outside the prompt from passing to underlying views.
            -
            -
            Returns:
            -
            True if touch events will not be passed to views below the prompt.
            -
            -
            • -
          - - - -
            -
          • -

            setTextGravity

            -
            @NonNull
-public T setTextGravity(int gravity)
            -
            Set the primary and secondary text horizontal layout gravity. - Default: Gravity.START
            -
            -
            Parameters:
            -
            gravity - The horizontal gravity
            -
            Returns:
            -
            This Builder object to allow for chaining of calls to set methods
            -
            -
            • -
          - - - -
            -
          • -

            setPrimaryTextGravity

            -
            @NonNull
-public T setPrimaryTextGravity(int gravity)
            -
            Set the primary text horizontal layout gravity. - Default: Gravity.START
            -
            -
            Parameters:
            -
            gravity - The horizontal gravity
            -
            Returns:
            -
            This Builder object to allow for chaining of calls to set methods
            -
            -
            • -
          - - - -
            -
          • -

            getPrimaryTextGravity

            -
            public int getPrimaryTextGravity()
            -
            Gets the gravity for the primary text.
            -
            -
            Returns:
            -
            The primary texts gravity.
            -
            -
            • -
          - - - -
            -
          • -

            setSecondaryTextGravity

            -
            @NonNull
-public T setSecondaryTextGravity(int gravity)
            -
            Set the secondary text horizontal layout gravity. - Default: Gravity.START
            -
            -
            Parameters:
            -
            gravity - The horizontal gravity
            -
            Returns:
            -
            This Builder object to allow for chaining of calls to set methods
            -
            -
            • -
          - - - -
            -
          • -

            getSecondaryTextGravity

            -
            public int getSecondaryTextGravity()
            -
            Gets the gravity for the secondary text.
            -
            -
            Returns:
            -
            The secondary texts gravity.
            -
            -
            • -
          - - - -
            -
          • -

            setClipToView

            -
            @NonNull
-public T setClipToView(@Nullable
-                                android.view.View view)
            -
            Set the view to clip the prompt to. - The prompt won't draw outside the bounds of this view. - Default: R.id.content -

            - Null can be used to stop the prompt being clipped to a view.

            -
            -
            Parameters:
            -
            view - The view to clip to
            -
            Returns:
            -
            This Builder object to allow for chaining of calls to set methods
            -
            -
            • -
          - - - -
            -
          • -

            getClipToView

            -
            @Nullable
-public android.view.View getClipToView()
            -
            Get the view that the prompt canvas is clipped to. - The prompt won't draw outside the bounds of this view.
            -
            -
            Returns:
            -
            The view that the prompt canvas is clipped to.
            -
            -
            • -
          - - - -
            -
          • -

            setBackButtonDismissEnabled

            -
            @NonNull
-public T setBackButtonDismissEnabled(boolean enabled)
            -
            Back button can be used to dismiss the prompt. - Default: true
            -
            -
            Parameters:
            -
            enabled - True for back button dismiss enabled
            -
            Returns:
            -
            This Builder object to allow for chaining of calls to set methods
            -
            -
            • -
          - - - -
            -
          • -

            getBackButtonDismissEnabled

            -
            public boolean getBackButtonDismissEnabled()
            -
            Will the pressing the system back button dismiss the prompt.
            -
            -
            Returns:
            -
            True if pressing the system back button will dismiss the prompt, false otherwise.
            -
            -
            • -
          - - - -
            -
          • -

            setPromptBackground

            -
            @NonNull
-public T setPromptBackground(@NonNull
-                                      PromptBackground promptBackground)
            -
            Sets the renderer for the prompt background.
            -
            -
            Parameters:
            -
            promptBackground - The background shape to use.
            -
            Returns:
            -
            This Builder object to allow for chaining of calls to set methods
            -
            -
            • -
          - - - -
            -
          • -

            getPromptBackground

            -
            @NonNull
-public PromptBackground getPromptBackground()
            -
            Get the prompt focal renderer.
            -
            -
            Returns:
            -
            The prompt focal instance.
            -
            -
            • -
          - - - -
            -
          • -

            setPromptFocal

            -
            @NonNull
-public T setPromptFocal(@NonNull
-                                 PromptFocal promptFocal)
            -
            Sets the renderer for the prompt focal.
            -
            -
            Parameters:
            -
            promptFocal - The focal shape to use.
            -
            Returns:
            -
            This Builder object to allow for chaining of calls to set methods
            -
            -
            • -
          - - - -
            -
          • -

            getPromptFocal

            -
            @NonNull
-public PromptFocal getPromptFocal()
            -
            Get the prompt focal renderer.
            -
            -
            Returns:
            -
            The prompt focal instance.
            -
            -
            • -
          - - - -
            -
          • -

            setPromptText

            -
            @NonNull
-public T setPromptText(@NonNull
-                                PromptText promptText)
            -
            Set the PromptText implementation to use to render the prompt text.
            -
            -
            Parameters:
            -
            promptText - The prompt text implementation.
            -
            Returns:
            -
            This Builder object to allow for chaining of calls to set methods
            -
            -
            • -
          - - - -
            -
          • -

            getPromptText

            -
            @NonNull
-public PromptText getPromptText()
            -
            Get the PromptText implementation used to render the prompt text.
            -
            -
            Returns:
            -
            This Builder object to allow for chaining of calls to set methods
            -
            -
            • -
          - - - -
            -
          • -

            create

            -
            @Nullable
-public MaterialTapTargetPrompt create()
            -
            Creates an MaterialTapTargetPrompt with the arguments supplied to this - builder. -

            - Calling this method does not display the prompt. If no additional - processing is needed, show() may be called instead to both - create and display the prompt. -

            -

            - Will return null if a valid target has not been set or the primary text is null. - To check that a valid target has been set call isTargetSet(). -

            -
            -
            Returns:
            -
            The created builder or null if no target
            -
            -
            • -
          - - - -
            -
          • -

            show

            -
            @Nullable
-public MaterialTapTargetPrompt show()
            -
            Creates a MaterialTapTargetPrompt with the arguments supplied to this - builder and immediately displays the prompt. -

            - Calling this method is functionally identical to: -

            - 
            -     MaterialTapTargetPrompt prompt = builder.create();
-     prompt.show();
-
            -

            - Will return null if a valid target has not been set or the primary text and secondary - text are null. - To check that a valid target has been set call isTargetSet(). -

            -
            -
            Returns:
            -
            The created builder or null if no target
            -
            -
            • -
          - - - -
            -
          • -

            showFor

            -
            @Nullable
-public MaterialTapTargetPrompt showFor(long milliseconds)
            -
            Creates a MaterialTapTargetPrompt with the arguments supplied to this - builder and immediately displays the prompt for the number of milliseconds supplied. -

            - Calling this method is functionally identical to: -

            - 
            -     MaterialTapTargetPrompt prompt = builder.create();
-     prompt.showFor(milliseconds);
-
            -

            - Will return null if a valid target has not been set or the primary text and secondary - text are null. - To check that a valid target has been set call isTargetSet(). -

            -
            -
            Parameters:
            -
            milliseconds - The number of milliseconds to show the prompt for.
            -
            Returns:
            -
            The created builder or null if no target
            -
            -
            • -
          -
          • -
        -
        • -
      -
      -
      - - -
      - - -
      Skip navigation links
      - - - - -
      -
      - - - -
      - -
      -
      -
        -
      • Summary: 
        • -
      • Nested | 
        • -
      • Field | 
        • -
      • Constr | 
        • -
      • Method
        • -
      - -
      - - -
      - - - + + + + + +PromptOptions (material-tap-target-prompt 3.0.1 API) + + + + + + + + + + + + + +
      + +
      +
      + +
      +
      Package uk.co.samuelwall.materialtaptargetprompt.extras
      +

      Class PromptOptions<T extends PromptOptions>

      +
      +
      java.lang.Object +
      uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions<T>
      +
      +
      +
      +
      Type Parameters:
      +
      T - The subclass that extends this.
      +
      +
      +
      Direct Known Subclasses:
      +
      MaterialTapTargetPrompt.Builder
      +
      +
      +
      public class PromptOptions<T extends PromptOptions>
+extends java.lang.Object
      +
      Contains all the settings for creating a prompt.
      +
      +
      + +
      +
      +
        + +
      • +
        +

        Constructor Details

        +
          +
        • +
          +

          PromptOptions

          +
          public PromptOptions​(@NonNull +ResourceFinder resourceFinder)
          +
          Constructor.
          +
          +
          Parameters:
          +
          resourceFinder - The resource finder implementation to use to find resources.
          +
          +
          +
          • +
        +
        +
        • + +
      • +
        +

        Method Details

        +
          +
        • +
          +

          load

          +
          public void load​(@StyleRes +int themeResId)
          +
          Loads the supplied theme into the prompt overwriting any previously set values if they are set in the theme.
          +
          +
          Parameters:
          +
          themeResId - The resource id for the theme.
          +
          +
          +
          • +
        • +
          +

          getResourceFinder

          +
          @NonNull +public ResourceFinder getResourceFinder()
          +
          Get the resource finder being used.
          +
          +
          Returns:
          +
          The resource finder being used.
          +
          +
          +
          • +
        • +
          +

          setTarget

          +
          @NonNull +public T setTarget​(@Nullable +android.view.View target)
          +
          Set the view for the prompt to focus on.
          +
          +
          Parameters:
          +
          target - The view that the prompt will highlight.
          +
          Returns:
          +
          This Builder object to allow for chaining of calls to set methods
          +
          +
          +
          • +
        • +
          +

          setTarget

          +
          @NonNull +public T setTarget​(@IdRes +int target)
          +
          Set the view for the prompt to focus on using the given resource id.
          +
          +
          Parameters:
          +
          target - The view that the prompt will highlight.
          +
          Returns:
          +
          This Builder object to allow for chaining of calls to set methods
          +
          +
          +
          • +
        • +
          +

          getTargetView

          +
          @Nullable +public android.view.View getTargetView()
          +
          Gets the view that the prompt is targeting.
          +
          +
          Returns:
          +
          The target view or null if not set or targeting a position.
          +
          +
          +
          • +
        • +
          +

          setTarget

          +
          @NonNull +public T setTarget​(float left, +float top)
          +
          Set the centre point as a screen position
          +
          +
          Parameters:
          +
          left - Centre point from screen left
          +
          top - Centre point from screen top
          +
          Returns:
          +
          This Builder object to allow for chaining of calls to set methods
          +
          +
          +
          • +
        • +
          +

          getTargetPosition

          +
          @Nullable +public android.graphics.PointF getTargetPosition()
          +
          Get the position on the screen that is being targeted.
          +
          +
          Returns:
          +
          The target position or null if targeting a view.
          +
          +
          +
          • +
        • +
          +

          setTargetRenderView

          +
          @NonNull +public T setTargetRenderView​(@Nullable +android.view.View view)
          +
          Change the view that is rendered as the target. + By default the view from setTarget(View) is rendered as the target.
          +
          +
          Parameters:
          +
          view - The view to use to render the prompt target
          +
          Returns:
          +
          This Builder object to allow for chaining of calls to set methods
          +
          +
          +
          • +
        • +
          +

          getTargetRenderView

          +
          @Nullable +public android.view.View getTargetRenderView()
          +
          Get the view that is rendered as the target.
          +
          +
          Returns:
          +
          The view used to render the prompt target.
          +
          +
          +
          • +
        • +
          +

          isTargetSet

          +
          public boolean isTargetSet()
          +
          Has the target been set successfully?
          +
          +
          Returns:
          +
          True if set successfully.
          +
          +
          +
          • +
        • +
          +

          setPrimaryText

          +
          @NonNull +public T setPrimaryText​(@StringRes +int resId)
          +
          Set the primary text using the given resource id.
          +
          +
          Parameters:
          +
          resId - The string resource id for the primary text
          +
          Returns:
          +
          This Builder object to allow for chaining of calls to set methods
          +
          +
          +
          • +
        • +
          +

          setPrimaryText

          +
          @NonNull +public T setPrimaryText​(@Nullable +java.lang.String text)
          +
          Set the primary text to the given string
          +
          +
          Parameters:
          +
          text - The primary text
          +
          Returns:
          +
          This Builder object to allow for chaining of calls to set methods
          +
          +
          +
          • +
        • +
          +

          setPrimaryText

          +
          @NonNull +public T setPrimaryText​(@Nullable +java.lang.CharSequence text)
          +
          Set the primary text to the given CharSequence. + It is recommended that you don't go crazy with custom Spannables.
          +
          +
          Parameters:
          +
          text - The primary text as CharSequence
          +
          Returns:
          +
          This Builder object to allow for chaining of calls to set methods
          +
          +
          +
          • +
        • +
          +

          getPrimaryText

          +
          @Nullable +public java.lang.CharSequence getPrimaryText()
          +
          Get the text to draw for the primary text.
          +
          +
          Returns:
          +
          The primary text.
          +
          +
          +
          • +
        • +
          +

          setPrimaryTextSize

          +
          @NonNull +public T setPrimaryTextSize​(@Dimension +float size)
          +
          Set the primary text font size.
          +
          +
          Parameters:
          +
          size - The primary text font size
          +
          Returns:
          +
          This Builder object to allow for chaining of calls to set methods
          +
          +
          +
          • +
        • +
          +

          setPrimaryTextSize

          +
          @NonNull +public T setPrimaryTextSize​(@DimenRes +int resId)
          +
          Set the primary text font size using the given resource id.
          +
          +
          Parameters:
          +
          resId - The resource id for the primary text size
          +
          Returns:
          +
          This Builder object to allow for chaining of calls to set methods
          +
          +
          +
          • +
        • +
          +

          getPrimaryTextSize

          +
          @Dimension +public float getPrimaryTextSize()
          +
          Get the primary text font size.
          +
          +
          Returns:
          +
          The primary text font size.
          +
          +
          +
          • +
        • +
          +

          setPrimaryTextColour

          +
          @NonNull +public T setPrimaryTextColour​(int colour)
          +
          Set the primary text colour.
          +
          +
          Parameters:
          +
          colour - The primary text colour resource id
          +
          Returns:
          +
          This Builder object to allow for chaining of calls to set methods
          +
          +
          +
          • +
        • +
          +

          getPrimaryTextColour

          +
          public int getPrimaryTextColour()
          +
          Gets the primary text font colour.
          +
          +
          Returns:
          +
          The primary text font colour.
          +
          +
          +
          • +
        • +
          +

          setPrimaryTextTypeface

          +
          @NonNull +public T setPrimaryTextTypeface​(@Nullable +android.graphics.Typeface typeface)
          +
          Sets the typeface and style used to display the primary text.
          +
          +
          Parameters:
          +
          typeface - The primary text typeface
          +
          +
          +
          • +
        • +
          +

          setPrimaryTextTypeface

          +
          @NonNull +public T setPrimaryTextTypeface​(@Nullable +android.graphics.Typeface typeface, +int style)
          +
          Sets the typeface used to display the primary text.
          +
          +
          Parameters:
          +
          typeface - The primary text typeface
          +
          style - The typeface style
          +
          Returns:
          +
          This Builder object to allow for chaining of calls to set methods
          +
          +
          +
          • +
        • +
          +

          getPrimaryTextTypeface

          +
          @Nullable +public android.graphics.Typeface getPrimaryTextTypeface()
          +
          Get the typeface for the primary text.
          +
          +
          Returns:
          +
          The primary text typeface.
          +
          +
          +
          • +
        • +
          +

          getPrimaryTextTypefaceStyle

          +
          public int getPrimaryTextTypefaceStyle()
          +
          Get the primary text typeface style.
          +
          +
          Returns:
          +
          the primary text typeface style.
          +
          +
          +
          • +
        • +
          +

          setSecondaryText

          +
          @NonNull +public T setSecondaryText​(@StringRes +int resId)
          +
          Set the secondary text using the given resource id.
          +
          +
          Parameters:
          +
          resId - The secondary text resource id
          +
          Returns:
          +
          This Builder object to allow for chaining of calls to set methods
          +
          +
          +
          • +
        • +
          +

          setSecondaryText

          +
          @NonNull +public T setSecondaryText​(@Nullable +java.lang.String text)
          +
          Set the secondary text.
          +
          +
          Parameters:
          +
          text - The secondary text
          +
          Returns:
          +
          This Builder object to allow for chaining of calls to set methods
          +
          +
          +
          • +
        • +
          +

          setSecondaryText

          +
          @NonNull +public T setSecondaryText​(@Nullable +java.lang.CharSequence text)
          +
          Set the secondary text. + It is recommended that you don't go crazy with custom Spannables.
          +
          +
          Parameters:
          +
          text - The secondary text as a CharSequence
          +
          Returns:
          +
          This Builder object to allow for chaining of calls to set methods
          +
          +
          +
          • +
        • +
          +

          getSecondaryText

          +
          @Nullable +public java.lang.CharSequence getSecondaryText()
          +
          Get the secondary text.
          +
          +
          Returns:
          +
          The secondary text.
          +
          +
          +
          • +
        • +
          +

          setSecondaryTextSize

          +
          @NonNull +public T setSecondaryTextSize​(@DimenRes +int resId)
          +
          Set the secondary text font size using the give resource id.
          +
          +
          Parameters:
          +
          resId - The secondary text string resource id
          +
          Returns:
          +
          This Builder object to allow for chaining of calls to set methods
          +
          +
          +
          • +
        • +
          +

          setSecondaryTextSize

          +
          @NonNull +public T setSecondaryTextSize​(@Dimension +float size)
          +
          Set the secondary text font size.
          +
          +
          Parameters:
          +
          size - The secondary text font size
          +
          Returns:
          +
          This Builder object to allow for chaining of calls to set methods
          +
          +
          +
          • +
        • +
          +

          getSecondaryTextSize

          +
          @Dimension +public float getSecondaryTextSize()
          +
          Get the secondary text size.
          +
          +
          Returns:
          +
          The secondary text size.
          +
          +
          +
          • +
        • +
          +

          setSecondaryTextColour

          +
          @NonNull +public T setSecondaryTextColour​(int colour)
          +
          Set the secondary text colour.
          +
          +
          Parameters:
          +
          colour - The secondary text colour resource id
          +
          Returns:
          +
          This Builder object to allow for chaining of calls to set methods
          +
          +
          +
          • +
        • +
          +

          getSecondaryTextColour

          +
          public int getSecondaryTextColour()
          +
          Get the secondary text colour.
          +
          +
          Returns:
          +
          The secondary text colour.
          +
          +
          +
          • +
        • +
          +

          setSecondaryTextTypeface

          +
          @NonNull +public T setSecondaryTextTypeface​(@Nullable +android.graphics.Typeface typeface)
          +
          Sets the typeface used to display the secondary text.
          +
          +
          Parameters:
          +
          typeface - The secondary text typeface
          +
          +
          +
          • +
        • +
          +

          setSecondaryTextTypeface

          +
          @NonNull +public T setSecondaryTextTypeface​(@Nullable +android.graphics.Typeface typeface, +int style)
          +
          Sets the typeface and style used to display the secondary text.
          +
          +
          Parameters:
          +
          typeface - The secondary text typeface
          +
          style - The typeface style
          +
          Returns:
          +
          This Builder object to allow for chaining of calls to set methods
          +
          +
          +
          • +
        • +
          +

          getSecondaryTextTypeface

          +
          @Nullable +public android.graphics.Typeface getSecondaryTextTypeface()
          +
          Get the secondary text typeface.
          +
          +
          Returns:
          +
          The secondary text typeface.
          +
          +
          +
          • +
        • +
          +

          getSecondaryTextTypefaceStyle

          +
          public int getSecondaryTextTypefaceStyle()
          +
          Get the secondary text typeface style.
          +
          +
          Returns:
          +
          The secondary text typeface style.
          +
          +
          +
          • +
        • +
          +

          setContentDescription

          +
          @NonNull +public T setContentDescription​(@StringRes +int resId)
          +
          Set the accessibility content description text using the given resource id.
          +
          +
          Parameters:
          +
          resId - The string resource id for the accessibility content description text
          +
          Returns:
          +
          This Builder object to allow for chaining of calls to set methods
          +
          +
          +
          • +
        • +
          +

          setContentDescription

          +
          @NonNull +public T setContentDescription​(@Nullable +java.lang.String text)
          +
          Set the accessibility content description text to the given string
          +
          +
          Parameters:
          +
          text - The accessibility content description text
          +
          Returns:
          +
          This Builder object to allow for chaining of calls to set methods
          +
          +
          +
          • +
        • +
          +

          getContentDescription

          +
          @Nullable +public java.lang.String getContentDescription()
          +
          Get the text for the accessibility content description. + Defaults to a concatenation of primary and secondary texts.
          +
          +
          Returns:
          +
          The accessibility content description text.
          +
          +
          +
          • +
        • +
          +

          setTextPadding

          +
          @NonNull +public T setTextPadding​(@DimenRes +int resId)
          +
          Set the text left and right padding using the given resource id.
          +
          +
          Parameters:
          +
          resId - The text padding dimension resource id
          +
          Returns:
          +
          This Builder object to allow for chaining of calls to set methods
          +
          +
          +
          • +
        • +
          +

          setTextPadding

          +
          @NonNull +public T setTextPadding​(@Dimension +float padding)
          +
          Set the text left and right padding.
          +
          +
          Parameters:
          +
          padding - The padding on the text left and right
          +
          Returns:
          +
          This Builder object to allow for chaining of calls to set methods
          +
          +
          +
          • +
        • +
          +

          getTextPadding

          +
          @Dimension +public float getTextPadding()
          +
          Get the text left and right padding.
          +
          +
          Returns:
          +
          The text left and right padding.
          +
          +
          +
          • +
        • +
          +

          setTextSeparation

          +
          @NonNull +public T setTextSeparation​(@DimenRes +int resId)
          +
          Set the distance between the primary and secondary text using the given resource id.
          +
          +
          Parameters:
          +
          resId - The dimension resource id for the text separation
          +
          Returns:
          +
          This Builder object to allow for chaining of calls to set methods
          +
          +
          +
          • +
        • +
          +

          setTextSeparation

          +
          @NonNull +public T setTextSeparation​(@Dimension +float separation)
          +
          Set the distance between the primary and secondary text.
          +
          +
          Parameters:
          +
          separation - The distance separation between the primary and secondary text
          +
          Returns:
          +
          This Builder object to allow for chaining of calls to set methods
          +
          +
          +
          • +
        • +
          +

          getTextSeparation

          +
          @Dimension +public float getTextSeparation()
          +
          Get the distance between the primary and secondary text.
          +
          +
          Returns:
          +
          the distance between the primary and secondary text.
          +
          +
          +
          • +
        • +
          +

          setFocalPadding

          +
          @NonNull +public T setFocalPadding​(@DimenRes +int resId)
          +
          Set the padding between the text and the focal point using the given resource id.
          +
          +
          Parameters:
          +
          resId - The dimension resource id for the focal to text distance
          +
          Returns:
          +
          This Builder object to allow for chaining of calls to set methods
          +
          +
          +
          • +
        • +
          +

          setFocalPadding

          +
          @NonNull +public T setFocalPadding​(@Dimension +float padding)
          +
          Set the padding between the text and the focal point.
          +
          +
          Parameters:
          +
          padding - The distance between the text and focal
          +
          Returns:
          +
          This Builder object to allow for chaining of calls to set methods
          +
          +
          +
          • +
        • +
          +

          getFocalPadding

          +
          @Dimension +public float getFocalPadding()
          +
          Get the padding between the text and the focal.
          +
          +
          Returns:
          +
          The padding between the text and the focal.
          +
          +
          +
          • +
        • +
          +

          setAnimationInterpolator

          +
          @NonNull +public T setAnimationInterpolator​(@Nullable +android.view.animation.Interpolator interpolator)
          +
          Set the interpolator to use in animations.
          +
          +
          Parameters:
          +
          interpolator - The animation interpolator to use
          +
          Returns:
          +
          This Builder object to allow for chaining of calls to set methods
          +
          +
          +
          • +
        • +
          +

          getAnimationInterpolator

          +
          @Nullable +public android.view.animation.Interpolator getAnimationInterpolator()
          +
          Get the animation interpolator that is used.
          +
          +
          Returns:
          +
          The animation interpolator that is used.
          +
          +
          +
          • +
        • +
          +

          setIdleAnimationEnabled

          +
          @NonNull +public T setIdleAnimationEnabled​(boolean enabled)
          +
          Enable/disable focal animation. + true by default
          +
          +
          Parameters:
          +
          enabled - Idle animation enabled
          +
          Returns:
          +
          This Builder object to allow for chaining of calls to set methods
          +
          +
          +
          • +
        • +
          +

          getIdleAnimationEnabled

          +
          public boolean getIdleAnimationEnabled()
          +
          Is the focal animation enabled.
          +
          +
          Returns:
          +
          True if the idle animation is enabled.
          +
          +
          +
          • +
        • +
          +

          setIcon

          +
          @NonNull +public T setIcon​(@DrawableRes +int resId)
          +
          Set the icon to draw in the focal point using the given resource id.
          +
          +
          Parameters:
          +
          resId - The drawable resource id for the icon
          +
          Returns:
          +
          This Builder object to allow for chaining of calls to set methods
          +
          +
          +
          • +
        • +
          +

          setIconDrawable

          +
          @NonNull +public T setIconDrawable​(@Nullable +android.graphics.drawable.Drawable drawable)
          +
          Set the icon to draw in the focal point.
          +
          +
          Parameters:
          +
          drawable - The drawable for the icon
          +
          Returns:
          +
          This Builder object to allow for chaining of calls to set methods
          +
          +
          +
          • +
        • +
          +

          getIconDrawable

          +
          @Nullable +public android.graphics.drawable.Drawable getIconDrawable()
          +
          Get the icon drawn as the target.
          +
          +
          Returns:
          +
          The icon drawn as the target.
          +
          +
          +
          • +
        • +
          +

          setIconDrawableTintList

          +
          @NonNull +public T setIconDrawableTintList​(@Nullable +android.content.res.ColorStateList tint)
          +
          Applies a tint to the icon drawable
          +
          +
          Parameters:
          +
          tint - the tint to apply to the icon drawable, null will remove the tint.
          +
          Returns:
          +
          This Builder object to allow for chaining of calls to set methods
          +
          +
          +
          • +
        • +
          +

          setIconDrawableTintMode

          +
          @NonNull +public T setIconDrawableTintMode​(@Nullable +android.graphics.PorterDuff.Mode tintMode)
          +
          Sets the PorterDuff mode to use to apply the tint.
          +
          +
          Parameters:
          +
          tintMode - the tint mode to use on the icon drawable, null will remove the + tint.
          +
          Returns:
          +
          This Builder object to allow for chaining of calls to set methods
          +
          +
          +
          • +
        • +
          +

          setIconDrawableColourFilter

          +
          @NonNull +public T setIconDrawableColourFilter​(int colour)
          +
          Sets the colour to use to tint the icon drawable.
          +
          +
          Parameters:
          +
          colour - The colour to use to tint the icon drawable, call setIconDrawableTintList(ColorStateList) or setIconDrawableTintMode(PorterDuff.Mode) with null to remove the + tint.
          +
          Returns:
          +
          This Builder object to allow for chaining of calls to set methods
          +
          +
          +
          • +
        • +
          +

          setPromptStateChangeListener

          +
          @NonNull +public T setPromptStateChangeListener​(@Nullable +MaterialTapTargetPrompt.PromptStateChangeListener listener)
          +
          Set the listener to listen for when the prompt state changes.
          +
          +
          Parameters:
          +
          listener - The listener to use
          +
          Returns:
          +
          This Builder object to allow for chaining of calls to set methods
          +
          +
          +
          • +
        • +
          +

          setSequenceListener

          +
          public void setSequenceListener​(@Nullable +MaterialTapTargetPrompt.PromptStateChangeListener 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
          +
          +
          Parameters:
          +
          listener - The listener to use
          +
          +
          +
          • +
        • +
          +

          onPromptStateChanged

          +
          public void onPromptStateChanged​(@NonNull +MaterialTapTargetPrompt prompt, +int state)
          +
          Handles emitting the prompt state changed events.
          +
          +
          Parameters:
          +
          state - The state that the prompt is now in.
          +
          +
          +
          • +
        • +
          +

          onExtraPromptStateChanged

          +
          public void onExtraPromptStateChanged​(@NonNull +MaterialTapTargetPrompt prompt, +int state)
          +
          Handles emitting the additional prompt state changed events.
          +
          +
          Parameters:
          +
          state - The state that the prompt is now in.
          +
          +
          +
          • +
        • +
          +

          setCaptureTouchEventOnFocal

          +
          @NonNull +public T setCaptureTouchEventOnFocal​(boolean captureTouchEvent)
          +
          Set if the prompt should stop touch events on the focal point from passing to underlying + views. Default is false.
          +
          +
          Parameters:
          +
          captureTouchEvent - True to capture touch events in the prompt
          +
          Returns:
          +
          This Builder object to allow for chaining of calls to set methods
          +
          +
          +
          • +
        • +
          +

          getCaptureTouchEventOnFocal

          +
          public boolean getCaptureTouchEventOnFocal()
          +
          Get if the prompt should stop touch events on the focal point from passing to underlying + views.
          +
          +
          Returns:
          +
          True to capture touch events in the prompt
          +
          +
          +
          • +
        • +
          +

          setMaxTextWidth

          +
          @NonNull +public T setMaxTextWidth​(@DimenRes +int resId)
          +
          Set the max width that the primary and secondary text can be using the given resource + id.
          +
          +
          Parameters:
          +
          resId - The dimension resource id for the max width that the text can reach
          +
          Returns:
          +
          This Builder object to allow for chaining of calls to set methods
          +
          +
          +
          • +
        • +
          +

          setMaxTextWidth

          +
          @NonNull +public T setMaxTextWidth​(@Dimension +float width)
          +
          Set the max width that the primary and secondary text can be.
          +
          +
          Parameters:
          +
          width - The max width that the text can reach
          +
          Returns:
          +
          This Builder object to allow for chaining of calls to set methods
          +
          +
          +
          • +
        • +
          +

          getMaxTextWidth

          +
          @Dimension +public float getMaxTextWidth()
          +
          Get the maximum width that the primary and secondary text can be.
          +
          +
          Returns:
          +
          The maximum text width.
          +
          +
          +
          • +
        • +
          +

          setBackgroundColour

          +
          @NonNull +public T setBackgroundColour​(int colour)
          +
          Set the background colour. + The Material Design Guidelines specify that this should be 244 or hex F4.
          +
          +
          Parameters:
          +
          colour - The background colour colour resource id
          +
          Returns:
          +
          This Builder object to allow for chaining of calls to set methods
          +
          +
          +
          • +
        • +
          +

          getBackgroundColour

          +
          public int getBackgroundColour()
          +
          Get the background colour.
          +
          +
          Returns:
          +
          The background colour.
          +
          +
          +
          • +
        • +
          +

          setFocalColour

          +
          @NonNull +public T setFocalColour​(int colour)
          +
          Set the focal point colour.
          +
          +
          Parameters:
          +
          colour - The focal colour colour resource id
          +
          Returns:
          +
          This Builder object to allow for chaining of calls to set methods
          +
          +
          +
          • +
        • +
          +

          getFocalColour

          +
          public int getFocalColour()
          +
          Get the focal point colour.
          +
          +
          Returns:
          +
          The focal point colour.
          +
          +
          +
          • +
        • +
          +

          setFocalRadius

          +
          @NonNull +public T setFocalRadius​(@DimenRes +int resId)
          +
          Set the focal point radius using the given resource id.
          +
          +
          Parameters:
          +
          resId - The focal radius dimension resource id
          +
          Returns:
          +
          This Builder object to allow for chaining of calls to set methods
          +
          +
          +
          • +
        • +
          +

          setFocalRadius

          +
          @NonNull +public T setFocalRadius​(@Dimension +float radius)
          +
          Set the focal point radius.
          +
          +
          Parameters:
          +
          radius - The focal radius
          +
          Returns:
          +
          This Builder object to allow for chaining of calls to set methods
          +
          +
          +
          • +
        • +
          +

          getFocalRadius

          +
          @Dimension +public float getFocalRadius()
          +
          Get the focal point radius for the circle prompt focal.
          +
          +
          Returns:
          +
          The radius used for the circle prompt focal.
          +
          +
          +
          • +
        • +
          +

          setAutoDismiss

          +
          @NonNull +public T setAutoDismiss​(boolean autoDismiss)
          +
          Set whether the prompt should dismiss itself when a touch event occurs outside the focal. + Default is true. + + Listen for the MaterialTapTargetPrompt.STATE_NON_FOCAL_PRESSED event in the + setPromptStateChangeListener(MaterialTapTargetPrompt.PromptStateChangeListener) to handle the prompt + being pressed outside the focal area.
          +
          +
          Parameters:
          +
          autoDismiss - True - prompt will dismiss when touched outside the focal, false - no + action taken.
          +
          Returns:
          +
          This Builder object to allow for chaining of calls to set methods
          +
          +
          +
          • +
        • +
          +

          getAutoDismiss

          +
          public boolean getAutoDismiss()
          +
          Get whether the prompt should dismiss itself when a touch event occurs outside the focal.
          +
          +
          Returns:
          +
          True - prompt will dismiss when touched outside the focal, false - no + action taken.
          +
          +
          +
          • +
        • +
          +

          setAutoFinish

          +
          @NonNull +public T setAutoFinish​(boolean autoFinish)
          +
          Set whether the prompt should finish itself when a touch event occurs inside the focal. + Default is true. + + Listen for the MaterialTapTargetPrompt.STATE_FOCAL_PRESSED event in the + setPromptStateChangeListener(MaterialTapTargetPrompt.PromptStateChangeListener) to handle the prompt + target being pressed.
          +
          +
          Parameters:
          +
          autoFinish - True - prompt will finish when touched inside the focal, false - no + action taken.
          +
          Returns:
          +
          This Builder object to allow for chaining of calls to set methods
          +
          +
          +
          • +
        • +
          +

          getAutoFinish

          +
          public boolean getAutoFinish()
          +
          Get if the prompt should finish itself when a touch event occurs inside the focal.
          +
          +
          Returns:
          +
          True if the prompt should finish itself when a touch event occurs inside the focal.
          +
          +
          +
          • +
        • +
          +

          setCaptureTouchEventOutsidePrompt

          +
          @NonNull +public T setCaptureTouchEventOutsidePrompt​(boolean captureTouchEventOutsidePrompt)
          +
          Set if the prompt should stop touch events outside the prompt from passing to underlying + views. Default is false.
          +
          +
          Parameters:
          +
          captureTouchEventOutsidePrompt - True to capture touch events out side the prompt
          +
          Returns:
          +
          This Builder object to allow for chaining of calls to set methods
          +
          +
          +
          • +
        • +
          +

          getCaptureTouchEventOutsidePrompt

          +
          public boolean getCaptureTouchEventOutsidePrompt()
          +
          Get if the prompt should stop touch events outside the prompt from passing to underlying views.
          +
          +
          Returns:
          +
          True if touch events will not be passed to views below the prompt.
          +
          +
          +
          • +
        • +
          +

          setTextGravity

          +
          @NonNull +public T setTextGravity​(int gravity)
          +
          Set the primary and secondary text horizontal layout gravity. + Default: Gravity.START
          +
          +
          Parameters:
          +
          gravity - The horizontal gravity
          +
          Returns:
          +
          This Builder object to allow for chaining of calls to set methods
          +
          +
          +
          • +
        • +
          +

          setPrimaryTextGravity

          +
          @NonNull +public T setPrimaryTextGravity​(int gravity)
          +
          Set the primary text horizontal layout gravity. + Default: Gravity.START
          +
          +
          Parameters:
          +
          gravity - The horizontal gravity
          +
          Returns:
          +
          This Builder object to allow for chaining of calls to set methods
          +
          +
          +
          • +
        • +
          +

          getPrimaryTextGravity

          +
          public int getPrimaryTextGravity()
          +
          Gets the gravity for the primary text.
          +
          +
          Returns:
          +
          The primary texts gravity.
          +
          +
          +
          • +
        • +
          +

          setSecondaryTextGravity

          +
          @NonNull +public T setSecondaryTextGravity​(int gravity)
          +
          Set the secondary text horizontal layout gravity. + Default: Gravity.START
          +
          +
          Parameters:
          +
          gravity - The horizontal gravity
          +
          Returns:
          +
          This Builder object to allow for chaining of calls to set methods
          +
          +
          +
          • +
        • +
          +

          getSecondaryTextGravity

          +
          public int getSecondaryTextGravity()
          +
          Gets the gravity for the secondary text.
          +
          +
          Returns:
          +
          The secondary texts gravity.
          +
          +
          +
          • +
        • +
          +

          setClipToView

          +
          @NonNull +public T setClipToView​(@Nullable +android.view.View view)
          +
          Set the view to clip the prompt to. + The prompt won't draw outside the bounds of this view. + Default: R.id.content +

          + Null can be used to stop the prompt being clipped to a view.

          +
          +
          Parameters:
          +
          view - The view to clip to
          +
          Returns:
          +
          This Builder object to allow for chaining of calls to set methods
          +
          +
          +
          • +
        • +
          +

          getClipToView

          +
          @Nullable +public android.view.View getClipToView()
          +
          Get the view that the prompt canvas is clipped to. + The prompt won't draw outside the bounds of this view.
          +
          +
          Returns:
          +
          The view that the prompt canvas is clipped to.
          +
          +
          +
          • +
        • +
          +

          setBackButtonDismissEnabled

          +
          @NonNull +public T setBackButtonDismissEnabled​(boolean enabled)
          +
          Back button can be used to dismiss the prompt. + Default: true
          +
          +
          Parameters:
          +
          enabled - True for back button dismiss enabled
          +
          Returns:
          +
          This Builder object to allow for chaining of calls to set methods
          +
          +
          +
          • +
        • +
          +

          getBackButtonDismissEnabled

          +
          public boolean getBackButtonDismissEnabled()
          +
          Will the pressing the system back button dismiss the prompt.
          +
          +
          Returns:
          +
          True if pressing the system back button will dismiss the prompt, false otherwise.
          +
          +
          +
          • +
        • +
          +

          setPromptBackground

          +
          @NonNull +public T setPromptBackground​(@NonNull +PromptBackground promptBackground)
          +
          Sets the renderer for the prompt background.
          +
          +
          Parameters:
          +
          promptBackground - The background shape to use.
          +
          Returns:
          +
          This Builder object to allow for chaining of calls to set methods
          +
          +
          +
          • +
        • +
          +

          getPromptBackground

          +
          @NonNull +public PromptBackground getPromptBackground()
          +
          Get the prompt focal renderer.
          +
          +
          Returns:
          +
          The prompt focal instance.
          +
          +
          +
          • +
        • +
          +

          setPromptFocal

          +
          @NonNull +public T setPromptFocal​(@NonNull +PromptFocal promptFocal)
          +
          Sets the renderer for the prompt focal.
          +
          +
          Parameters:
          +
          promptFocal - The focal shape to use.
          +
          Returns:
          +
          This Builder object to allow for chaining of calls to set methods
          +
          +
          +
          • +
        • +
          +

          getPromptFocal

          +
          @NonNull +public PromptFocal getPromptFocal()
          +
          Get the prompt focal renderer.
          +
          +
          Returns:
          +
          The prompt focal instance.
          +
          +
          +
          • +
        • +
          +

          setPromptText

          +
          @NonNull +public T setPromptText​(@NonNull +PromptText promptText)
          +
          Set the PromptText implementation to use to render the prompt text.
          +
          +
          Parameters:
          +
          promptText - The prompt text implementation.
          +
          Returns:
          +
          This Builder object to allow for chaining of calls to set methods
          +
          +
          +
          • +
        • +
          +

          getPromptText

          +
          @NonNull +public PromptText getPromptText()
          +
          Get the PromptText implementation used to render the prompt text.
          +
          +
          Returns:
          +
          This Builder object to allow for chaining of calls to set methods
          +
          +
          +
          • +
        • +
          +

          create

          +
          @Nullable +public MaterialTapTargetPrompt create()
          +
          Creates an MaterialTapTargetPrompt with the arguments supplied to this + builder. +

          + Calling this method does not display the prompt. If no additional + processing is needed, show() may be called instead to both + create and display the prompt. +

          +

          + Will return null if a valid target has not been set or the primary text is null. + To check that a valid target has been set call isTargetSet(). +

          +
          +
          Returns:
          +
          The created builder or null if no target
          +
          +
          +
          • +
        • +
          +

          show

          +
          @Nullable +public MaterialTapTargetPrompt show()
          +
          Creates a MaterialTapTargetPrompt with the arguments supplied to this + builder and immediately displays the prompt. +

          + Calling this method is functionally identical to: +

          + 
          +     MaterialTapTargetPrompt prompt = builder.create();
+     prompt.show();
+
          +

          + Will return null if a valid target has not been set or the primary text and secondary + text are null. + To check that a valid target has been set call isTargetSet(). +

          +
          +
          Returns:
          +
          The created builder or null if no target
          +
          +
          +
          • +
        • +
          +

          showFor

          +
          @Nullable +public MaterialTapTargetPrompt showFor​(long milliseconds)
          +
          Creates a MaterialTapTargetPrompt with the arguments supplied to this + builder and immediately displays the prompt for the number of milliseconds supplied. +

          + Calling this method is functionally identical to: +

          + 
          +     MaterialTapTargetPrompt prompt = builder.create();
+     prompt.showFor(milliseconds);
+
          +

          + Will return null if a valid target has not been set or the primary text and secondary + text are null. + To check that a valid target has been set call isTargetSet(). +

          +
          +
          Parameters:
          +
          milliseconds - The number of milliseconds to show the prompt for.
          +
          Returns:
          +
          The created builder or null if no target
          +
          +
          +
          • +
        +
        +
        • +
      +
      + +
      + +
      +
      + + diff --git a/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/PromptText.html b/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/PromptText.html index 63ff63bc..fdd93c71 100644 --- a/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/PromptText.html +++ b/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/PromptText.html @@ -1,372 +1,286 @@ - - - - - -PromptText (material-tap-target-prompt 3.0.0 API) - - - - - - - - -
      - - -
      Skip navigation links
      - - - - -
      -
      - - - -
      - -
      -
      -
        -
      • Summary: 
        • -
      • Nested | 
        • -
      • Field | 
        • -
      • Constr | 
        • -
      • Method
        • -
      - -
      - - -
      - - -
      -
      uk.co.samuelwall.materialtaptargetprompt.extras
      -

      Class PromptText

      -
      -
      -
        -
      • java.lang.Object
        • -
      • -
          -
        • uk.co.samuelwall.materialtaptargetprompt.extras.PromptText
          • -
        -
        • -
      -
      -
        -
      • -
        -
        -
        public class PromptText
-extends java.lang.Object
        -
        • -
      -
      -
      -
        -
      • - -
          -
        • - - -

          Constructor Summary

          - - - - - - - - -
          Constructors 
          Constructor and Description
          PromptText() 
          -
          • -
        - -
          -
        • - - -

          Method Summary

          - - - - - - - - - - - - - - - - - - - - - - - - - - -
          All Methods Instance Methods Concrete Methods 
          Modifier and TypeMethod and Description
          booleancontains(float x, - float y) -
          Does the element contain the point.
          -
          voiddraw(android.graphics.Canvas canvas) -
          Draw the element.
          -
          android.graphics.RectFgetBounds() -
          Get the window position for the prompt text.
          -
          voidprepare(PromptOptions options, - boolean clipToBounds, - android.graphics.Rect clipBounds) -
          Recalculates the primary and secondary text positions.
          -
          voidupdate(PromptOptions options, - float revealModifier, - float alphaModifier) -
          Update the current prompt rendering state based on the prompt options and current reveal & alpha scales.
          -
          -
            -
          • - - -

            Methods inherited from class java.lang.Object

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

          Constructor Detail

          - - - -
            -
          • -

            PromptText

            -
            public PromptText()
            -
            • -
          -
          • -
        - -
          -
        • - - -

          Method Detail

          - - - -
            -
          • -

            getBounds

            -
            @NonNull
-public android.graphics.RectF getBounds()
            -
            Get the window position for the prompt text.
            -
            -
            Returns:
            -
            The prompt text bounds.
            -
            -
            • -
          - - - -
            -
          • -

            prepare

            -
            public void prepare(@NonNull
-                    PromptOptions options,
-                    boolean clipToBounds,
-                    @NonNull
-                    android.graphics.Rect clipBounds)
            -
            Recalculates the primary and secondary text positions.
            -
            • -
          - - - -
            -
          • -

            update

            -
            public void update(@NonNull
-                   PromptOptions options,
-                   float revealModifier,
-                   float alphaModifier)
            -
            Update the current prompt rendering state based on the prompt options and current reveal & alpha scales.
            -
            -
            Parameters:
            -
            options - The options used to create the prompt.
            -
            revealModifier - The current size/revealed scale from 0 - 1.
            -
            alphaModifier - The current colour alpha scale from 0 - 1.
            -
            -
            • -
          - - - -
            -
          • -

            draw

            -
            public void draw(@NonNull
-                 android.graphics.Canvas canvas)
            -
            Draw the element.
            -
            -
            Parameters:
            -
            canvas - The canvas to draw to.
            -
            -
            • -
          - - - -
            -
          • -

            contains

            -
            public boolean contains(float x,
-                        float y)
            -
            Does the element contain the point.
            -
            -
            Parameters:
            -
            x - x coordinate.
            -
            y - y coordinate.
            -
            Returns:
            -
            True if the element contains the point, false otherwise.
            -
            -
            • -
          -
          • -
        -
        • -
      -
      -
      - - -
      - - -
      Skip navigation links
      - - - - -
      -
      - - - -
      - -
      -
      -
        -
      • Summary: 
        • -
      • Nested | 
        • -
      • Field | 
        • -
      • Constr | 
        • -
      • Method
        • -
      - -
      - - -
      - - - + + + + + +PromptText (material-tap-target-prompt 3.0.1 API) + + + + + + + + + + + + + +
      + +
      +
      + +
      +
      Package uk.co.samuelwall.materialtaptargetprompt.extras
      +

      Class PromptText

      +
      +
      java.lang.Object +
      uk.co.samuelwall.materialtaptargetprompt.extras.PromptText
      +
      +
      +
      +
      public class PromptText
+extends java.lang.Object
      +
      +
      +
        + +
      • +
        +

        Constructor Summary

        +
        + + + + + + + + + + + + + + +
        Constructors
        ConstructorDescription
        PromptText() 
        +
        +
        +
        • + +
      • +
        +

        Method Summary

        +
        +
        +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        Modifier and TypeMethodDescription
        booleancontains​(float x, +float y) 
        voiddraw​(android.graphics.Canvas canvas) 
        android.graphics.RectFgetBounds() +
        Get the window position for the prompt text.
        +
        voidprepare​(PromptOptions options, +boolean clipToBounds, +android.graphics.Rect clipBounds) +
        Recalculates the primary and secondary text positions.
        +
        voidupdate​(PromptOptions options, +float revealModifier, +float alphaModifier) 
        +
        +
        +
        +

        Methods inherited from class java.lang.Object

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

        Constructor Details

        +
          +
        • +
          +

          PromptText

          +
          public PromptText()
          +
          +
          • +
        +
        +
        • + +
      • +
        +

        Method Details

        +
          +
        • +
          +

          getBounds

          +
          @NonNull +public android.graphics.RectF getBounds()
          +
          Get the window position for the prompt text.
          +
          +
          Returns:
          +
          The prompt text bounds.
          +
          +
          +
          • +
        • +
          +

          prepare

          +
          public void prepare​(@NonNull +PromptOptions options, +boolean clipToBounds, +@NonNull +android.graphics.Rect clipBounds)
          +
          Recalculates the primary and secondary text positions.
          +
          +
          • +
        • +
          +

          update

          +
          public void update​(@NonNull +PromptOptions options, +float revealModifier, +float alphaModifier)
          +
          +
          • +
        • +
          +

          draw

          +
          public void draw​(@NonNull +android.graphics.Canvas canvas)
          +
          +
          • +
        • +
          +

          contains

          +
          public boolean contains​(float x, +float y)
          +
          +
          • +
        +
        +
        • +
      +
      + +
      + +
      +
      + + diff --git a/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/PromptUtils.html b/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/PromptUtils.html index a0b99c05..1a6832b5 100644 --- a/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/PromptUtils.html +++ b/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/PromptUtils.html @@ -1,538 +1,463 @@ - - - - - -PromptUtils (material-tap-target-prompt 3.0.0 API) - - - - - - - - -
      - - -
      Skip navigation links
      - - - - -
      -
      - - - -
      - -
      -
      -
        -
      • Summary: 
        • -
      • Nested | 
        • -
      • Field | 
        • -
      • Constr | 
        • -
      • Method
        • -
      -
        -
      • Detail: 
        • -
      • Field | 
        • -
      • Constr | 
        • -
      • Method
        • -
      -
      - - -
      - - -
      -
      uk.co.samuelwall.materialtaptargetprompt.extras
      -

      Class PromptUtils

      -
      -
      -
        -
      • java.lang.Object
        • -
      • -
          -
        • uk.co.samuelwall.materialtaptargetprompt.extras.PromptUtils
          • -
        -
        • -
      -
      -
        -
      • -
        -
        -
        public class PromptUtils
-extends java.lang.Object
        -
        Useful methods for prompts that don't fit else where.
        -
        • -
      -
      -
      -
        -
      • - -
          -
        • - - -

          Method Summary

          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
          All Methods Static Methods Concrete Methods 
          Modifier and TypeMethod and Description
          static floatcalculateMaxTextWidth(android.text.Layout textLayout) -
          Calculates the maximum width line in a text layout.
          -
          static floatcalculateMaxWidth(float maxTextWidth, - android.graphics.Rect clipBounds, - int parentWidth, - float textPadding) -
          Calculates the maximum width that the prompt can be.
          -
          static booleancontainsInset(android.graphics.Rect bounds, - int inset, - int x, - int y) -
          Determines if a point is within a rectangle that has been inset.
          -
          static android.text.StaticLayoutcreateStaticTextLayout(java.lang.CharSequence text, - android.text.TextPaint paint, - int maxTextWidth, - android.text.Layout.Alignment textAlignment, - float alphaModifier) -
          Creates a static text layout.
          -
          static android.text.Layout.AlignmentgetTextAlignment(android.content.res.Resources resources, - int gravity, - java.lang.CharSequence text) -
          Gets the absolute text alignment value based on the supplied gravity and the activities - layout direction.
          -
          static booleanisPointInCircle(float x, - float y, - android.graphics.PointF circleCentre, - float radius) -
          Determines if a point is in the centre of a circle with a radius from the point.
          -
          static booleanisRtlText(android.text.Layout layout, - android.content.res.Resources resources) -
          Determines if the text in the supplied layout is displayed right to left.
          -
          static android.graphics.PorterDuff.ModeparseTintMode(int value, - android.graphics.PorterDuff.Mode defaultMode) -
          Based on parseTintMode in android appcompat v7 DrawableUtils, Copyright (C) 2014 The - Android Open Source Project.
          -
          static voidscale(android.graphics.PointF origin, - android.graphics.RectF base, - android.graphics.RectF out, - float scale, - boolean even) -
          Scales a rectangle.
          -
          static voidsetTypeface(android.text.TextPaint textPaint, - android.graphics.Typeface typeface, - int style) -
          Based on setTypeface in android TextView, Copyright (C) 2006 The Android Open Source - Project.
          -
          static android.graphics.TypefacesetTypefaceFromAttrs(java.lang.String familyName, - int typefaceIndex, - int styleIndex) -
          Based on setTypefaceFromAttrs in android TextView, Copyright (C) 2006 The Android Open - Source Project.
          -
          -
            -
          • - - -

            Methods inherited from class java.lang.Object

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

          Method Detail

          - - - -
            -
          • -

            isPointInCircle

            -
            public static boolean isPointInCircle(float x,
-                                      float y,
-                                      @NonNull
-                                      android.graphics.PointF circleCentre,
-                                      float radius)
            -
            Determines if a point is in the centre of a circle with a radius from the point.
            -
            -
            Parameters:
            -
            x - The x position in the view.
            -
            y - The y position in the view.
            -
            circleCentre - The circle centre position
            -
            radius - The radius of the circle.
            -
            Returns:
            -
            True if the point (x, y) is in the circle.
            -
            -
            • -
          - - - -
            -
          • -

            setTypeface

            -
            public static void setTypeface(@NonNull
-                               android.text.TextPaint textPaint,
-                               @Nullable
-                               android.graphics.Typeface typeface,
-                               int style)
            -
            Based on setTypeface in android TextView, Copyright (C) 2006 The Android Open Source - Project. https://android.googlesource.com/platform/frameworks/base.git/+/master/core/java/android/widget/TextView.java
            -
            • -
          - - - -
            -
          • -

            setTypefaceFromAttrs

            -
            @NonNull
-public static android.graphics.Typeface setTypefaceFromAttrs(@Nullable
-                                                                      java.lang.String familyName,
-                                                                      int typefaceIndex,
-                                                                      int styleIndex)
            -
            Based on setTypefaceFromAttrs in android TextView, Copyright (C) 2006 The Android Open - Source Project. https://android.googlesource.com/platform/frameworks/base.git/+/master/core/java/android/widget/TextView.java
            -
            • -
          - - - -
            -
          • -

            parseTintMode

            -
            @Nullable
-public static android.graphics.PorterDuff.Mode parseTintMode(int value,
-                                                                       @Nullable
-                                                                       android.graphics.PorterDuff.Mode defaultMode)
            -
            Based on parseTintMode in android appcompat v7 DrawableUtils, Copyright (C) 2014 The - Android Open Source Project. https://android.googlesource.com/platform/frameworks/support.git/+/master/v7/appcompat/src/android/support/v7/widget/DrawableUtils.java
            -
            • -
          - - - -
            -
          • -

            getTextAlignment

            -
            @NonNull
-public static android.text.Layout.Alignment getTextAlignment(@NonNull
-                                                                      android.content.res.Resources resources,
-                                                                      int gravity,
-                                                                      @Nullable
-                                                                      java.lang.CharSequence text)
            -
            Gets the absolute text alignment value based on the supplied gravity and the activities - layout direction.
            -
            -
            Parameters:
            -
            gravity - The gravity to convert to absolute values
            -
            Returns:
            -
            absolute layout direction
            -
            -
            • -
          - - - -
            -
          • -

            createStaticTextLayout

            -
            @NonNull
-public static android.text.StaticLayout createStaticTextLayout(@NonNull
-                                                                        java.lang.CharSequence text,
-                                                                        @NonNull
-                                                                        android.text.TextPaint paint,
-                                                                        int maxTextWidth,
-                                                                        @NonNull
-                                                                        android.text.Layout.Alignment textAlignment,
-                                                                        float alphaModifier)
            -
            Creates a static text layout. Uses the StaticLayout.Builder if - available.
            -
            -
            Parameters:
            -
            text - The text to be laid out, optionally with spans
            -
            paint - The base paint used for layout
            -
            maxTextWidth - The width in pixels
            -
            textAlignment - Alignment for the resulting StaticLayout
            -
            alphaModifier - The modification to apply to the alpha value between 0 and 1.
            -
            Returns:
            -
            the newly constructed StaticLayout object
            -
            -
            • -
          - - - -
            -
          • -

            scale

            -
            public static void scale(@NonNull
-                         android.graphics.PointF origin,
-                         @NonNull
-                         android.graphics.RectF base,
-                         @NonNull
-                         android.graphics.RectF out,
-                         float scale,
-                         boolean even)
            -
            Scales a rectangle.
            -
            -
            Parameters:
            -
            origin - The point to scale from.
            -
            base - The rectangle at scale 1.0.
            -
            out - The rectangle to put the scaled size in.
            -
            scale - The amount to scale the rectangle by.
            -
            even - Should the rectangle be scaled evenly in both directions.
            -
            -
            • -
          - - - -
            -
          • -

            isRtlText

            -
            public static boolean isRtlText(@Nullable
-                                android.text.Layout layout,
-                                @NonNull
-                                android.content.res.Resources resources)
            -
            Determines if the text in the supplied layout is displayed right to left.
            -
            -
            Parameters:
            -
            layout - The layout to check.
            -
            Returns:
            -
            True if the text in the supplied layout is displayed right to left. False otherwise.
            -
            -
            • -
          - - - -
            -
          • -

            calculateMaxWidth

            -
            public static float calculateMaxWidth(float maxTextWidth,
-                                      @Nullable
-                                      android.graphics.Rect clipBounds,
-                                      int parentWidth,
-                                      float textPadding)
            -
            Calculates the maximum width that the prompt can be.
            -
            -
            Returns:
            -
            Maximum width in pixels that the prompt can be.
            -
            -
            • -
          - - - -
            -
          • -

            calculateMaxTextWidth

            -
            public static float calculateMaxTextWidth(@Nullable
-                                          android.text.Layout textLayout)
            -
            Calculates the maximum width line in a text layout.
            -
            -
            Parameters:
            -
            textLayout - The text layout
            -
            Returns:
            -
            The maximum length line
            -
            -
            • -
          - - - -
            -
          • -

            containsInset

            -
            public static boolean containsInset(@NonNull
-                                    android.graphics.Rect bounds,
-                                    int inset,
-                                    int x,
-                                    int y)
            -
            Determines if a point is within a rectangle that has been inset.
            -
            -
            Parameters:
            -
            bounds - The rectangle bounds.
            -
            inset - The amount that the rectangle is inset by.
            -
            x - The point x coordinate.
            -
            y - The point y coordinate.
            -
            Returns:
            -
            True if the point is within the inset rectangle, false otherwise.
            -
            -
            • -
          -
          • -
        -
        • -
      -
      -
      - - -
      - - -
      Skip navigation links
      - - - - -
      -
      - - - -
      - -
      -
      -
        -
      • Summary: 
        • -
      • Nested | 
        • -
      • Field | 
        • -
      • Constr | 
        • -
      • Method
        • -
      -
        -
      • Detail: 
        • -
      • Field | 
        • -
      • Constr | 
        • -
      • Method
        • -
      -
      - - -
      - - - + + + + + +PromptUtils (material-tap-target-prompt 3.0.1 API) + + + + + + + + + + + + + +
      + +
      +
      + +
      +
      Package uk.co.samuelwall.materialtaptargetprompt.extras
      +

      Class PromptUtils

      +
      +
      java.lang.Object +
      uk.co.samuelwall.materialtaptargetprompt.extras.PromptUtils
      +
      +
      +
      +
      public class PromptUtils
+extends java.lang.Object
      +
      Useful methods for prompts that don't fit else where.
      +
      +
      +
        + +
      • +
        +

        Method Summary

        +
        +
        +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        Modifier and TypeMethodDescription
        static floatcalculateMaxTextWidth​(android.text.Layout textLayout) +
        Calculates the maximum width line in a text layout.
        +
        static floatcalculateMaxWidth​(float maxTextWidth, +android.graphics.Rect clipBounds, +int parentWidth, +float textPadding) +
        Calculates the maximum width that the prompt can be.
        +
        static booleancontainsInset​(android.graphics.Rect bounds, +int inset, +int x, +int y) +
        Determines if a point is within a rectangle that has been inset.
        +
        static android.text.StaticLayoutcreateStaticTextLayout​(java.lang.CharSequence text, +android.text.TextPaint paint, +int maxTextWidth, +android.text.Layout.Alignment textAlignment, +float alphaModifier) +
        Creates a static text layout.
        +
        static android.text.Layout.AlignmentgetTextAlignment​(android.content.res.Resources resources, +int gravity, +java.lang.CharSequence text) +
        Gets the absolute text alignment value based on the supplied gravity and the activities + layout direction.
        +
        static booleanisPointInCircle​(float x, +float y, +android.graphics.PointF circleCentre, +float radius) +
        Determines if a point is in the centre of a circle with a radius from the point.
        +
        static booleanisRtlText​(android.text.Layout layout, +android.content.res.Resources resources) +
        Determines if the text in the supplied layout is displayed right to left.
        +
        static android.graphics.PorterDuff.ModeparseTintMode​(int value, +android.graphics.PorterDuff.Mode defaultMode) +
        Based on parseTintMode in android appcompat v7 DrawableUtils, Copyright (C) 2014 The + Android Open Source Project.
        +
        static voidscale​(android.graphics.PointF origin, +android.graphics.RectF base, +android.graphics.RectF out, +float scale, +boolean even) +
        Scales a rectangle.
        +
        static voidsetTypeface​(android.text.TextPaint textPaint, +android.graphics.Typeface typeface, +int style) +
        Based on setTypeface in android TextView, Copyright (C) 2006 The Android Open Source + Project.
        +
        static android.graphics.TypefacesetTypefaceFromAttrs​(java.lang.String familyName, +int typefaceIndex, +int styleIndex) +
        Based on setTypefaceFromAttrs in android TextView, Copyright (C) 2006 The Android Open + Source Project.
        +
        +
        +
        +
        +

        Methods inherited from class java.lang.Object

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

        Method Details

        +
          +
        • +
          +

          isPointInCircle

          +
          public static boolean isPointInCircle​(float x, +float y, +@NonNull +android.graphics.PointF circleCentre, +float radius)
          +
          Determines if a point is in the centre of a circle with a radius from the point.
          +
          +
          Parameters:
          +
          x - The x position in the view.
          +
          y - The y position in the view.
          +
          circleCentre - The circle centre position
          +
          radius - The radius of the circle.
          +
          Returns:
          +
          True if the point (x, y) is in the circle.
          +
          +
          +
          • +
        • +
          +

          setTypeface

          +
          public static void setTypeface​(@NonNull +android.text.TextPaint textPaint, +@Nullable +android.graphics.Typeface typeface, +int style)
          +
          Based on setTypeface in android TextView, Copyright (C) 2006 The Android Open Source + Project. https://android.googlesource.com/platform/frameworks/base.git/+/master/core/java/android/widget/TextView.java
          +
          +
          • +
        • +
          +

          setTypefaceFromAttrs

          +
          @NonNull +public static android.graphics.Typeface setTypefaceFromAttrs​(@Nullable +java.lang.String familyName, +int typefaceIndex, +int styleIndex)
          +
          Based on setTypefaceFromAttrs in android TextView, Copyright (C) 2006 The Android Open + Source Project. https://android.googlesource.com/platform/frameworks/base.git/+/master/core/java/android/widget/TextView.java
          +
          +
          • +
        • +
          +

          parseTintMode

          +
          @Nullable +public static android.graphics.PorterDuff.Mode parseTintMode​(int value, +@Nullable +android.graphics.PorterDuff.Mode defaultMode)
          +
          Based on parseTintMode in android appcompat v7 DrawableUtils, Copyright (C) 2014 The + Android Open Source Project. https://android.googlesource.com/platform/frameworks/support.git/+/master/v7/appcompat/src/android/support/v7/widget/DrawableUtils.java
          +
          +
          • +
        • +
          +

          getTextAlignment

          +
          @NonNull +public static android.text.Layout.Alignment getTextAlignment​(@NonNull +android.content.res.Resources resources, +int gravity, +@Nullable +java.lang.CharSequence text)
          +
          Gets the absolute text alignment value based on the supplied gravity and the activities + layout direction.
          +
          +
          Parameters:
          +
          gravity - The gravity to convert to absolute values
          +
          Returns:
          +
          absolute layout direction
          +
          +
          +
          • +
        • +
          +

          createStaticTextLayout

          +
          @NonNull +public static android.text.StaticLayout createStaticTextLayout​(@NonNull +java.lang.CharSequence text, +@NonNull +android.text.TextPaint paint, +int maxTextWidth, +@NonNull +android.text.Layout.Alignment textAlignment, +float alphaModifier)
          +
          Creates a static text layout. Uses the StaticLayout.Builder if + available.
          +
          +
          Parameters:
          +
          text - The text to be laid out, optionally with spans
          +
          paint - The base paint used for layout
          +
          maxTextWidth - The width in pixels
          +
          textAlignment - Alignment for the resulting StaticLayout
          +
          alphaModifier - The modification to apply to the alpha value between 0 and 1.
          +
          Returns:
          +
          the newly constructed StaticLayout object
          +
          +
          +
          • +
        • +
          +

          scale

          +
          public static void scale​(@NonNull +android.graphics.PointF origin, +@NonNull +android.graphics.RectF base, +@NonNull +android.graphics.RectF out, +float scale, +boolean even)
          +
          Scales a rectangle.
          +
          +
          Parameters:
          +
          origin - The point to scale from.
          +
          base - The rectangle at scale 1.0.
          +
          out - The rectangle to put the scaled size in.
          +
          scale - The amount to scale the rectangle by.
          +
          even - Should the rectangle be scaled evenly in both directions.
          +
          +
          +
          • +
        • +
          +

          isRtlText

          +
          public static boolean isRtlText​(@Nullable +android.text.Layout layout, +@NonNull +android.content.res.Resources resources)
          +
          Determines if the text in the supplied layout is displayed right to left.
          +
          +
          Parameters:
          +
          layout - The layout to check.
          +
          Returns:
          +
          True if the text in the supplied layout is displayed right to left. False otherwise.
          +
          +
          +
          • +
        • +
          +

          calculateMaxWidth

          +
          public static float calculateMaxWidth​(float maxTextWidth, +@Nullable +android.graphics.Rect clipBounds, +int parentWidth, +float textPadding)
          +
          Calculates the maximum width that the prompt can be.
          +
          +
          Returns:
          +
          Maximum width in pixels that the prompt can be.
          +
          +
          +
          • +
        • +
          +

          calculateMaxTextWidth

          +
          public static float calculateMaxTextWidth​(@Nullable +android.text.Layout textLayout)
          +
          Calculates the maximum width line in a text layout.
          +
          +
          Parameters:
          +
          textLayout - The text layout
          +
          Returns:
          +
          The maximum length line
          +
          +
          +
          • +
        • +
          +

          containsInset

          +
          public static boolean containsInset​(@NonNull +android.graphics.Rect bounds, +int inset, +int x, +int y)
          +
          Determines if a point is within a rectangle that has been inset.
          +
          +
          Parameters:
          +
          bounds - The rectangle bounds.
          +
          inset - The amount that the rectangle is inset by.
          +
          x - The point x coordinate.
          +
          y - The point y coordinate.
          +
          Returns:
          +
          True if the point is within the inset rectangle, false otherwise.
          +
          +
          +
          • +
        +
        +
        • +
      +
      + +
      + +
      +
      + + diff --git a/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/backgrounds/CirclePromptBackground.html b/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/backgrounds/CirclePromptBackground.html index c701b962..37c8df99 100644 --- a/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/backgrounds/CirclePromptBackground.html +++ b/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/backgrounds/CirclePromptBackground.html @@ -1,366 +1,303 @@ - - - - - -CirclePromptBackground (material-tap-target-prompt 3.0.0 API) - - - - - - - - -
      - - -
      Skip navigation links
      - - - - -
      -
      - - - -
      - -
      -
      -
        -
      • Summary: 
        • -
      • Nested | 
        • -
      • Field | 
        • -
      • Constr | 
        • -
      • Method
        • -
      - -
      - - -
      - - -
      -
      uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds
      -

      Class CirclePromptBackground

      -
      -
      - -
      - -
      -
      -
        -
      • - -
          -
        • - - -

          Constructor Summary

          - - - - - - - - -
          Constructors 
          Constructor and Description
          CirclePromptBackground() -
          Constructor.
          -
          -
          • -
        - -
          -
        • - - -

          Method Summary

          - - - - - - - - - - - - - - - - - - - - - - - - - - -
          All Methods Instance Methods Concrete Methods 
          Modifier and TypeMethod and Description
          booleancontains(float x, - float y) 
          voiddraw(android.graphics.Canvas canvas) 
          voidprepare(PromptOptions options, - boolean clipToBounds, - android.graphics.Rect clipBounds) -
          Prepares the background for drawing.
          -
          voidsetColour(int colour) -
          Sets the colour to use for the background.
          -
          voidupdate(PromptOptions options, - float revealModifier, - float alphaModifier) 
          -
            -
          • - - -

            Methods inherited from class java.lang.Object

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

          Constructor Detail

          - - - -
            -
          • -

            CirclePromptBackground

            -
            public CirclePromptBackground()
            -
            Constructor.
            -
            • -
          -
          • -
        - -
          -
        • - - -

          Method Detail

          - - - -
            -
          • -

            setColour

            -
            public void setColour(int colour)
            -
            Description copied from class: PromptBackground
            -
            Sets the colour to use for the background.
            -
            -
            Specified by:
            -
            setColour in class PromptBackground
            -
            Parameters:
            -
            colour - Colour integer representing the colour.
            -
            -
            • -
          - - - -
            -
          • -

            prepare

            -
            public void prepare(@NonNull
-                    PromptOptions options,
-                    boolean clipToBounds,
-                    @NonNull
-                    android.graphics.Rect clipBounds)
            -
            Description copied from class: PromptBackground
            -
            Prepares the background for drawing.
            -
            -
            Specified by:
            -
            prepare in class PromptBackground
            -
            Parameters:
            -
            options - The options from which the prompt was created.
            -
            clipToBounds - Should the prompt be clipped to the supplied clipBounds.
            -
            clipBounds - The bounds to clip the drawing to.
            -
            -
            • -
          - - - -
            -
          • -

            update

            -
            public void update(@NonNull
-                   PromptOptions options,
-                   float revealModifier,
-                   float alphaModifier)
            -
            • -
          - - - -
            -
          • -

            draw

            -
            public void draw(@NonNull
-                 android.graphics.Canvas canvas)
            -
            • -
          - - - -
            -
          • -

            contains

            -
            public boolean contains(float x,
-                        float y)
            -
            • -
          -
          • -
        -
        • -
      -
      -
      - - -
      - - -
      Skip navigation links
      - - - - -
      -
      - - - -
      - -
      -
      -
        -
      • Summary: 
        • -
      • Nested | 
        • -
      • Field | 
        • -
      • Constr | 
        • -
      • Method
        • -
      - -
      - - -
      - - - + + + + + +CirclePromptBackground (material-tap-target-prompt 3.0.1 API) + + + + + + + + + + + + + +
      + +
      +
      + +
      +
      Package uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds
      +

      Class CirclePromptBackground

      +
      +
      java.lang.Object +
      uk.co.samuelwall.materialtaptargetprompt.extras.PromptBackground +
      uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds.CirclePromptBackground
      +
      +
      +
      +
      +
      public class CirclePromptBackground
+extends PromptBackground
      +
      PromptBackground implementation that renders the prompt background as a circle.
      +
      +
      +
        + +
      • +
        +

        Constructor Summary

        +
        + + + + + + + + + + + + + + +
        Constructors
        ConstructorDescription
        CirclePromptBackground() +
        Constructor.
        +
        +
        +
        +
        • + +
      • +
        +

        Method Summary

        +
        +
        +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        Modifier and TypeMethodDescription
        booleancontains​(float x, +float y) 
        voiddraw​(android.graphics.Canvas canvas) 
        voidprepare​(PromptOptions options, +boolean clipToBounds, +android.graphics.Rect clipBounds) +
        Prepares the background for drawing.
        +
        voidsetColour​(int colour) +
        Sets the colour to use for the background.
        +
        voidupdate​(PromptOptions options, +float revealModifier, +float alphaModifier) 
        +
        +
        +
        +

        Methods inherited from class java.lang.Object

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

        Constructor Details

        +
          +
        • +
          +

          CirclePromptBackground

          +
          public CirclePromptBackground()
          +
          Constructor.
          +
          +
          • +
        +
        +
        • + +
      • +
        +

        Method Details

        +
          +
        • +
          +

          setColour

          +
          public void setColour​(int colour)
          +
          Description copied from class: PromptBackground
          +
          Sets the colour to use for the background.
          +
          +
          Specified by:
          +
          setColour in class PromptBackground
          +
          Parameters:
          +
          colour - Colour integer representing the colour.
          +
          +
          +
          • +
        • +
          +

          prepare

          +
          public void prepare​(@NonNull +PromptOptions options, +boolean clipToBounds, +@NonNull +android.graphics.Rect clipBounds)
          +
          Description copied from class: PromptBackground
          +
          Prepares the background for drawing.
          +
          +
          Specified by:
          +
          prepare in class PromptBackground
          +
          Parameters:
          +
          options - The options from which the prompt was created.
          +
          clipToBounds - Should the prompt be clipped to the supplied clipBounds.
          +
          clipBounds - The bounds to clip the drawing to.
          +
          +
          +
          • +
        • +
          +

          update

          +
          public void update​(@NonNull +PromptOptions options, +float revealModifier, +float alphaModifier)
          +
          +
          • +
        • +
          +

          draw

          +
          public void draw​(@NonNull +android.graphics.Canvas canvas)
          +
          +
          • +
        • +
          +

          contains

          +
          public boolean contains​(float x, +float y)
          +
          +
          • +
        +
        +
        • +
      +
      + +
      + +
      +
      + + diff --git a/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/backgrounds/FullscreenPromptBackground.html b/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/backgrounds/FullscreenPromptBackground.html index 34ebc881..4bf28209 100644 --- a/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/backgrounds/FullscreenPromptBackground.html +++ b/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/backgrounds/FullscreenPromptBackground.html @@ -1,410 +1,343 @@ - - - - - -FullscreenPromptBackground (material-tap-target-prompt 3.0.0 API) - - - - - - - - -
      - - -
      Skip navigation links
      - - - - -
      -
      - - - -
      - -
      -
      -
        -
      • Summary: 
        • -
      • Nested | 
        • -
      • Field | 
        • -
      • Constr | 
        • -
      • Method
        • -
      - -
      - - -
      - - -
      -
      uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds
      -

      Class FullscreenPromptBackground

      -
      -
      - -
      - -
      -
      -
        -
      • - - - -
          -
        • - - -

          Method Summary

          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
          All Methods Instance Methods Concrete Methods 
          Modifier and TypeMethod and Description
          booleancontains(float x, - float y) 
          voiddraw(android.graphics.Canvas canvas) 
          protected android.util.DisplayMetricsgetDisplayMetrics() 
          voidprepare(PromptOptions options, - boolean clipToBounds, - android.graphics.Rect clipBounds) -
          Prepares the background for drawing.
          -
          voidsetColour(int colour) -
          Sets the colour to use for the background.
          -
          FullscreenPromptBackgroundsetCornerRadius(float rx, - float ry) -
          Set the radius for the rectangle corners.
          -
          voidupdate(PromptOptions prompt, - float revealModifier, - float alphaModifier) 
          -
            -
          • - - -

            Methods inherited from class java.lang.Object

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

          Constructor Detail

          - - - -
            -
          • -

            FullscreenPromptBackground

            -
            public FullscreenPromptBackground()
            -
            Constructor.
            -
            • -
          -
          • -
        - -
          -
        • - - -

          Method Detail

          - - - -
            -
          • -

            setCornerRadius

            -
            @NonNull
-public FullscreenPromptBackground setCornerRadius(float rx,
-                                                           float ry)
            -
            Set the radius for the rectangle corners.
            -
            -
            Parameters:
            -
            rx - The x-radius of the oval used to round the corners
            -
            ry - The y-radius of the oval used to round the corners
            -
            Returns:
            -
            This prompt background
            -
            -
            • -
          - - - -
            -
          • -

            setColour

            -
            public void setColour(int colour)
            -
            Description copied from class: PromptBackground
            -
            Sets the colour to use for the background.
            -
            -
            Specified by:
            -
            setColour in class PromptBackground
            -
            Parameters:
            -
            colour - Colour integer representing the colour.
            -
            -
            • -
          - - - -
            -
          • -

            prepare

            -
            public void prepare(@NonNull
-                    PromptOptions options,
-                    boolean clipToBounds,
-                    @NonNull
-                    android.graphics.Rect clipBounds)
            -
            Description copied from class: PromptBackground
            -
            Prepares the background for drawing.
            -
            -
            Specified by:
            -
            prepare in class PromptBackground
            -
            Parameters:
            -
            options - The options from which the prompt was created.
            -
            clipToBounds - Should the prompt be clipped to the supplied clipBounds.
            -
            clipBounds - The bounds to clip the drawing to.
            -
            -
            • -
          - - - -
            -
          • -

            getDisplayMetrics

            -
            @NonNull
-protected android.util.DisplayMetrics getDisplayMetrics()
            -
            • -
          - - - -
            -
          • -

            update

            -
            public void update(@NonNull
-                   PromptOptions prompt,
-                   float revealModifier,
-                   float alphaModifier)
            -
            • -
          - - - -
            -
          • -

            draw

            -
            public void draw(@NonNull
-                 android.graphics.Canvas canvas)
            -
            • -
          - - - -
            -
          • -

            contains

            -
            public boolean contains(float x,
-                        float y)
            -
            • -
          -
          • -
        -
        • -
      -
      -
      - - -
      - - -
      Skip navigation links
      - - - - -
      -
      - - - -
      - -
      -
      -
        -
      • Summary: 
        • -
      • Nested | 
        • -
      • Field | 
        • -
      • Constr | 
        • -
      • Method
        • -
      - -
      - - -
      - - - + + + + + +FullscreenPromptBackground (material-tap-target-prompt 3.0.1 API) + + + + + + + + + + + + + +
      + +
      +
      + +
      +
      Package uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds
      +

      Class FullscreenPromptBackground

      +
      +
      java.lang.Object +
      uk.co.samuelwall.materialtaptargetprompt.extras.PromptBackground +
      uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds.FullscreenPromptBackground
      +
      +
      +
      +
      +
      Direct Known Subclasses:
      +
      ImmersiveModeCompatPromptBackground
      +
      +
      +
      public class FullscreenPromptBackground
+extends PromptBackground
      +
      PromptBackground implementation that renders the prompt background as a rectangle.
      +
      +
      +
        + +
      • +
        +

        Constructor Summary

        +
        + + + + + + + + + + + + + + +
        Constructors
        ConstructorDescription
        FullscreenPromptBackground() +
        Constructor.
        +
        +
        +
        +
        • + +
      • +
        +

        Method Summary

        +
        +
        +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        Modifier and TypeMethodDescription
        booleancontains​(float x, +float y) 
        voiddraw​(android.graphics.Canvas canvas) 
        protected android.util.DisplayMetricsgetDisplayMetrics() 
        voidprepare​(PromptOptions options, +boolean clipToBounds, +android.graphics.Rect clipBounds) +
        Prepares the background for drawing.
        +
        voidsetColour​(int colour) +
        Sets the colour to use for the background.
        +
        FullscreenPromptBackgroundsetCornerRadius​(float rx, +float ry) +
        Set the radius for the rectangle corners.
        +
        voidupdate​(PromptOptions prompt, +float revealModifier, +float alphaModifier) 
        +
        +
        +
        +

        Methods inherited from class java.lang.Object

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

        Constructor Details

        +
          +
        • +
          +

          FullscreenPromptBackground

          +
          public FullscreenPromptBackground()
          +
          Constructor.
          +
          +
          • +
        +
        +
        • + +
      • +
        +

        Method Details

        +
          +
        • +
          +

          setCornerRadius

          +
          @NonNull +public FullscreenPromptBackground setCornerRadius​(float rx, +float ry)
          +
          Set the radius for the rectangle corners.
          +
          +
          Parameters:
          +
          rx - The x-radius of the oval used to round the corners
          +
          ry - The y-radius of the oval used to round the corners
          +
          Returns:
          +
          This prompt background
          +
          +
          +
          • +
        • +
          +

          setColour

          +
          public void setColour​(int colour)
          +
          Description copied from class: PromptBackground
          +
          Sets the colour to use for the background.
          +
          +
          Specified by:
          +
          setColour in class PromptBackground
          +
          Parameters:
          +
          colour - Colour integer representing the colour.
          +
          +
          +
          • +
        • +
          +

          prepare

          +
          public void prepare​(@NonNull +PromptOptions options, +boolean clipToBounds, +@NonNull +android.graphics.Rect clipBounds)
          +
          Description copied from class: PromptBackground
          +
          Prepares the background for drawing.
          +
          +
          Specified by:
          +
          prepare in class PromptBackground
          +
          Parameters:
          +
          options - The options from which the prompt was created.
          +
          clipToBounds - Should the prompt be clipped to the supplied clipBounds.
          +
          clipBounds - The bounds to clip the drawing to.
          +
          +
          +
          • +
        • +
          +

          getDisplayMetrics

          +
          @NonNull +protected android.util.DisplayMetrics getDisplayMetrics()
          +
          +
          • +
        • +
          +

          update

          +
          public void update​(@NonNull +PromptOptions prompt, +float revealModifier, +float alphaModifier)
          +
          +
          • +
        • +
          +

          draw

          +
          public void draw​(@NonNull +android.graphics.Canvas canvas)
          +
          +
          • +
        • +
          +

          contains

          +
          public boolean contains​(float x, +float y)
          +
          +
          • +
        +
        +
        • +
      +
      + +
      + +
      +
      + + diff --git a/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/backgrounds/ImmersiveModeCompatPromptBackground.html b/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/backgrounds/ImmersiveModeCompatPromptBackground.html index 8030eba6..93587281 100644 --- a/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/backgrounds/ImmersiveModeCompatPromptBackground.html +++ b/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/backgrounds/ImmersiveModeCompatPromptBackground.html @@ -1,293 +1,231 @@ - - - - - -ImmersiveModeCompatPromptBackground (material-tap-target-prompt 3.0.0 API) - - - - - - - - -
      - - -
      Skip navigation links
      - - - - -
      -
      - - - -
      - -
      -
      -
        -
      • Summary: 
        • -
      • Nested | 
        • -
      • Field | 
        • -
      • Constr | 
        • -
      • Method
        • -
      - -
      - - -
      - - -
      -
      uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds
      -

      Class ImmersiveModeCompatPromptBackground

      -
      -
      - -
      - -
      -
      - -
      -
      -
        -
      • - -
          -
        • - - -

          Constructor Detail

          - - - -
            -
          • -

            ImmersiveModeCompatPromptBackground

            -
            public ImmersiveModeCompatPromptBackground(@NonNull
-                                           android.view.WindowManager windowManager)
            -
            • -
          -
          • -
        - - -
        • -
      -
      -
      - - -
      - - -
      Skip navigation links
      - - - - -
      -
      - - - -
      - -
      -
      -
        -
      • Summary: 
        • -
      • Nested | 
        • -
      • Field | 
        • -
      • Constr | 
        • -
      • Method
        • -
      - -
      - - -
      - - - + + + + + +ImmersiveModeCompatPromptBackground (material-tap-target-prompt 3.0.1 API) + + + + + + + + + + + + + +
      + +
      +
      + +
      +
      Package uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds
      +

      Class ImmersiveModeCompatPromptBackground

      +
      +
      java.lang.Object +
      uk.co.samuelwall.materialtaptargetprompt.extras.PromptBackground +
      uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds.FullscreenPromptBackground +
      uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds.ImmersiveModeCompatPromptBackground
      +
      +
      +
      +
      +
      +
      public class ImmersiveModeCompatPromptBackground
+extends FullscreenPromptBackground
      +
      ImmersiveModeCompatPromptBackground implementation that renders the prompt background as a rectangle for supporting immersive mode.
      +
      +
      +
        + +
      • +
        +

        Constructor Summary

        +
        + + + + + + + + + + + + + + +
        Constructors
        ConstructorDescription
        ImmersiveModeCompatPromptBackground​(android.view.WindowManager windowManager) 
        +
        +
        +
        • + +
      • +
        +

        Method Summary

        +
        +
        +
        + + + + + + + + + + + + + + + +
        Modifier and TypeMethodDescription
        protected android.util.DisplayMetricsgetDisplayMetrics() 
        +
        +
        +
        +

        Methods inherited from class uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds.FullscreenPromptBackground

        +contains, draw, prepare, setColour, setCornerRadius, update
        +
        +

        Methods inherited from class java.lang.Object

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

        Constructor Details

        +
          +
        • +
          +

          ImmersiveModeCompatPromptBackground

          +
          public ImmersiveModeCompatPromptBackground​(@NonNull +android.view.WindowManager windowManager)
          +
          +
          • +
        +
        +
        • + +
      • +
        +

        Method Details

        + +
        +
        • +
      +
      + +
      + +
      +
      + + diff --git a/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/backgrounds/RectanglePromptBackground.html b/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/backgrounds/RectanglePromptBackground.html index 23a28c87..bb54700d 100644 --- a/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/backgrounds/RectanglePromptBackground.html +++ b/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/backgrounds/RectanglePromptBackground.html @@ -1,392 +1,327 @@ - - - - - -RectanglePromptBackground (material-tap-target-prompt 3.0.0 API) - - - - - - - - -
      - - -
      Skip navigation links
      - - - - -
      -
      - - - -
      - -
      -
      -
        -
      • Summary: 
        • -
      • Nested | 
        • -
      • Field | 
        • -
      • Constr | 
        • -
      • Method
        • -
      - -
      - - -
      - - -
      -
      uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds
      -

      Class RectanglePromptBackground

      -
      -
      - -
      -
        -
      • -
        -
        -
        public class RectanglePromptBackground
-extends PromptBackground
        -
        PromptBackground implementation that renders the prompt background as a rectangle.
        -
        • -
      -
      -
      -
        -
      • - - - -
          -
        • - - -

          Method Summary

          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
          All Methods Instance Methods Concrete Methods 
          Modifier and TypeMethod and Description
          booleancontains(float x, - float y) 
          voiddraw(android.graphics.Canvas canvas) 
          voidprepare(PromptOptions options, - boolean clipToBounds, - android.graphics.Rect clipBounds) -
          Prepares the background for drawing.
          -
          voidsetColour(int colour) -
          Sets the colour to use for the background.
          -
          RectanglePromptBackgroundsetCornerRadius(float rx, - float ry) -
          Set the radius for the rectangle corners.
          -
          voidupdate(PromptOptions prompt, - float revealModifier, - float alphaModifier) 
          -
            -
          • - - -

            Methods inherited from class java.lang.Object

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

          Constructor Detail

          - - - -
            -
          • -

            RectanglePromptBackground

            -
            public RectanglePromptBackground()
            -
            Constructor.
            -
            • -
          -
          • -
        - -
          -
        • - - -

          Method Detail

          - - - -
            -
          • -

            setCornerRadius

            -
            @NonNull
-public RectanglePromptBackground setCornerRadius(float rx,
-                                                          float ry)
            -
            Set the radius for the rectangle corners.
            -
            -
            Parameters:
            -
            rx - The x-radius of the oval used to round the corners
            -
            ry - The y-radius of the oval used to round the corners
            -
            Returns:
            -
            This prompt background
            -
            -
            • -
          - - - -
            -
          • -

            setColour

            -
            public void setColour(int colour)
            -
            Description copied from class: PromptBackground
            -
            Sets the colour to use for the background.
            -
            -
            Specified by:
            -
            setColour in class PromptBackground
            -
            Parameters:
            -
            colour - Colour integer representing the colour.
            -
            -
            • -
          - - - -
            -
          • -

            prepare

            -
            public void prepare(@NonNull
-                    PromptOptions options,
-                    boolean clipToBounds,
-                    @NonNull
-                    android.graphics.Rect clipBounds)
            -
            Description copied from class: PromptBackground
            -
            Prepares the background for drawing.
            -
            -
            Specified by:
            -
            prepare in class PromptBackground
            -
            Parameters:
            -
            options - The options from which the prompt was created.
            -
            clipToBounds - Should the prompt be clipped to the supplied clipBounds.
            -
            clipBounds - The bounds to clip the drawing to.
            -
            -
            • -
          - - - -
            -
          • -

            update

            -
            public void update(@NonNull
-                   PromptOptions prompt,
-                   float revealModifier,
-                   float alphaModifier)
            -
            • -
          - - - -
            -
          • -

            draw

            -
            public void draw(@NonNull
-                 android.graphics.Canvas canvas)
            -
            • -
          - - - -
            -
          • -

            contains

            -
            public boolean contains(float x,
-                        float y)
            -
            • -
          -
          • -
        -
        • -
      -
      -
      - - -
      - - -
      Skip navigation links
      - - - - -
      -
      - - - -
      - -
      -
      -
        -
      • Summary: 
        • -
      • Nested | 
        • -
      • Field | 
        • -
      • Constr | 
        • -
      • Method
        • -
      - -
      - - -
      - - - + + + + + +RectanglePromptBackground (material-tap-target-prompt 3.0.1 API) + + + + + + + + + + + + + +
      + +
      +
      + +
      +
      Package uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds
      +

      Class RectanglePromptBackground

      +
      +
      java.lang.Object +
      uk.co.samuelwall.materialtaptargetprompt.extras.PromptBackground +
      uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds.RectanglePromptBackground
      +
      +
      +
      +
      +
      public class RectanglePromptBackground
+extends PromptBackground
      +
      PromptBackground implementation that renders the prompt background as a rectangle.
      +
      +
      +
        + +
      • +
        +

        Constructor Summary

        +
        + + + + + + + + + + + + + + +
        Constructors
        ConstructorDescription
        RectanglePromptBackground() +
        Constructor.
        +
        +
        +
        +
        • + +
      • +
        +

        Method Summary

        +
        +
        +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        Modifier and TypeMethodDescription
        booleancontains​(float x, +float y) 
        voiddraw​(android.graphics.Canvas canvas) 
        voidprepare​(PromptOptions options, +boolean clipToBounds, +android.graphics.Rect clipBounds) +
        Prepares the background for drawing.
        +
        voidsetColour​(int colour) +
        Sets the colour to use for the background.
        +
        RectanglePromptBackgroundsetCornerRadius​(float rx, +float ry) +
        Set the radius for the rectangle corners.
        +
        voidupdate​(PromptOptions prompt, +float revealModifier, +float alphaModifier) 
        +
        +
        +
        +

        Methods inherited from class java.lang.Object

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

        Constructor Details

        +
          +
        • +
          +

          RectanglePromptBackground

          +
          public RectanglePromptBackground()
          +
          Constructor.
          +
          +
          • +
        +
        +
        • + +
      • +
        +

        Method Details

        +
          +
        • +
          +

          setCornerRadius

          +
          @NonNull +public RectanglePromptBackground setCornerRadius​(float rx, +float ry)
          +
          Set the radius for the rectangle corners.
          +
          +
          Parameters:
          +
          rx - The x-radius of the oval used to round the corners
          +
          ry - The y-radius of the oval used to round the corners
          +
          Returns:
          +
          This prompt background
          +
          +
          +
          • +
        • +
          +

          setColour

          +
          public void setColour​(int colour)
          +
          Description copied from class: PromptBackground
          +
          Sets the colour to use for the background.
          +
          +
          Specified by:
          +
          setColour in class PromptBackground
          +
          Parameters:
          +
          colour - Colour integer representing the colour.
          +
          +
          +
          • +
        • +
          +

          prepare

          +
          public void prepare​(@NonNull +PromptOptions options, +boolean clipToBounds, +@NonNull +android.graphics.Rect clipBounds)
          +
          Description copied from class: PromptBackground
          +
          Prepares the background for drawing.
          +
          +
          Specified by:
          +
          prepare in class PromptBackground
          +
          Parameters:
          +
          options - The options from which the prompt was created.
          +
          clipToBounds - Should the prompt be clipped to the supplied clipBounds.
          +
          clipBounds - The bounds to clip the drawing to.
          +
          +
          +
          • +
        • +
          +

          update

          +
          public void update​(@NonNull +PromptOptions prompt, +float revealModifier, +float alphaModifier)
          +
          +
          • +
        • +
          +

          draw

          +
          public void draw​(@NonNull +android.graphics.Canvas canvas)
          +
          +
          • +
        • +
          +

          contains

          +
          public boolean contains​(float x, +float y)
          +
          +
          • +
        +
        +
        • +
      +
      + +
      + +
      +
      + + diff --git a/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/backgrounds/package-frame.html b/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/backgrounds/package-frame.html deleted file mode 100644 index ae30ffc1..00000000 --- a/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/backgrounds/package-frame.html +++ /dev/null @@ -1,23 +0,0 @@ - - - - - -uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds (material-tap-target-prompt 3.0.0 API) - - - - - -

      uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds

      -
      -

      Classes

      - -
      - - diff --git a/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/backgrounds/package-summary.html b/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/backgrounds/package-summary.html index d1ff9c4f..a4ded4ac 100644 --- a/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/backgrounds/package-summary.html +++ b/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/backgrounds/package-summary.html @@ -1,160 +1,122 @@ - - - - - -uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds (material-tap-target-prompt 3.0.0 API) - - - - - - - - -
      - - -
      Skip navigation links
      - - - - -
      -
      - - - -
      - -
      - - -
      - -
      -

      Package uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds

      -
      -
      - -
      - -
      - - -
      Skip navigation links
      - - - - -
      -
      - - - -
      - -
      - - -
      - - - + + + + + +uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds (material-tap-target-prompt 3.0.1 API) + + + + + + + + + + + + + +
      + +
      +
      +
      +

      Package uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds

      +
      +
      + +
      +
      + +
      +
      + + diff --git a/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/backgrounds/package-tree.html b/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/backgrounds/package-tree.html index 8e54ac62..989d0d52 100644 --- a/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/backgrounds/package-tree.html +++ b/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/backgrounds/package-tree.html @@ -1,145 +1,103 @@ - - - - - -uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds Class Hierarchy (material-tap-target-prompt 3.0.0 API) - - - - - - - - -
      - - -
      Skip navigation links
      - - - - -
      -
      - - - -
      - -
      - - -
      - -
      -

      Hierarchy For Package uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds

      -Package Hierarchies: - -
      -
      -

      Class Hierarchy

      - -
      - -
      - - -
      Skip navigation links
      - - - - -
      -
      - - - -
      - -
      - - -
      - - - + + + + + +uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds Class Hierarchy (material-tap-target-prompt 3.0.1 API) + + + + + + + + + + + + + +
      + +
      +
      +
      +

      Hierarchy For Package uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds

      +Package Hierarchies: + +
      +
      +

      Class Hierarchy

      + +
      +
      + +
      +
      + + diff --git a/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/focals/CirclePromptFocal.html b/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/focals/CirclePromptFocal.html index 08508454..0ab7abdc 100644 --- a/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/focals/CirclePromptFocal.html +++ b/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/focals/CirclePromptFocal.html @@ -1,548 +1,463 @@ - - - - - -CirclePromptFocal (material-tap-target-prompt 3.0.0 API) - - - - - - - - -
      - - -
      Skip navigation links
      - - - - -
      -
      - - - -
      - -
      -
      - - -
      - - -
      - - -
      -
      uk.co.samuelwall.materialtaptargetprompt.extras.focals
      -

      Class CirclePromptFocal

      -
      -
      - -
      -
        -
      • -
        -
        -
        public class CirclePromptFocal
-extends PromptFocal
        -
        Prompt focal implementation to draw the focal as a circle.
        -
        • -
      -
      -
      -
        -
      • - - - -
          -
        • - - -

          Constructor Summary

          - - - - - - - - -
          Constructors 
          Constructor and Description
          CirclePromptFocal() -
          Constructor.
          -
          -
          • -
        - -
          -
        • - - -

          Method Summary

          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
          All Methods Instance Methods Concrete Methods 
          Modifier and TypeMethod and Description
          android.graphics.PointFcalculateAngleEdgePoint(float angle, - float padding) -
          Calculate the point on the focal edge based on the angle.
          -
          booleancontains(float x, - float y) 
          voiddraw(android.graphics.Canvas canvas) 
          android.graphics.RectFgetBounds() -
          Get the focal bounds at scale 1.
          -
          android.graphics.PathgetPath() -
          Get the focal path to be drawn.
          -
          voidprepare(PromptOptions options, - float targetX, - float targetY) -
          Setup the focal ready for rendering when targeting a point on the screen, called prior to first render.
          -
          voidprepare(PromptOptions options, - android.view.View target, - int[] promptViewPosition) -
          Setup the focal ready for rendering when targeting a view, called prior to first render.
          -
          voidsetColour(int colour) -
          Set the focal colour.
          -
          CirclePromptFocalsetRadius(float radius) -
          Set the focal radius.
          -
          voidupdate(PromptOptions options, - float revealModifier, - float alphaModifier) 
          voidupdateRipple(float revealModifier, - float alphaModifier) -
          Update the ripple around the focal.
          -
          - -
            -
          • - - -

            Methods inherited from class java.lang.Object

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

          Constructor Detail

          - - - -
            -
          • -

            CirclePromptFocal

            -
            public CirclePromptFocal()
            -
            Constructor.
            -
            • -
          -
          • -
        - -
          -
        • - - -

          Method Detail

          - - - -
            -
          • -

            setRadius

            -
            @NonNull
-public CirclePromptFocal setRadius(float radius)
            -
            Set the focal radius.
            -
            -
            Parameters:
            -
            radius - The radius for the circle to be drawn.
            -
            Returns:
            -
            This prompt focal
            -
            -
            • -
          - - - -
            -
          • -

            getBounds

            -
            @NonNull
-public android.graphics.RectF getBounds()
            -
            Description copied from class: PromptFocal
            -
            Get the focal bounds at scale 1.
            -
            -
            Specified by:
            -
            getBounds in class PromptFocal
            -
            Returns:
            -
            The screen area that the focal is drawn in at scale 1.
            -
            -
            • -
          - - - -
            -
          • -

            getPath

            -
            @NonNull
-public android.graphics.Path getPath()
            -
            Description copied from class: PromptFocal
            -
            Get the focal path to be drawn. Override this to support a transparent focal colour.
            -
            -
            Overrides:
            -
            getPath in class PromptFocal
            -
            Returns:
            -
            The path used to draw the focal
            -
            -
            • -
          - - - - - - - -
            -
          • -

            setColour

            -
            public void setColour(int colour)
            -
            Description copied from class: PromptFocal
            -
            Set the focal colour.
            -
            -
            Specified by:
            -
            setColour in class PromptFocal
            -
            Parameters:
            -
            colour - Int colour.
            -
            -
            • -
          - - - -
            -
          • -

            prepare

            -
            public void prepare(@NonNull
-                    PromptOptions options,
-                    @NonNull
-                    android.view.View target,
-                    int[] promptViewPosition)
            -
            Description copied from class: PromptFocal
            -
            Setup the focal ready for rendering when targeting a view, called prior to first render.
            -
            -
            Specified by:
            -
            prepare in class PromptFocal
            -
            Parameters:
            -
            options - The option that the prompt was built from.
            -
            target - The prompt target view.
            -
            promptViewPosition - The prompt views screen position.
            -
            -
            • -
          - - - -
            -
          • -

            prepare

            -
            public void prepare(@NonNull
-                    PromptOptions options,
-                    float targetX,
-                    float targetY)
            -
            Description copied from class: PromptFocal
            -
            Setup the focal ready for rendering when targeting a point on the screen, called prior to first render.
            -
            -
            Specified by:
            -
            prepare in class PromptFocal
            -
            Parameters:
            -
            options - The option that the prompt was built from.
            -
            targetX - The target screen x position.
            -
            targetY - The target screen y position.
            -
            -
            • -
          - - - -
            -
          • -

            update

            -
            public void update(@NonNull
-                   PromptOptions options,
-                   float revealModifier,
-                   float alphaModifier)
            -
            • -
          - - - -
            -
          • -

            updateRipple

            -
            public void updateRipple(float revealModifier,
-                         float alphaModifier)
            -
            Description copied from class: PromptFocal
            -
            Update the ripple around the focal.
            -
            -
            Specified by:
            -
            updateRipple in class PromptFocal
            -
            Parameters:
            -
            revealModifier - The amount to scale the ripple by where a 1 value is the same size as the focal.
            -
            alphaModifier - The amount to modify the ripple alpha by.
            -
            -
            • -
          - - - -
            -
          • -

            draw

            -
            public void draw(@NonNull
-                 android.graphics.Canvas canvas)
            -
            • -
          - - - -
            -
          • -

            contains

            -
            public boolean contains(float x,
-                        float y)
            -
            • -
          -
          • -
        -
        • -
      -
      -
      - - -
      - - -
      Skip navigation links
      - - - - -
      -
      - - - -
      - -
      -
      - - -
      - - -
      - - - + + + + + +CirclePromptFocal (material-tap-target-prompt 3.0.1 API) + + + + + + + + + + + + + +
      + +
      +
      + +
      +
      Package uk.co.samuelwall.materialtaptargetprompt.extras.focals
      +

      Class CirclePromptFocal

      +
      +
      java.lang.Object +
      uk.co.samuelwall.materialtaptargetprompt.extras.PromptFocal +
      uk.co.samuelwall.materialtaptargetprompt.extras.focals.CirclePromptFocal
      +
      +
      +
      +
      +
      public class CirclePromptFocal
+extends PromptFocal
      +
      Prompt focal implementation to draw the focal as a circle.
      +
      +
      +
        + +
      • +
        +

        Field Summary

        +
        +

        Fields inherited from class uk.co.samuelwall.materialtaptargetprompt.extras.PromptFocal

        +mBaseRippleAlpha, mDrawRipple
        +
        +
        • + +
      • +
        +

        Constructor Summary

        +
        + + + + + + + + + + + + + + +
        Constructors
        ConstructorDescription
        CirclePromptFocal() +
        Constructor.
        +
        +
        +
        +
        • + +
      • +
        +

        Method Summary

        +
        +
        +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        Modifier and TypeMethodDescription
        android.graphics.PointFcalculateAngleEdgePoint​(float angle, +float padding) +
        Calculate the point on the focal edge based on the angle.
        +
        booleancontains​(float x, +float y) 
        voiddraw​(android.graphics.Canvas canvas) 
        android.graphics.RectFgetBounds() +
        Get the focal bounds at scale 1.
        +
        android.graphics.PathgetPath() +
        Get the focal path to be drawn.
        +
        voidprepare​(PromptOptions options, +float targetX, +float targetY) +
        Setup the focal ready for rendering when targeting a point on the screen, called prior to first render.
        +
        voidprepare​(PromptOptions options, +android.view.View target, +int[] promptViewPosition) +
        Setup the focal ready for rendering when targeting a view, called prior to first render.
        +
        voidsetColour​(int colour) +
        Set the focal colour.
        +
        CirclePromptFocalsetRadius​(float radius) +
        Set the focal radius.
        +
        voidupdate​(PromptOptions options, +float revealModifier, +float alphaModifier) 
        voidupdateRipple​(float revealModifier, +float alphaModifier) +
        Update the ripple around the focal.
        +
        +
        +
        +
        +

        Methods inherited from class uk.co.samuelwall.materialtaptargetprompt.extras.PromptFocal

        +setDrawRipple, setRippleAlpha
        +
        +

        Methods inherited from class java.lang.Object

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

        Constructor Details

        +
          +
        • +
          +

          CirclePromptFocal

          +
          public CirclePromptFocal()
          +
          Constructor.
          +
          +
          • +
        +
        +
        • + +
      • +
        +

        Method Details

        +
          +
        • +
          +

          setRadius

          +
          @NonNull +public CirclePromptFocal setRadius​(float radius)
          +
          Set the focal radius.
          +
          +
          Parameters:
          +
          radius - The radius for the circle to be drawn.
          +
          Returns:
          +
          This prompt focal
          +
          +
          +
          • +
        • +
          +

          getBounds

          +
          @NonNull +public android.graphics.RectF getBounds()
          +
          Description copied from class: PromptFocal
          +
          Get the focal bounds at scale 1.
          +
          +
          Specified by:
          +
          getBounds in class PromptFocal
          +
          Returns:
          +
          The screen area that the focal is drawn in at scale 1.
          +
          +
          +
          • +
        • +
          +

          getPath

          +
          @NonNull +public android.graphics.Path getPath()
          +
          Description copied from class: PromptFocal
          +
          Get the focal path to be drawn. Override this to support a transparent focal colour.
          +
          +
          Overrides:
          +
          getPath in class PromptFocal
          +
          Returns:
          +
          The path used to draw the focal
          +
          +
          +
          • +
        • +
          +

          calculateAngleEdgePoint

          +
          @NonNull +public android.graphics.PointF calculateAngleEdgePoint​(float angle, +float padding)
          +
          Description copied from class: PromptFocal
          +
          Calculate the point on the focal edge based on the angle. + This is called after PromptFocal.prepare(PromptOptions, float, float) or + PromptFocal.prepare(PromptOptions, View, int[]). + + Base implementation assumes that focal is a rectangle.
          +
          +
          Overrides:
          +
          calculateAngleEdgePoint in class PromptFocal
          +
          Parameters:
          +
          angle - The angle with 0 based on the right.
          +
          padding - The padding added to the focal bounds.
          +
          Returns:
          +
          The calculated point
          +
          +
          +
          • +
        • +
          +

          setColour

          +
          public void setColour​(int colour)
          +
          Description copied from class: PromptFocal
          +
          Set the focal colour.
          +
          +
          Specified by:
          +
          setColour in class PromptFocal
          +
          Parameters:
          +
          colour - Int colour.
          +
          +
          +
          • +
        • +
          +

          prepare

          +
          public void prepare​(@NonNull +PromptOptions options, +@NonNull +android.view.View target, +int[] promptViewPosition)
          +
          Description copied from class: PromptFocal
          +
          Setup the focal ready for rendering when targeting a view, called prior to first render.
          +
          +
          Specified by:
          +
          prepare in class PromptFocal
          +
          Parameters:
          +
          options - The option that the prompt was built from.
          +
          target - The prompt target view.
          +
          promptViewPosition - The prompt views screen position.
          +
          +
          +
          • +
        • +
          +

          prepare

          +
          public void prepare​(@NonNull +PromptOptions options, +float targetX, +float targetY)
          +
          Description copied from class: PromptFocal
          +
          Setup the focal ready for rendering when targeting a point on the screen, called prior to first render.
          +
          +
          Specified by:
          +
          prepare in class PromptFocal
          +
          Parameters:
          +
          options - The option that the prompt was built from.
          +
          targetX - The target screen x position.
          +
          targetY - The target screen y position.
          +
          +
          +
          • +
        • +
          +

          update

          +
          public void update​(@NonNull +PromptOptions options, +float revealModifier, +float alphaModifier)
          +
          +
          • +
        • +
          +

          updateRipple

          +
          public void updateRipple​(float revealModifier, +float alphaModifier)
          +
          Description copied from class: PromptFocal
          +
          Update the ripple around the focal.
          +
          +
          Specified by:
          +
          updateRipple in class PromptFocal
          +
          Parameters:
          +
          revealModifier - The amount to scale the ripple by where a 1 value is the same size as the focal.
          +
          alphaModifier - The amount to modify the ripple alpha by.
          +
          +
          +
          • +
        • +
          +

          draw

          +
          public void draw​(@NonNull +android.graphics.Canvas canvas)
          +
          +
          • +
        • +
          +

          contains

          +
          public boolean contains​(float x, +float y)
          +
          +
          • +
        +
        +
        • +
      +
      + +
      + +
      +
      + + diff --git a/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/focals/RectanglePromptFocal.html b/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/focals/RectanglePromptFocal.html index 4bab49fb..3c55aa51 100644 --- a/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/focals/RectanglePromptFocal.html +++ b/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/focals/RectanglePromptFocal.html @@ -1,566 +1,479 @@ - - - - - -RectanglePromptFocal (material-tap-target-prompt 3.0.0 API) - - - - - - - - -
      - - -
      Skip navigation links
      - - - - -
      -
      - - - -
      - -
      -
      - - -
      - - -
      - - -
      -
      uk.co.samuelwall.materialtaptargetprompt.extras.focals
      -

      Class RectanglePromptFocal

      -
      -
      - -
      -
        -
      • -
        -
        -
        public class RectanglePromptFocal
-extends PromptFocal
        -
        Prompt focal implementation to draw the focal as a rectangle.
        -
        • -
      -
      -
      -
        -
      • - - - -
          -
        • - - -

          Constructor Summary

          - - - - - - - - -
          Constructors 
          Constructor and Description
          RectanglePromptFocal() -
          Constructor.
          -
          -
          • -
        - -
          -
        • - - -

          Method Summary

          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
          All Methods Instance Methods Concrete Methods 
          Modifier and TypeMethod and Description
          booleancontains(float x, - float y) 
          voiddraw(android.graphics.Canvas canvas) 
          android.graphics.RectFgetBounds() -
          Get the focal bounds at scale 1.
          -
          android.graphics.PathgetPath() -
          Get the focal path to be drawn.
          -
          voidprepare(PromptOptions options, - float targetX, - float targetY) -
          Setup the focal ready for rendering when targeting a point on the screen, called prior to first render.
          -
          voidprepare(PromptOptions options, - android.view.View target, - int[] promptViewPosition) -
          Setup the focal ready for rendering when targeting a view, called prior to first render.
          -
          voidsetColour(int colour) -
          Set the focal colour.
          -
          RectanglePromptFocalsetCornerRadius(float rx, - float ry) -
          Set the radius for the rectangle corners.
          -
          RectanglePromptFocalsetSize(android.graphics.PointF size) -
          Sets the focal to a fixed size.
          -
          RectanglePromptFocalsetTargetPadding(float padding) -
          Set the padding between the target bounds and the rectangle edge.
          -
          voidupdate(PromptOptions options, - float revealModifier, - float alphaModifier) 
          voidupdateRipple(float revealModifier, - float alphaModifier) -
          Update the ripple around the focal.
          -
          - -
            -
          • - - -

            Methods inherited from class java.lang.Object

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

          Constructor Detail

          - - - -
            -
          • -

            RectanglePromptFocal

            -
            public RectanglePromptFocal()
            -
            Constructor.
            -
            • -
          -
          • -
        - -
          -
        • - - -

          Method Detail

          - - - -
            -
          • -

            setCornerRadius

            -
            @NonNull
-public RectanglePromptFocal setCornerRadius(float rx,
-                                                     float ry)
            -
            Set the radius for the rectangle corners.
            -
            -
            Parameters:
            -
            rx - The x-radius of the oval used to round the corners
            -
            ry - The y-radius of the oval used to round the corners
            -
            Returns:
            -
            This prompt focal
            -
            -
            • -
          - - - -
            -
          • -

            setTargetPadding

            -
            @NonNull
-public RectanglePromptFocal setTargetPadding(@Dimension
-                                                      float padding)
            -
            Set the padding between the target bounds and the rectangle edge.
            -
            -
            Parameters:
            -
            padding - The distance from the target edge to the rectangle edge.
            -
            Returns:
            -
            This prompt focal.
            -
            -
            • -
          - - - -
            -
          • -

            setSize

            -
            @NonNull
-public RectanglePromptFocal setSize(@Nullable
-                                             android.graphics.PointF size)
            -
            Sets the focal to a fixed size. Set as null to change it back to dynamic.
            -
            -
            Parameters:
            -
            size - The fixed focal size or null to change back to the default dynamic size.
            -
            Returns:
            -
            This prompt focal
            -
            -
            • -
          - - - -
            -
          • -

            getBounds

            -
            @NonNull
-public android.graphics.RectF getBounds()
            -
            Description copied from class: PromptFocal
            -
            Get the focal bounds at scale 1.
            -
            -
            Specified by:
            -
            getBounds in class PromptFocal
            -
            Returns:
            -
            The screen area that the focal is drawn in at scale 1.
            -
            -
            • -
          - - - -
            -
          • -

            getPath

            -
            @NonNull
-public android.graphics.Path getPath()
            -
            Description copied from class: PromptFocal
            -
            Get the focal path to be drawn. Override this to support a transparent focal colour.
            -
            -
            Overrides:
            -
            getPath in class PromptFocal
            -
            Returns:
            -
            The path used to draw the focal
            -
            -
            • -
          - - - -
            -
          • -

            setColour

            -
            public void setColour(int colour)
            -
            Description copied from class: PromptFocal
            -
            Set the focal colour.
            -
            -
            Specified by:
            -
            setColour in class PromptFocal
            -
            Parameters:
            -
            colour - Int colour.
            -
            -
            • -
          - - - -
            -
          • -

            prepare

            -
            public void prepare(@NonNull
-                    PromptOptions options,
-                    @NonNull
-                    android.view.View target,
-                    int[] promptViewPosition)
            -
            Description copied from class: PromptFocal
            -
            Setup the focal ready for rendering when targeting a view, called prior to first render.
            -
            -
            Specified by:
            -
            prepare in class PromptFocal
            -
            Parameters:
            -
            options - The option that the prompt was built from.
            -
            target - The prompt target view.
            -
            promptViewPosition - The prompt views screen position.
            -
            -
            • -
          - - - -
            -
          • -

            prepare

            -
            public void prepare(@NonNull
-                    PromptOptions options,
-                    float targetX,
-                    float targetY)
            -
            Description copied from class: PromptFocal
            -
            Setup the focal ready for rendering when targeting a point on the screen, called prior to first render.
            -
            -
            Specified by:
            -
            prepare in class PromptFocal
            -
            Parameters:
            -
            options - The option that the prompt was built from.
            -
            targetX - The target screen x position.
            -
            targetY - The target screen y position.
            -
            -
            • -
          - - - -
            -
          • -

            update

            -
            public void update(@NonNull
-                   PromptOptions options,
-                   float revealModifier,
-                   float alphaModifier)
            -
            • -
          - - - -
            -
          • -

            updateRipple

            -
            public void updateRipple(float revealModifier,
-                         float alphaModifier)
            -
            Description copied from class: PromptFocal
            -
            Update the ripple around the focal.
            -
            -
            Specified by:
            -
            updateRipple in class PromptFocal
            -
            Parameters:
            -
            revealModifier - The amount to scale the ripple by where a 1 value is the same size as the focal.
            -
            alphaModifier - The amount to modify the ripple alpha by.
            -
            -
            • -
          - - - -
            -
          • -

            draw

            -
            public void draw(@NonNull
-                 android.graphics.Canvas canvas)
            -
            • -
          - - - -
            -
          • -

            contains

            -
            public boolean contains(float x,
-                        float y)
            -
            • -
          -
          • -
        -
        • -
      -
      -
      - - -
      - - -
      Skip navigation links
      - - - - -
      -
      - - - -
      - -
      -
      - - -
      - - -
      - - - + + + + + +RectanglePromptFocal (material-tap-target-prompt 3.0.1 API) + + + + + + + + + + + + + +
      + +
      +
      + +
      +
      Package uk.co.samuelwall.materialtaptargetprompt.extras.focals
      +

      Class RectanglePromptFocal

      +
      +
      java.lang.Object +
      uk.co.samuelwall.materialtaptargetprompt.extras.PromptFocal +
      uk.co.samuelwall.materialtaptargetprompt.extras.focals.RectanglePromptFocal
      +
      +
      +
      +
      +
      public class RectanglePromptFocal
+extends PromptFocal
      +
      Prompt focal implementation to draw the focal as a rectangle.
      +
      +
      +
        + +
      • +
        +

        Field Summary

        +
        +

        Fields inherited from class uk.co.samuelwall.materialtaptargetprompt.extras.PromptFocal

        +mBaseRippleAlpha, mDrawRipple
        +
        +
        • + +
      • +
        +

        Constructor Summary

        +
        + + + + + + + + + + + + + + +
        Constructors
        ConstructorDescription
        RectanglePromptFocal() +
        Constructor.
        +
        +
        +
        +
        • + +
      • +
        +

        Method Summary

        +
        +
        +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        Modifier and TypeMethodDescription
        booleancontains​(float x, +float y) 
        voiddraw​(android.graphics.Canvas canvas) 
        android.graphics.RectFgetBounds() +
        Get the focal bounds at scale 1.
        +
        android.graphics.PathgetPath() +
        Get the focal path to be drawn.
        +
        voidprepare​(PromptOptions options, +float targetX, +float targetY) +
        Setup the focal ready for rendering when targeting a point on the screen, called prior to first render.
        +
        voidprepare​(PromptOptions options, +android.view.View target, +int[] promptViewPosition) +
        Setup the focal ready for rendering when targeting a view, called prior to first render.
        +
        voidsetColour​(int colour) +
        Set the focal colour.
        +
        RectanglePromptFocalsetCornerRadius​(float rx, +float ry) +
        Set the radius for the rectangle corners.
        +
        RectanglePromptFocalsetSize​(android.graphics.PointF size) +
        Sets the focal to a fixed size.
        +
        RectanglePromptFocalsetTargetPadding​(float padding) +
        Set the padding between the target bounds and the rectangle edge.
        +
        voidupdate​(PromptOptions options, +float revealModifier, +float alphaModifier) 
        voidupdateRipple​(float revealModifier, +float alphaModifier) +
        Update the ripple around the focal.
        +
        +
        +
        +
        +

        Methods inherited from class uk.co.samuelwall.materialtaptargetprompt.extras.PromptFocal

        +calculateAngleEdgePoint, setDrawRipple, setRippleAlpha
        +
        +

        Methods inherited from class java.lang.Object

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

        Constructor Details

        +
          +
        • +
          +

          RectanglePromptFocal

          +
          public RectanglePromptFocal()
          +
          Constructor.
          +
          +
          • +
        +
        +
        • + +
      • +
        +

        Method Details

        +
          +
        • +
          +

          setCornerRadius

          +
          @NonNull +public RectanglePromptFocal setCornerRadius​(float rx, +float ry)
          +
          Set the radius for the rectangle corners.
          +
          +
          Parameters:
          +
          rx - The x-radius of the oval used to round the corners
          +
          ry - The y-radius of the oval used to round the corners
          +
          Returns:
          +
          This prompt focal
          +
          +
          +
          • +
        • +
          +

          setTargetPadding

          +
          @NonNull +public RectanglePromptFocal setTargetPadding​(@Dimension +float padding)
          +
          Set the padding between the target bounds and the rectangle edge.
          +
          +
          Parameters:
          +
          padding - The distance from the target edge to the rectangle edge.
          +
          Returns:
          +
          This prompt focal.
          +
          +
          +
          • +
        • +
          +

          setSize

          +
          @NonNull +public RectanglePromptFocal setSize​(@Nullable +android.graphics.PointF size)
          +
          Sets the focal to a fixed size. Set as null to change it back to dynamic.
          +
          +
          Parameters:
          +
          size - The fixed focal size or null to change back to the default dynamic size.
          +
          Returns:
          +
          This prompt focal
          +
          +
          +
          • +
        • +
          +

          getBounds

          +
          @NonNull +public android.graphics.RectF getBounds()
          +
          Description copied from class: PromptFocal
          +
          Get the focal bounds at scale 1.
          +
          +
          Specified by:
          +
          getBounds in class PromptFocal
          +
          Returns:
          +
          The screen area that the focal is drawn in at scale 1.
          +
          +
          +
          • +
        • +
          +

          getPath

          +
          @NonNull +public android.graphics.Path getPath()
          +
          Description copied from class: PromptFocal
          +
          Get the focal path to be drawn. Override this to support a transparent focal colour.
          +
          +
          Overrides:
          +
          getPath in class PromptFocal
          +
          Returns:
          +
          The path used to draw the focal
          +
          +
          +
          • +
        • +
          +

          setColour

          +
          public void setColour​(int colour)
          +
          Description copied from class: PromptFocal
          +
          Set the focal colour.
          +
          +
          Specified by:
          +
          setColour in class PromptFocal
          +
          Parameters:
          +
          colour - Int colour.
          +
          +
          +
          • +
        • +
          +

          prepare

          +
          public void prepare​(@NonNull +PromptOptions options, +@NonNull +android.view.View target, +int[] promptViewPosition)
          +
          Description copied from class: PromptFocal
          +
          Setup the focal ready for rendering when targeting a view, called prior to first render.
          +
          +
          Specified by:
          +
          prepare in class PromptFocal
          +
          Parameters:
          +
          options - The option that the prompt was built from.
          +
          target - The prompt target view.
          +
          promptViewPosition - The prompt views screen position.
          +
          +
          +
          • +
        • +
          +

          prepare

          +
          public void prepare​(@NonNull +PromptOptions options, +float targetX, +float targetY)
          +
          Description copied from class: PromptFocal
          +
          Setup the focal ready for rendering when targeting a point on the screen, called prior to first render.
          +
          +
          Specified by:
          +
          prepare in class PromptFocal
          +
          Parameters:
          +
          options - The option that the prompt was built from.
          +
          targetX - The target screen x position.
          +
          targetY - The target screen y position.
          +
          +
          +
          • +
        • +
          +

          update

          +
          public void update​(@NonNull +PromptOptions options, +float revealModifier, +float alphaModifier)
          +
          +
          • +
        • +
          +

          updateRipple

          +
          public void updateRipple​(float revealModifier, +float alphaModifier)
          +
          Description copied from class: PromptFocal
          +
          Update the ripple around the focal.
          +
          +
          Specified by:
          +
          updateRipple in class PromptFocal
          +
          Parameters:
          +
          revealModifier - The amount to scale the ripple by where a 1 value is the same size as the focal.
          +
          alphaModifier - The amount to modify the ripple alpha by.
          +
          +
          +
          • +
        • +
          +

          draw

          +
          public void draw​(@NonNull +android.graphics.Canvas canvas)
          +
          +
          • +
        • +
          +

          contains

          +
          public boolean contains​(float x, +float y)
          +
          +
          • +
        +
        +
        • +
      +
      + +
      + +
      +
      + + diff --git a/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/focals/package-frame.html b/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/focals/package-frame.html deleted file mode 100644 index 4e100e72..00000000 --- a/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/focals/package-frame.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - -uk.co.samuelwall.materialtaptargetprompt.extras.focals (material-tap-target-prompt 3.0.0 API) - - - - - -

      uk.co.samuelwall.materialtaptargetprompt.extras.focals

      -
      -

      Classes

      - -
      - - diff --git a/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/focals/package-summary.html b/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/focals/package-summary.html index 68676dac..39004da3 100644 --- a/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/focals/package-summary.html +++ b/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/focals/package-summary.html @@ -1,148 +1,110 @@ - - - - - -uk.co.samuelwall.materialtaptargetprompt.extras.focals (material-tap-target-prompt 3.0.0 API) - - - - - - - - -
      - - -
      Skip navigation links
      - - - - -
      -
      - - - -
      - -
      - - -
      - -
      -

      Package uk.co.samuelwall.materialtaptargetprompt.extras.focals

      -
      -
      -
        -
      • - - - - - - - - - - - - - - - - -
        Class Summary 
        ClassDescription
        CirclePromptFocal -
        Prompt focal implementation to draw the focal as a circle.
        -
        RectanglePromptFocal -
        Prompt focal implementation to draw the focal as a rectangle.
        -
        -
        • -
      -
      - -
      - - -
      Skip navigation links
      - - - - -
      -
      - - - -
      - -
      - - -
      - - - + + + + + +uk.co.samuelwall.materialtaptargetprompt.extras.focals (material-tap-target-prompt 3.0.1 API) + + + + + + + + + + + + + +
      + +
      +
      +
      +

      Package uk.co.samuelwall.materialtaptargetprompt.extras.focals

      +
      +
      +
        +
      • +
        + + + + + + + + + + + + + + + + + + +
        Class Summary
        ClassDescription
        CirclePromptFocal +
        Prompt focal implementation to draw the focal as a circle.
        +
        RectanglePromptFocal +
        Prompt focal implementation to draw the focal as a rectangle.
        +
        +
        +
        • +
      +
      +
      + +
      +
      + + diff --git a/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/focals/package-tree.html b/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/focals/package-tree.html index 1c081025..315d62f2 100644 --- a/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/focals/package-tree.html +++ b/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/focals/package-tree.html @@ -1,140 +1,98 @@ - - - - - -uk.co.samuelwall.materialtaptargetprompt.extras.focals Class Hierarchy (material-tap-target-prompt 3.0.0 API) - - - - - - - - -
      - - -
      Skip navigation links
      - - - - -
      -
      - - - -
      - -
      - - -
      - -
      -

      Hierarchy For Package uk.co.samuelwall.materialtaptargetprompt.extras.focals

      -Package Hierarchies: - -
      -
      -

      Class Hierarchy

      -
        -
      • java.lang.Object - -
        • -
      -
      - -
      - - -
      Skip navigation links
      - - - - -
      -
      - - - -
      - -
      - - -
      - - - + + + + + +uk.co.samuelwall.materialtaptargetprompt.extras.focals Class Hierarchy (material-tap-target-prompt 3.0.1 API) + + + + + + + + + + + + + +
      + +
      +
      +
      +

      Hierarchy For Package uk.co.samuelwall.materialtaptargetprompt.extras.focals

      +Package Hierarchies: + +
      +
      +

      Class Hierarchy

      +
        +
      • java.lang.Object + +
        • +
      +
      +
      + +
      +
      + + diff --git a/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/package-frame.html b/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/package-frame.html deleted file mode 100644 index 2b58d670..00000000 --- a/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/package-frame.html +++ /dev/null @@ -1,24 +0,0 @@ - - - - - -uk.co.samuelwall.materialtaptargetprompt.extras (material-tap-target-prompt 3.0.0 API) - - - - - -

      uk.co.samuelwall.materialtaptargetprompt.extras

      -
      -

      Classes

      - -
      - - diff --git a/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/package-summary.html b/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/package-summary.html index d501eac1..3e4bbf65 100644 --- a/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/package-summary.html +++ b/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/package-summary.html @@ -1,164 +1,126 @@ - - - - - -uk.co.samuelwall.materialtaptargetprompt.extras (material-tap-target-prompt 3.0.0 API) - - - - - - - - -
      - - -
      Skip navigation links
      - - - - -
      -
      - - - -
      - -
      - - -
      - -
      -

      Package uk.co.samuelwall.materialtaptargetprompt.extras

      -
      -
      - -
      - -
      - - -
      Skip navigation links
      - - - - -
      -
      - - - -
      - -
      - - -
      - - - + + + + + +uk.co.samuelwall.materialtaptargetprompt.extras (material-tap-target-prompt 3.0.1 API) + + + + + + + + + + + + + +
      + +
      +
      +
      +

      Package uk.co.samuelwall.materialtaptargetprompt.extras

      +
      +
      +
        +
      • +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        Class Summary
        ClassDescription
        PromptBackground +
        Used to render the prompt background.
        +
        PromptFocal +
        Used to render the prompt focal.
        +
        PromptOptions<T extends PromptOptions> +
        Contains all the settings for creating a prompt.
        +
        PromptText 
        PromptUtils +
        Useful methods for prompts that don't fit else where.
        +
        +
        +
        • +
      +
      +
      + +
      +
      + + diff --git a/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/package-tree.html b/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/package-tree.html index 9db7dbaf..adbd24ca 100644 --- a/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/package-tree.html +++ b/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/package-tree.html @@ -1,139 +1,97 @@ - - - - - -uk.co.samuelwall.materialtaptargetprompt.extras Class Hierarchy (material-tap-target-prompt 3.0.0 API) - - - - - - - - -
      - - -
      Skip navigation links
      - - - - -
      -
      - - - -
      - -
      - - -
      - -
      -

      Hierarchy For Package uk.co.samuelwall.materialtaptargetprompt.extras

      -Package Hierarchies: - -
      -
      -

      Class Hierarchy

      -
        -
      • java.lang.Object -
          -
        • uk.co.samuelwall.materialtaptargetprompt.extras.PromptBackground
          • -
        • uk.co.samuelwall.materialtaptargetprompt.extras.PromptFocal
          • -
        • uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions<T>
          • -
        • uk.co.samuelwall.materialtaptargetprompt.extras.PromptText
          • -
        • uk.co.samuelwall.materialtaptargetprompt.extras.PromptUtils
          • -
        -
        • -
      -
      - -
      - - -
      Skip navigation links
      - - - - -
      -
      - - - -
      - -
      - - -
      - - - + + + + + +uk.co.samuelwall.materialtaptargetprompt.extras Class Hierarchy (material-tap-target-prompt 3.0.1 API) + + + + + + + + + + + + + +
      + +
      +
      +
      +

      Hierarchy For Package uk.co.samuelwall.materialtaptargetprompt.extras

      +Package Hierarchies: + +
      +
      +

      Class Hierarchy

      +
        +
      • java.lang.Object +
          +
        • uk.co.samuelwall.materialtaptargetprompt.extras.PromptBackground
          • +
        • uk.co.samuelwall.materialtaptargetprompt.extras.PromptFocal
          • +
        • uk.co.samuelwall.materialtaptargetprompt.extras.PromptOptions<T>
          • +
        • uk.co.samuelwall.materialtaptargetprompt.extras.PromptText
          • +
        • uk.co.samuelwall.materialtaptargetprompt.extras.PromptUtils
          • +
        +
        • +
      +
      +
      + +
      +
      + + diff --git a/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/sequence/SequenceItem.html b/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/sequence/SequenceItem.html index 4a61ecf7..f8342e89 100644 --- a/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/sequence/SequenceItem.html +++ b/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/sequence/SequenceItem.html @@ -1,505 +1,433 @@ - - - - - -SequenceItem (material-tap-target-prompt 3.0.0 API) - - - - - - - - -
      - - -
      Skip navigation links
      - - - - -
      -
      - - - -
      - -
      -
      -
        -
      • Summary: 
        • -
      • Nested | 
        • -
      • Field | 
        • -
      • Constr | 
        • -
      • Method
        • -
      - -
      - - -
      - - -
      -
      uk.co.samuelwall.materialtaptargetprompt.extras.sequence
      -

      Class SequenceItem

      -
      -
      -
        -
      • java.lang.Object
        • -
      • -
          -
        • uk.co.samuelwall.materialtaptargetprompt.extras.sequence.SequenceItem
          • -
        -
        • -
      -
      - -
      -
      - -
      -
      - -
      -
      - - -
      - - -
      Skip navigation links
      - - - - -
      -
      - - - -
      - -
      -
      -
        -
      • Summary: 
        • -
      • Nested | 
        • -
      • Field | 
        • -
      • Constr | 
        • -
      • Method
        • -
      - -
      - - -
      - - - + + + + + +SequenceItem (material-tap-target-prompt 3.0.1 API) + + + + + + + + + + + + + +
      + +
      +
      + +
      +
      Package uk.co.samuelwall.materialtaptargetprompt.extras.sequence
      +

      Class SequenceItem

      +
      +
      java.lang.Object +
      uk.co.samuelwall.materialtaptargetprompt.extras.sequence.SequenceItem
      +
      +
      +
      +
      All Implemented Interfaces:
      +
      MaterialTapTargetPrompt.PromptStateChangeListener
      +
      +
      +
      Direct Known Subclasses:
      +
      SequenceItemShowFor
      +
      +
      +
      public class SequenceItem
+extends java.lang.Object
+implements MaterialTapTargetPrompt.PromptStateChangeListener
      +
      Represents a prompt to display in a sequence.
      +
      +
      + +
      +
      + +
      + +
      + +
      +
      + + diff --git a/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/sequence/SequenceItemShowFor.html b/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/sequence/SequenceItemShowFor.html index b00631a4..4be6eb61 100644 --- a/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/sequence/SequenceItemShowFor.html +++ b/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/sequence/SequenceItemShowFor.html @@ -1,308 +1,249 @@ - - - - - -SequenceItemShowFor (material-tap-target-prompt 3.0.0 API) - - - - - - - - -
      - - -
      Skip navigation links
      - - - - -
      -
      - - - -
      - -
      -
      -
        -
      • Summary: 
        • -
      • Nested | 
        • -
      • Field | 
        • -
      • Constr | 
        • -
      • Method
        • -
      - -
      - - -
      - - -
      -
      uk.co.samuelwall.materialtaptargetprompt.extras.sequence
      -

      Class SequenceItemShowFor

      -
      -
      - -
      - -
      -
      - -
      -
      -
        -
      • - -
          -
        • - - -

          Constructor Detail

          - - - -
            -
          • -

            SequenceItemShowFor

            -
            public SequenceItemShowFor(@NonNull
-                           SequenceState state,
-                           long milliseconds)
            -
            Constructor.
            -
            -
            Parameters:
            -
            state - The prompt that this item will show.
            -
            milliseconds - The number of milliseconds to show the prompt for.
            -
            -
            • -
          -
          • -
        - -
          -
        • - - -

          Method Detail

          - - - -
            -
          • -

            show

            -
            protected void show(@NonNull
-                    MaterialTapTargetPrompt prompt)
            -
            Description copied from class: SequenceItem
            -
            Show the created prompt for this sequence item.
            -
            -
            Overrides:
            -
            show in class SequenceItem
            -
            Parameters:
            -
            prompt - The prompt to show, this will never be null here.
            -
            -
            • -
          -
          • -
        -
        • -
      -
      -
      - - -
      - - -
      Skip navigation links
      - - - - -
      -
      - - - -
      - -
      -
      -
        -
      • Summary: 
        • -
      • Nested | 
        • -
      • Field | 
        • -
      • Constr | 
        • -
      • Method
        • -
      - -
      - - -
      - - - + + + + + +SequenceItemShowFor (material-tap-target-prompt 3.0.1 API) + + + + + + + + + + + + + +
      + +
      +
      + +
      +
      Package uk.co.samuelwall.materialtaptargetprompt.extras.sequence
      +

      Class SequenceItemShowFor

      +
      +
      java.lang.Object +
      uk.co.samuelwall.materialtaptargetprompt.extras.sequence.SequenceItem +
      uk.co.samuelwall.materialtaptargetprompt.extras.sequence.SequenceItemShowFor
      +
      +
      +
      +
      +
      All Implemented Interfaces:
      +
      MaterialTapTargetPrompt.PromptStateChangeListener
      +
      +
      +
      public class SequenceItemShowFor
+extends SequenceItem
      +
      Shows a prompt in a sequence for the supplied milliseconds.
      +
      +
      + +
      +
      +
        + +
      • +
        +

        Constructor Details

        +
          +
        • +
          +

          SequenceItemShowFor

          +
          public SequenceItemShowFor​(@NonNull +SequenceState state, +long milliseconds)
          +
          Constructor.
          +
          +
          Parameters:
          +
          state - The prompt that this item will show.
          +
          milliseconds - The number of milliseconds to show the prompt for.
          +
          +
          +
          • +
        +
        +
        • + +
      • +
        +

        Method Details

        +
          +
        • +
          +

          show

          +
          protected void show​(@NonNull +MaterialTapTargetPrompt prompt)
          +
          Description copied from class: SequenceItem
          +
          Show the created prompt for this sequence item.
          +
          +
          Overrides:
          +
          show in class SequenceItem
          +
          Parameters:
          +
          prompt - The prompt to show, this will never be null here.
          +
          +
          +
          • +
        +
        +
        • +
      +
      + +
      + +
      +
      + + diff --git a/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/sequence/SequenceState.html b/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/sequence/SequenceState.html index 518de5d1..5c1fa218 100644 --- a/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/sequence/SequenceState.html +++ b/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/sequence/SequenceState.html @@ -1,290 +1,238 @@ - - - - - -SequenceState (material-tap-target-prompt 3.0.0 API) - - - - - - - - -
      - - -
      Skip navigation links
      - - - - -
      -
      - - - -
      - -
      -
      -
        -
      • Summary: 
        • -
      • Nested | 
        • -
      • Field | 
        • -
      • Constr | 
        • -
      • Method
        • -
      - -
      - - -
      - - -
      -
      uk.co.samuelwall.materialtaptargetprompt.extras.sequence
      -

      Class SequenceState

      -
      -
      -
        -
      • java.lang.Object
        • -
      • -
          -
        • uk.co.samuelwall.materialtaptargetprompt.extras.sequence.SequenceState
          • -
        -
        • -
      -
      - -
      -
      - -
      -
      -
        -
      • - -
          -
        • - - -

          Constructor Detail

          - - - -
            -
          • -

            SequenceState

            -
            public SequenceState(@Nullable
-                     MaterialTapTargetPrompt prompt)
            -
            Constructor.
            -
            -
            Parameters:
            -
            prompt - The prompt to use in this state.
            -
            -
            • -
          -
          • -
        - -
          -
        • - - -

          Method Detail

          - - - -
            -
          • -

            getPrompt

            -
            @Nullable
-public MaterialTapTargetPrompt getPrompt()
            -
            Get the stored prompt.
            -
            -
            Returns:
            -
            The prompt.
            -
            -
            • -
          -
          • -
        -
        • -
      -
      -
      - - -
      - - -
      Skip navigation links
      - - - - -
      -
      - - - -
      - -
      -
      -
        -
      • Summary: 
        • -
      • Nested | 
        • -
      • Field | 
        • -
      • Constr | 
        • -
      • Method
        • -
      - -
      - - -
      - - - + + + + + +SequenceState (material-tap-target-prompt 3.0.1 API) + + + + + + + + + + + + + +
      + +
      +
      + +
      +
      Package uk.co.samuelwall.materialtaptargetprompt.extras.sequence
      +

      Class SequenceState

      +
      +
      java.lang.Object +
      uk.co.samuelwall.materialtaptargetprompt.extras.sequence.SequenceState
      +
      +
      +
      +
      Direct Known Subclasses:
      +
      SequenceStatePromptOptions
      +
      +
      +
      public class SequenceState
+extends java.lang.Object
      +
      Stores a prompt for a SequenceItem in a sequence.
      +
      +
      +
        + +
      • +
        +

        Constructor Summary

        +
        + + + + + + + + + + + + + + +
        Constructors
        ConstructorDescription
        SequenceState​(MaterialTapTargetPrompt prompt) +
        Constructor.
        +
        +
        +
        +
        • + +
      • +
        +

        Method Summary

        +
        +
        +
        + + + + + + + + + + + + + + + +
        Modifier and TypeMethodDescription
        MaterialTapTargetPromptgetPrompt() +
        Get the stored prompt.
        +
        +
        +
        +
        +

        Methods inherited from class java.lang.Object

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

        Constructor Details

        +
          +
        • +
          +

          SequenceState

          +
          public SequenceState​(@Nullable +MaterialTapTargetPrompt prompt)
          +
          Constructor.
          +
          +
          Parameters:
          +
          prompt - The prompt to use in this state.
          +
          +
          +
          • +
        +
        +
        • + +
      • +
        +

        Method Details

        +
          +
        • +
          +

          getPrompt

          +
          @Nullable +public MaterialTapTargetPrompt getPrompt()
          +
          Get the stored prompt.
          +
          +
          Returns:
          +
          The prompt.
          +
          +
          +
          • +
        +
        +
        • +
      +
      + +
      + +
      +
      + + diff --git a/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/sequence/SequenceStatePromptOptions.html b/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/sequence/SequenceStatePromptOptions.html index 439c38e4..2853f5ba 100644 --- a/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/sequence/SequenceStatePromptOptions.html +++ b/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/sequence/SequenceStatePromptOptions.html @@ -1,295 +1,240 @@ - - - - - -SequenceStatePromptOptions (material-tap-target-prompt 3.0.0 API) - - - - - - - - -
      - - -
      Skip navigation links
      - - - - -
      -
      - - - -
      - -
      -
      -
        -
      • Summary: 
        • -
      • Nested | 
        • -
      • Field | 
        • -
      • Constr | 
        • -
      • Method
        • -
      - -
      - - -
      - - -
      -
      uk.co.samuelwall.materialtaptargetprompt.extras.sequence
      -

      Class SequenceStatePromptOptions

      -
      -
      - -
      - -
      -
      - -
      -
      -
        -
      • - -
          -
        • - - -

          Constructor Detail

          - - - -
            -
          • -

            SequenceStatePromptOptions

            -
            public SequenceStatePromptOptions(@NonNull
-                                  PromptOptions promptOptions)
            -
            Constructor.
            -
            -
            Parameters:
            -
            promptOptions - The builder to create the prompt from.
            -
            -
            • -
          -
          • -
        - - -
        • -
      -
      -
      - - -
      - - -
      Skip navigation links
      - - - - -
      -
      - - - -
      - -
      -
      -
        -
      • Summary: 
        • -
      • Nested | 
        • -
      • Field | 
        • -
      • Constr | 
        • -
      • Method
        • -
      - -
      - - -
      - - - + + + + + +SequenceStatePromptOptions (material-tap-target-prompt 3.0.1 API) + + + + + + + + + + + + + +
      + +
      +
      + +
      +
      Package uk.co.samuelwall.materialtaptargetprompt.extras.sequence
      +

      Class SequenceStatePromptOptions

      +
      +
      java.lang.Object +
      uk.co.samuelwall.materialtaptargetprompt.extras.sequence.SequenceState +
      uk.co.samuelwall.materialtaptargetprompt.extras.sequence.SequenceStatePromptOptions
      +
      +
      +
      +
      +
      public class SequenceStatePromptOptions
+extends SequenceState
      +
      A SequenceState where the prompt is created the first time that getPrompt() is + called.
      +
      +
      +
        + +
      • +
        +

        Constructor Summary

        +
        + + + + + + + + + + + + + + +
        Constructors
        ConstructorDescription
        SequenceStatePromptOptions​(PromptOptions promptOptions) +
        Constructor.
        +
        +
        +
        +
        • + +
      • +
        +

        Method Summary

        +
        +
        +
        + + + + + + + + + + + + + + + +
        Modifier and TypeMethodDescription
        MaterialTapTargetPromptgetPrompt() +
        Get the stored prompt.
        +
        +
        +
        +
        +

        Methods inherited from class java.lang.Object

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

        Constructor Details

        +
          +
        • +
          +

          SequenceStatePromptOptions

          +
          public SequenceStatePromptOptions​(@NonNull +PromptOptions promptOptions)
          +
          Constructor.
          +
          +
          Parameters:
          +
          promptOptions - The builder to create the prompt from.
          +
          +
          +
          • +
        +
        +
        • + +
      • +
        +

        Method Details

        + +
        +
        • +
      +
      + +
      + +
      +
      + + diff --git a/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/sequence/package-frame.html b/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/sequence/package-frame.html deleted file mode 100644 index e437b9d6..00000000 --- a/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/sequence/package-frame.html +++ /dev/null @@ -1,23 +0,0 @@ - - - - - -uk.co.samuelwall.materialtaptargetprompt.extras.sequence (material-tap-target-prompt 3.0.0 API) - - - - - -

      uk.co.samuelwall.materialtaptargetprompt.extras.sequence

      -
      -

      Classes

      - -
      - - diff --git a/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/sequence/package-summary.html b/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/sequence/package-summary.html index a46d50f3..87d670bc 100644 --- a/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/sequence/package-summary.html +++ b/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/sequence/package-summary.html @@ -1,161 +1,123 @@ - - - - - -uk.co.samuelwall.materialtaptargetprompt.extras.sequence (material-tap-target-prompt 3.0.0 API) - - - - - - - - -
      - - -
      Skip navigation links
      - - - - -
      -
      - - - -
      - -
      - - -
      - -
      -

      Package uk.co.samuelwall.materialtaptargetprompt.extras.sequence

      -
      -
      - -
      - -
      - - -
      Skip navigation links
      - - - - -
      -
      - - - -
      - -
      - - -
      - - - + + + + + +uk.co.samuelwall.materialtaptargetprompt.extras.sequence (material-tap-target-prompt 3.0.1 API) + + + + + + + + + + + + + +
      + +
      +
      +
      +

      Package uk.co.samuelwall.materialtaptargetprompt.extras.sequence

      +
      +
      + +
      +
      + +
      +
      + + diff --git a/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/sequence/package-tree.html b/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/sequence/package-tree.html index 77836d84..ef69d801 100644 --- a/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/sequence/package-tree.html +++ b/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/extras/sequence/package-tree.html @@ -1,144 +1,102 @@ - - - - - -uk.co.samuelwall.materialtaptargetprompt.extras.sequence Class Hierarchy (material-tap-target-prompt 3.0.0 API) - - - - - - - - -
      - - -
      Skip navigation links
      - - - - -
      -
      - - - -
      - -
      - - -
      - -
      -

      Hierarchy For Package uk.co.samuelwall.materialtaptargetprompt.extras.sequence

      -Package Hierarchies: - -
      -
      -

      Class Hierarchy

      - -
      - -
      - - -
      Skip navigation links
      - - - - -
      -
      - - - -
      - -
      - - -
      - - - + + + + + +uk.co.samuelwall.materialtaptargetprompt.extras.sequence Class Hierarchy (material-tap-target-prompt 3.0.1 API) + + + + + + + + + + + + + +
      + +
      +
      +
      +

      Hierarchy For Package uk.co.samuelwall.materialtaptargetprompt.extras.sequence

      +Package Hierarchies: + +
      +
      +

      Class Hierarchy

      + +
      +
      + +
      +
      + + diff --git a/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/package-frame.html b/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/package-frame.html deleted file mode 100644 index 26ed74db..00000000 --- a/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/package-frame.html +++ /dev/null @@ -1,31 +0,0 @@ - - - - - -uk.co.samuelwall.materialtaptargetprompt (material-tap-target-prompt 3.0.0 API) - - - - - -

      uk.co.samuelwall.materialtaptargetprompt

      -
      -

      Interfaces

      - -

      Classes

      - -
      - - diff --git a/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/package-summary.html b/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/package-summary.html index 1f7b822f..23e7eee4 100644 --- a/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/package-summary.html +++ b/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/package-summary.html @@ -1,201 +1,167 @@ - - - - - -uk.co.samuelwall.materialtaptargetprompt (material-tap-target-prompt 3.0.0 API) - - - - - - - - -
      - - -
      Skip navigation links
      - - - - -
      -
      - - - -
      - -
      - - -
      - -
      -

      Package uk.co.samuelwall.materialtaptargetprompt

      -
      -
      - -
      - -
      - - -
      Skip navigation links
      - - - - -
      -
      - - - -
      - -
      - - -
      - - - + + + + + +uk.co.samuelwall.materialtaptargetprompt (material-tap-target-prompt 3.0.1 API) + + + + + + + + + + + + + +
      + +
      +
      +
      +

      Package uk.co.samuelwall.materialtaptargetprompt

      +
      +
      + +
      +
      + +
      +
      + + diff --git a/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/package-tree.html b/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/package-tree.html index 9f35c110..5a57ed7c 100644 --- a/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/package-tree.html +++ b/docs/javadoc/uk/co/samuelwall/materialtaptargetprompt/package-tree.html @@ -1,153 +1,113 @@ - - - - - -uk.co.samuelwall.materialtaptargetprompt Class Hierarchy (material-tap-target-prompt 3.0.0 API) - - - - - - - - -
      - - -
      Skip navigation links
      - - - - -
      -
      - - - -
      - -
      - - -
      - -
      -

      Hierarchy For Package uk.co.samuelwall.materialtaptargetprompt

      -Package Hierarchies: - -
      -
      -

      Class Hierarchy

      - -

      Interface Hierarchy

      - -
      - -
      - - -
      Skip navigation links
      - - - - -
      -
      - - - -
      - -
      - - -
      - - - + + + + + +uk.co.samuelwall.materialtaptargetprompt Class Hierarchy (material-tap-target-prompt 3.0.1 API) + + + + + + + + + + + + + +
      + +
      +
      +
      +

      Hierarchy For Package uk.co.samuelwall.materialtaptargetprompt

      +Package Hierarchies: + +
      +
      +

      Class Hierarchy

      + +
      +
      +

      Interface Hierarchy

      + +
      +
      + +
      +
      + +