Is the xml attribute singleLine deprecated or not in Android?

Question

singleLine is/was used in xml layout files for TextView and EditText something like the following:

<TextView
    android:layout_width="wrap_content"
    android:layout_height="wrap_content"
    android:singleLine="true" />

Some people on SO say singleLine is deprecated, while other people still suggest using it. Sometimes it even seems necessary to use when maxLines="1" doesn't work. (see here, here, and here)

The docs should be the place to go to answer this question, right? Here, they say:

This constant was deprecated in API level 3.

This attribute is deprecated. Use maxLines instead to change the layout of a static text, and use the textMultiLine flag in the inputType attribute instead for editable text views (if both singleLine and inputType are supplied, the inputType flags will override the value of singleLine).

However, in the TextView docs, there is no indication that it is deprecated, either for android:singleLine or for setSingleLine or for setTransformationMethod. The same TextView docs, by comparison, do state that other things like STATUS_BAR_HIDDEN and fitSystemWindows are deprecated. So is the singleLine deprecation an omission, was it "undeprecated", or what?

This question has been previously asked before but was not the main focus of the question (and was not answered).

Solution 1

I think the answer to your question is already in one of the SO posts you linked to. Unfortunately, the deprecation of singleLines is not a black-or-white matter.

It is deprecated, but it is not going anywhere anytime soon.

It was deprecated because its performance is poor, relative to its successor, maxLines. It uses SingleLineTransformationMethod to replace newlines and carriage returns in the String you place in the TextView, unlike maxLines, which "just" adjusts the height of the TextView based on the number of lines and does no String replacing.

This method of replacing characters also meant that singleLine could break in unexpected ways (e.g. if you use custom fonts). It was these performance and reliability issues that led to its deprecation.

However, it is not going anywhere because, as the SO post you linked to states, it is still in use by many old Android applications, and it is still useful sometimes (e.g. when you want to show the entire text on one line and ignore carriage-returns and newlines).

Do note that deprecation does not necessarily mean that an API is going away. It just means that its use is discouraged, but may be permitted.

Solution 2

The deprecated attribute was added in change d24b8183b9 which is nothing but a dump from Google's internal SCM:

auto import from //branches/cupcake/...@130745

As can be seen from the change core/res/res/values/attrs.xml diff adds the @deprecated doc comment, but core/java/android/widget/TextView.java diff does not alter anything from setSingleLine()'s doc comment.

Now without access to Google's internal SCM history, it is not possible to know what exactly caused above change in attrs.xml doc comment, but for your question

So is the singleLine deprecation an omission, was it "undeprecated", or what?

one possible answer is:TextView's single-line was neither deprecated, nor "undeprecated", but it was enhanced to take into account whether the view is editable, a password field or uses any other input type flag that affects single/multi-lineness.

Solution 3

Just for adding some more information to the discussion, Lint now has the following error:

"Combining ellipsize and maxLines=1 can lead to crashes on some devices. Earlier versions of lint recommended replacing singleLine=true with maxLines=1 but that should not be done when using ellipsize.

More info: https://issuetracker.google.com/issues/36950033"

So, I guess that singleLine is now, and I think we should come up with a new term... "deprecatedish"?

Solution 4

In the official grepcode of TextView (v5.1.0 r1) :

android:singleLine is not annotated with @Deprecated.

I also see this in setInputType method:

boolean singleLine = !isMultilineInputType(type);

// We need to update the single line mode if it has changed or we
// were previously in password mode.
if (mSingleLine != singleLine || forceUpdate) {
    // Change single line mode, but only change the transformation if
    // we are not in password mode.
    applySingleLine(singleLine, !isPassword, true);
}

setInputType overrides the mSingleLine value so.

EDIT : This xml attribute is now officially deprecated. (since API 3?). It is now visible in AndroidStudio xml editor.

Solution 5

While Android Studio claims that it is deprecated, in reality we had an edit text which should allow itself to be only single-line.

Adding maxLines="1" made it allow newline characters, which is not suitable for our needs.

So we went back to using singleLine="true".

View more solutions

Comments

[Suragch]

If it is actually deprecated, then isn't it the official practice to mark it as so throughout the documentation? Yet the TextView docs don't do that. That's what makes me wonder whether this is an oversight or if it is being purposefully vague or something else.

[ugo]

@Suragch yes, it is likely an oversight (it wouldn't be the first oversight in Android docs). Keep in mind that it was deprecated very early on in Android's development. In fact, the git commit that deprecated it is one of the first ones in Github's import of Android source and is dated April 2009. It was deprecated very early on in development, but not all docs were updated.

[Suragch]

Several of the answers here provide some useful discussion and insight into this problem, but since the bounty time is almost up, I am awarding it to this answer because it goes into the most depth and draws the most from credible and official sources. I'm not quite ready to choose an accepted answer, yet, though.

[Eliezer]

I'm not sure why the documentation would recommend using maxLines. It does not supply the same behavior as singleLine.

[oguzhan]

I removed singleLine attribute and i did your answer, it works for me congratulations !

[LarsH]

The OP described why discussion is needed. Declaring "no discussion needed" without citing a credible source as to why the issue is closed doesn't help.

[avalancha]

This comment is 4 years old. FOUR years ago this was "deprecatedish" and unclear, and now it still ist. This is insanity.