diff --git a/reference/litho-core/com.facebook.litho.accessibility/content-description.html b/reference/litho-core/com.facebook.litho.accessibility/content-description.html index d524574e431..cfbc68c7310 100644 --- a/reference/litho-core/com.facebook.litho.accessibility/content-description.html +++ b/reference/litho-core/com.facebook.litho.accessibility/content-description.html @@ -63,7 +63,7 @@
A description of the contents of this Component for accessibility.
A description of the contents of this Component for accessibility.
Uses a stack trace to find the closest stack element inside a KComponent.render method.
Uses a stack trace to find the closest stack element inside a KComponent.render method.
Uses a stack trace to find the closest stack element inside a KComponent.render method.
Uses a stack trace to find the closest stack element inside a KComponent.render method.
Comparable Drawable allows drawables to be compared by explicitly implementing the Equivalence.isEquivalentTo. This allows drawables to be compared in a more meaningful way, instead of using Drawable.equals which only checks if the references are equal.
Comparable Drawable allows drawables to be compared by explicitly implementing the Equivalence.isEquivalentTo. This allows drawables to be compared in a more meaningful way, instead of using Drawable.equals which only checks if the references are equal.
Sets an alpha on the View this Component mounts to. Setting this property will cause the Component to be represented as a View at mount time if it wasn't going to already.
Sets an alpha on the View this Component mounts to. Setting this property will cause the Component to be represented as a View at mount time if it wasn't going to already.
Stop the previous animation and start a new one.
Stop the previous animation and start a new one.
Stop the previous animation and start a new one.
A reference to the previous animation. This will be changed to the new animation.
Stop the previous animation and start a new one.
A reference to the previous animation. This will be changed to the new animation.
Returns the Drawables associated with this ComponentHost for animations, for example the background Drawable and/or the drawable that otherwise has a transitionKey on it that has caused it to be hosted in this ComponentHost.
Returns the Drawables associated with this ComponentHost for animations, for example the background Drawable and/or the drawable that otherwise has a transitionKey on it that has caused it to be hosted in this ComponentHost.
This is a helper method to get all the text (as CharSequence) that is contained inside this ComponentHost.
This is a helper method to get all the text (as CharSequence) that is contained inside this ComponentHost.
This exception is to allow us to identify potential wrong modifications of a ComponentHost. This can happen if clients get access to them (e.g. onVisibility callbacks) and then perform modifications such as setting click listeners/modifying alpha. It is important to identify these situations since it can break other behaviors such as host recycling.
This exception is to allow us to identify potential wrong modifications of a ComponentHost. This can happen if clients get access to them (e.g. onVisibility callbacks) and then perform modifications such as setting click listeners/modifying alpha. It is important to identify these situations since it can break other behaviors such as host recycling.
Registers a callback to perform error handling for exceptions that might happen in child components down in the tree.
Registers a callback to perform error handling for exceptions that might happen in child components down in the tree.
a StateContainer with lazy state updates applied. This may be the same container passed in if there were no updates to apply. This method won't mutate the passed container.
a StateContainer with lazy state updates applied. This may be the same container passed in if there were no updates to apply. This method won't mutate the passed container.
String
This allows you to create an association of the ComponentTree with any identifier or sorts that enables you to trace the logs of this ComponentTree with the identifier.String
This allows you to create an association of the ComponentTree with any identifier or sorts that enables you to trace the logs of this ComponentTree with the identifier.Calculate the level of the target Component/Section. The level here means how many bracket pairs are needed to break until reaching the component type. For example, the level of List
Calculate the level of the target Component/Section. The level here means how many bracket pairs are needed to break until reaching the component type. For example, the level of List
Calculate the level of the target Component/Section. The level here means how many bracket pairs are needed to break until reaching the component type. For example, the level of List
the level of the target component, or 0 if the target isn't a component.
Calculate the level of the target Component/Section. The level here means how many bracket pairs are needed to break until reaching the component type. For example, the level of List
the level of the target component, or 0 if the target isn't a component.
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
the enum constant with the specified name
if this enum type has no constant with the specified name
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
the enum constant with the specified name
if this enum type has no constant with the specified name
Compares this component to a different one to check if they are the same
This is used to be able to skip rendering a component again. We avoid using the equals so we can optimize the code better over time since we don't have to adhere to the contract required for a equals method.
true if the components are of the same type and have the same props
the component to compare to
This method is retained in Component only to avoid breaking existing call sites. It'll be gradually removed over the next few iterations.
Note that the semantic of shouldCompoareCommonProps still makes sense in the context of SpecGeneratedComponents, so, this overload will continue to exist there indefinitely.
Compares this component to a different one to check if they are the same
This is used to be able to skip rendering a component again. We avoid using the equals so we can optimize the code better over time since we don't have to adhere to the contract required for a equals method.
true if the components are of the same type and have the same props
the component to compare to
This method is retained in Component only to avoid breaking existing call sites. It'll be gradually removed over the next few iterations.
Note that the semantic of shouldCompoareCommonProps still makes sense in the context of SpecGeneratedComponents, so, this overload will continue to exist there indefinitely.
Appends a compact description of a DebugComponent for debugging purposes.
The DebugComponent
The StringBuilder to which the description is appended
Offset of the parent component relative to litho view
Offset of the parent component relative to litho view
Whether the call is embedded in "adb dumpsys activity"
An interface for callsite to append extra description.
Appends a compact description of a DebugComponent for debugging purposes.
The DebugComponent
The StringBuilder to which the description is appended
Offset of the parent component relative to litho view
Offset of the parent component relative to litho view
Whether the call is embedded in "adb dumpsys activity"
An interface for callsite to append extra description.
An fun interface for callsite to append extra description into StringBuilder by given DebugComponent.
An fun interface for callsite to append extra description into StringBuilder by given DebugComponent.
Appends a compact description of a DebugComponent for debugging purposes.
Appends a compact description of a DebugComponent for debugging purposes.
DebugHierarchy provides a light(er) weight way to track and access information about the component parentage of a given com.facebook.rendercore.MountItem. For a given com.facebook.rendercore.MountItem, it provides access to a linked list of Class objects representing the class of the Component and each of it's hierarchy parents.
DebugHierarchy provides a light(er) weight way to track and access information about the component parentage of a given com.facebook.rendercore.MountItem. For a given com.facebook.rendercore.MountItem, it provides access to a linked list of Class objects representing the class of the Component and each of it's hierarchy parents.
A lightweight representation of a layout node, used to cache measurements between two Layout tree calculations.
A lightweight representation of a layout node, used to cache measurements between two Layout tree calculations.
This indicates the type of the Object that will be returned by mount.
This indicates the type of the Object that will be returned by mount.
{@inheritDoc}
{@inheritDoc}
{@inheritDoc}
In this implementation, postAtFront() is equivalent to post().
{@inheritDoc}
In this implementation, postAtFront() is equivalent to post().
This indicates the type of the Object that will be returned by mount.
This indicates the type of the Object that will be returned by mount.
Compares this component to a different one to check if they are the same
This is used to be able to skip rendering a component again. We avoid using the equals so we can optimize the code better over time since we don't have to adhere to the contract required for a equals method.
true if the components are of the same type and have the same props
the component to compare to
Compares this component to a different one to check if they are the same
This is used to be able to skip rendering a component again. We avoid using the equals so we can optimize the code better over time since we don't have to adhere to the contract required for a equals method.
true if the components are of the same type and have the same props
the component to compare to
Exception class used to add additional Litho metadata to a crash.
Exception class used to add additional Litho metadata to a crash.
Generic method to create a LithoRenderUnit.
Generic method to create a LithoRenderUnit.
Generic method to create a LithoRenderUnit.
Generic method to create a LithoRenderUnit.
The goal of this method is to add the optional mount binders to the associated to this LithoNode. If we are dealing with a Primitive, we will get the corresponding LithoNode and associate the binders map as optional mount binders. For this reason, this method should be called as soon as their RenderUnit is created. In Litho, this happens in the Resolve phase, specifically when the mount content preparation is invoked.
For MountSpecLithoRenderUnit (e.g., the node is associated with a MountSpec, or the Primitive mounts a Drawable and, therefore will need to be wrapped in a ComponentHost to work with the view binders), the addition of the optional mount binders is delayed until the moment of its creation. For that, we store these binders in the LithoNode and use them later.
The goal of this method is to add the optional mount binders to the associated to this LithoNode. If we are dealing with a Primitive, we will get the corresponding LithoNode and associate the binders map as optional mount binders. For this reason, this method should be called as soon as their RenderUnit is created. In Litho, this happens in the Resolve phase, specifically when the mount content preparation is invoked.
For MountSpecLithoRenderUnit (e.g., the node is associated with a MountSpec, or the Primitive mounts a Drawable and, therefore will need to be wrapped in a ComponentHost to work with the view binders), the addition of the optional mount binders is delayed until the moment of its creation. For that, we store these binders in the LithoNode and use them later.
Returns a nullable map of RenderUnit.DelegateBinder that is aimed to be used to set the optional mount binders right after creating a MountSpecLithoRenderUnit.
Returns a nullable map of RenderUnit.DelegateBinder that is aimed to be used to set the optional mount binders right after creating a MountSpecLithoRenderUnit.
The goal of this method is to add the optional mount binders to the associated to this LithoNode. If we are dealing with a Primitive, we will get the corresponding LithoNode and associate the binders map as optional mount binders. For this reason, this method should be called as soon as their RenderUnit is created. In Litho, this happens in the Resolve phase, specifically when the mount content preparation is invoked.
The goal of this method is to add the optional mount binders to the associated to this LithoNode. If we are dealing with a Primitive, we will get the corresponding LithoNode and associate the binders map as optional mount binders. For this reason, this method should be called as soon as their RenderUnit is created. In Litho, this happens in the Resolve phase, specifically when the mount content preparation is invoked.
Dispatch a visibility events to all the components hosted in this BaseMountingView.
Dispatch a visibility events to all the components hosted in this BaseMountingView.
LayoutParams that override the LayoutManager.
If you set LayoutParams on a LithoView that implements this interface, the view will completely ignore the layout specs given to it by its LayoutManager and use these specs instead. To use, set the LayoutParams height and width to WRAP_CONTENT and then provide a width and height measure spec though this interface.
This is helpful for implementing AT_MOST support since Android LayoutManagers don't support an AT_MOST concept as part of ViewGroup.LayoutParams's special values.
LayoutParams that override the LayoutManager.
If you set LayoutParams on a LithoView that implements this interface, the view will completely ignore the layout specs given to it by its LayoutManager and use these specs instead. To use, set the LayoutParams height and width to WRAP_CONTENT and then provide a width and height measure spec though this interface.
This is helpful for implementing AT_MOST support since Android LayoutManagers don't support an AT_MOST concept as part of ViewGroup.LayoutParams's special values.
For Litho we will use the root as hint for which is the hierarchy backed by the .
For Litho we will use the root as hint for which is the hierarchy backed by the .
Returns the Drawables associated with this ComponentHost for animations, for example the background Drawable and/or the drawable that otherwise has a transitionKey on it that has caused it to be hosted in this ComponentHost.
Returns the Drawables associated with this ComponentHost for animations, for example the background Drawable and/or the drawable that otherwise has a transitionKey on it that has caused it to be hosted in this ComponentHost.
This is a helper method to get all the text (as CharSequence) that is contained inside this ComponentHost.
This is a helper method to get all the text (as CharSequence) that is contained inside this ComponentHost.
Returns a nullable map of RenderUnit.DelegateBinder that is aimed to be used to set the optional mount binders right after creating a MountSpecLithoRenderUnit.
Returns a nullable map of RenderUnit.DelegateBinder that is aimed to be used to set the optional mount binders right after creating a MountSpecLithoRenderUnit.
The goal of this method is to add the optional mount binders to the associated to this LithoNode. If we are dealing with a Primitive, we will get the corresponding LithoNode and associate the binders map as optional mount binders. For this reason, this method should be called as soon as their RenderUnit is created. In Litho, this happens in the Resolve phase, specifically when the mount content preparation is invoked.
The goal of this method is to add the optional mount binders to the associated to this LithoNode. If we are dealing with a Primitive, we will get the corresponding LithoNode and associate the binders map as optional mount binders. For this reason, this method should be called as soon as their RenderUnit is created. In Litho, this happens in the Resolve phase, specifically when the mount content preparation is invoked.
Returns a nullable map of RenderUnit.DelegateBinder that is aimed to be used to set the optional mount binders right after creating a MountSpecLithoRenderUnit.
Returns a nullable map of RenderUnit.DelegateBinder that is aimed to be used to set the optional mount binders right after creating a MountSpecLithoRenderUnit.
The goal of this method is to add the optional mount binders to the associated to this LithoNode. If we are dealing with a Primitive, we will get the corresponding LithoNode and associate the binders map as optional mount binders. For this reason, this method should be called as soon as their RenderUnit is created. In Litho, this happens in the Resolve phase, specifically when the mount content preparation is invoked.
The goal of this method is to add the optional mount binders to the associated to this LithoNode. If we are dealing with a Primitive, we will get the corresponding LithoNode and associate the binders map as optional mount binders. For this reason, this method should be called as soon as their RenderUnit is created. In Litho, this happens in the Resolve phase, specifically when the mount content preparation is invoked.
Components should implement an event of this type in order to receive callbacks to onInitializeAccessibilityEvent
Components should implement an event of this type in order to receive callbacks to onInitializeAccessibilityEvent
Components should implement an event of this type in order to receive callbacks to onInitializeAccessibilityNodeInfo
Components should implement an event of this type in order to receive callbacks to onInitializeAccessibilityNodeInfo
Components should implement an event of this type in order to receive callbacks to onPopulateAccessibilityEvent
Components should implement an event of this type in order to receive callbacks to onPopulateAccessibilityEvent
Components should implement an event of this type in order to receive callbacks to onRequestSendAccessibilityEvent
Components should implement an event of this type in order to receive callbacks to onRequestSendAccessibilityEvent
Components should implement an event of this type in order to receive callbacks to performAccessibilityAction
Components should implement an event of this type in order to receive callbacks to performAccessibilityAction
Registers a callback to perform error handling for exceptions that might happen in child components down in the tree.
Registers a callback to perform error handling for exceptions that might happen in child components down in the tree.
This indicates the type of the Object that will be returned by mount.
This indicates the type of the Object that will be returned by mount.
Compares this component to a different one to check if they are the same
This is used to be able to skip rendering a component again. We avoid using the equals so we can optimize the code better over time since we don't have to adhere to the contract required for a equals method.
true if the components are of the same type and have the same props
the component to compare to
Compares this component to a different one to check if they are the same
This is used to be able to skip rendering a component again. We avoid using the equals so we can optimize the code better over time since we don't have to adhere to the contract required for a equals method.
true if the components are of the same type and have the same props
the component to compare to
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
the enum constant with the specified name
if this enum type has no constant with the specified name
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
the enum constant with the specified name
if this enum type has no constant with the specified name
Ports setAccessibilityHeading into components world. However, since the aforementioned ViewCompat's method is available only on API 19 and above, calling this method on lower APIs will have no effect. On the legit versions, on the other hand, calling this method will lead to the component being treated as a heading. The AccessibilityHeading property allows accessibility services to help users navigate directly from one heading to the next. See setHeading for more information.
Ports setAccessibilityHeading into components world. However, since the aforementioned ViewCompat's method is available only on API 19 and above, calling this method on lower APIs will have no effect. On the legit versions, on the other hand, calling this method will lead to the component being treated as a heading. The AccessibilityHeading property allows accessibility services to help users navigate directly from one heading to the next. See setHeading for more information.
Components should implement an event of this type in order to receive callbacks to sendAccessibilityEvent
Components should implement an event of this type in order to receive callbacks to sendAccessibilityEvent
Components should implement an event of this type in order to receive callbacks to sendAccessibilityEventUnchecked
Components should implement an event of this type in order to receive callbacks to sendAccessibilityEventUnchecked
Should only be used by logging to provide more readable messages.
Should only be used by logging to provide more readable messages.
Compares this component to a different one to check if they are the same
This is used to be able to skip rendering a component again. We avoid using the equals so we can optimize the code better over time since we don't have to adhere to the contract required for a equals method.
true if the components are of the same type and have the same props
the component to compare to
Compares this component to a different one to check if they are the same
This is used to be able to skip rendering a component again. We avoid using the equals so we can optimize the code better over time since we don't have to adhere to the contract required for a equals method.
true if the components are of the same type and have the same props
the component to compare to
Ports setAccessibilityHeading into components world. However, since the aforementioned ViewCompat's method is available only on API 19 and above, calling this method on lower APIs will have no effect. On the legit versions, on the other hand, calling this method will lead to the component being treated as a heading. The AccessibilityHeading property allows accessibility services to help users navigate directly from one heading to the next. See setHeading for more information.
Ports setAccessibilityHeading into components world. However, since the aforementioned ViewCompat's method is available only on API 19 and above, calling this method on lower APIs will have no effect. On the legit versions, on the other hand, calling this method will lead to the component being treated as a heading. The AccessibilityHeading property allows accessibility services to help users navigate directly from one heading to the next. See setHeading for more information.
This indicates the type of the Object that will be returned by mount.
This indicates the type of the Object that will be returned by mount.
Ports setAccessibilityHeading into components world. However, since the aforementioned ViewCompat's method is available only on API 19 and above, calling this method on lower APIs will have no effect. On the legit versions, on the other hand, calling this method will lead to the component being treated as a heading. The AccessibilityHeading property allows accessibility services to help users navigate directly from one heading to the next. See setHeading for more information.
Ports setAccessibilityHeading into components world. However, since the aforementioned ViewCompat's method is available only on API 19 and above, calling this method on lower APIs will have no effect. On the legit versions, on the other hand, calling this method will lead to the component being treated as a heading. The AccessibilityHeading property allows accessibility services to help users navigate directly from one heading to the next. See setHeading for more information.
Defines a single tree prop, i.e. a mapping from type to concrete instance of that type that is visible to the subtree, to be used with TreePropProvider.
Defines a single tree prop, i.e. a mapping from type to concrete instance of that type that is visible to the subtree, to be used with TreePropProvider.
DebugHierarchy provides a light(er) weight way to track and access information about the component parentage of a given com.facebook.rendercore.MountItem. For a given com.facebook.rendercore.MountItem, it provides access to a linked list of Class objects representing the class of the Component and each of it's hierarchy parents.
DebugHierarchy provides a light(er) weight way to track and access information about the component parentage of a given com.facebook.rendercore.MountItem. For a given com.facebook.rendercore.MountItem, it provides access to a linked list of Class objects representing the class of the Component and each of it's hierarchy parents.
A LithoHandler
implementation that runs all layout computations against the provided Executor
. This LithoHandler
can be used in apps that have a well established threading model and need to run layout against one of their already available executors.
A LithoHandler
implementation that runs all layout computations against the provided Executor
. This LithoHandler
can be used in apps that have a well established threading model and need to run layout against one of their already available executors.
Exception class used to add additional Litho metadata to a crash.
Exception class used to add additional Litho metadata to a crash.
MountExtension to ensure that content with nested LithoViews is properly clearing those LithoViews when the item is unmounted. Since this should only happen when unmounting an item and not when it's being updated, shouldUpdateItem is not overridden (defaulting to super implementation which returns false).
MountExtension to ensure that content with nested LithoViews is properly clearing those LithoViews when the item is unmounted. Since this should only happen when unmounting an item and not when it's being updated, shouldUpdateItem is not overridden (defaulting to super implementation which returns false).
ThreadTracingRunnable tries to help debugging crashes happening across threads showing the stacktrace of the crash origin which scheduled this runnable.
ThreadTracingRunnable tries to help debugging crashes happening across threads showing the stacktrace of the crash origin which scheduled this runnable.
Base class that wraps a FutureTask to allow calculating the same result across threads.
Base class that wraps a FutureTask to allow calculating the same result across threads.
Utility for preloading classes that should be loaded early but may not be accessible outside of Litho.
Utility for preloading classes that should be loaded early but may not be accessible outside of Litho.
Registers a callback to perform error handling for exceptions that might happen in child components down in the tree.
Registers a callback to perform error handling for exceptions that might happen in child components down in the tree.