https://github.com/moagrius/spatula
View and Click Binder via Runtime Annotation Processing (blunter version of ButterKnife, after it started taking itself too seriously)
https://github.com/moagrius/spatula
Last synced: over 1 year ago
JSON representation
View and Click Binder via Runtime Annotation Processing (blunter version of ButterKnife, after it started taking itself too seriously)
- Host: GitHub
- URL: https://github.com/moagrius/spatula
- Owner: moagrius
- License: mit
- Created: 2016-07-19T20:17:13.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2016-09-12T19:15:33.000Z (almost 10 years ago)
- Last Synced: 2025-01-29T12:47:05.566Z (over 1 year ago)
- Language: Java
- Size: 104 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Spatula
Spatula is a very simple View and Click binder using Java annotations.
> ButterKnives are infinitely sharper than Spatulas...
We all love Square's stuff, but ButterKnife started taking itself too seriously when it demanded 4 lines and a plugin in my module's gradle. Thus, Spatula - a super simple runtime annotation processor for binding Views, OnClickListeners, and click methods. Spatula is intended to be super simple, super lightweight, super easy to use or modify, and super easy to read. It's not trying to solve the most important problems, and it's not the most performant version of this functionality.
Unlike ButterKnife, Spatula is able to decorate `private` fields.
## Usage
There are 2 binding annoations, both take a resource ID:
```
@BindView(R.id.whatever)
@OnClick(R.id.whatever)
```
The first works on any `View` reference, the second works on a `View.OnClickListener` or a method that takes a single `View` parameter.
To process, use any of the static `bind` methods.
```
Spatula.bind(someActivityOrViewGroup);
```
## Example
It might look like this in an application:
```
public class MyActivity extends Activity {
// bind a view
@BindView(R.id.button_go)
private Button mButtonGo;
public void onCreate(Bundle b){
super.onCreate(b);
Spatula.bind(this);
mButtonGo.setText("Works!");
}
// bind a listener
@OnClick(R.id.button_listener)
private View.OnClickListener mOnClickListener = new View.OnClickListener() {
@Override
public void onClick(View view) {
Log.d(getClass().getSimpleName(), "mOnClickListener");
}
}
// bind a method
@OnClick(R.id.button_method)
private void onClickMethod(View view) {
Log.d(getClass().getSimpleName(), "onClickMethod");
}
}
```
##Installation
Add it to your gradle:
```
compile 'com.qozix:spatula:1.3'
```
If you're minifying, add these rules to `proguard-rules.pro`
```
-keep class com.qozix.spatula.** { *; }
-keep interface com.qozix.spatula.** { *; }
-dontwarn com.qozix.spatula.**
-keepclassmembers class * {
@com.qozix.spatula.OnClick *;
}
```
## Caveats
- Yep, this this uses _runtime_ annotation processing, which is going to be technically much slower than compile time using the APT plugin. That said, you're still probably looking at an average of 0 to 1 milliseconds for a medium-sized instance with several bindings.
- Yep, ~~all~~ most of the restrictions of ButterKnife apply (and probably more).
- We get around restricted access members by temporarily setting them accessible, updating, then setting them back (yep, ick!)