page.title=Loading Views On Demand parent.title=Improving Layout Performance parent.link=index.html trainingnavtop=true previous.title=Re-using Layouts with <include/> previous.link=reusing-layouts.html next.title=Making ListView Scrolling Smooth next.link=smooth-scrolling.html @jd:body

This lesson teaches you to

  1. Define a ViewStub
  2. Load the ViewStub Layout

You should also read

Sometimes your layout might require complex views that are rarely used. Whether they are item details, progress indicators, or undo messages, you can reduce memory usage and speed up rendering by loading the views only when they are needed.

Define a ViewStub

{@link android.view.ViewStub} is a lightweight view with no dimension and doesn’t draw anything or participate in the layout. As such, it's cheap to inflate and cheap to leave in a view hierarchy. Each {@link android.view.ViewStub} simply needs to include the {@code android:layout} attribute to specify the layout to inflate.

The following {@link android.view.ViewStub} is for a translucent progress bar overlay. It should be visible only when new items are being imported into the application.

<ViewStub
    android:id="@+id/stub_import"
    android:inflatedId="@+id/panel_import"
    android:layout="@layout/progress_overlay"
    android:layout_width="fill_parent"
    android:layout_height="wrap_content"
    android:layout_gravity="bottom" />

Load the ViewStub Layout

When you want to load the layout specified by the {@link android.view.ViewStub}, either set it visible by calling {@link android.view.View#setVisibility setVisibility(View.VISIBLE)} or call {@link android.view.ViewStub#inflate()}.

((ViewStub) findViewById(R.id.stub_import)).setVisibility(View.VISIBLE);
// or
View importPanel = ((ViewStub) findViewById(R.id.stub_import)).inflate();

Note: The {@link android.view.ViewStub#inflate()} method returns the inflated {@link android.view.View} once complete. so you don't need to call {@link android.app.Activity#findViewById findViewById()} if you need to interact with the layout.

Once visible/inflated, the {@link android.view.ViewStub} element is no longer part of the view hierarchy. It is replaced by the inflated layout and the ID for the root view of that layout is the one specified by the {@code android:inflatedId} attribute of the ViewStub. (The ID {@code android:id} specified for the {@link android.view.ViewStub} is valid only until the {@link android.view.ViewStub} layout is visible/inflated.)

Note: One drawback of {@link android.view.ViewStub} is that it doesn’t currently support the {@code } tag in the layouts to be inflated.