Today, I’m proud to introduce QuickTools, an Android Library that provides a toolkit that simplifies some tasks related to Strings, Colors and other functions.
Welcome to my first Android Library which combines several useful utility classes to make coding easier. You can be sure that more useful features will be added over time.
Getting started (:
Add the library to your project first
Step 1. Add the JitPack repository to your build file if it isn’t already there
{
repositories
{
...
maven { url 'https://jitpack.io' }
}
}
Add it in your root build.gradle at the end of repositories
Step 2. Add the dependency
compile 'com.kenicenoel:QuickTools:v1.2'
Afterwards
In your fragment, create an instance of Toolkit. e.g Toolkit toolkit = new Toolkit(getContext()); Or, in your activity, create an instance of Toolkit. e.g Toolkit toolkit = new Toolkit(this);
Toolkit class
After you created an instance of the toolkit class, you can use two of its built in functions:
Generate random number
toolkit.generateRandomNumber(min, max); This takes an integer min and max range and returns a random integer with the min and max range included.
Is app installed?
toolkit.isAppInstalled(appPackageName);
example: toolkit.isAppInstalled(com.kenicenoel.doze); This takes a package name of any app and returns true if it is installed or false if not. It can be used for instance to take the user of the store or do somthing that requires the presence of another app.
Available tools
In this release, there are 4 kits that can take advantage of:
1. ColorBuddy
ColorBuddy is your helper that makes getting colors for your project a sinch. You can get a random color or add your own color. You can also use standalone e.g ColorBuddy colorBuddy = new ColorBuddy(); without first creating a Toolkit object.
Getting a color
toolkit.colorBuddy.newColor(); This returns a random color in the HEX format eg. #EA1E63
You can use this however you wish, example:
String color = toolkit.colorBuddy.newColor();
TextView header = (TextView) findViewById('testId');
header.setColor(Color.parseColor(color));
You can also add colors in a similar way
Adding a color
toolkit.colorBuddy.add('#EA1E63'); Add a color to the list of colors in the HEX format
Get all colors
toolkit.colorBuddy.getColors(); Returns an ArrayList of Strings of HEX format colors (ArrayList colorsList for example)
Get size of color list
toolkit.colorBuddy.size(); Returns an integer value of the number of colors
2. StringBuddy
StringBuddy provides some useful functions for working with Strings You can also use standalone e.g StringBuddy stringBuddy = new StringBuddy(); without first creating a Toolkit object.
Remove Non Alpha-Numberic characters from String
toolkit.stringBuddy.removeNonAlphaNumericCharacters(myStringHere); This returns a String with all characters that aren’t letters or numbers removed.
Convert to proper case
toolkit.stringBuddy.convertToProperCase(myStringHere); This returns a String in proper format e.g HEllo wORlD! becomes Hello World!
Strip HTML
toolkit.stringBuddy.stripHTML(myStringHere); This returns a String with the Html.escapeHtml function performmed on it
Get Current timestamp
toolkit.stringBuddy.getCurrentTimeStamp(); This returns a String of current timestamp in format: yyyy-MM-dd HH:mm:ss
3. SettingsBuddy
SettingsBuddy makes working with shared preferences easier. If you are using it stand alone, create like so: SettingsBuddy settingsBuddy = SettingsBuddy.getInstance(context);
If you created a toolkit instance then you can just use its functions like toolkit.settingsBuddy.functionName() without having to create the stand alone instance. The name of the shared preference is AppSettings and the context mode is Context.MODE_PRIVATE
Saving data
toolkit.settingsBuddy.saveData(key, value); This saves the key/value pair in the shared preference
Get data
toolkit.settingsBuddy.getData(key); This returns the value for the supplied key if it exists or the default value if non-existant.
Remove data
toolkit.settingsBuddy.remove(key); This removes the value for the supplied key if it exists.
Default value
By default the default value is “N/A” but you can change this: toolkit.settingsBuddy.getDefault(); to get the current default value or toolkit.settingsBuddy.setDefault(aStringValue); to set the default value
4. ZipBuddy
ZipBuddy makes working with Zip files easier. It provides 2 functions: Zip and Unzip. You can also use standalone e.g ZipBuddy zipBuddy = new ZipBuddy() without first creating a Toolkit object.
Zip files
toolkit.zipBuddy.zip(filesToZip, nameOfZipFile); This takes a list of files (string paths) to zip and the name to call the generated zip file and zips them
UnZip files
toolkit.zipBuddy.unzip(fileToUnzip, targetDirectory); This takes the zip file (string path) to unzip and the target directory to put the result and unzips it.
