MVVM Light Toolkit


Source link: https://github.com/Kelin-Hong/MVVMLight

MVVM Light Toolkit


A toolkit help to build Android MVVM Application?We have more attributes for Data Binding of View(like Uri for ImageView) ,we create some command for deal with event( like click of Button),also have a global message pipe to communicate with other ViewModel. ##Download##

 compile 'com.kelin.mvvmlight:library:1.0.0'

requires at least android gradle plugin 1.5.0.

##Usage##

####????? MVVM Light Toolkit????#### ####????? ????Android MVVM????####

###Data Binding###

Binding URI to the ImageView with bind:uri will make it loading bitmap from URI and render to ImageView automatically.

<ImageView
android:layout_width="match_parent"
android:layout_height="match_parent"
android:layout_alignParentRight="true"
bind:uri="@{
viewModel.imageUrl
}
"
bind:placeholderImageRes="@{
R.drawable.ic_launcher
}
"/>

Fresco.initialize(this) is require,because of loading image use Fresco default).

  public class MyApp extends Application {

  @Override
  public void onCreate() {

super.onCreate();

Fresco.initialize(this);

 
}

Example


AdapterView like ListView?RecyclerView ?ViewPager is convenient, bind it to the collection view with app:items and app:itemView,You should use an ObservableList to automatically update your view based on list changes.

 <android.support.v7.widget.RecyclerView
  android:layout_width="match_parent"
  android:layout_height="match_parent"
  bind:itemView="@{
viewModel.itemView
}
"
  bind:items="@{
viewModel.itemViewModel
}
"
  bind:layoutManager="@{
LayoutManagers.linear()
}
"

In ViewModel define itemViewModel and itemView

 public final ObservableList<ViewModel> itemViewModel = new ObservableArrayList<>();
  public final ItemView itemView = ItemView.of(BR.viewModel, R.layout.layoutitem_list_view);

Adapter?ViewHolder ..is Not Required:


Example


Other attributes supported:

  • ImageView

    <attr name="uri" /> <!--width for ResizeOptions (use Fresco to load bitmap). --> <attr name="request_width" format="integer" /> <!--height for ResizeOptions (use Fresco to load bitmap). --> <attr name="request_height" format="integer" /> <attr name="placeholderImageRes" format="reference|color" />
  • ListView? ViewPager? RecyclerView

    <!-- require ItemView  or  ItemViewSelector
    --> <attr name="itemView" /> <!-- require List<ViewModel> bind to ItemView to presentation.--> <attr name="items" /> <!-- require a adapter which type of BindingRecyclerViewAdapter<T> to AdapterView--> <attr name="adapter" /> <attr name="dropDownItemView" format="reference" /> <attr name="itemIds" format="reference" /> <attr name="itemIsEnabled" format="reference" /> <!-- require PageTitles<T>--> <attr name="pageTitles" format="reference" />
  • ViewGroup

    <!-- require ItemView  or ItemViewSelector --> <attr name="itemView" /> <!-- require List<ViewModel> bind to ItemView to presentation.--> <attr name="viewModels" format="reference" />
  • EditText

    <!-- require boolean value to decide whether requestFocus for view. --> <attr name="requestFocus"  format="boolean" />
  • SimpleDraweeView

    <!-- require String to load Image"--> <attr name="uri" />
  • WebView

    <!-- require String render to html show in webview--> <attr name="render" format="string" />

###Command Binding###

When RecyclerView scroll to end of list,we have onLoadMoreCommand to deal with event.

<android.support.v7.widget.RecyclerView

android:id="@+id/recyclerView"

android:layout_width="match_parent"

android:layout_height="match_parent"

bind:onLoadMoreCommand="@{
viewModel.loadMoreCommand
}
"/>

In ViewModel define a ReplyCommand field to deal with this event.

public final ReplyCommand<Integer> loadMoreCommand = new ReplyCommand<>(

 (count) -> {

  /*count: count of list items*/

int page=count / LIMIT +1;

loadData(page)

 
}
);

Example


Deal with click event of View is more convenient:

 <Button

 android:layout_width="match_parent"

 android:layout_height="wrap_content"

 bind:clickCommand="@{
viewModel.btnClickCommand
}
" />

In ViewModel define a ReplyCommand btnClickCommand will be call when click event occur.

 public ReplyCommand btnClickCommand = new ReplyCommand(() -> {

  do something...
  
}
);

Example


onRefreshCommand to SwipeRefreshLayout


More command binding is supported:

  • View

    <!-- require ReplyCommand to deal with view click event. --> <attr name="clickCommand" format="reference" /> <!-- require ReplyCommand<Boolean> to deal with view focus change event. ReplyCommand would has params which means if view hasFocus.--> <attr name="onFocusChangeCommand" format="reference" /> <!-- require ReplyCommand<MotionEvent> --> <attr name="onTouchCommand" />
  • ListView? RecyclerView

    <!-- require ReplyCommand<Integer> --> <attr name="onScrollStateChangedCommand" /> <!-- require ReplyCommand<ListViewScrollDataWrapper> --> <attr name="onScrollChangeCommand" /> <!-- require ReplyCommand<Integer> count of list items--> <attr name="onLoadMoreCommand" format="reference" />
  • ViewPager

    <!--require ReplyCommand<ViewPagerDataWrapper> --> <attr name="onPageScrolledCommand" format="reference" /> <!--require ReplyCommand<Integer> --> <attr name="onPageSelectedCommand" format="reference" /> <!--require ReplyCommand<Integer> --> <attr name="onPageScrollStateChangedCommand" format="reference" />
  • EditText

    <!--require ReplyCommand<TextChangeDataWrapper> --> <attr name="beforeTextChangedCommand" format="reference" /> <!--require ReplyCommand<TextChangeDataWrapper> --> <attr name="onTextChangedCommand" format="reference" /> <!--require ReplyCommand<String> --> <attr name="afterTextChangedCommand" format="reference" />
  • ImageView

     <!--  require ReplyCommand<Bitmap> -->  <attr name="onSuccessCommand" format="reference" />  <!--require ReplyCommand<CloseableReference<CloseableImage>> -->  <attr name="onFailureCommand" format="reference" />
  • ScrollView? NestedScrollView

    <!-- require ReplyCommand<ScrollDataWrapper> --> <attr name="onScrollChangeCommand" /> <!-- require ReplyCommand<NestScrollDataWrapper> --> <attr name="onScrollChangeCommand" />
  • SwipeRefreshLayout

    <!-- require RelayCommand<> --> <attr name="onRefreshCommand" format="reference" />

###Messenger###

simplifies the communication between ViewModel(major) or any components


Example


  • global message broadcast without deliver data

    /* TOKEN: like Action of broadcast with who register this token will be notified when event occur.*/
    Messenger.Default().sendNoMsg(TOKEN);
    
    /*context: it usually to be a activity ?this parameter is represent to 
    
     a receiver which is mean for convenient when unregister message.   TOKEN: like Action of broadcast with who register this token will be notified when event occur.   (data)->{
     
    }
    :Action to deal with event. */
    Messenger.Default().register(context, TOKEN, () -> {
     
    }
    );
    
  • global message broadcast (carry data to receiver)

     Messenger.getDefault().send(data, TOKEN)  /*context:  TOKEN:  Data.class: type of deliver data. (data)->{
     
    }
    : function to deal with event which has data is deliver by sender.*/  Messenger.getDefault().register(context, TOKEN, Data.class, (data) -> {
     
    }
    );
    
  • send to specify target (inactive)

    Messenger.getDefault().sendToTarget(T message, R target) Messenger.getDefault().sendNoMsgToTargetWithToken(Object token,R target) Messenger.getDefault().sendNoMsgToTarget(Object target)
  • cancel register

     Messenger.getDefault().unregister(Object recipient)"  /* Usually Usage*/  @Override  protected void onDestroy() {
     
    
    super.onDestroy();
     
    
    Messenger.getDefault().unregister(this);
       
    }
    

License

 Copyright 2016 Kelin Hong
 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.

Resources

Widget to calibrate sensors (Orientation). This Calibrator can be embedded in your own App.

Android library which can turn any View into a draggable dialog with swipe to dismiss feature.

Project to set up basics of a Java annotation processor.

Motivations

  • Provide a fluent and complete stack to write a custom annotation processor using Android Studio
  • Set up a robust testing strategy of the Processor implementation

An easy way to build RecyclerView.Adapter. This adapter also has multiple ItemViewType, if needed.

This ImageView is adjusted auto by aspect ratio.

Litho Picasso is a Litho compatible library, which provides an Image Component compatible with Picasso. Litho-Picasso supports a wide part of Picasso's functionality.

Topics


2D Engines   3D Engines   9-Patch   Action Bars   Activities   ADB   Advertisements   Analytics   Animations   ANR   AOP   API   APK   APT   Architecture   Audio   Autocomplete   Background Processing   Backward Compatibility   Badges   Bar Codes   Benchmarking   Bitmaps   Bluetooth   Blur Effects   Bread Crumbs   BRMS   Browser Extensions   Build Systems   Bundles   Buttons   Caching   Camera   Canvas   Cards   Carousels   Changelog   Checkboxes   Cloud Storages   Color Analysis   Color Pickers   Colors   Comet/Push   Compass Sensors   Conferences   Content Providers   Continuous Integration   Crash Reports   Credit Cards   Credits   CSV   Curl/Flip   Data Binding   Data Generators   Data Structures   Database   Database Browsers   Date &   Debugging   Decompilers   Deep Links   Dependency Injections   Design   Design Patterns   Dex   Dialogs   Distributed Computing   Distribution Platforms   Download Managers   Drawables   Emoji   Emulators   EPUB   Equalizers &   Event Buses   Exception Handling   Face Recognition   Feedback &   File System   File/Directory   Fingerprint   Floating Action   Fonts   Forms   Fragments   FRP   FSM   Functional Programming   Gamepads   Games   Geocaching   Gestures   GIF   Glow Pad   Gradle Plugins   Graphics   Grid Views   Highlighting   HTML   HTTP Mocking   Icons   IDE   IDE Plugins   Image Croppers   Image Loaders   Image Pickers   Image Processing   Image Views   Instrumentation   Intents   Job Schedulers   JSON   Keyboard   Kotlin   Layouts   Library Demos   List View   List Views   Localization   Location   Lock Patterns   Logcat   Logging   Mails   Maps   Markdown   Mathematics   Maven Plugins   MBaaS   Media   Menus   Messaging   MIME   Mobile Web   Native Image   Navigation   NDK   Networking   NFC   NoSQL   Number Pickers   OAuth   Object Mocking   OCR Engines   OpenGL   ORM   Other Pickers   Parallax List   Parcelables   Particle Systems   Password Inputs   PDF   Permissions   Physics Engines   Platforms   Plugin Frameworks   Preferences   Progress Indicators   ProGuard   Properties   Protocol Buffer   Pull To   Purchases   Push/Pull   QR Codes   Quick Return   Radio Buttons   Range Bars   Ratings   Recycler Views   Resources   REST   Ripple Effects   RSS   Screenshots   Scripting   Scroll Views   SDK   Search Inputs   Security   Sensors   Services   Showcase Views   Signatures   Sliding Panels   Snackbars   SOAP   Social Networks   Spannable   Spinners   Splash Screens   SSH   Static Analysis   Status Bars   Styling   SVG   System   Tags   Task Managers   TDD &   Template Engines   Testing   Testing Tools   Text Formatting   Text Views   Text Watchers   Text-to   Toasts   Toolkits For   Tools   Tooltips   Trainings   TV   Twitter   Updaters   USB   User Stories   Utils   Validation   Video   View Adapters   View Pagers   Views   Watch Face   Wearable Data   Wearables   Weather   Web Tools   Web Views   WebRTC   WebSockets   Wheel Widgets   Wi-Fi   Widgets   Windows   Wizards   XML   XMPP   YAML   ZIP Codes