Как: определить элемент темы (стиля) для пользовательского виджета

86

Я написал специальный виджет для элемента управления, который мы широко используем в нашем приложении. Класс виджета является производным от него ImageButtonи расширяет его несколькими простыми способами. Я определил стиль, который я могу применить к виджету по мере его использования, но я бы предпочел настроить его через тему. В R.styleableЯ вижу виджет атрибуты стиля , как imageButtonStyleи textViewStyle. Есть ли способ создать что-то подобное для написанного мной пользовательского виджета?

android android-theme jsmith
источник

Ответы:

209

Да, есть один способ:

Предположим, у вас есть объявление атрибутов для вашего виджета (in attrs.xml):

<declare-styleable name="CustomImageButton">
    <attr name="customAttr" format="string"/>
</declare-styleable>

Объявите атрибут, который вы будете использовать для ссылки на стиль (in attrs.xml):

<declare-styleable name="CustomTheme">
    <attr name="customImageButtonStyle" format="reference"/>
</declare-styleable>

Объявите набор значений атрибутов по умолчанию для виджета (in styles.xml):

<style name="Widget.ImageButton.Custom" parent="android:style/Widget.ImageButton">
    <item name="customAttr">some value</item>
</style>

Объявить настраиваемую тему (in themes.xml):

<style name="Theme.Custom" parent="@android:style/Theme">
    <item name="customImageButtonStyle">@style/Widget.ImageButton.Custom</item>
</style>

Используйте этот атрибут в качестве третьего аргумента в конструкторе вашего виджета (in CustomImageButton.java):

public class CustomImageButton extends ImageButton {
    private String customAttr;

    public CustomImageButton( Context context ) {
        this( context, null );
    }

    public CustomImageButton( Context context, AttributeSet attrs ) {
        this( context, attrs, R.attr.customImageButtonStyle );
    }

    public CustomImageButton( Context context, AttributeSet attrs,
            int defStyle ) {
        super( context, attrs, defStyle );

        final TypedArray array = context.obtainStyledAttributes( attrs,
            R.styleable.CustomImageButton, defStyle,
            R.style.Widget_ImageButton_Custom ); // see below
        this.customAttr =
            array.getString( R.styleable.CustomImageButton_customAttr, "" );
        array.recycle();
    }
}

Теперь вам нужно применить Theme.Customко всем действиям, которые используют CustomImageButton(в AndroidManifest.xml):

<activity android:name=".MyActivity" android:theme="@style/Theme.Custom"/>

Вот и все. Теперь CustomImageButtonпытается загрузить значения атрибутов по умолчанию из customImageButtonStyleатрибута текущей темы. Если такой атрибут не найден в теме или значение атрибута будет использоваться @nullпоследним аргументом для obtainStyledAttributes: Widget.ImageButton.Customв этом случае.

Вы можете изменить имена всех экземпляров и всех файлов (кроме AndroidManifest.xml), но было бы лучше использовать соглашение об именах Android.

Майкл
источник
4
Есть ли способ сделать то же самое без использования темы? У меня есть несколько настраиваемых виджетов, но я хочу, чтобы пользователи могли использовать эти виджеты с любой темой, которую они хотят. Если вы сделаете это так, как вы разместили, пользователи должны использовать мою тему.
theDazzler
3
@theDazzler: если вы имеете в виду библиотеку, которую могут использовать разработчики, то они смогут создавать свои собственные темы и указывать стиль для виджета, используя атрибут стиля в теме ( customImageButtonStyleв этом ответе). Так настраивается панель действий на Android. И если вы имеете в виду изменение темы во время выполнения, то при таком подходе это невозможно.
Майкл
@Michael, да я имел ввиду библиотеку, которую могут использовать разработчики. Ваш комментарий решил мою проблему. Благодарность!
theDazzler
30
Самое удивительное во всем этом то, что кто-то в Google думает, что это нормально.
Glenn Maynard
1
Есть ли name="CustomTheme"в declare-styleableатрибуте обертка служить какой - либо цели? Это просто для организации, потому что я нигде не вижу, чтобы это использовалось. Могу ли я просто поместить все свои атрибуты стиля для различных виджетов в одну оболочку?
Tenfour04,
4

Еще один аспект в дополнение к отличному ответу Майкла - переопределение настраиваемых атрибутов в темах. Предположим, у вас есть несколько настраиваемых представлений, которые все ссылаются на настраиваемый атрибут custom_background.

<declare-styleable name="MyCustomStylables">
    <attr name="custom_background" format="color"/>
</declare-styleable>

В теме вы определяете ценность

<style name="MyColorfulTheme" parent="AppTheme">
    <item name="custom_background">#ff0000</item>
</style>

или

<style name="MyBoringTheme" parent="AppTheme">
    <item name="custom_background">#ffffff</item>
</style>

Вы можете ссылаться на атрибут в стиле

<style name="MyDefaultLabelStyle" parent="AppTheme">
    <item name="android:background">?background_label</item>
</style>

Обратите внимание на вопросительный знак, который также используется для справочного атрибута android, как в

?android:attr/colorBackground

Как большинство из вас заметили, вы можете и, вероятно, должны использовать ссылки @color вместо жестко заданных цветов.

Так почему бы просто не сделать

<item name="android:background">@color/my_background_color</item>

Вы не можете изменить определение my_background_color во время выполнения, тогда как вы можете легко переключать темы.

мир
источник