https://github.com/agrosner/smartinflater
injects view operations into classes
https://github.com/agrosner/smartinflater
Last synced: 4 months ago
JSON representation
injects view operations into classes
- Host: GitHub
- URL: https://github.com/agrosner/smartinflater
- Owner: agrosner
- License: mit
- Created: 2014-07-08T21:06:16.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2014-07-22T15:49:33.000Z (about 11 years ago)
- Last Synced: 2025-01-11T01:49:21.915Z (9 months ago)
- Language: Java
- Size: 375 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.TXT
Awesome Lists containing this project
README
SmartInflater
=============
Why do we bother with ```findViewById(R.id.someView)``` and the simply set an ```OnClickListener```? Why do we need to find the view and store it into a variable in our class each and every time? SmartInflater is a simple, yet powerful way to inject views, provide **Handlers** that allow for special methods that will be called for specific events.
## Usage
### Prerequisites
1. MinSdk is 5
2. Compiled on SDK 20 with buildToolsVersion 20
3. Has no dependencies (yet)
4. Java 7 (you should be using it now anyways)
### Including It in your project
1. Clone this repo
2. Go to your top-level build.gradle file
```groovy
dependencies{
compile 'com.github.agrosner:smartinflater:1.0.+'
//or locally in the a folder named "Libraries"
compile project(':Libraries:SmartInflater');
}
```
### Getting Started
#### Initialize the instance.
In an Activity or Application's ``` onCreate() ``` method:
```java
SmartInflater.initialize(this);
```
Note: SmartInflater holds on a **WeakReference** to the Context, so you do not need to worry about memory leaks!
#### Inflate Your Layout!
In a view:
``` java
public void myInitializationMethod(){
//note this will automatically attach to root in a ViewGroup class!
SmartInflater.inflate(this, R.layout.my_layout);
}
```
In your base fragment:
```java
@Override
public View onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState) {
if(mLayout==-1){
throw new RuntimeException("You must define a layout for: " + getClass().getSimpleName());
}
return SmartInflater.inflate(this, mLayout);
}
```
In your activity:
```java
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(SmartInflater.inflate(this, R.layout.activity_my_activity));
...
}
```
It's *that* easy.
### SResource
*SResource* is an annotation that specifies we want to fill this View with its corresponding XML view when inflated by SmartInflater. By default, these fields are **not** optional, meaning that if at runtime, SmartInflater does not find the view specified by the field, it will throw an exception.
Supported Properties:
1. id() - specify a different id than the field name, or for easy navigation to the id it corresponds to
2. optional() = throws an exception if the corresponding view is not found. **False** by default.
```xml
...
...
````
```java
@SResource private TextView title;
//or
@SResource(id = R.id.title)
private TextView my_textview_with_another_name;
```
### SMethod and SHandlers
*SHandler* is an interface that provides a standard callback for handling view operations. It enables limitless additions to this library by overriding ``` handleView(Method method, View view) ```. A SHandler has a method prefix that SmartInflater uses to associate each Method name you declare in your class to an **SHandler**. Each **SHandler** must have a **unique method prefix**.
*SMethod* is an annotation that tells SmartInflater we want to associate this method with some SHandler. We do this by taking the method prefix and seeing if the **SGlobalHandlerList** has a SHandler with the method prefix.
Out-of-the-box-handlers include:
1. OnCheckedChangedHandler
2. OnChildClickHandler
3. OnClickHandler
4. OnCreateHandler (called after View is first injected)
5. OnGroupClickHandler
6. OnItemClickHandler
7. OnItemSelectedHandler
8. OnLongClickHandler
9. OnTouchHandler
10. Your own SHandler implementation (more on this later)
```java
//any visibility is allowed
// parameter must be baser-than-or-equal-to the corresponding XML view
@SMethod
private void onClickTitle(TextView title){
//do something here
}
//id() option exits here too!
@SMethod(id=R.id.title)
private void onClickSuperLongTitleMethod(TextView title){
//do something else here
}
```
#### Custom SHandler example
Say we use the support library's OnRefreshListener a lot. We want to make it available in SmartInflater. How do we do it?
1. Create class that implements SHandler.
2. Register the SHandler in the SGlobalHandlerList in your Application
3. Call the method in your class where you want it!
##### 1
```java
public class OnRefreshHandler extends OnRefreshListener implements SHandler {
private Method mMethod;
//don't worry about calling this. SGlobalHandlerList will take care of it.
public OnRefreshHandler(Object inObject){
super(inObject);
}
@Override
public void onRefresh(){
//invoke our method here
try{
mMethod.setAccessble(true);
mMethod.invoke(inObject);
} catch(Exception e){
throw new RuntimeException(e);
}
}
@Override
public void handleView(Method method, View view){
mMethod = method;
((SwipeRefreshLayout)view).setOnRefreshListener(this);
}
@Override
public String getMethodPrefix(){
return "onRefresh";
}
```
##### 2
```java
public class MyApp extends Application{
@Override
public void onCreate(){
super();
SGlobalHandlerList.addHandler(OnRefreshHandler.class);
}
}
```
##### 3
```java
@SMethod
public void onRefreshMyRefresh(){
}
```
### Open Source
I will love and appreciate all merge requests. Here are some basic rules on them: 1. Try to match my coding style. 2. If they require any breaking changes, they must be on development branch, otherwise I will reject them. 3. Please leave a summary of what you changed/added.
Thank you!
### License
The MIT License (MIT)
Copyright (c) 2014 Andrew Grosner
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.