uk.co.chrisjenx.calligraphy

Class CalligraphyConfig.Builder

java.lang.Object

uk.co.chrisjenx.calligraphy.CalligraphyConfig.Builder

Enclosing class:

CalligraphyConfig

public static class CalligraphyConfig.Builder
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static int	INVALID_ATTR_ID Default AttrID if not set.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CalligraphyConfig.Builder	addCustomStyle(java.lang.Class<? extends android.widget.TextView> styleClass, int styleResourceAttribute) Add a custom style to get looked up.
CalligraphyConfig.Builder	addCustomViewWithSetTypeface(java.lang.Class<?> clazz) Register custom non-TextView's which implement setTypeface so they can have the Typeface applied during inflation.
CalligraphyConfig	build()
CalligraphyConfig.Builder	disableCustomViewInflation() Due to the poor inflation order where custom views are created and never returned inside an onCreateView(...) method.
CalligraphyConfig.Builder	disablePrivateFactoryInjection() Turn of the use of Reflection to inject the private factory.
CalligraphyConfig.Builder	setDefaultFontPath(java.lang.String defaultFontAssetPath) Set the default font if you don't define one else where in your styles.
CalligraphyConfig.Builder	setFontAttrId(int fontAssetAttrId) This defaults to R.attr.fontPath.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

INVALID_ATTR_ID

public static final int INVALID_ATTR_ID

Default AttrID if not set.

See Also:

Constant Field Values

Constructor Detail

Builder

public Builder()

Method Detail

setFontAttrId

public CalligraphyConfig.Builder setFontAttrId(int fontAssetAttrId)

This defaults to R.attr.fontPath. So only override if you want to use your own attrId.

Parameters:

fontAssetAttrId - the custom attribute to look for fonts in assets.

Returns:

this builder.

setDefaultFontPath

public CalligraphyConfig.Builder setDefaultFontPath(java.lang.String defaultFontAssetPath)

Set the default font if you don't define one else where in your styles.

Parameters:

defaultFontAssetPath - a path to a font file in the assets folder, e.g. "fonts/Roboto-light.ttf", passing null will default to the device font-family.

Returns:

this builder.

disablePrivateFactoryInjection

public CalligraphyConfig.Builder disablePrivateFactoryInjection()

Turn of the use of Reflection to inject the private factory. This has operational consequences! Please read and understand before disabling. This is already disabled on pre Honeycomb devices. (API 11)

If you disable this you will need to override your Activity.onCreateView(android.view.View, String, android.content.Context, android.util.AttributeSet) as this is set as the LayoutInflater private factory.

Use the following code in the Activity if you disable FactoryInjection:

  @Override
  @TargetApi(Build.VERSION_CODES.HONEYCOMB)
 public View onCreateView(View parent, String name, Context context, AttributeSet attrs) {
   return CalligraphyContextWrapper.onActivityCreateView(this, parent, super.onCreateView(parent, name, context, attrs), name, context, attrs);
 }
 

disableCustomViewInflation

public CalligraphyConfig.Builder disableCustomViewInflation()

Due to the poor inflation order where custom views are created and never returned inside an onCreateView(...) method. We have to create CustomView's at the latest point in the overrideable injection flow. On HoneyComb+ this is inside the Activity.onCreateView(android.view.View, String, android.content.Context, android.util.AttributeSet) Pre HoneyComb this is in the LayoutInflater.onCreateView(String, android.util.AttributeSet) We wrap base implementations, so if you LayoutInflater/Factory/Activity creates the custom view before we get to this point, your view is used. (Such is the case with the TintEditText etc) The problem is, the native methods pass there parents context to the constructor in a really specific place. We have to mimic this in CalligraphyLayoutInflater.createCustomViewInternal(android.view.View, android.view.View, String, android.content.Context, android.util.AttributeSet) To mimic this we have to use reflection as the Class constructor args are hidden to us. We have discussed other means of doing this but this is the only semi-clean way of doing it. (Without having to do proxy classes etc). Calling this will of course speed up inflation by turning off reflection, but not by much, But if you want Calligraphy to inject the correct typeface then you will need to make sure your CustomView's are created before reaching the LayoutInflater onViewCreated.

addCustomStyle

public CalligraphyConfig.Builder addCustomStyle(java.lang.Class<? extends android.widget.TextView> styleClass,
                                                int styleResourceAttribute)

Add a custom style to get looked up. If you use a custom class that has a parent style which is not part of the default android styles you will need to add it here. The Calligraphy inflater is unaware of custom styles in your custom classes. We use the class type to look up the style attribute in the theme resources. So if you had a MyTextField.class which looked up it's default style as R.attr.textFieldStyle you would add those here. builder.addCustomStyle(MyTextField.class,R.attr.textFieldStyle

Parameters:

styleClass - the class that related to the parent styleResource. null is ignored.

styleResourceAttribute - e.g. R.attr.textFieldStyle, 0 is ignored.

Returns:

this builder.

addCustomViewWithSetTypeface

public CalligraphyConfig.Builder addCustomViewWithSetTypeface(java.lang.Class<?> clazz)

Register custom non-TextView's which implement setTypeface so they can have the Typeface applied during inflation.

build

public CalligraphyConfig build()