Does Android data-binding support raw resources? - android

I am currently trying to pass the resource id of a raw resource to a special View using the new Android data-binding mechanism. When I try something like this
...
app:bufferedSvg="#{ViewModel.headerCollapsed ? #raw/header_expand : #raw/header_collapse}"
...
I get an error <expr> expected, got '#'. The raw resources exist and cannot be turned into another kind of resource as they contain SVG data.
Is this a bug of Android data binding or is this intended behaviour?

At least I found a workaround meanwhile. Import the R class:
<data>
<import type="com.yourdomain.R"/>
<variable name="ViewModel" type="com.yourdomain.ViewModel"/>
</data>
...
<com.yourdomain.yourview
...
app:bufferedSvg="#{ViewModel.yourchoice ? R.raw.raw_resource1 : R.raw.raw_resource2}"
...
/>
Hope this helps someone who runs into the same problem. Would still like to know whether the #-notation for raw resources is planned to be supported or not.

Related

How to reference user's input in strings.xml (res/value) Android Studio

I was following a Developers.Android codelab tutorial. In the code I learnt you can use #={} (dot notation to access the data inside the data class) to reference data, right in the .xml layout file..
Something like this;
<TextView
...
android:text="#={myName.nickname}"
...
/>
But I want to be able to use the inputed data several in the strings, something like this;
<string name="bio">Hi, #={myName.nickname}.
I'm Alexia, I love fish.
The kind that is alive and swims around in an aquarium or river, or a lake, and definitely the ocean.
Fun fact is that I have several aquariums and also a river.
I like eating fish, too. Raw fish. Grilled fish. Smoked fish. Poached fish - not so much.
And sometimes I even go fishing.
And even less sometimes, I actually catch something.
Once, when I was camping in Canada, and very hungry, I even caught a large salmon with my hands.
I\'ll be happy to teach you #={myName.nickname}, how to make your own aquarium.
But, #={myName.nickname} you should ask someone else about fishing, though, lol.</string>
but when I run this it just returns a the #={myName.nickname} as #={myName.nickname}, i.e not the data, I'm trying to reference, So please how do I reference the data in the strings.xml value file.??
Thank you for your help in Advance...
Here are my files relevant to this, if you need you anything please let me know..
data class:
package com.example.aboutme
data class MyName(var name: String = "", var nickname: String = "")
activity_main.xml;
<layout
xmlns:android="http://schemas.android.com/apk/res/android"
xmlns:app="http://schemas.android.com/apk/res-auto"
xmlns:tools="http://schemas.android.com/tools">
<data>
<variable
name="myName"
type="com.example.aboutme.MyName" />
</data>
<LinearLayout
android:layout_width="match_parent"
android:layout_height="match_parent"
android:orientation="vertical"
tools:context=".MainActivity">
...
format the text:
binding.nameText = context.getString(R.string.bio, myName.nickname)
layout:
<variable
name="nameText"
type="String" />
...
<TextView
...
android:text="#{nameText}"
...
/>
string:
<string name="bio">Hi, %s, I'm Alexia</string>

Android Databinding fails to create static fields in BR.java for variables from external library

I have created an Android library (aar) that contains some fragments that make use of databinding, by using <data> tag inside xml layout components. For example:
<?xml version="1.0" encoding="utf-8"?>
<layout xmlns:android="http://schemas.android.com/apk/res/android">
<data>
<variable
name="type"
type="String" />
<variable
name="letter"
type="String" />
<variable
name="color"
type="Integer" />
<variable
name="confirmTaskButtonListener"
type="android.view.View.OnClickListener" />
</data>
<ScrollView>
...
</ScrollView>
</layout>
When I assemble the aar, I can correctly see, under generated-classes, BR.java that contains a static field for each variable declared for binding.
When I use the aar as dependency in an Android application, instead, BR.java is rebuilt and it does not contain static fields for variables declared in the parent library.
This is not a problem at compile time. But, at runtime, fragments from library reference static fields that are not present in BR of the child application and causes a crash.
How can I manage to build in the child application static fields also for databindings declared in the parent library?
I have enabled databinding in both application and library modules:
dataBinding {
enabled = true
}
I am using classpath 'com.android.tools.build:gradle:3.6.1'.
Any help? Thank you!
I've solved the issue.
The problem was that the package names of the app and of the library were the same.
As I've changed package name on the library, it started working.
Thank you!

how can i use getLifecycleOwner() method in databinding xml files

The class ViewDataBinding provides setLifecycleOwner() and setLifecycleOwner()
but when I use it in xml such as
android:onClick="#{()->InteractionPresenter.toggleFeedDiss(getLifecycleOwner())}"
it will turn out an error like this
[databinding] {"msg":"Could not find identifier
\u0027lifecycleOwner\u0027\n\nCheck that the identifier is spelled
correctly, and that no \u003cimport\u003e or \u003cvariable\u003e tags
are
missing.","file":"/Users/maxz/AndroidStudioProjects/ppjoke/app/src/main/res/layout/layout_feed_interaction.xml","pos":[{"line0":34,"col0":71,"line1":34,"col1":84}]}
so if I want to use LifeCycleOwner in data-binding with lambda, I have to declare another variable like
<variable
name="lifeCycleOwner"
type="androidx.lifecycle.LifecycleOwner" />
then I will use my own variable,it works
but how can I get a lifecycle owner by the first way?
To achieve first approach, You have to pass fragment instance to your layout.
<variable
name="fragment"
type="androidx.fragment.app.Fragment" />
And then use
android:onClick="#{()->InteractionPresenter.toggleFeedDiss(fragment.viewLifecycleOwner)}"

How to use Android predefined constants for binding data in xml layout file

Android provided new concept of showing data on UI via data binding. I tried implementing it on one of my application. While implementing Lambda expression as a click handler of my button, I required a constant i.e.View.VISIBLE for comparing it in my expression. But when I write below code:
android:onClick="#{(activity_main)-> activity_main.getVisibility() == View.VISIBLE ? eventHandler.eventHandlerViaListenerBinding(true) : eventHandler.eventHandlerViaListenerBinding(false)}"
It is giving me an error:
Error:(57, 83) Identifiers must have user defined types from the XML file. View is missing it
My question is how can I import constants in the xml?
Thanks in advance.
Inside your data tag add this.
<import type="android.view.View" />
or Just upate the build.gradle of the library to enable databinding as well as in the main project:
dataBinding {
enabled = true
}

Data Binding class not generated

I am using Data Binding in my project, when using <layout> and <data> in my xml binding class is not generated.
For example i have activity_main.xml
<?xml version="1.0" encoding="utf-8"?>
<layout xmlns:android="http://schemas.android.com/apk/res/android">
<data> </data>
<RelativeLayout
android:layout_width="match_parent"
android:layout_height="match_parent">
</RelativeLayout>
</layout>
Now if i am writing ActivityMainBinding in my activity/fragment it shows error that class is not available. But after including <variable> in my xml file, it is able to generate ActivityMainBinding class.
Android Studio : 2.1.3
Classpath : com.android.tools.build:gradle:2.1.3
minSdkVersion 16
targetSdkVersion 24
buildToolsVersion 24.0.0
I did not get any satisfying answers. So here are the tips which are summary of my data binding knowledge.
Tips For Solving DataBinding Issues
Update
To get more accurate errors and suggestions, I strongly recommend to update Android Studio and Gradle plugin version to the latest. Because I am not facing many issues after AS 3.2 version.
See Latest Android Studio, and Latest Gradle Plugin.
Orignal Solution
After reading this answer, you will not get stuck in data binding auto generation issues for both Classes and Data Variables.
Check these points one by one. Any of these can make your work done. Point 3 to last are really important, so don't miss them.
1. Check if data-binding enabled
You should have data binding enabled in build.gradle. If not then add this and Sync.
android {
...
buildFeatures {
dataBinding true
}
}
2. Check layout is converted in binding layout
Now if you want data binding class to be generated then you should wrap xml layout with data binding (<layout tag). Something like this.
<?xml version="1.0" encoding="utf-8"?>
<layout xmlns:android="http://schemas.android.com/apk/res/android">
<android.support.constraint.ConstraintLayout
android:layout_width="match_parent"
android:layout_height="match_parent">
</android.support.constraint.ConstraintLayout>
</layout>
Along with this check whether the binding variable names are correct as in the view model class
3. Auto-generated Binding class name?
Your data binding class should be generated after creating binding layout.
If your layout name is in snake case activity_main.xml then data binding class
will be generated in camel case like ActivityMainBinding.
4. Can't See Import Suggestion?
Sometimes when you type ActivityMai..., then it does not show suggestion, in that case import manually.
import <yourpackage>databinding.ActivityMainBinding;
5. Read Build Fail Logcat
Your binding class and new variables in layout will not be generated if your build fails. So first Make project by Ctrl + F9 (Build > Make project).
If a build fails then see what is an error, usually we have errors in layout fields. Error logs will point out the error line number with the issue.
Binding may fail cause some stupid error, like syntax error or missing import. In that case, you will get logcat full of errors of binding classes. But you should read complete logcat to find appropriate issue.
6. Close and open project from recent
I always do this because it takes much less time than Rebuild / Make project.
Close project from File > Close Project
Open again from recent
Note that I prefer Close and Open from Recent because it takes much less time than Rebuild / Restart IDE.
7. Rebuild Project
If still your class is not generated. (Some time when we paste layout file, then it happens). Then Rebuild Project from Build> Rebuild (Not Build or Make project). It will generate your data binding class. (Rebuild does Magic for me.)
8. Have latest Android Studio
After updating AS to Android Studio 3.2, I felt many bugs fix in data binding auto generation. So you should also have the latest AS.
#Solution for <variables
<data>
<variable
name="item"
type="com.package.Model"/>
</data>
Usually, when we put a variable in layout, it creates a getter and setter of it. And we can use binding.setItem(item); and binding.getItem();, but if you can't see those methods then read the below information.
1. Close and open project from recent
If you have created a data variable - <variable in your layout and it does not show up its setter and getter in data binding class, then Close and Open from Recent your project.
2. Clean project after changing the type
If you changed the type of some <variable in your layout and getter setter type is not changing then Clean project (Build> Clean Project)
Final words
Finally if still your binding class is not generated, then we have our most powerful weapon. - Restart Android Studio
First, try just restart, this always generates variables of my binding layout after restart.
If it does not work then Invalidate Cache & Restart.
This is all that i do to solve my data binding errors. If you get any further issues, you can comment here.
DataBinding class generated automatically.
if your xml name is activity_test then the Binding class will be ActivityTestBinding.
but,
dataBinding {
enabled = true
}
layout should have layout as root
<layout xmlns:android="http://schemas.android.com/apk/res/android">
</layout>
I had the same issue. After reading over the android sdk docs, there is only the expected file name to be created but nothing about what to do if it does not happen. I noticed after some more research that after removing the namespace to the layout element like below (using your example), it worked for me.
<?xml version="1.0" encoding="utf-8"?>
<layout>
<data> </data>
<RelativeLayout
xmlns:android="http://schemas.android.com/apk/res/android"
android:layout_width="match_parent"
android:layout_height="match_parent">
</RelativeLayout>
</layout>
In my case, the Binding class was generated and in place ( but I thought it wasn't) ... but it does not automatically add import of said class to the activity/fragment import section... so... OPTION + ENTER :)
dataBinding {
enabled = true
}
To enable the new data binding compiler, add the following option to your gradle.properties file:
android.databinding.enableV2=true
Update:
To enable databinding please use,
android {
...
buildFeatures {
dataBinding true
}
}
Please follow this link:
https://developer.android.com/jetpack/androidx/releases/databinding
if you do base job, for enable databainding in your project, like use enable in gradle and use layout tag in xml, when you change xml code and did not generat new databinding class for those xml you can use a fast way for generation only data binding class in gradle->other->databindinggenbaseclassesDebug it fast more than bulid whole project. its generate only databinding class.
After having set up it properly (including xml namespace and wrapping everything into <layout>), the one which worked for me was doing Build -> Make project. Nor Clean Project or Rebuild Project did. I'm in Android Studio 2.3.1, using 26.0.2 build tools. There's no need for <data> tags.
My solution was to take as a suffix FragmentBinding in the class name.
A binding class is generated for each layout file. By default, the name of the class is based on the name of the layout file, converting it to Pascal case and adding the Binding suffix to it. The above layout filename is activity_main.xml so the corresponding generated class is ActivityMainBinding. This class holds all the bindings from the layout properties (for example, the user variable) to the layout's views and knows how to assign values for the binding expressions.
The nomenclature of the name of the activity or fragment class may vary in terms of prefixes. Because the suffix is always Binding.
After following the response of Khemraj and Invalidate Caches / Restart, you should rewrite ActivityBinding or FragmentBinding to get the IDE suggestions of the classes that were already generated and DO NOT hardcode the import.
In my case I was trying to import the name of the class backwards be FragmentCompetitionsBinding instead of CompetitionsFragmentBinding.
GL
Source
I had the same problem. I made a mistake while I refactored.
The autogen binding class has its name from the xml layout file.
fragment_name.xml -> FragmentNameBinding
Most of time it just need to rebuild. not build not make project . and it will be better if you first of all do invalid Caches and restart Android studio then clean and rebuild it .
Data binding classes are generated during the build so after you enable data binding in the Gradle build of the app and surround your xml with the layout tag you should rebuild your app. If that doesn't help, delete your build folder and do it again.
I do not know it will work for you or not. Just rename the layout XML file name. Like suppose your layout name is activity_main.xml just change rename it to anything like main.xml and again rename it to activity_main.xml. Then you can able to see the import option on ActivityMainBinding.
Hope it works for you.
Thanks to this answer here - it looks like the "layout namespace" needs to either be cleared out, or you need a new unique name.
Here are the options that worked for me:
Create a fresh name for the layout to make sure it can be generated. This solved my issue, where I had a layout that was first created, without data binding - let's call it fragment_abc.xml. When I tried to add data binding to it, it was not recognized - even after multiple clear cache & restart calls. However, soon as I made a copy of the layout fragment_abc2.xml, immediately I got the generated data-binding .java/.class object.
After seeing the above work, I tried to just remove the /build folder from the module, and rebuilt the project - this worked to get data binding for the original layout.
When you work with a multimodule Android application check your binding class path. Maybe you should use:
import com.yourcompany.app.android.modulename.databinding.FragmentABCtBinding
insted of:
import com.yourcompany.app.android.databinding.FragmentABCtBinding
In my case, I thought that generated class had to appear with my usual classes in src folder. In addition, I thought that the name of the generated class should be slightly different. It all was my mistake. The generated class can be found in build folder, build -> generated -> ... path. If there is no import of the generated class in your activity, add the import
import com.yourcompany.app.databinding.ActivityMainBinding;"
Delete layouts and undo, and make sure the generated binding classes are imported correctly after that.
Make sure data binding enabled
android {
...
dataBinding {
enabled = true
}
...
}
dan click the button (Sync project with Gradle)
If answer did not work for you, then my recommendation is simple but effective.
The idea is to determine which is the component that is generating the problem. To do this, comment on all the lines of your custom_fragment.xml and its uses in the CustomFragment.kt and leave something minimalist like the following.
<layout xmlns:android="http://schemas.android.com/apk/res/android"
xmlns:app="http://schemas.android.com/apk/res-auto"
xmlns:tools="http://schemas.android.com/tools">
<androidx.constraintlayout.widget.ConstraintLayout
android:id="#+id/test"
android:layout_width="match_parent"
android:layout_height="match_parent"/>
</layout>
Then run the app and add component to component while you Apply Code Changes (Ctrl+Alt+F10) to the execution of the app until the app crashes, that is when you found the fault.
Data binding logs are sometimes not so descriptive and this is a generic strategy to find the faulty component.
GL
The only thing I can imagine if possible is if you don't have
dataBinding {
enabled true
}
in your gradle file. If not just add it to the gradle file.
i.e
android {
......
dataBinding {
enabled true
}
}
then sync your project. If it still fail, you may need to do Invalidate/Restart of your android studio
I had same problem. Everything you done correct. Thing is you need add variable inside data tag in xml. For that you should create a sample model class and add it as variable in data tag.
Until that you won't get to see generated ActivityMainBinding.
1.Add Below in app gradle
dataBinding {
enabled = true
}
2.In xml layout write below code
<layout
xmlns:android="http://schemas.android.com/apk/res/android">
<data></data>
</layout>if you don't get data binding class just rename the layout file name and you will get data binding class.
I had a similar issue where I had the layout wrapped and my data binding enabled in the gradle file. Main activity still couldn't intellisense or see my classes. What fixed it for me was adding the binding variable and importing the binding anyway. From there I just built the solution and then it seemed to know what the class was. From there I was able to import my camel case classes that were generated.
I got the issue and the problem was in the layout the field used was not a String, it was a Date.
Looks that all field got to be text to work, at least with the TexView component.
If you build with the command
./gradlew build --stacktrace
This show better the errors.
In case you get the following error in DataBindingUtil.setContentView
Unresolved reference: activity_main
all you need to do is remove the following import statement
import android.R
I found the solution on another forum. Source
If Recently any one migrated existing project into androidx then you need to replace your import from
import com.yourpackagename.BR;
to
import androidx.databinding.library.baseAdapters.BR;
After Google 2 days finally got solution, which one work for me.
There are cases when you won't see a file under generated directory, you might be binding a property that is not declared in viewmodel. It doesn't essentially give you a lint error if you do so in xml.
If you are implement the Serializable -> you must implement the Serializable
else you will get this error. Hope it will help someone in future
In my case I use the Parcel library. I missed to annotate #Parcel in my sub class
In addition to the above steps, you can also check the variable type. Make sure it's String for TextView or the same as defined in the BindingAdapter.
For example:
data class MyDataObject(val name: String, val age: Int)
and in XML:
android:text="#{dataobject.age}"
This will cause the above error. To fix you can either make the age variable of type String or you can import String in your XML and use String.valueOf(age) as following:
<data>
<import type="String" />
...
</data>
And in your TextView:
android:text="#{String.valueOf(dataobject.age)}"
In my case, data binding classes were not generated because I had deleted the mipmap Android Resource Directory. I recreated the res/mipmap/ directory and the data binding classes were reinstated.
I encountered a similar issue where DataBinding failed to generate the BindingImpl class.
In my case was an issue from a method in the data class where the name was used wrong:
The model contained a method onSignInCliked() and in the layout I used onSigninCliked(). Notice the SignIn vs Signin.
The error message wasn't enough and I discovered the issue only when I used the build script with the stack-trace option.

Categories

Resources