paris

Paris

Mit Paris können Sie Stile programmgesteuert definieren und auf Android-Ansichten anwenden, einschließlich benutzerdefinierter Attribute.

• Wenden Sie Stile jederzeit programmgesteuert an.
• Kombinieren Sie mehrere Stile miteinander.
• Erstellen Sie Stile programmgesteuert (im Gegensatz zur Verwendung von XML).
• Verwenden Sie Anmerkungen, um benutzerdefinierte Attribute einfach zu unterstützen (inspiriert von Barber).
• Deklarieren Sie explizit unterstützte Stile für Ihre benutzerdefinierten Ansichten.
• Und noch viel mehr...

Installation

Im build.gradle Ihres Projekts:

 dependencies {
    implementation ' com.airbnb.android:paris:2.0.0 '
    // Apply the Paris processor if you're using Paris annotations for code gen.
    kapt ' com.airbnb.android:paris-processor:2.0.0 '
    // or if you are using Kotlin Symbol Processing
    ksp ' com.airbnb.android:paris-processor:2.0.0 '
}

Informationen zur Verwendung von Paris in einem Bibliotheksmodul finden Sie unter Bibliotheksmodule.

Schnellstart

Anwenden eines XML-definierten Stils

myView.style( R .style. MyStyle )

Klicken Sie hier, um das Beispiel in Java anzuzeigen.

 Paris . style ( myView ). apply ( R . style . MyStyle );

Dabei ist myView eine beliebige Ansichtsinstanz, MyStyle ein XML-definierter Stil und style eine von Paris bereitgestellte Erweiterungsfunktion. Viele, aber nicht alle Attribute werden unterstützt. Weitere Informationen finden Sie unter Unterstützte Ansichtstypen und Attribute.

Kombinieren von 2 oder mehr Stilen

myView.style {
    add( R .style. StyleA )
    add( R .style. StyleB )
    …
}

Klicken Sie hier, um das Beispiel in Java anzuzeigen.

 Paris . styleBuilder ( myView )
        . add ( R . style . StyleA )
        . add ( R . style . StyleB )
        …
        . apply ();

In Fällen, in denen es zu Überschneidungen kommt, hat der Attributwert des zuletzt hinzugefügten Stils Vorrang. Weitere Informationen finden Sie unter Stile kombinieren.

Stile programmgesteuert definieren

textView.style {
    // Using an actual value.
    textColor( Color . GREEN )
    // Or a resource.
    textSizeRes( R .dimen.my_text_size_small)
}

Klicken Sie hier, um das Beispiel in Java anzuzeigen.

 Paris . styleBuilder ( textView )
        // Using an actual value.
        . textColor ( Color . GREEN )
        // Or a resource.
        . textSizeRes ( R . dimen . my_text_size_small )
        . apply ();

Auch mit Stilmitteln kombinierbar:

textView.style {
    // Adds all the attributes defined in the MyGreenTextView style.
    add( R .style. MyGreenTextView )
    textSizeRes( R .dimen.my_text_size_small)
}

Klicken Sie hier, um das Beispiel in Java anzuzeigen.

 Paris . styleBuilder ( textView )
        // Adds all the attributes defined in the MyGreenTextView style.
        . add ( R . style . MyGreenTextView )
        . textSizeRes ( R . dimen . my_text_size_small )
        . apply ();

Weitere Informationen finden Sie unter Stile programmgesteuert definieren.

Benutzerdefinierte Ansichtsattribute

Attribute werden wie folgt deklariert:

< declare-styleable name = " MyView " >
    < attr name = " title " format = " string " />
    < attr name = " image " format = " reference " />
    < attr name = " imageSize " format = " dimension " />
</ declare-styleable >

Die benutzerdefinierte Ansicht wird mit @Styleable und @Attr annotiert:

 // The value here corresponds to the name chosen in declare-styleable.
@Styleable( " MyView " )
class MyView (…) : ViewGroup(…) {

    init {
        // This call enables the custom attributes when used in XML layouts. It
        // extracts styling information from AttributeSet like it would a StyleRes.
        style(attrs)
    }

    @Attr( R .styleable. MyView_title )
    fun setTitle ( title : String ) {
        // Automatically called with the title value (if any) when an AttributeSet
        // or StyleRes is applied to the MyView instance.
    }

    @Attr( R .styleable. MyView_image )
    fun setImage ( image : Drawable ? ) {
        // Automatically called with the image value (if any) when an AttributeSet
        // or StyleRes is applied to the MyView instance.
    }

    @Attr( R .styleable. MyView_imageSize )
    fun setImageSize (@Px imageSize : Int ) {
        // Automatically called with the imageSize value (if any) when an
        // AttributeSet or StyleRes is applied to the MyView instance.
    }
}

Klicken Sie hier, um das Beispiel in Java anzuzeigen.

 // The value here corresponds to the name chosen in declare-styleable.
@ Styleable ( "MyView" )
public class MyView extends ViewGroup {

    public MyView ( Context context ) {
        super ( context );
    }

    public MyView ( Context context , AttributeSet attrs ) {
        this ( context , attrs , 0 );
    }

    public MyView ( Context context , AttributeSet attrs , int defStyle ) {
        this ( context , attrs , defStyle );
        // This call enables the custom attributes when used in XML layouts. It
        // extracts styling information from AttributeSet like it would a StyleRes.
        Paris . style ( this ). apply ( attrs );
    }

    @ Attr ( R . styleable . MyView_title )
    public void setTitle ( String title ) {
        // Automatically called with the title value (if any) when an AttributeSet
        // or StyleRes is applied to the MyView instance.
    }

    @ Attr ( R . styleable . MyView_image )
    public void setImage ( Drawable image ) {
        // Automatically called with the image value (if any) when an AttributeSet
        // or StyleRes is applied to the MyView instance.
    }

    @ Attr ( R . styleable . MyView_imageSize )
    public void setImageSize ( @ Px int imageSize ) {
        // Automatically called with the imageSize value (if any) when an
        // AttributeSet or StyleRes is applied to the MyView instance.
    }
}

Die @Attr -annotierten Methoden werden von Paris aufgerufen, wenn die Ansicht mit einem AttributeSet erweitert oder ein Stil angewendet wird.

Weitere Informationen finden Sie unter Benutzerdefinierte Ansichtsattribute.

Unteransichten gestalten

Attribute werden für die beiden Unteransichten, die wir formatieren möchten, wie folgt deklariert:

< declare-styleable name = " MyHeader " >
    < attr name = " titleStyle " format = " reference " />
    < attr name = " subtitleStyle " format = " reference " />
    ...
</ declare-styleable >

Die Unteransichtsfelder werden mit @StyleableChild annotiert:

@Styleable( " MyHeader " )
class MyHeader (…) : ViewGroup(…) {

    @StyleableChild( R .styleable. MyHeader_titleStyle )
    internal val title : TextView …
    
    @StyleableChild( R .styleable. MyHeader_subtitleStyle )
    internal val subtitle : TextView …
    
    init {
        style(attrs)
    }
}

Klicken Sie hier, um das Beispiel in Java anzuzeigen.

 @ Styleable ( "MyHeader" )
public class MyHeader extends ViewGroup {

    @ StyleableChild ( R . styleable . MyHeader_titleStyle )
    TextView title ;
    
    @ StyleableChild ( R . styleable . MyHeader_subtitleStyle )
    TextView subtitle ;
    
    …
    // Make sure to call Paris.style(this).apply(attrs) during initialization.
}

Die Titel- und Untertitelstile können jetzt Teil der MyHeader -Stile sein:

< MyHeader
    ...
    app : titleStyle = " @style/Title2 "
    app : subtitleStyle = " @style/Regular " />

myHeader.style {
    // Defined in XML.
    titleStyle( R .style. Title2 )
    // Defined programmatically.
    subtitleStyle {
        textColorRes( R .color.text_color_regular)
        textSizeRes( R .dimen.text_size_regular)
    }
}

Klicken Sie hier, um das Beispiel in Java anzuzeigen.

 Paris . styleBuilder ( myHeader )
        // Defined in XML.
        . titleStyle ( R . style . Title2 )
        // Defined programmatically.
        . subtitleStyle (( builder ) -> builder
                . textColorRes ( R . color . text_color_regular )
                . textSizeRes ( R . dimen . text_size_regular ))
        . apply ();

Achtung: Erweiterungsfunktionen wie titleStyle und subtitleStyle werden während der Kompilierung vom Paris-Annotation-Prozessor generiert. Wenn neue @StyleableChild -Annotationen hinzugefügt werden, muss das Projekt einmal (neu) kompiliert werden, damit die zugehörigen Funktionen verfügbar sind.

Weitere Informationen finden Sie unter Unteransichten gestalten.

Stile mit Ansichten verknüpfen

@Styleable
class MyView (…) : View(…) {

    companion object {
        // For styles defined in XML.
        @Style
        val RED_STYLE = R .style. MyView_Red

        // For styles defined programmatically.
        @Style
        val GREEN_STYLE = myViewStyle {
            background( R .color.green)
        }
    }
}

Klicken Sie hier, um das Beispiel in Java anzuzeigen.

 @ Styleable
public class MyView extends View {

    // For styles defined in XML.
    @ Style
    static final int RED_STYLE = R . style . MyView_Red ;

    // For styles defined programmatically.
    @ Style
    static void greenStyle ( MyViewStyleApplier . StyleBuilder builder ) {
        builder . background ( R . color . green );
    }
}

Für jeden verknüpften Stil werden Hilfsmethoden generiert:

myView.style { addRed() } // Equivalent to style(R.style.MyView_Red)
myView.style { addGreen() } // Equivalent to add(MyView.GREEN_STYLE)

myView.style {
    addRed() // Equivalent to add(R.style.MyView_Red)
    addGreen() // Equivalent to add(MyView.GREEN_STYLE)
    …
}

Klicken Sie hier, um das Beispiel in Java anzuzeigen.

 Paris . style ( myView ). applyRed (); // Equivalent to apply(R.style.MyView_Red)
Paris . style ( myView ). applyGreen (); // No equivalent.

Paris . styleBuilder ( myView )
        . addRed () // Equivalent to add(R.style.MyView_Red)
        . addGreen () // No equivalent.
        …
        . apply ();

Achtung: Erweiterungsfunktionen wie addRed und addGreen werden während der Kompilierung vom Paris-Annotation-Prozessor generiert. Wenn neue @Style -Annotationen hinzugefügt werden, muss das Projekt einmal (neu) kompiliert werden, damit die zugehörigen Funktionen verfügbar sind.

Weitere Informationen finden Sie unter Stile mit benutzerdefinierten Ansichten verknüpfen.

Dokumentation

Sehen Sie sich Beispiele an und durchsuchen Sie die vollständige Dokumentation im Paris Wiki.

Wenn Sie noch Fragen haben, können Sie gerne eine neue Ausgabe erstellen.

Mitwirken

Wir lieben Beiträge! Schauen Sie sich unsere Beitragsrichtlinien an und befolgen Sie unbedingt unseren Verhaltenskodex.

Lizenz

 Copyright 2018 Airbnb, Inc.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.