AboutPage

java.lang.Object
- mehdi.sakout.aboutpage.AboutPage

```
public class AboutPage
extends java.lang.Object
```
The main class of this library with many predefined methods to add Elements for common items in an About page. This class creates a View that can be passed as the root view in Fragment.onCreateView(LayoutInflater, ViewGroup, Bundle) or passed to the Activity.setContentView(View) in an activity's Activity.onCreate(Bundle) (Bundle)} method
To create a custom item in the about page, pass an instance of Element to the addItem(Element) method.

See Also:

Element

Constructor Summary

Constructors
Constructor and Description

AboutPage(android.content.Context context)
The AboutPage requires a context to perform it's functions.

Constructors
Constructor and Description
`AboutPage(android.content.Context context)` The AboutPage requires a context to perform it's functions.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AboutPage`	`addEmail(java.lang.String email)` Convenience method for `addEmail(java.lang.String, java.lang.String)` but with a predefined title string
`AboutPage`	`addEmail(java.lang.String email, java.lang.String title)` Add a predefined Element that opens the users default email client with a new email to the email address passed as parameter
`AboutPage`	`addFacebook(java.lang.String id)` Convenience method for `addFacebook(java.lang.String, java.lang.String)` but with a predefined title string
`AboutPage`	`addFacebook(java.lang.String id, java.lang.String title)` Add a predefined Element that the opens Facebook app with a deep link to the specified user id If the Facebook application is not installed this will open a web page instead.
`AboutPage`	`addGitHub(java.lang.String id)` Convenience method for `addGitHub(String, String)` but with a predefined title string
`AboutPage`	`addGitHub(java.lang.String id, java.lang.String title)` Add a predefined Element that the opens the a browser and displays the specified GitHub users profile page.
`AboutPage`	`addGroup(java.lang.String name)` Add a new group that will display a header in this AboutPage
`AboutPage`	`addInstagram(java.lang.String id)` Convenience method for `addInstagram(String, String)` (String, String)} but with a predefined title string
`AboutPage`	`addInstagram(java.lang.String id, java.lang.String title)` Add a predefined Element that the opens the Instagram app with a deep link to the specified user id.
`AboutPage`	`addItem(Element element)` Add a custom `Element` to this AboutPage
`AboutPage`	`addPlayStore(java.lang.String id)` Convenience method for `addPlayStore(String, String)` but with a predefined title string
`AboutPage`	`addPlayStore(java.lang.String id, java.lang.String title)` Add a predefined Element that the opens the PlayStore app with a deep link to the specified app application id.
`AboutPage`	`addTwitter(java.lang.String id)` Convenience method for `addTwitter(String, String)` but with a predefined title string
`AboutPage`	`addTwitter(java.lang.String id, java.lang.String title)` Add a predefined Element that the opens the Twitter app with a deep link to the specified user id If the Twitter application is not installed this will open a web page instead.
`AboutPage`	`addWebsite(java.lang.String url)` Convenience method for `addWebsite(String, String)` but with a predefined title string
`AboutPage`	`addWebsite(java.lang.String url, java.lang.String title)` Add a predefined Element that the opens a browser and loads the specified URL
`AboutPage`	`addYoutube(java.lang.String id)` Convenience method for `addYoutube(String, String)` but with a predefined title string
`AboutPage`	`addYoutube(java.lang.String id, java.lang.String title)` Add a predefined Element that the opens the Youtube app with a deep link to the specified channel id.
`android.view.View`	`create()` Create and inflate this AboutPage.
`AboutPage`	`enableDarkMode(java.lang.Boolean enabled)` Provide a way to force dark mode or not
`AboutPage`	`isRTL(boolean value)` Turn on the RTL mode.
`AboutPage`	`setCustomFont(java.lang.String path)` Provide a valid path to a font here to use another font for the text inside this AboutPage
`AboutPage`	`setCustomFont(android.graphics.Typeface typeface)` Provide a typeface to use as custom font
`AboutPage`	`setDescription(java.lang.CharSequence description)`
`AboutPage`	`setImage(int resource)` Set the header image to display in this AboutPage

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

- Constructor Detail
  - AboutPage
```
public AboutPage(android.content.Context context)
```
    The AboutPage requires a context to perform it's functions. Give it a context associated to an Activity or a Fragment. To avoid memory leaks, don't pass a Context.getApplicationContext() here.
    
    Parameters:
    
    context -
- Method Detail
  - setCustomFont
```
public AboutPage setCustomFont(java.lang.String path)
```
    Provide a valid path to a font here to use another font for the text inside this AboutPage
    
    Parameters:
    
    path -
    
    Returns:
    
    this AboutPage instance for builder pattern support
  - setCustomFont
```
public AboutPage setCustomFont(android.graphics.Typeface typeface)
```
    Provide a typeface to use as custom font
    
    Parameters:
    
    typeface -
    
    Returns:
    
    this AboutPage instance for builder pattern support
  - enableDarkMode
```
public AboutPage enableDarkMode(java.lang.Boolean enabled)
```
    Provide a way to force dark mode or not
    
    Parameters:
    
    enabled -
    
    Returns:
    
    this AboutPage instance for builder pattern support
  - addEmail
```
public AboutPage addEmail(java.lang.String email)
```
    Convenience method for addEmail(java.lang.String, java.lang.String) but with a predefined title string
    
    Parameters:
    
    email - the email address to send to
    
    Returns:
    
    this AboutPage instance for builder pattern support
  - addEmail
```
public AboutPage addEmail(java.lang.String email,
                          java.lang.String title)
```
    Add a predefined Element that opens the users default email client with a new email to the email address passed as parameter
    
    Parameters:
    
    email - the email address to send to
    
    title - the title string to display on this item
    
    Returns:
    
    this AboutPage instance for builder pattern support
  - addFacebook
```
public AboutPage addFacebook(java.lang.String id)
```
    Convenience method for addFacebook(java.lang.String, java.lang.String) but with a predefined title string
    
    Parameters:
    
    id - the facebook id to display
    
    Returns:
    
    this AboutPage instance for builder pattern support
  - addFacebook
```
public AboutPage addFacebook(java.lang.String id,
                             java.lang.String title)
```
    Add a predefined Element that the opens Facebook app with a deep link to the specified user id If the Facebook application is not installed this will open a web page instead.
    
    Parameters:
    
    id - the id of the Facebook user to display in the Facebook app
    
    title - the title to display on this item
    
    Returns:
    
    this AboutPage instance for builder pattern support
  - addTwitter
```
public AboutPage addTwitter(java.lang.String id)
```
    Convenience method for addTwitter(String, String) but with a predefined title string
    
    Parameters:
    
    id - the Twitter id to display
    
    Returns:
    
    this AboutPage instance for builder pattern support
  - addTwitter
```
public AboutPage addTwitter(java.lang.String id,
                            java.lang.String title)
```
    Add a predefined Element that the opens the Twitter app with a deep link to the specified user id If the Twitter application is not installed this will open a web page instead.
    
    Parameters:
    
    id - the id of the Twitter user to display in the Twitter app
    
    title - the title to display on this item
    
    Returns:
    
    this AboutPage instance for builder pattern support
  - addPlayStore
```
public AboutPage addPlayStore(java.lang.String id)
```
    Convenience method for addPlayStore(String, String) but with a predefined title string
    
    Parameters:
    
    id - the package id of the app to display
    
    Returns:
    
    this AboutPage instance for builder pattern support
  - addPlayStore
```
public AboutPage addPlayStore(java.lang.String id,
                              java.lang.String title)
```
    Add a predefined Element that the opens the PlayStore app with a deep link to the specified app application id.
    
    Parameters:
    
    id - the package id of the app to display
    
    title - the title to display on this item
    
    Returns:
    
    this AboutPage instance for builder pattern support
  - addYoutube
```
public AboutPage addYoutube(java.lang.String id)
```
    Convenience method for addYoutube(String, String) but with a predefined title string
    
    Parameters:
    
    id - the id of the channel to deep link to
    
    Returns:
    
    this AboutPage instance for builder pattern support
  - addYoutube
```
public AboutPage addYoutube(java.lang.String id,
                            java.lang.String title)
```
    Add a predefined Element that the opens the Youtube app with a deep link to the specified channel id.
    If the Youtube app is not installed this will open the Youtube web page instead.
    
    Parameters:
    
    id - the id of the channel to deep link to
    
    title - the title to display on this item
    
    Returns:
    
    this AboutPage instance for builder pattern support
  - addInstagram
```
public AboutPage addInstagram(java.lang.String id)
```
    Convenience method for addInstagram(String, String) (String, String)} but with a predefined title string
    
    Parameters:
    
    id - the id of the instagram user to deep link to
    
    Returns:
    
    this AboutPage instance for builder pattern support
  - addInstagram
```
public AboutPage addInstagram(java.lang.String id,
                              java.lang.String title)
```
    Add a predefined Element that the opens the Instagram app with a deep link to the specified user id.
    If the Instagram app is not installed this will open the Intagram web page instead.
    
    Parameters:
    
    id - the user id to deep link to
    
    title - the title to display on this item
    
    Returns:
    
    this AboutPage instance for builder pattern support
  - addGitHub
```
public AboutPage addGitHub(java.lang.String id)
```
    Convenience method for addGitHub(String, String) but with a predefined title string
    
    Parameters:
    
    id - the id of the GitHub user to display
    
    Returns:
    
    this AboutPage instance for builder pattern support
  - addGitHub
```
public AboutPage addGitHub(java.lang.String id,
                           java.lang.String title)
```
    Add a predefined Element that the opens the a browser and displays the specified GitHub users profile page.
    
    Parameters:
    
    id - the GitHub user to link to
    
    title - the title to display on this item
    
    Returns:
    
    this AboutPage instance for builder pattern support
  - addWebsite
```
public AboutPage addWebsite(java.lang.String url)
```
    Convenience method for addWebsite(String, String) but with a predefined title string
    
    Parameters:
    
    url - the URL to open in a browser
    
    Returns:
    
    this AboutPage instance for builder pattern support
  - addWebsite
```
public AboutPage addWebsite(java.lang.String url,
                            java.lang.String title)
```
    Add a predefined Element that the opens a browser and loads the specified URL
    
    Parameters:
    
    url - the URL to open in a browser
    
    title - the title to display on this item
    
    Returns:
    
    this AboutPage instance for builder pattern support
  - addItem
```
public AboutPage addItem(Element element)
```
    Add a custom Element to this AboutPage
    
    Parameters:
    
    element -
    
    Returns:
    
    this AboutPage instance for builder pattern support
    
    See Also:
    
    Element
  - setImage
```
public AboutPage setImage(int resource)
```
    Set the header image to display in this AboutPage
    
    Parameters:
    
    resource - the resource id of the image to display
    
    Returns:
    
    this AboutPage instance for builder pattern support
  - addGroup
```
public AboutPage addGroup(java.lang.String name)
```
    Add a new group that will display a header in this AboutPage
    A header will be displayed in the order it was added. For e.g:
    new AboutPage(this) .addItem(firstItem) .addGroup("Header") .addItem(secondItem) .create();
    Will display the following [First item] [Header] [Second item]
    
    Parameters:
    
    name - the title for this group
    
    Returns:
    
    this AboutPage instance for builder pattern support
  - isRTL
```
public AboutPage isRTL(boolean value)
```
    Turn on the RTL mode.
    
    Parameters:
    
    value -
    
    Returns:
    
    this AboutPage instance for builder pattern support
  - setDescription
```
public AboutPage setDescription(java.lang.CharSequence description)
```
  - create
```
public android.view.View create()
```
    Create and inflate this AboutPage. After this method is called the AboutPage cannot be customized any more.
    
    Returns:
    
    the inflated View of this AboutPage

Class AboutPage

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AboutPage

Method Detail

setCustomFont

setCustomFont

enableDarkMode

addEmail

addEmail

addFacebook

addFacebook

addTwitter

addTwitter

addPlayStore

addPlayStore

addYoutube

addYoutube

addInstagram

addInstagram

addGitHub

addGitHub

addWebsite

addWebsite

addItem

setImage

addGroup

isRTL

setDescription

create