AQuery
A Write Less Do More Library for Android
AQuery is a lightweight library that allows UI manipulation in a syntactically similar way to the Javascript library JQuery. AQuery aims to remove the boilerplate code that comes with UI manipulation in Android. This helps with readability, ease of development and maintainability.
Code Samples
Using AQuery Objects
// constructing an AQuery object from a context
AQ rootView = AQ(this); // the underlying View is the activity's root layout
// constructing an AQuery object from a view
AQ someView = AQ(findViewById(R.id.some_view));
// constructing an AQuery object from Resource Id
AQ anotherView = AQ(this, R.id.another_view));
// to retrieve the plain View object:
View rawView = someView.raw();
Login User Example
// vanilla Android
Button loginButton = (Button) findViewById(R.id.login_button);
button.setOnClickListener(view -> {
EditText emailField = (EditText) findViewById(R.id.email);
EditText passwordField = (EditText) findViewById(R.id.password);
String email = emailField.text().toString();
String password = passwordField.text().toString();
loginUser(email, password):
});
// AQuery
AQ(this, R.id.login_button).click(view -> {
String email = AQ(this, R.id.email).text();
String password = AQ(this, R.id.password).text();
loginUser(email, password);
});
Inflating Views
// Vanilla Android
ViewGroup parent = (ViewGroup) findViewById(R.id.parent_layout);
LayoutInflater inflater = (LayoutInflater) getSystemService(Context.LAYOUT_INFLATER_SERVICE);
View inflatedView = inflater.inflate(R.layout.child_view, parent);
inflatedView.getViewTreeObserver().addOnGlobalLayoutListener(() -> {
inflatedView.getViewTreeObserver().removeOnGlobalLayoutListener(this);
Toast.makeText(this, "The view is rendered!!", Toast.LENGTH_SHORT).show();
});
inflatedView.setOnClickListener(view -> {
// do something
});
// AQuery
AQ parent = AQ(this, R.id.parent_layout);
AQ.inflate(this, R.id.child_view, parent)
.ready(() -> AQ.toast(this, "The view is rendered!!"))
.click(view -> {
// do something
});
Animations
// vanilla Android
View view = findViewById(R.id.animated_view);
Animation animation = AnimationUtils.loadAnimation(this, R.anim.some_animation);
animation.setAnimationListener(new Animation.AnimationListener() {
@Override
public void onAnimationStart(Animation animation) {
}
@Override
public void onAnimationEnd(Animation animation) {
// do something
}
@Override
public void onAnimationRepeat(Animation animation) {
}
});
view.startAnimation(animation);
// AQuery
AQ(this, R.id.animated_view)
.animate(new AnimationBuilder(R.anim.some_animation, this)
.onEnd(animation -> // do something)
.build());
AQuery has a lot features other than the ones showcased here. You can view the JavaDoc for detailed documentation.
Getting Started
Gradle
repositories {
jcenter()
}
dependencies {
compile 'com.mzaart:aquery:1.1'
}
You can import it as follows:
import com.mzaart.aquery.AQ;
import static com.mzaart.aquery.Constructors.*;
Note that the static import isn't necessary. Its sole purpose is to make the instantiation of AQuery objects look as close as possible to JQeury.
// you can still use AQuery without the static import
AQ view = new AQ(this, R.id.some_view);In fact, the static import is completely unnecessary in Kotlin since you create objects without the 'new' keyword.
import com.mzaart.aquery.AQ;
var view = AQ(this, R.id.some_view);
License
Copyright (C) 2017 Mouhammed El Zaart
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.