com.facebook.litho.widget

Class EditText

java.lang.Object

com.facebook.litho.ComponentLifecycle

com.facebook.litho.Component

com.facebook.litho.widget.EditText

All Implemented Interfaces:

Equivalence<Component>, EventDispatcher, EventTriggerTarget, HasEventDispatcher, HasEventTrigger, Cloneable

Deprecated.

@Deprecated
public final class EditText
extends Component

This class is Deprecated and will not be supported. Use TextInput instead.

Component that renders an EditText.

See Also:

com.facebook.litho.widget.EditTextSpec

Optional Props

cursorDrawableRes

Drawable to set for the edit texts cursor.

Type:

int

editable

If set, allows the text to be editable.

Type:

boolean

editorActionListener

Special listener to be called when an action is performed

Type:

android.widget.TextView.OnEditorActionListener

ellipsize

If sets, specifies the position of the text to be ellispized.

Type:

android.text.TextUtils.TruncateAt

extraSpacing

Extra spacing between the lines of text.

Type:

float

gravity

Gravity for the text within its container.

Type:

int

highlightColor

The color to apply to highlights within the text.

Type:

int

hint

Hint text to display.

Type:

java.lang.CharSequence

hintColor

The color to apply to the hint text.

Type:

int

hintColorStateList

A {@link ColorStateList to use for the hint text}.

Type:

android.content.res.ColorStateList

imeOptions

Type of data in the text field, reported to an IME when it has focus.

Type:

int

initialText

Initial text to display. This only takes effect if the text prop is null. If set, the value is set on the EditText exactly once: on initial mount. From then on, the EditText's text property is not modified.

Type:

java.lang.CharSequence

inputFilters

Type:

java.util.List

inputType

Type of data being placed in a text field, used to help an input method decide how to let the user enter text.

Type:

int

isSingleLine

If set, makes the text to be rendered in a single line.

Type:

boolean

isSingleLineWrap

If set, single line text would warp and horizontal scroll would be disabled only works when isSingleLine is set.

Type:

boolean

linkColor

The color to apply to links within the text.

Type:

int

maxLength

Specifies the maximum number of characters to accept.

Type:

int

maxLines

Maximum number of lines to show.

Type:

int

minLines

Minimum number of lines to show.

Type:

int

rawInputType

Type of data being placed in a text field, used to help an input method decide how to let the user enter text. This prop will override inputType if both are provided.

Type:

int

requestFocus

If set, attempts to give focus.

Type:

boolean

selection

Moves the cursor to the selection index.

Type:

int

shadowColor

Color for the shadow underneath the text.

Type:

int

shadowDx

Horizontal offset of the shadow.

Type:

float

shadowDy

Vertical offset of the shadow.

Type:

float

shadowRadius

Blur radius of the shadow.

Type:

float

spacingMultiplier

Extra spacing between the lines of text, as a multiplier.

Type:

float

stateUpdatePolicy

A policy describing when and how internal state should be updated. This does violate encapsulation, but is essential for optimization, so costly state updates, which trigger relayout, happen only when is really needed.

Type:

com.facebook.litho.widget.EditTextStateUpdatePolicy

text

Text to display; changing this overrides and replaces the current text. Leave this as null to signal that the EditText's text property should be left untouched.

Type:

java.lang.CharSequence

textAlignment

Alignment of the text within its container.

Type:

android.text.Layout.Alignment

textColor

Color of the text.

Type:

int

textColorStateList

ColorStateList of the text.

Type:

android.content.res.ColorStateList

textSize

Size of the text.

Type:

int

textStyle

Style (bold, italic, bolditalic) for the text.

Type:

int

textWatchers

Type:

java.util.List

tintColorStateList

Type:

android.content.res.ColorStateList

typeface

Typeface for the text.

Type:

android.graphics.Typeface

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EditText.Builder Deprecated.

Nested classes/interfaces inherited from class com.facebook.litho.Component

Component.ContainerBuilder<T extends Component.ContainerBuilder<T>>

Nested classes/interfaces inherited from class com.facebook.litho.ComponentLifecycle

ComponentLifecycle.MountType, ComponentLifecycle.RenderData, ComponentLifecycle.TransitionContainer

Method Summary

Modifier and Type	Method and Description
Object	acceptTriggerEvent(EventTrigger eventTrigger, Object eventState, Object[] params) Deprecated.
protected boolean	canMeasure() Deprecated. Whether this ComponentLifecycle is able to measure itself according to specific size constraints.
protected boolean	canPreallocate() Deprecated.
static void	clearFocus(ComponentContext c, Handle handle) Deprecated.
static void	clearFocus(ComponentContext c, String key) Deprecated.
static void	clearFocus(EventTrigger trigger) Deprecated.
static EventTrigger	clearFocusTrigger(ComponentContext c, String key) Deprecated.
static EditText.Builder	create(ComponentContext context) Deprecated.
static EditText.Builder	create(ComponentContext context, int defStyleAttr, int defStyleRes) Deprecated.
protected void	createInitialState(ComponentContext c) Deprecated.
static EventHandler	getKeyUpEventHandler(ComponentContext context) Deprecated.
ComponentLifecycle.MountType	getMountType() Deprecated. This indicates the type of the Object that will be returned by ComponentLifecycle.mount(com.facebook.litho.ComponentContext, java.lang.Object).
static EventHandler	getSelectionChangedEventHandler(ComponentContext context) Deprecated.
static EventHandler	getSetTextEventHandler(ComponentContext context) Deprecated.
protected StateContainer	getStateContainer() Deprecated.
static EventHandler	getTextChangedEventHandler(ComponentContext context) Deprecated.
protected boolean	hasState() Deprecated.
boolean	isEquivalentTo(Component other) Deprecated. Compares this component to a different one to check if they are the same
boolean	isPureRender() Deprecated.
protected static void	lazyUpdateInput(ComponentContext c, CharSequence lazyUpdateValue) Deprecated.
EditText	makeShallowCopy() Deprecated.
protected void	onBind(ComponentContext c, Object editText) Deprecated.
protected Object	onCreateMountContent(Context c) Deprecated. Create the object that will be mounted in the LithoView.
protected void	onLoadStyle(ComponentContext c) Deprecated.
protected void	onMeasure(ComponentContext c, ComponentLayout layout, int widthSpec, int heightSpec, Size size) Deprecated.
protected void	onMount(ComponentContext c, Object editText) Deprecated. Deploy all UI elements representing the final bounds defined in the given ComponentLayout.
protected void	onUnbind(ComponentContext c, Object editText) Deprecated.
protected void	onUnmount(ComponentContext c, Object editText) Deprecated. Unload UI elements associated with this component.
protected int	poolSize() Deprecated.
void	recordEventTrigger(EventTriggersContainer container) Deprecated.
static void	requestFocus(ComponentContext c, Handle handle) Deprecated.
static void	requestFocus(ComponentContext c, String key) Deprecated.
static void	requestFocus(EventTrigger trigger) Deprecated.
static EventTrigger	requestFocusTrigger(ComponentContext c, String key) Deprecated.
static void	setText(ComponentContext c, Handle handle, CharSequence text) Deprecated.
static void	setText(ComponentContext c, String key, CharSequence text) Deprecated.
static void	setText(EventTrigger trigger, CharSequence text) Deprecated.
static EventTrigger	setTextTrigger(ComponentContext c, String key) Deprecated.
protected void	transferState(StateContainer _prevStateContainer, StateContainer _nextStateContainer) Deprecated. Call this to transfer the State annotated values between two Component with the same global scope.
protected static void	updateInput(ComponentContext c, CharSequence newInput) Deprecated.
protected static void	updateInputAsync(ComponentContext c, CharSequence newInput) Deprecated.
protected static void	updateInputSync(ComponentContext c, CharSequence newInput) Deprecated.

Methods inherited from class com.facebook.litho.Component

bindDynamicProp, canResolve, clearCachedLayout, copyInterStageImpl, getCommonProps, getDynamicProps, getEventDispatcher, getHandle, getId, getKey, getScopedContext, getSimpleName, getSimpleNameDelegate, hasBackgroundSet, hasClickHandlerSet, measure, measureMightNotCacheInternalNode, registerWorkingRange, retrieveValue, setScopedContext, updateInternalChildState, willRender

Methods inherited from class com.facebook.litho.ComponentLifecycle

applyPreviousRenderData, callsShouldUpdateOnMount, createMountContent, dispatchErrorEvent, dispatchErrorEvent, dispatchOnEnteredRange, dispatchOnEvent, dispatchOnExitedRange, getEventTrigger, getEventTrigger, getExtraAccessibilityNodeAt, getExtraAccessibilityNodesCount, getTreePropsForChildren, hasAttachDetachCallback, hasChildLithoViews, implementsAccessibility, implementsExtraAccessibilityNodes, isLayoutSpecWithSizeSpecCheck, isMountSizeDependent, needsPreviousRenderData, newEventHandler, newEventTrigger, onAttached, onBoundsDefined, onCreateLayout, onCreateLayoutWithSizeSpec, onCreateMountContentPool, onCreateTransition, onDetached, onError, onMeasureBaseline, onPopulateAccessibilityNode, onPopulateExtraAccessibilityNode, onPrepare, onShouldCreateLayoutWithNewSizeSpec, populateTreeProps, recordRenderData, resolve, shouldAlwaysRemeasure, shouldUpdate, shouldUseGlobalPool

Methods inherited from class java.lang.Object

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

Method Detail

getStateContainer

protected StateContainer getStateContainer()

Deprecated.

Overrides:

getStateContainer in class Component

isEquivalentTo

public boolean isEquivalentTo(Component other)

Deprecated.

Description copied from class: Component

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 Object.equals(Object) so we can optimize the code better over time since we don't have to adhere to the contract required for a equals method.

Specified by:

isEquivalentTo in interface Equivalence<Component>

Overrides:

isEquivalentTo in class Component

Parameters:

other - the component to compare to

Returns:

true if the components are of the same type and have the same props

makeShallowCopy

public EditText makeShallowCopy()

Deprecated.

Overrides:

makeShallowCopy in class Component

onLoadStyle

protected void onLoadStyle(ComponentContext c)

Deprecated.

Overrides:

onLoadStyle in class ComponentLifecycle

onMeasure

protected void onMeasure(ComponentContext c,
                         ComponentLayout layout,
                         int widthSpec,
                         int heightSpec,
                         Size size)

Deprecated.

Overrides:

onMeasure in class ComponentLifecycle

canMeasure

protected boolean canMeasure()

Deprecated.

Description copied from class: ComponentLifecycle

Whether this ComponentLifecycle is able to measure itself according to specific size constraints.

Overrides:

canMeasure in class ComponentLifecycle

onCreateMountContent

protected Object onCreateMountContent(Context c)

Deprecated.

Description copied from class: ComponentLifecycle

Create the object that will be mounted in the LithoView.

Overrides:

onCreateMountContent in class ComponentLifecycle

Parameters:

c - The Context to be used to create the content.

Returns:

an Object that can be mounted for this component.

onMount

protected void onMount(ComponentContext c,
                       Object editText)

Deprecated.

Description copied from class: ComponentLifecycle

Deploy all UI elements representing the final bounds defined in the given ComponentLayout. Return either a Drawable or a View or null to be mounted.

Overrides:

onMount in class ComponentLifecycle

Parameters:

c - The ComponentContext to mount the component into.

onBind

protected void onBind(ComponentContext c,
                      Object editText)

Deprecated.

Overrides:

onBind in class ComponentLifecycle

onUnbind

protected void onUnbind(ComponentContext c,
                        Object editText)

Deprecated.

Overrides:

onUnbind in class ComponentLifecycle

onUnmount

protected void onUnmount(ComponentContext c,
                         Object editText)

Deprecated.

Description copied from class: ComponentLifecycle

Unload UI elements associated with this component.

Overrides:

onUnmount in class ComponentLifecycle

Parameters:

c - The Context for this mount operation.

editText - The Drawable or View mounted by this component.

createInitialState

protected void createInitialState(ComponentContext c)

Deprecated.

Overrides:

createInitialState in class ComponentLifecycle

getMountType

public ComponentLifecycle.MountType getMountType()

Deprecated.

Description copied from class: ComponentLifecycle

This indicates the type of the Object that will be returned by ComponentLifecycle.mount(com.facebook.litho.ComponentContext, java.lang.Object).

Overrides:

getMountType in class ComponentLifecycle

Returns:

one of ComponentLifecycle.MountType

poolSize

protected int poolSize()

Deprecated.

Overrides:

poolSize in class ComponentLifecycle

canPreallocate

protected boolean canPreallocate()

Deprecated.

Overrides:

canPreallocate in class ComponentLifecycle

Returns:

true if this component can be preallocated.

isPureRender

public boolean isPureRender()

Deprecated.

Overrides:

isPureRender in class ComponentLifecycle

getTextChangedEventHandler

public static EventHandler getTextChangedEventHandler(ComponentContext context)

Deprecated.

getSelectionChangedEventHandler

public static EventHandler getSelectionChangedEventHandler(ComponentContext context)

Deprecated.

getKeyUpEventHandler

public static EventHandler getKeyUpEventHandler(ComponentContext context)

Deprecated.

getSetTextEventHandler

public static EventHandler getSetTextEventHandler(ComponentContext context)

Deprecated.

requestFocusTrigger

@Deprecated
public static EventTrigger requestFocusTrigger(ComponentContext c,
                                                           String key)

Deprecated.

clearFocusTrigger

@Deprecated
public static EventTrigger clearFocusTrigger(ComponentContext c,
                                                         String key)

Deprecated.

setTextTrigger

@Deprecated
public static EventTrigger setTextTrigger(ComponentContext c,
                                                      String key)

Deprecated.

requestFocus

public static void requestFocus(ComponentContext c,
                                Handle handle)

Deprecated.

requestFocus

public static void requestFocus(ComponentContext c,
                                String key)

Deprecated.

requestFocus

public static void requestFocus(EventTrigger trigger)

Deprecated.

clearFocus

public static void clearFocus(ComponentContext c,
                              Handle handle)

Deprecated.

clearFocus

public static void clearFocus(ComponentContext c,
                              String key)

Deprecated.

clearFocus

public static void clearFocus(EventTrigger trigger)

Deprecated.

setText

public static void setText(ComponentContext c,
                           Handle handle,
                           CharSequence text)

Deprecated.

setText

public static void setText(ComponentContext c,
                           String key,
                           CharSequence text)

Deprecated.

setText

public static void setText(EventTrigger trigger,
                           CharSequence text)

Deprecated.

acceptTriggerEvent

public Object acceptTriggerEvent(EventTrigger eventTrigger,
                                 Object eventState,
                                 Object[] params)

Deprecated.

Specified by:

acceptTriggerEvent in interface EventTriggerTarget

Overrides:

acceptTriggerEvent in class ComponentLifecycle

recordEventTrigger

public void recordEventTrigger(EventTriggersContainer container)

Deprecated.

Specified by:

recordEventTrigger in interface HasEventTrigger

Overrides:

recordEventTrigger in class Component

hasState

protected boolean hasState()

Deprecated.

Overrides:

hasState in class ComponentLifecycle

Returns:

true if the Component is using state, false otherwise.

transferState

protected void transferState(StateContainer _prevStateContainer,
                             StateContainer _nextStateContainer)

Deprecated.

Description copied from class: ComponentLifecycle

Call this to transfer the State annotated values between two Component with the same global scope.

Overrides:

transferState in class ComponentLifecycle

updateInput

protected static void updateInput(ComponentContext c,
                                  CharSequence newInput)

Deprecated.

updateInputAsync

protected static void updateInputAsync(ComponentContext c,
                                       CharSequence newInput)

Deprecated.

updateInputSync

protected static void updateInputSync(ComponentContext c,
                                      CharSequence newInput)

Deprecated.

lazyUpdateInput

protected static void lazyUpdateInput(ComponentContext c,
                                      CharSequence lazyUpdateValue)

Deprecated.

create

public static EditText.Builder create(ComponentContext context)

Deprecated.

create

public static EditText.Builder create(ComponentContext context,
                                      int defStyleAttr,
                                      int defStyleRes)

Deprecated.