Skip to content
/ Spatula Public

Spatula is a small android library font/typeface binder to apply custom fonts to TextView, Button, etc.

License

Notifications You must be signed in to change notification settings

mturki/Spatula

Repository files navigation

Spatula

Spatula

Download

A small/modest android library to bind fonts to common android text Views via annotations processing like (lowly) butterknife. You can easely apply your custom typefaces .ttf or .otf(not tested) files, contained in your assets folder, on text views that extends TextView like android.widget.Button or android.widget.ToggleButton or extends android support design TextInputLayout.

  • Eliminates Typeface.createFromAsset and view.setTypeface by using @BindTypeface on fields.
  • TypeFace Caching.
  • Works fine with butterknife fields binding.
class ExampleActivity extends Activity {

@BindView(R.id.label)
@BindTypeface(Font.bold)
EditText label;

@BindView(R.id.user)
@BindTypeface //bind default font
EditText username;

@BindView(R.id.pass)
@BindTypeface(Font.myCustomTypeFace)
EditText password;

  @Override public void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    setContentView(R.layout.simple_activity);
    ButterKnife.bind(this);
    Spatulla.bindTypefaces(this);
    // TODO Use fields...
  }
}

Download

Add to your project scope build.gradle file (jcenter repository is comming)

maven {
        url  "http://dl.bintray.com/mturki/android" 
    }

Add to your application scope build.gradle file

dependencies {
  compile 'com.mika_tk.android.spatula:spatula:1.0.0-beta4'
}

Configuration

  1. Copy your fonts to the assets/fonts/ folder

Create a new class that implements TypefaceMapper You have to return the desired file name for each font index. Do not forget to fill in the file extension!

public class Font implements TypefaceMapper {
 int myCustomTypeFace = 1

@Override
    @NonNull
    public String getTypefaceName(int index) {
        switch (index) {
            case bold:
                return "HelvNeue75_W1G.ttf";
            (...)
            case myCustomTypeFace:
                return "HelvNeue35_W1G.ttf";

            default:
            case regular:
                return "HelvNeue55_W1G.ttf";
        }
  1. Now, you have to declare this mapping
  • You can declare it in your custom Application class :
public class MyApp extends Application {

    @Override
    public void onCreate() {
        super.onCreate();
                Spatula.with(new MyFonts());
    }

}
  • Or you can insert a new meta-data into the AndroidManifest.xml application element :
<application android:label="@string/app_name" ...>
    ...
        <meta-data
            android:name="com.mika_tk.android.spatula.Mapper"
            android:value="your.custom.font.mapper.class" />
    ...
</application>

Usage

You have to anotate your View fields with the '@BindTypeface' annotation.

//without font index, the binder use the default font 'FontMapper.regular'.
@BindTypeface
TextView textView01;

// The binder use the given font.
@BindTypeface(MyMapper.bold) //or '@BindTypeface(FontMapper.bold)'
TextView textView02;

// The binder use your custom font name returned by your font mapper implementation. It is better to not use negative values for your custom fonts.
@BindTypeface(MyMapper.myCustomTypeFace)
TextView textView03;

Finally, you just have to call Spatula.(objectToBind) after any .findViewById(...) or ButterKnife.bind(this).

Note : You can bind any object containing non null @BindTypeface annotated view fields like activities, fragments or adapter view holders.

Bonux

You can use some bonus functions to manually apply fonts to your text views:

// apply font to a TextView
Spatula.apply(MyMapper.bold, myTextView);

// apply default font to a TextView
Spatula.apply(myTextView);

// apply font to several views
Spatula.apply(MyMapper.bold, myTextView01, myTextView02);

// apply default font to several views
Spatula.apply(myTextView01, myTextView02);

License

Copyright 2017 Mikhael Turki

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.