Include tag and dataBinding

Question

I want to use one of my layouts multiple times in the same view using include. Let's say I have a custom.xml including some TextViews.

custom.xml:

 <LinearLayout
    xmlns:android="http://schemas.android.com/apk/res/android"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    android:padding="10dp"
    android:orientation="vertical" >

    <TextView
        android:id="@+id/text1"
        android:layout_width="match_parent"
        android:layout_height="wrap_content" />

    <TextView
        android:id="@+id/text2"
        android:layout_width="match_parent"
        android:layout_height="wrap_content" />
</LinearLayout>

I have included this layout multiple times in parent.xml:

 <LinearLayout
    xmlns:android="http://schemas.android.com/apk/res/android"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    android:orientation="vertical" >

    <include layout="@layout/custom"
        android:id="@+id/layout1"/>

    <include layout="@layout/custom"
        android:id="@+id/layout2"/>
</LinearLayout>

Now I want to bind my data models to this layout, but the problem is that I don't know how to bind two different data models to layout1 and layout2 since both of them are refrenced from one layout which is custom.xml. As far as I know I can add this tag in my xml layout:

    <data>
       <variable name="user" type="com.myproject.model.User"/>
   </data>

But I need to bind two different data models to custom.xml.

My question is how to have an included layout multiple times in one view and passing different data to them using Data Binding? something like passing data to the layout but not statically binding a model to an xml.

I also found this question which is exactly had the same problem But since Data Binding is released in newer versions of android I am seeking a way to solve the same issue using Data Binding. Here is the part of that question that I have quoted for clarification:

For instance, I have a carefully crafted layout that I want to display three times in my view. Every of those instances would need different values. Since the include is basically a take that XML and paste it here, I'd need something more powerful.

If the layouts are same, and only the data is changing, why dont you consider to using a custom recycleView ? — Alex Chengalan, Oct 05 '16 at 06:51
because I want to pass two different data models for example one is User and another is Address but both models are using the same layout to show their data — Milad Faridnia, Oct 05 '16 at 06:54
@MiladFaridnia hey Gentleman can u help me with given link question comment? https://stackoverflow.com/questions/35554796/rotate-marker-and-move-animation-on-map-like-uber-android/39569076 — Kevan Aghera, Apr 06 '18 at 07:14

score 63 · Accepted Answer · edited May 23 '17 at 12:34

63

You can pass that from parent.xml

<include layout="@layout/custom"
    android:id="@+id/layout1"
    app:user="@{object of user1`}"/>

<include layout="@layout/custom"
    android:id="@+id/layout2"
    app:user="@{object of user2`}"/>

Here you need to pass User object from parent.xml

Make sure you have <data> in custom.xml

<data>
   <variable name="user" type="com.myproject.model.User"/>
</data>

Here is detailed answer related to this, refer it

edited May 23 '17 at 12:34

Community

1
1

answered Oct 05 '16 at 07:12

Ravi

34,851
21
122
183

Thanks for your answer It's so close to the final answer but is it possible to pass two kinds of models (for example one is User and another is Address) to custom.xml ? – Milad Faridnia Oct 05 '16 at 07:18
yes, in that case you need to take two variables in `custom.xml` – Ravi Oct 05 '16 at 07:25
something like this ? – Milad Faridnia Oct 05 '16 at 07:30
1

first I was wondering why this should work because I havn't defined a binding for `app:user`. BUT it works like a charm! thanks – m.zander Dec 15 '17 at 12:35
what if I want to pass in two paramter, it will not work – CodingTT Oct 17 '18 at 20:19
You can pass 2 parameters. – RatneZ Dec 27 '19 at 12:13
1

It has to be "bind:user" instead of "app:user" https://developer.android.com/topic/libraries/data-binding/expressions#imports_variables_and_includes – Wamiq Nov 18 '20 at 09:05

score 18 · Answer 2 · edited Nov 26 '17 at 03:41

We know how to use the POJO name and its type on the XML which we are using in setContentView() as a parent view. We should focus on the include tag if we are including any layouts from resource as follows:

<?xml version="1.0" encoding="utf-8"?>

<layout xmlns:bind="http://schemas.android.com/apk/res-auto">

    <data>

        <variable
            name="user"
            type="exapmpe.model.User" />
    </data>

    <android.support.design.widget.CoordinatorLayout
        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"
        android:layout_width="match_parent"
        android:layout_height="match_parent">

        <android.support.design.widget.AppBarLayout
            android:layout_width="match_parent"
            android:layout_height="wrap_content"
            android:theme="@style/AppTheme.AppBarOverlay">

            <android.support.v7.widget.Toolbar
                android:id="@+id/toolbar"
                android:layout_width="match_parent"
                android:layout_height="?attr/actionBarSize"
                android:background="?attr/colorPrimary"
                app:popupTheme="@style/AppTheme.PopupOverlay" />

        </android.support.design.widget.AppBarLayout>

        <include
            layout="@layout/content_main"
            bind:user="@{user}" />

    </android.support.design.widget.CoordinatorLayout>

</layout>

Here we've use the bind attribute to pass the object to show the detailed info on the content screen. Please make sure the object name should be same in both places like bind:user="@{user}. The content_main.xml should look as follows:

<?xml version="1.0" encoding="utf-8"?>

<layout>

    <data>

        <variable
            name="user"
            type="exapmpe.model.User" />
    </data>

    <RelativeLayout 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"
        android:id="@+id/content_main" >

        <TextView
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:text="@{user.firstName + user.lastName}" />

    </RelativeLayout>

</layout>

score 2 · Answer 3 · edited May 23 '17 at 12:02

2

The problem is that the included layout isn't being thought of as a data-bound layout, take a look here to undertstand how to solve it

edited May 23 '17 at 12:02

Community

1
1

answered Oct 05 '16 at 07:14

Lior

832
6
6

2

Thanks for your useful link but I think you must include more description in your answer – Milad Faridnia Oct 05 '16 at 07:23

score 0 · Answer 4 · edited Aug 14 '23 at 10:20

1> In the Main layout screen where you use include tag added xmlns:bind="http://schemas.android.com/apk/res-auto" This code is under the layout tag. For your reference check the screenshot.

point 1

2> Now under your include tag add bind:includeLayoutViewModel="@{viewModel}" (In this case add your ViewModel name which you declare)For more check out the screenshot

For point 2

3> Now in your included layout screen call ViewModel here for reference check the below screenshot (In screenshots there is TestViewModel behalf of this you mention your view model which is you declare in your main layout screen)

For point 3

Include tag and dataBinding

4 Answers4

Linked