B4A Library AppCompat - Make Material Design apps compatible with older Android versions

This library is a wrapper for the Google AppCompat v7 support library.

B4A V6.0 or newer is required!
From V3.52 on B4A V6.80 or newer is required! If you still use B4A < V6.80, use V3.51 of this library.

The main reason for this library is to make your apps compatible with older Android versions and to use features in old Android versions which were implemented in newer Android releases. One big advantage of this library is that you can bring Material Design to pre Lollipop Android devices.

Setting up the library
Note: Please, Please read these instructions carefully. AppCompat depends on many things like a special theme with special features. Even special versions of build tools are required and last but not least there are often bugs in the Google support libraries.

I created this instructions to help you getting things ready for using AppCompat. So please follow these instructions carefully and all should work as expected and you don't have to ask in the forum.

Thanks.

The library uses the Android Support Repository. Please install it from the Extras Section of the Android SDK Manager. If you upgrade from an earlier release you can deinstall the "Android Support Library" since it is outdated and marked as obsolete in the Android SDK.
  1. First copy the AppCompat.jar, AppCompat.aar and AppCompat.xml files to your additional libraries folder.
  2. Start the Android SDK-Manager and download/update the latest Extras->Android Support Repository. Use at least support repository 36!
  3. In Android SDK-Manager be sure that the "Android SDK Build-tools" 25.x.x is installed! Deinstall all versions prior to version 25! If you leave older versions than 23.0.3 of build tools installed, your compiled app may work on Android 5.0 and above but it will fail on older Android versions like KitKat.
  4. In the B4A IDE in your projects check the AppCompat library on the libraries tab.
  5. Make sure that you reference the latest android.jar in the IDE under the "Tools/Configure Paths" menu. Don't worry. The android.jar is only used for compilation. It does not mean that you can't run your app on lower Android Versions. The Support libraries require to compile against the same API version as the library itself. So for Support library 25.xx which is the current now you should compile with API25 android.jar.
  6. If you are updating from a version older than v3.20 then remove the b4a_appcompat resource folder delivered with older versions of this library.
To use the AppCompat library your activities MUST extend android.support.v7.app.AppCompatActivity (extending the old android.support.v7.app.ActionBarActivity still works.)

B4X:
 #Extends: android.support.v7.app.AppCompatActivity

Additionally you MUST use one of the AppCompat themes like Theme.AppCompat. You can set it directly in the manifest editor or create your own theme that has an AppCompat theme as its parent. The easiest way is to set the AppCompat theme in the manifest:

B4X:
SetApplicationAttribute(android:theme, "@style/Theme.AppCompat")

If you have upgraded this library from an older version than 3.20 then you have to remove the #AdditionalRes: attribute related to the AppCompat library from your projects. They are not needed anymore.

Some Tutorials for this library
Material Design 2 - Using the AppCompat library
Material Design 3 - Using a ToolBar as ActionBar
Material Design 4 - Modifyable and advanced Menu

Troubleshooting Guide
Because it is not so easy to setup this library I will try to give a troubleshooting guide here for the most common problems.

1. Compile always with the newest android.jar file. This can be configured in the IDE under "Tools/Configure Paths". Download the latest platform version with the SDK Manager and configure it with the IDE. Don't worry, your app will still run on older platform versions. AppCompat support library needs this only at compile time.

2. Be sure you have a correct theme file for your project. If the app seems to crash immediately without a stack trace it is most probably a problem with the theme file.

3. If you post your issue in the forum please provide the stack trace of the error! And before you post, please do a forum seach. Most probably the same error was previously reported by another user. If you don't see a stack trace in the log window, please try the unfiltered logs. Unfortunately most errors only show when you have your device connected via USB in the unfiltered logs.

4. If you post your issue in the forum please provide as many information as possible. The error you receive, screenshots if possible and most important: the stack trace.

Your support:
Creating libraries and wrappers for existing library projects is a lot of work. The use of this library is totally free and you even don't need to mention in your app that you use it.
But if you use this library in your projects and you think it is useful to you please consider to make a donation:

Thanks very much for your support.

Version History

V1.00
  • Object AppCompat - Utilities which are useful for working with AppCompat
  • Object ACActionBar - Like StdActionBar or StdActionBarHelper to control some features of the ActionBar.
  • Object ACEditText - Replacement for EditText with Material Design colors.
  • Object ACCheckBox - Replacement for CheckBox with Material Design colors.
  • Object ACRadioButton - Replacement for RadioButton with Material Design colors.
  • Object ACSwitch - Wrapper for a Switch.
  • Object ACFlatButton - Borderless Button for Dialogs etc.
V1.10
  • New object ACToolBarLight - Toolbar for light themes
  • New object ACToolBarDark - Toolbar for dark themes
  • New object ACActionMenu - Create action menus (action items and/or overflow menu everywhere in your layout. (The view needs to have a minimum width of 56dip to work properly. This seems to be a bug and hopefully will change in later versions of the AppCompat library)
  • New object ACActionModeWrapper - Change ActionBar/Toolbar to an ActionMode ActionBar. Mostly used for multiselect lists.
  • New object ACMenu - Access and modify the ActionMode, ActionMenu or Toolbar menus.
  • New object ACMenuItem - Access and modify the ActionMode, ActionMenu or Toolbar menu items.
  • New object ACPopupMenu - Implements a popup menu.
  • New object ACSearchView - Add a search view to your ActionBar/Toolbar
  • Add: AppCompat object has new methods for getting height of system components like StatusBar, ActionBar and NavigationBar.
  • Add: AppCompat object has a new method for setting the elevation of every view. With this all views (like Panels) can cast shadows. Unfortunately the shadow is only visible on Android 5.0 or above.
V2.00
  • #Extends: android.support.v7.app.AppCompatActivity should now be used (ActionBarActivity still works)
  • New object ACSpinner - AppCompat Spinner with additional support to show an icon in front of the text.
  • New object ACSubMenu - Adding Submenus to menus.
  • New Event ACSearchView_QueryChanged
  • Some internal changes (xml files for Views are not needed anymore)
  • Support for tinting Drawables.
  • Possibility to set a click effect to any view - This is experimental. It should add a ripple effect in Lollipop and above and a color change in previous versions.
  • To update from V1.xx to V2.00 delete the b4a_appcompat resource folder and copy the new one from the archive. The old xml files for buttons, edittext etc. are not needed anymore. Now there is only one xml for the spinner needed.
V3.00
  • Requires B4A 6.0 or above
  • References AppCompat from Maven repository
  • Full designer custom properties support for all views
  • Fix: ACRadioButton now supports grouping in a panel
  • Desupport of the Activity Entry animation.
  • New: ACSeekbar
  • Fix: ACSearchview closed() event does not fire (AppCompat bug). Added workaround for this.
  • Fix: Fixed several minor and major bugs
  • New example App which shows main features
V3.01

  • Fix: additionally depends on com.android.support:support-v4 which should make it work better if you mix old and new libraries.
  • Fix: ACSearchview_Closed event will not crash on API < 12 but it will not fire on these devices. Sorry, there is no workaround for this.
V3.20
  • Moved resource files to aar library file - see new setup instructions
  • Fix: ACButton ButtonColor attribute now works on all Android versions.
V3.30
  • Fix: Remove log output from ACSpinner
  • Fix: Hopefully fixed crashes with missing designer properties
  • Fix: Mixed case Eventnames in Toolbars now working
  • New: Support for ActionViews in MenuItems (Needed for CustomViews in NavigationView of DesignSupport library)
  • Change: Minimum Support Repository 36
V3.41:
  • Fix: Change packagename to anywheresoftware.b4a.orbjects to reduce resouce fields
V3.42:
  • Fix: ToolBars should raise their events correctly again.
V3.50:
  • New: Support for CharSequences wherever possible.
V3.51
  • Fix: Getters return String instead of CharSequence again to avoid problems.
V3.52
  • Fix: Compiled against B4A 6.80 Core library to avoid some problems with CharSequences.
V4.00
  • Change: Compiled against 28.0.0 Support library
  • New: Styles for most Views
 

Attachments

  • AppCompatBaseExample3_20.zip
    10.9 KB · Views: 4,453
  • AppCompatLib3_51.zip
    87.2 KB · Views: 2,270
  • AppCompatLib3_52.zip
    87.3 KB · Views: 4,179
  • AppCompatLib4_00.zip
    181.8 KB · Views: 4,244
Last edited by a moderator:

johndb

Active Member
Licensed User
Longtime User
Is there a way of changing the background and text color of the ACPopupMenu?
The reason why I'm asking is that I'm using the ACToolBarDark where the overflow menu background is dark with white text. When I use the ACPopupMenu the menu is displayed with white background and black text. It would be nice to have the popup match the overflow for consistency.
 
Last edited:

SCIS

Active Member
Licensed User
Longtime User
Hi Corwin,
I've followed your instructions step by step.
Every time I debug the app I get this error:

Compiling generated Java code. Error
javac 1.8.0_31
src\b4a\example\main.java:16: error: package android.support.v7.app does not exist
public class main extends android.support.v7.app.ActionBarActivity implements B4AActivity{​

I can't figure out what the problem is.
 

lemonisdead

Well-Known Member
Licensed User
Longtime User
Hello @corwin42 : sorry to insert my question before your reply.
I have noticed that the Activity_ActionBarHomeClick event is reached only if I have added a Menu item. If I don't add a Menu item to the Activity, when I press the UpIndicator, nothing happens.
Please could you confirm that's the wanted behavior ? Many thanks
 

johndb

Active Member
Licensed User
Longtime User
Is there a way of changing the background and text color of the ACPopupMenu?
The reason why I'm asking is that I'm using the ACToolBarDark where the overflow menu background is dark with white text. When I use the ACPopupMenu the menu is displayed with white background and black text. It would be nice to have the popup match the overflow for consistency.
Since there isn't a response to my question, I'm assuming that changing the text and background color of the ACPopupMenu isn't possible?
 

corwin42

Expert
Licensed User
Longtime User
Since there isn't a response to my question, I'm assuming that changing the text and background color of the ACPopupMenu isn't possible?
You cannot change it directly from code but you can add a style for it in xml. See this Stackoverflow answer for how to do it.

Hello @corwin42 : sorry to insert my question before your reply.
I have noticed that the Activity_ActionBarHomeClick event is reached only if I have added a Menu item. If I don't add a Menu item to the Activity, when I press the UpIndicator, nothing happens.
Please could you confirm that's the wanted behavior ? Many thanks
No, this is a bug.
Workaround should be:
Call ToolBar.InitMenuListener and then use the ToolBar_NavigationItemClick event.

Yes, I copied the files to the custom libs folder.
Have you checked the AppCompat library in the IDE? It seems that the android-support-v7-appcompat library is not added to your project.
 

corwin42

Expert
Licensed User
Longtime User
Hey @corwin42,
The flat button is nice, but it's more for dialogs (according to google: http://www.google.com/design/spec/components/buttons.html#)
Will Appcompat support the raised button soon? because that is the "real" material button.

I searched for a nice "Raised Button" library but I haven't found a really nice one. If I find one it may be added to the AppCompat library.

Edit: With the new version of the support library (v22.1) it seems that we can just use normal buttons as raised buttons. AppCompat library will be updated to support this.
 
Last edited:

corwin42

Expert
Licensed User
Longtime User
Google just released a bigger update to v22.1 for the support library with many additions/changes to the AppCompat classes.

The wrapper library provided here is still working with this new support library. Just be sure to copy the new jar files (android-support-v4.jar, android-support-v7.jar) to your custom libs folder and be sure that your #AdditionalRes parameter points to the new resource files.

There may be an issue with your theme which will cause the app to crash at start. See explanation in first post how to fix this.

There are many enhancements to the AppCompat part and I will update the AppCompat wrapper library soon. It will then support more views and the additional resources for the wrapper will be not necessary anymore. Overall Google added some nice features and resolved many issues and now it looks a bit more complete.
 
Last edited:

Peter Simpson

Expert
Licensed User
Longtime User
Hello @corwin42,
I updated to Support library version 22.1 and yes you're correct, all my reassembled apps just stopped working full stop and would not even start correctly. To get all my apps running again I just did the following.

1. I copied the updated android-support-v4.jar and android-support-v7.jar files from extras\android\support\v7\appcompat\libs to my additional libraries folder.
2. I added the following to my theme xml file, I did not add 'Theme.AppCompat.NoActionBar'.
B4X:
'I just added 2 lines
    <item name="windowActionBar">false</item>
    <item name="windowNoTitle">true</item>

The following does not matter but I also set my Android jar file to platforms\android-22\android.jar and set android:targetSdkVersion="22". I set my Android jar file to 22 after everything started working again.

Hmm the spinner looks better too, I'm sure of it :)
 
Last edited:

rbirago

Active Member
Licensed User
Longtime User
Surely I mismatch something...but I don't understand what!!!!
I've tried to run "ACTToolbarExample", but it doesn't work.
I followed the instructions (see snap0). Well:
As you can see points 1. and 2. seems ok (see snap1).
3. Android Support Library seems ok (see snap2, snap3).
4. In my AddLibraries are the same versions (snap1)
5. In the example project I changed only the two AdditionalRes and (6.) the version 22 is used (snap 4).

So, it doesn't work (snap5). Where is my mistake?

Thank you in advance
 

Attachments

  • Snap0.png
    Snap0.png
    11.4 KB · Views: 358
  • Snap1.png
    Snap1.png
    36 KB · Views: 342
  • Snap2.png
    Snap2.png
    22.3 KB · Views: 330
  • Snap3.png
    Snap3.png
    20.8 KB · Views: 327
  • Snap4.png
    Snap4.png
    67.8 KB · Views: 337
  • Snap5.png
    Snap5.png
    19.5 KB · Views: 325

corwin42

Expert
Licensed User
Longtime User
Surely I mismatch something...but I don't understand what!!!!
I've tried to run "ACTToolbarExample", but it doesn't work.
I followed the instructions (see snap0). Well:
As you can see points 1. and 2. seems ok (see snap1).
3. Android Support Library seems ok (see snap2, snap3).
4. In my AddLibraries are the same versions (snap1)
5. In the example project I changed only the two AdditionalRes and (6.) the version 22 is used (snap 4).

So, it doesn't work (snap5). Where is my mistake?

Thank you in advance

See the info about support library v22.1 in first post. You have to change the theme file.
 

rbirago

Active Member
Licensed User
Longtime User
great! it works! Thank you (I must learn to read BETTER ALL the posts).
 

migrec

Member
Licensed User
Longtime User
Hey @corwin42, I've changed the theme file to this:
HTML:
<?xml version="1.0" encoding="utf-8" ?>
- <resources>
- <style name="MyAppTheme" parent="Theme.AppCompat.Light.DarkActionBar">
  <item name="colorPrimary">#FF9800</item>
  <item name="colorPrimaryDark">#F57C00</item>
  <item name="colorAccent">#FFA726</item>
  <item name="windowNoTitle">true</item>
  <item name="windowActionBar">false</item>
  </style>
  </resources>
...because I have the support library at 22.2
but it throws this error:
B4X:
Installing file.
PackageAdded: package:b4a.example
java.lang.RuntimeException: Unable to start activity ComponentInfo{b4a.example/b4a.example.main}: android.util.AndroidRuntimeException: requestFeature() must be called before adding content
    at android.app.ActivityThread.performLaunchActivity(ActivityThread.java:1967)
    at android.app.ActivityThread.handleLaunchActivity(ActivityThread.java:1992)
    at android.app.ActivityThread.access$600(ActivityThread.java:127)
    at android.app.ActivityThread$H.handleMessage(ActivityThread.java:1158)
    at android.os.Handler.dispatchMessage(Handler.java:99)
    at android.os.Looper.loop(Looper.java:137)
    at android.app.ActivityThread.main(ActivityThread.java:4441)
    at java.lang.reflect.Method.invokeNative(Native Method)
    at java.lang.reflect.Method.invoke(Method.java:511)
    at com.android.internal.os.ZygoteInit$MethodAndArgsCaller.run(ZygoteInit.java:784)
    at com.android.internal.os.ZygoteInit.main(ZygoteInit.java:551)
    at dalvik.system.NativeStart.main(Native Method)
Caused by: android.util.AndroidRuntimeException: requestFeature() must be called before adding content
    at com.android.internal.policy.impl.PhoneWindow.requestFeature(PhoneWindow.java:229)
    at b4a.example.main.onCreate(main.java:50)
    at android.app.Activity.performCreate(Activity.java:4465)
    at android.app.Instrumentation.callActivityOnCreate(Instrumentation.java:1049)
    at android.app.ActivityThread.performLaunchActivity(ActivityThread.java:1931)
    ... 11 more
I have hard to believe that it should be the same type of difference from 22.1 to 22.2? :eek:
So what could be wrong?
 

Inman

Well-Known Member
Licensed User
Longtime User
Hello @corwin42,
I updated to Support library version 22.1 and yes you're correct, all my reassembled apps just stopped working full stop and would not even start correctly. To get all my apps running again I just did the following.

1. I copied the updated android-support-v4.jar and android-support-v7.jar files from extras\android\support\v7\appcompat\libs to my additional libraries folder.
2. I added the following to my theme xml file, I did not add 'Theme.AppCompat.NoActionBar'.
B4X:
'I just added 2 lines
    <item name="windowActionBar">false</item>
    <item name="windowNoTitle">true</item>

The following does not matter but I also set my Android jar file to platforms\android-22\android.jar and set android:targetSdkVersion="22". I set my Android jar file to 22 after everything started working again.

Hmm the spinner looks better too, I'm sure of it :)

I updated to 22.2 and started getting the same error. I changed theme.xml to this format and that fixed it.
B4X:
<?xml version="1.0" encoding="utf-8"?>

<resources>
    <style name="MyAppTheme" parent="Theme.AppCompat.Light.DarkActionBar">
       <item name="colorPrimary">#FF9800</item>
 <item name="colorPrimaryDark">#F57C00</item>
 <item name="colorAccent">#FFA726</item>
    </style>

    <style name="MyAppTheme.NoActionBar">
    <!-- Both of these are needed -->
    <item name="windowActionBar">false</item>
    <item name="windowNoTitle">true</item>
</style>
</resources>
 
Top