com.facebook.react.views.textinput

Class ReactTextInputManager

java.lang.Object

com.facebook.react.uimanager.ViewManager<T,C>

com.facebook.react.uimanager.BaseViewManager<ReactEditText,ReactTextInputShadowNode>

com.facebook.react.views.textinput.ReactTextInputManager

public class ReactTextInputManager
extends BaseViewManager<ReactEditText,ReactTextInputShadowNode>

Manages instances of TextInput.

Field Summary

Fields inherited from class com.facebook.react.uimanager.BaseViewManager

PROP_TEST_ID

Constructor Summary

Constructors

Constructor and Description
ReactTextInputManager()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addEventEmitters(ThemedReactContext reactContext, ReactEditText editText) Subclasses can override this method to install custom event emitters on the given View.
ReactTextInputShadowNode	createShadowNodeInstance() This method should return a subclass of ReactShadowNode which will be then used for measuring position and size of the view.
ReactEditText	createViewInstance(ThemedReactContext context) Subclasses should return a new View instance of the proper type.
java.util.Map<java.lang.String,java.lang.Integer>	getCommandsMap() Subclasses of ViewManager that expect to receive commands through UIManagerModule.dispatchViewManagerCommand(int, int, com.facebook.react.bridge.ReadableArray) should override this method returning the map between names of the commands and IDs that are then used in ViewManager.receiveCommand(T, int, com.facebook.react.bridge.ReadableArray) method whenever the command is dispatched for this particular ViewManager.
java.util.Map<java.lang.String,java.lang.Object>	getExportedCustomBubblingEventTypeConstants() Returns a map of config data passed to JS that defines eligible events that can be placed on native views.
java.util.Map	getExportedViewConstants() Returns a map of view-specific constants that are injected to JavaScript.
java.lang.String	getName()
java.lang.Class<ReactTextInputShadowNode>	getShadowNodeClass() This method should return Class instance that represent type of shadow node that this manager will return from ViewManager.createShadowNodeInstance().
protected void	onAfterUpdateTransaction(ReactEditText view) Callback that will be triggered after all properties are updated in current update transaction (all @ReactProp handlers for properties updated in current transaction have been called).
void	receiveCommand(ReactEditText reactEditText, int commandId, ReadableArray args) Subclasses may use this method to receive events/commands directly from JS through the UIManager.
void	setAutoCapitalize(ReactEditText view, int autoCapitalize)
void	setAutoCorrect(ReactEditText view, java.lang.Boolean autoCorrect)
void	setEditable(ReactEditText view, boolean editable)
void	setFontSize(ReactEditText view, float fontSize)
void	setKeyboardType(ReactEditText view, java.lang.String keyboardType)
void	setMaxLength(ReactEditText view, java.lang.Integer maxLength)
void	setMultiline(ReactEditText view, boolean multiline)
void	setNumLines(ReactEditText view, int numLines)
void	setOnSelectionChange(ReactEditText view, boolean onSelectionChange)
void	setPassword(ReactEditText view, boolean password)
void	setPlaceholder(ReactEditText view, java.lang.String placeholder)
void	setPlaceholderTextColor(ReactEditText view, java.lang.Integer color)
void	setSelectionColor(ReactEditText view, java.lang.Integer color)
void	setTextAlign(ReactEditText view, java.lang.String textAlign)
void	setTextAlignVertical(ReactEditText view, java.lang.String textAlignVertical)
void	setUnderlineColor(ReactEditText view, java.lang.Integer underlineColor)
void	updateExtraData(ReactEditText view, java.lang.Object extraData) Subclasses can implement this method to receive an optional extra data enqueued from the corresponding instance of ReactShadowNode in ReactShadowNode.onCollectExtraUpdates(com.facebook.react.uimanager.UIViewOperationQueue).

Methods inherited from class com.facebook.react.uimanager.BaseViewManager

setAccessibilityComponentType, setAccessibilityLabel, setAccessibilityLiveRegion, setBackgroundColor, setDecomposedMatrix, setElevation, setImportantForAccessibility, setOpacity, setRenderToHardwareTexture, setRotation, setScaleX, setScaleY, setTestId, setTranslateX, setTranslateY

Methods inherited from class com.facebook.react.uimanager.ViewManager

createView, getExportedCustomDirectEventTypeConstants, getNativeProps, onDropViewInstance, updateProperties

Methods inherited from class java.lang.Object

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

Constructor Detail

ReactTextInputManager

public ReactTextInputManager()

Method Detail

getName

public java.lang.String getName()

Specified by:

getName in class ViewManager<ReactEditText,ReactTextInputShadowNode>

Returns:

the name of this view manager. This will be the name used to reference this view manager from JavaScript in createReactNativeComponentClass.

createViewInstance

public ReactEditText createViewInstance(ThemedReactContext context)

Description copied from class: ViewManager

Subclasses should return a new View instance of the proper type.

Specified by:

createViewInstance in class ViewManager<ReactEditText,ReactTextInputShadowNode>

createShadowNodeInstance

public ReactTextInputShadowNode createShadowNodeInstance()

Description copied from class: ViewManager

This method should return a subclass of ReactShadowNode which will be then used for measuring position and size of the view. In mose of the cases this should just return an instance of ReactShadowNode

Specified by:

createShadowNodeInstance in class ViewManager<ReactEditText,ReactTextInputShadowNode>

getShadowNodeClass

public java.lang.Class<ReactTextInputShadowNode> getShadowNodeClass()

Description copied from class: ViewManager

This method should return Class instance that represent type of shadow node that this manager will return from ViewManager.createShadowNodeInstance(). This method will be used in the bridge initialization phase to collect properties exposed using ReactProp (or ReactPropGroup) annotation from the ReactShadowNode subclass specific for native view this manager provides.

Specified by:

getShadowNodeClass in class ViewManager<ReactEditText,ReactTextInputShadowNode>

Returns:

Class object that represents type of shadow node used by this view manager.

getExportedCustomBubblingEventTypeConstants

@Nullable
public java.util.Map<java.lang.String,java.lang.Object> getExportedCustomBubblingEventTypeConstants()

Description copied from class: ViewManager

Returns a map of config data passed to JS that defines eligible events that can be placed on native views. This should return bubbling directly-dispatched event types and specify what names should be used to subscribe to either form (bubbling/capturing). Returned map should be of the form: { "onTwirl": { "phasedRegistrationNames": { "bubbled": "onTwirl", "captured": "onTwirlCaptured" } } }

Overrides:

getExportedCustomBubblingEventTypeConstants in class ViewManager<ReactEditText,ReactTextInputShadowNode>

getCommandsMap

@Nullable
public java.util.Map<java.lang.String,java.lang.Integer> getCommandsMap()

Description copied from class: ViewManager

Subclasses of ViewManager that expect to receive commands through UIManagerModule.dispatchViewManagerCommand(int, int, com.facebook.react.bridge.ReadableArray) should override this method returning the map between names of the commands and IDs that are then used in ViewManager.receiveCommand(T, int, com.facebook.react.bridge.ReadableArray) method whenever the command is dispatched for this particular ViewManager. As an example we may consider ReactWebViewManager that expose the following commands: goBack, goForward, reload. In this case the map returned from ViewManager.getCommandsMap() from ReactWebViewManager will look as follows: { "goBack": 1, "goForward": 2, "reload": 3, } Now assuming that "reload" command is dispatched through UIManagerModule we trigger ReactWebViewManager#receiveCommand passing "3" as commandId argument.

Overrides:

getCommandsMap in class ViewManager<ReactEditText,ReactTextInputShadowNode>

Returns:

map of string to int mapping of the expected commands

receiveCommand

public void receiveCommand(ReactEditText reactEditText,
                  int commandId,
                  @Nullable
                  ReadableArray args)

Description copied from class: ViewManager

Subclasses may use this method to receive events/commands directly from JS through the UIManager. Good example of such a command would be scrollTo request with coordinates for a ScrollView or goBack request for a WebView instance.

Overrides:

receiveCommand in class ViewManager<ReactEditText,ReactTextInputShadowNode>

Parameters:

reactEditText - View instance that should receive the command

commandId - code of the command

args - optional arguments for the command

updateExtraData

public void updateExtraData(ReactEditText view,
                   java.lang.Object extraData)

Description copied from class: ViewManager

Subclasses can implement this method to receive an optional extra data enqueued from the corresponding instance of ReactShadowNode in ReactShadowNode.onCollectExtraUpdates(com.facebook.react.uimanager.UIViewOperationQueue). Since css layout step and ui updates can be executed in separate thread apart of setting x/y/width/height this is the recommended and thread-safe way of passing extra data from css node to the native view counterpart. TODO(7247021): Replace updateExtraData with generic update props mechanism after D2086999

Specified by:

updateExtraData in class ViewManager<ReactEditText,ReactTextInputShadowNode>

setFontSize

public void setFontSize(ReactEditText view,
               float fontSize)

setOnSelectionChange

public void setOnSelectionChange(ReactEditText view,
                        boolean onSelectionChange)

setPlaceholder

public void setPlaceholder(ReactEditText view,
                  @Nullable
                  java.lang.String placeholder)

setPlaceholderTextColor

public void setPlaceholderTextColor(ReactEditText view,
                           @Nullable
                           java.lang.Integer color)

setSelectionColor

public void setSelectionColor(ReactEditText view,
                     @Nullable
                     java.lang.Integer color)

setUnderlineColor

public void setUnderlineColor(ReactEditText view,
                     @Nullable
                     java.lang.Integer underlineColor)

setTextAlign

public void setTextAlign(ReactEditText view,
                @Nullable
                java.lang.String textAlign)

setTextAlignVertical

public void setTextAlignVertical(ReactEditText view,
                        @Nullable
                        java.lang.String textAlignVertical)

setEditable

public void setEditable(ReactEditText view,
               boolean editable)

setNumLines

public void setNumLines(ReactEditText view,
               int numLines)

setMaxLength

public void setMaxLength(ReactEditText view,
                @Nullable
                java.lang.Integer maxLength)

setAutoCorrect

public void setAutoCorrect(ReactEditText view,
                  @Nullable
                  java.lang.Boolean autoCorrect)

setMultiline

public void setMultiline(ReactEditText view,
                boolean multiline)

setPassword

public void setPassword(ReactEditText view,
               boolean password)

setAutoCapitalize

public void setAutoCapitalize(ReactEditText view,
                     int autoCapitalize)

setKeyboardType

public void setKeyboardType(ReactEditText view,
                   @Nullable
                   java.lang.String keyboardType)

onAfterUpdateTransaction

protected void onAfterUpdateTransaction(ReactEditText view)

Description copied from class: ViewManager

Callback that will be triggered after all properties are updated in current update transaction (all @ReactProp handlers for properties updated in current transaction have been called). If you want to override this method you should call super.onAfterUpdateTransaction from it as the parent class of the ViewManager may rely on callback being executed.

Overrides:

onAfterUpdateTransaction in class ViewManager<ReactEditText,ReactTextInputShadowNode>

addEventEmitters

protected void addEventEmitters(ThemedReactContext reactContext,
                    ReactEditText editText)

Description copied from class: ViewManager

Subclasses can override this method to install custom event emitters on the given View. You might want to override this method if your view needs to emit events besides basic touch events to JS (e.g. scroll events).

Overrides:

addEventEmitters in class ViewManager<ReactEditText,ReactTextInputShadowNode>

getExportedViewConstants

@Nullable
public java.util.Map getExportedViewConstants()

Description copied from class: ViewManager

Returns a map of view-specific constants that are injected to JavaScript. These constants are made accessible via UIManager..Constants.

Overrides:

getExportedViewConstants in class ViewManager<ReactEditText,ReactTextInputShadowNode>