com.snilius.aboutit

Class AboutIt

java.lang.Object

com.snilius.aboutit.AboutIt

public class AboutIt
extends Object

AboutIt

A About-page creator

 new AboutIt(this).app(R.string.app_name)
     .buildInfo(BuildConfig.DEBUG, BuildConfig.VERSION_CODE, BuildConfig.VERSION_NAME)
     .copyright("Example Business")
     .libLicense("AboutIt", "Victor Häggqvist", L.AP2, "https://github.com/victorhaggqvist/aboutit")
     .toTextView(R.id.about_text);
 
 

Since:

12/29/14

Constructor Summary

Constructors

Constructor and Description
AboutIt(Activity activity) Create a page generator

Method Summary

Methods

Modifier and Type	Method and Description
AboutIt	app(int stringResource) App name to display
AboutIt	app(String appName) App name to display
AboutIt	buildInfo(boolean debug, int versionCode, String versionName) App build info.
AboutIt	copyright(String copyright) Copyright name
AboutIt	description(int stringResource) A longer description
AboutIt	description(String description) A longer description
String	getVersionString() Get a baked version string.
AboutIt	libLicense(com.snilius.aboutit.AboutIt.Lib library) Add a library to the list
AboutIt	libLicense(String name, String author, L license, String url) Add a library to the list
AboutIt	release(String releaseName) Set a custom release name.
void	toTextView(int about_text) Generate text and put in @ref{about_text}
AboutIt	year(int year) Start copyright year.

Methods inherited from class java.lang.Object

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

Constructor Detail

AboutIt

public AboutIt(Activity activity)

Create a page generator

Parameters:

activity - The about page activity

Method Detail

toTextView

public void toTextView(@IdRes
              int about_text)

Generate text and put in @ref{about_text}

Parameters:

about_text - Resource it of destination TextView

getVersionString

public String getVersionString()

Get a baked version string. Version string is build from build info and release name It will look something like '1.42 (42-debug)'

Returns:

baked version string

copyright

public AboutIt copyright(String copyright)

Copyright name

Parameters:

copyright - Name

year

public AboutIt year(int year)

Start copyright year. If there is no start year no year will be displayed at all.

Parameters:

year - Year

libLicense

public AboutIt libLicense(String name,
                 String author,
                 L license,
                 String url)

Add a library to the list

Parameters:

name - Name of Library

author - Author of library

license - Library license, defined by L

url - Url to or otherwise reference to library

See Also:

L

libLicense

public AboutIt libLicense(com.snilius.aboutit.AboutIt.Lib library)

Add a library to the list

Parameters:

library - A library build with LibBuilder

app

public AboutIt app(@StringRes
          int stringResource)

App name to display

Parameters:

stringResource - A string resource id

app

public AboutIt app(String appName)

App name to display

See Also:

app(int)

release

public AboutIt release(String releaseName)

Set a custom release name. Override the default name eg. beta

Parameters:

releaseName - The release name

buildInfo

public AboutIt buildInfo(boolean debug,
                int versionCode,
                String versionName)

App build info. To be used in conjunction with the BuildConfig class .buildInfo(BuildConfig.DEBUG, BuildConfig.VERSION_CODE, BuildConfig.VERSION_NAME)

Parameters:

debug - If is debug build

versionCode - Version code

versionName - Version name

description

public AboutIt description(@StringRes
                  int stringResource)

A longer description

Parameters:

stringResource - A string resource id

description

public AboutIt description(String description)

A longer description

Parameters:

description - The description

See Also:

description(int)