External Resources


Source link: https://github.com/prcaen/external-resources

External Resources

Update your Android resources (strings, integers, booleans, ...) over the air.

Main features

  • Use native Android resources or default raw JSON / XML files.
  • Define your own URL builder which allow you calling your server with query strings or url params
  • Define if a config change through onConfigurationChanged if the library should call your server.
  • Cache based on Http last modified header.
  • Event triggered when resources have changed.
  • Event triggered when ressources loading has fail.
  • Define your own converter. Json is the default one. This library also provide a Xml converter.
  • Tested: > 120 tests.

Download

The libary is available on JCenter or MavenCentral Via Gradle:

compile 'fr.pierrickcaen:external-resources:2.0.1'

Via Maven:

<dependency>
  <groupId>fr.pierrickcaen</groupId>
  <artifactId>external-resources</artifactId>
  <version>2.0.1</version> </dependency>

Usage

Basic

  1. Initialization:

a. Via a String base URL:

eg: If your base url is http://test.com/android-resources.json, it will be append by query parameters: http://test.com/android-resources.json?locale=fr_FR&density_dpi=320&screen_height_dp=100&navigation_hidden=0&...

 ```java

 public class SampleApplication extends Application {

@Override

  public void onCreate() {

super.onCreate();

 ExternalResources.initialize(this, "http://your-url.com/path.json");

  
}

@Override

  public void onConfigurationChanged(Configuration newConfig) {

super.onConfigurationChanged(newConfig);

 ExternalResources.getInstance().onConfigurationChanged(newConfig);

  
}

  
}
  ``` 

b. Via URL implementation

 ```java

 public class SampleApplication extends Application {

@Override

  public void onCreate() {

  super.onCreate();

ExternalResources.initialize(this, new Url() {

 private Locale locale;

  @Override public void locale(locale locale) {

this.locale = locale;

 
}

  // ...

  @Override public String build() {

return "http://your-url.com/path.json?locale=" + locale;

 
}

}
);

  
}

@Override

  public void onConfigurationChanged(Configuration newConfig) {

super.onConfigurationChanged(newConfig);

 ExternalResources.getInstance().onConfigurationChanged(newConfig);

  
}

  
}
  ``` 
  1. Register & Unregister OnExternalResourcesChangeListener

    public class SampleActivity extends Activity implements OnExternalResourcesChangeListener {
    
    @Override protected void onResume() {
    
     super.onResume();
    
     ExternalResources.getInstance().register(this);
    
    }
    
     @Override protected void onPause() {
    
      ExternalResources.getInstance().unregister(this);
    
      super.onPause();
    
    }
    
    @Override public void onExternalResourcesChange(ExternalResources externalResources) {
    
      // TODO: update your view here.
    
    }
     
    }
    
  2. Use resources as you wish

    • String via getString(@StringRes int resId) or getString(@NonNull String key) or getString(@StringRes int resId, Object... formatArgs) or getString(@NonNull String key, Object... formatArgs).
    • String array via getStringArray(@ArrayRes int resId) or getStringArray(@NonNull String key).
    • Boolean via getBoolean(@BoolRes int resId) or getBoolean(@NonNull String key)
    • Color via getColor(@ColorRes int resId) or getColor(@NonNull String key)
    • Dimension via getDimension(@DimenRes int resId) or getDimension(@NonNull String key)
    • Integer via getInteger(@IntegerRes int resId) or getInteger(@NonNull String key)
    • Int array via getIntArray(@ArrayRes int resId) or getIntArray(@NonNull String key)

    Warning!: If external resources is not found, these methods throws a NotFoundException.

Advanced

Default resources

In your application class add the following lines in onCreate:

@Override public void onCreate() {

  super.onCreate();

Resources defaults = Resources.fromJson(getAssets().open("defaults.json"))
  ExternalResources.Builder builder = new ExternalResources.Builder(this, new MyUrlImpl());

  builder.defaultResources(defaults);
 
}

Sample app

See the sample application available in sample-app/src/main

License

 Copyright (C) 2015 Pierrick CAEN (http://www.pierrickcaen.fr)
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

The EllipsizeTextView extends TextView and supports to omit redundant characters in situation with multiple lines.

Floating expandable action button.

Easy to implement a drop-down warning / message.

This is a simple and elegant menu control.

Error handling library for Android and Java.

Confetti is a high-performance, easily-configurable particle system library that can animate any set of objects through space. You can specify your starting conditions and physical conditions (e.g. X and Y acceleration, boundaries, etc.), and let the confetti library take care of the rest.

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