Package com.facebook.litho.annotations

Enum Summary

Enum	Description
MountingType
ResType	This enum's constants are used to mark that Prop can receive resources of a corresponding Android resource type as values.

Annotation Types Summary

Annotation Type	Description
CachedValue	Annotates a parameter to a component's spec method indicating that it will be supplied as a cached value.
Comparable	Annotates a parameter (Prop, TreeProp or State) indicating what kind of equivalence should be used in the "isEquivalentTo" call.
Comparable.Type
Event
FromBoundsDefined	FromBoundsDefined is used to pass objects from the OnBoundsDefined lifecycle methods of MountSpec to lifecycle methods called successively such as OnMount or OnBind method, use FromBoundsDefined with the same type and name to retrieve your previously set
FromEvent	Annotates a parameter to a component's event handler callback method indicating that it will be supplied by the event object.
FromMeasure	Annotates that the argument's value should be set to the named inter-stage output from the OnMeasure lifecycle method.
FromMeasureBaseline
FromPrepare	FromPrepare is used to pass objects from the OnPrepare lifecycle methods of MountSpec to lifecycle methods called successively such as OnMount or OnBind method, use FromPrepare with the same type and name to retrieve your previously set
FromTrigger	Parameters declared in a class annotated with Event that are used in OnTrigger
Generated
GetExtraAccessibilityNodeAt
GetExtraAccessibilityNodesCount
ImportantForAccessibility
InjectProp	Annotates a parameter of a component's spec method indicating that the parameter will be automatically supplied via dependency injection.
OnAttached	A method annotated with this annotation is called when the component is attached to the ComponentTree.
OnBind	A method annotation used in classes that are annotated with MountSpec.
OnBindDynamicValue	EXPERIMENTAL.
OnBoundsDefined
OnCalculateCachedValue	Annotation for a method on a component's spec that indicates that the method is used to calculate a value that is cached by the component, and may be access in methods using CachedValue.
OnCreateInitialState	This annotation is used in a LayoutSpec; the framework calls the method annotated with OnCreateInitialState before resolving its layout, i.e.
OnCreateLayout	This annotation is used in conjugation with LayoutSpec.
OnCreateMountContent	The method annotated with this annotation will be called to instantiate the mount content for the MountSpec, when the pool of objects corresponding to this mount content type is empty and recycling is not possible.
OnCreateMountContentPool	The annotated method will be called to create a custom MountContentPool for this mount spec.
OnCreateTransition	Annotation for a method that specifies how to animate this component to its new layout and props.
OnCreateTreeProp	An annotation for a Spec method that generates tree props.
OnDetached	A method annotated with this annotation is called when the component is detached from the ComponentTree.
OnEnteredRange	Annotated function in the component will allow it be called when entering a working range.
OnError	Annotate a method inside your component with @OnError to receive a callback when an exception inside supported delegate methods of a child component happens.
OnEvent	Annotation for event handling.
OnExitedRange	Annotated function in the component will allow it be called when exiting a working range.
OnLoadStyle
OnMeasure	A method annotation used in classes that are annotated with MountSpec.
OnMeasureBaseline	A method that is annotated with this annotation will be used to compute the baseline of your component.
OnMount	A method annotated with OnMount is called on a MountSpec component before the component is attached to a hosting view.
OnPopulateAccessibilityNode
OnPopulateExtraAccessibilityNode
OnPrepare	A MountSpec can define a method annotated with OnPrepare to run code that is more heavy and cannot be done during OnMount or OnBind.
OnRegisterRanges	The method annotated with this annotation will be called to register working ranges for the LayoutSpec.
OnTrigger	Annotated function in the component will allow its parents to call it with an EventTrigger.
OnUnbind	A method annotation used in classes that are annotated with MountSpec.
OnUnmount
OnUpdateState	Used to mark a method that can update the state of a Component.
OnUpdateStateWithTransition	Used to mark a method that can update the state of a Component and trigger Transition returned from this method.
Param	Params can be used together with Event callbacks i.e.
Prop	Inputs to a Component are its props.
PropDefault	PropDefault can be used for setting the default value of an optional Prop in a LayoutSpec or MountSpec.
PropSetter	Indicates that a method implementation sets Prop.
RequiredProp	Indicates that a method implementation sets required Prop.
ShouldAlwaysRemeasure	Annotated function in the component will allow it always be measured when receiving a remeasure event no matter the SizeSpecs are changed or not.
ShouldExcludeFromIncrementalMount	Annotated function in the component will inform the framework that if this particular instance of the component should be excluded from Incremental Mount.
ShouldUpdate
State	States for a given Component are the union of all arguments annotated with State in the spec.
TreeProp	A prop passed silently down from a Spec's parents.