(#) Ignored layout params on include
!!! ERROR: Ignored layout params on include
This is an error.
Id
: `IncludeLayoutParam`
Summary
: Ignored layout params on include
Severity
: Error
Category
: Correctness
Platform
: Android
Vendor
: Android Open Source Project
Feedback
: https://issuetracker.google.com/issues/new?component=192708
Since
: Initial
Affects
: Resource files
Editing
: This check runs on the fly in the IDE editor
See
: https://stackoverflow.com/questions/2631614/does-android-xml-layouts-include-tag-really-work
Implementation
: [Source Code](https://cs.android.com/android-studio/platform/tools/base/+/mirror-goog-studio-main:lint/libs/lint-checks/src/main/java/com/android/tools/lint/checks/IncludeDetector.java)
Tests
: [Source Code](https://cs.android.com/android-studio/platform/tools/base/+/mirror-goog-studio-main:lint/libs/lint-tests/src/test/java/com/android/tools/lint/checks/IncludeDetectorTest.java)
Copyright Year
: 2014
Layout parameters specified on an `` tag will only be used if
you also override `layout_width` and `layout_height` on the ``
tag; otherwise they will be ignored.
!!! Tip
This lint check has an associated quickfix available in the IDE.
(##) Example
Here is an example of lint warnings produced by this check:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~text
res/layout/include_params.xml:43:Error: Layout parameter layout_margin
ignored unless both layout_width and layout_height are also specified on
tag [IncludeLayoutParam]
android:layout_margin="20dp"
----------------------------
res/layout/include_params.xml:44:Error: Layout parameter layout_weight
ignored unless both layout_width and layout_height are also specified on
tag [IncludeLayoutParam]
android:layout_weight="1.5"
---------------------------
res/layout/include_params.xml:51:Error: Layout parameter layout_weight
ignored unless layout_width is also specified on tag
[IncludeLayoutParam]
android:layout_weight="1.5"
---------------------------
res/layout/include_params.xml:58:Error: Layout parameter layout_weight
ignored unless layout_height is also specified on tag
[IncludeLayoutParam]
android:layout_weight="1.5"
---------------------------
res/layout/include_params.xml:65:Error: Layout parameter layout_width
ignored unless layout_height is also specified on tag
[IncludeLayoutParam]
android:layout_width="fill_parent"
----------------------------------
res/layout/include_params.xml:72:Error: Layout parameter layout_height
ignored unless layout_width is also specified on tag
[IncludeLayoutParam]
android:layout_height="fill_parent"
-----------------------------------
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Here is the source file referenced above:
`res/layout/include_params.xml`:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~xml linenumbers
<?xml version="1.0" encoding="utf-8"?>
<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
xmlns:tools="http://schemas.android.com/tools"
android:layout_width="match_parent"
android:layout_height="match_parent"
android:orientation="vertical">
<!-- Ok: No layout params -->
<include layout="@layout/myincluded" />
<!-- Ok: No layout params -->
<include
android:id="@+id/myInclude"
layout="@layout/myincluded"
android:gravity="left"
android:visibility="visible" />
<!-- Ok: No layout params -->
<include
layout="@layout/myincluded"
android:layout_width="fill_parent"
android:layout_height="fill_parent" />
<!-- Ok: Specifies both width and height -->
<include
layout="@layout/myincluded"
android:layout_width="fill_parent"
android:layout_height="0dp"
android:layout_weight="1.5"
android:visibility="visible" />
<!-- Ok: ignored -->
<include
layout="@layout/myincluded"
android:layout_width="fill_parent"
android:layout_weight="1.5"
android:visibility="visible"
tools:ignore="IncludeLayoutParam" />
<!-- Wrong: Missing both -->
<include
layout="@layout/myincluded"
android:layout_margin="20dp"
android:layout_weight="1.5"
android:visibility="visible" />
<!-- Wrong: Missing width -->
<include
layout="@layout/myincluded"
android:layout_height="0dp"
android:layout_weight="1.5"
android:visibility="visible" />
<!-- Wrong: Missing height -->
<include
layout="@layout/myincluded"
android:layout_width="fill_parent"
android:layout_weight="1.5"
android:visibility="visible" />
<!-- Wrong: Specified only width -->
<include
android:id="@+id/myInclude"
layout="@layout/myincluded"
android:layout_width="fill_parent"
android:visibility="visible" />
<!-- Wrong: Specified only height -->
<include
android:id="@+id/myInclude"
layout="@layout/myincluded"
android:layout_height="fill_parent"
android:visibility="visible" />
</LinearLayout>
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
You can also visit the
[source code](https://cs.android.com/android-studio/platform/tools/base/+/mirror-goog-studio-main:lint/libs/lint-tests/src/test/java/com/android/tools/lint/checks/IncludeDetectorTest.java)
for the unit tests for this check to see additional scenarios.
The above example was automatically extracted from the first unit test
found for this lint check, `IncludeDetector.test`.
To report a problem with this extracted sample, visit
https://issuetracker.google.com/issues/new?component=192708.
(##) Suppressing
You can suppress false positives using one of the following mechanisms:
* Adding the suppression attribute `tools:ignore="IncludeLayoutParam"`
on the problematic XML element (or one of its enclosing elements).
You may also need to add the following namespace declaration on the
root element in the XML file if it's not already there:
`xmlns:tools="http://schemas.android.com/tools"`.
```xml
<?xml version="1.0" encoding="UTF-8"?>
<include xmlns:tools="http://schemas.android.com/tools"
tools:ignore="IncludeLayoutParam" ...>
...
</include>
```
* Using a special `lint.xml` file in the source tree which turns off
the check in that folder and any sub folder. A simple file might look
like this:
```xml
<?xml version="1.0" encoding="UTF-8"?>
<lint>
<issue id="IncludeLayoutParam" severity="ignore" />
</lint>
```
Instead of `ignore` you can also change the severity here, for
example from `error` to `warning`. You can find additional
documentation on how to filter issues by path, regular expression and
so on
[here](https://googlesamples.github.io/android-custom-lint-rules/usage/lintxml.md.html).
* In Gradle projects, using the DSL syntax to configure lint. For
example, you can use something like
```gradle
lintOptions {
disable 'IncludeLayoutParam'
}
```
In Android projects this should be nested inside an `android { }`
block.
* For manual invocations of `lint`, using the `--ignore` flag:
```
$ lint --ignore IncludeLayoutParam ...`
```
* Last, but not least, using baselines, as discussed
[here](https://googlesamples.github.io/android-custom-lint-rules/usage/baselines.md.html).