com.facebook.litho.annotations

Annotation Type MountSpec

@Retention(value=RUNTIME)
public @interface MountSpec

A class that is annotated with this annotation will be used to create a component that renders something, in the form of either a Drawable or a View.

A class that is annotated with MountSpec must implement a method with the OnCreateMountContent annotation. It may also implement methods with the following annotations: - OnLoadStyle - OnEvent - OnPrepare - OnMeasure - OnBoundsDefined - OnMount - OnBind - OnUnbind - OnUnmount

If you wish to create a component that is a composition of other components, then use LayoutSpec instead.

For example: @MountSpec public class MyComponentSpec { @OnCreateMountContent MyDrawable onCreateMountContent(ComponentContext c) { return new MyDrawable(c); } @OnMount void onMount( ComponentContext context, MyDrawable myDrawable, @Prop MyProp prop) { myDrawable.setMyProp(prop); } }

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	canMountIncrementally
java.lang.Class<?>[]	events
boolean	isPublic
boolean	isPureRender
int	poolSize
boolean	shouldUseDisplayList
java.lang.Class<?>[]	triggers
java.lang.String	value

Element Detail

value

public abstract java.lang.String value

Default:

""

isPublic

public abstract boolean isPublic

Returns:

Boolean indicating whether the generated class should be public. If not, it will be package-private.

Default:

true

isPureRender

public abstract boolean isPureRender

Returns:

Boolean indicating whether the component implements a pure render function. If this is true and the Component didn't change during an update of the ComponentTree measurements and LayoutOutputs will be reused instead of being calculated again.

Default:

false

canMountIncrementally

public abstract boolean canMountIncrementally

Returns:

Boolean indicating whether this mount spec supports incremental mount. This is only applicable to MountSpecs which mount a View which is or contains a LithoView.

Default:

false

events

public abstract java.lang.Class<?>[] events

Returns:

List of event POJOs this component can dispatch. Used to generate event dispatch methods.

Default:

{}

shouldUseDisplayList

public abstract boolean shouldUseDisplayList

Returns:

Boolean indicating whether this drawable mount spec should cache its drawing in a display list.

Default:

false

poolSize

public abstract int poolSize

Returns:

The max number of preallocated Mount objects we want to keep in the pools for this type of MountSpec

Default:

15

triggers

public abstract java.lang.Class<?>[] triggers

Returns:

List of trigger POJOs this component can dispatch. Used to generate trigger creation methods.

Default:

{}