Create an Android ViewStub Programmatically in Android

Greetings!
We have recently published 100+ articles on android tutorials with kotlin and java. If you need, you may visit Android Tutorial for beginners page. You can also check Kotlin Tutorial for beginners. Also, if you are interested in content writing, you can mail us at tutorialwing@gmail.com.

Hello Readers! In this post, we are going to learn how to create and use android viewStub programmatically in any android application. We will also learn to add viewStub in linearLayout programmatically in any application.

Output

Tutorialwing Android Dynamic ViewStub Output Android ViewStub Programmatically in Android

Tutorialwing Android Dynamic ViewStub Output

Getting Started

At first, we will create an android application. Then, we will use viewStub widget in the application.

1. Creating New Project

Follow the steps below to create a new project. Please ignore the steps if you have already created a new project.

Step Description
1. Open Android Studio.
2. Go to File => New => New Project. Write application name as DynamicViewStub. Then, click next button.
3. Select minimum SDK you need. However, we have selected 17 as minimum SDK. Then, click next button
4. Then, select Empty Activity => click next => click finish.
5. If you have followed above process correctly, you will get a newly created project successfully. However, you can also visit post to create a new project to know steps in detail.

Now, we will modify xml and java file to use android viewStub programmatically.

2. Modify values folder

Open res/values/strings.xml file and add below code into it.

<resources>
	<string name="app_name">DynamicViewStub</string>
	<string name="hide">HIDE</string>
	<string name="show">SHOW</string>
	<string name="sub_view">This view is inflated by ViewStub by calling either inflate() or setVisibility(true) method</string>
</resources>

3. Create Views that replaces ViewStub

Whenever we call viewStub.inflate() or viewStub.setVisibility(true), viewStub replaces itself with another views. So, we will define that view now. Create an xml file, sub_item.xml file, in res/layout folder. Add below code into this file.

<?xml version="1.0" encoding="utf-8"?>
<LinearLayout
	xmlns:android="http://schemas.android.com/apk/res/android"
	android:layout_width="match_parent"
	android:layout_height="match_parent"
	android:background="@android:color/holo_blue_light"
	android:gravity="center"
	android:padding="10dp">

	<TextView
		android:layout_width="wrap_content"
		android:layout_height="wrap_content"
		android:gravity="center"
		android:text="@string/sub_view"
		android:textColor="@android:color/black"
		android:textSize="18sp"/>

</LinearLayout>

Here, we have defined the view that replaces viewStub when inflate() method is called.

4. Modify Layout Folder

Open res/layout/activity_main.xml file. Then, add below code into it.

<?xml version="1.0" encoding="utf-8"?>
<LinearLayout
	android:id="@+id/rootContainer"
	xmlns:android="http://schemas.android.com/apk/res/android"
	android:layout_width="match_parent"
	android:layout_height="match_parent"
	android:layout_margin="10dp"
	android:gravity="center_horizontal"
	android:orientation="vertical">

	<Button
		android:id="@+id/button"
		android:layout_width="wrap_content"
		android:layout_height="wrap_content"
		android:text="@string/hide"/>

</LinearLayout>

In activity_main.xml file, we have defined linearLayout, with id rootContainer, that will act as container for the viewStub created dynamically in the application. We have also defined a button that are used to toggle the display of view inflated by viewStub.

5. Create Android ViewStub Programmatically / Dynamically

Open app/src/main/java/com.tutorialwing.dynamicviewstub/MainActivity.java file and add below code into it.

package com.tutorialwing.dynamicviewstub;

import android.os.Bundle;
import android.support.v7.app.AppCompatActivity;
import android.view.View;
import android.view.ViewGroup;
import android.view.ViewStub;
import android.widget.Button;
import android.widget.LinearLayout;

public class MainActivity extends AppCompatActivity {

	boolean isViewInflated = true; // Default state that represents viewStub has been replaced by sub view

	@Override
	protected void onCreate(Bundle savedInstanceState) {
		super.onCreate(savedInstanceState);
		setContentView(R.layout.activity_main);

		final ViewStub viewStub = new ViewStub(this);
		LinearLayout.LayoutParams layoutParams = new LinearLayout.LayoutParams(ViewGroup.LayoutParams.WRAP_CONTENT, ViewGroup.LayoutParams.WRAP_CONTENT);
		viewStub.setLayoutParams(layoutParams);
		viewStub.setLayoutResource(R.layout.sub_item);

		LinearLayout linearLayout = findViewById(R.id.rootContainer);
		if (linearLayout != null) {
			linearLayout.addView(viewStub);
		}

		viewStub.setVisibility(View.VISIBLE); // or you can use viewStub.inflate()

		final Button button = findViewById(R.id.button);
		if (button != null) {
			button.setOnClickListener(new View.OnClickListener() {
				@Override
				public void onClick(View view) {
					isViewInflated = !isViewInflated;
					viewStub.setVisibility(isViewInflated ? View.VISIBLE : View.GONE);
					button.setText(isViewInflated ? getString(R.string.hide) : getString(R.string.show));
				}
			});
		}
	}
}

In MainActivity.java file, we have created viewStub programmatically in the application. Then, we have set layout params, margins etc. in it. setLayoutResource() method is called to specifies layout that will replace viewStub when inflate() or setVisibility(true) method is called. We have also set listener to button that toggle the visibility of inflated view by viewStub.

Since AndroidManifest.xml file is very important in any android project. We are also going to see the content inside this file.

AndroidManifest.xml file

Code inside src/main/AndroidManifest.xml file would look like below –

<?xml version="1.0" encoding="utf-8"?>
<manifest package="com.tutorialwing.dynamicviewstub"
		  xmlns:android="http://schemas.android.com/apk/res/android">

	<application
		android:allowBackup="true"
		android:icon="@mipmap/ic_launcher"
		android:label="@string/app_name"
		android:roundIcon="@mipmap/ic_launcher_round"
		android:supportsRtl="true"
		android:theme="@style/AppTheme">
		<activity android:name=".MainActivity">
			<intent-filter>
				<action android:name="android.intent.action.MAIN"/>

				<category android:name="android.intent.category.LAUNCHER"/>
			</intent-filter>
		</activity>
	</application>

</manifest>

When we run the application, we will get output as shown above.

That’s the end of tutorial on Creating Android ViewStub Programmatically.

Support Us

If you like Tutorialwing and would like to contribute, you can email an article on any educational topic at tutorialwing@gmail.com. We would love to publish your article. See your article on Tutorialwing and help others with your knowledge. Follow Facebook, LinkedIn, Google+, Twitter, Youtube for latest updates.
Greetings!
We have recently published 100+ articles on android tutorials with kotlin and java. If you need, you may visit Android Tutorial for beginners page. You can also check Kotlin Tutorial for beginners