com.facebook.react.views.textinput

Class ReactTextInputManager

java.lang.Object

com.facebook.react.uimanager.ViewManager<ReactEditText,com.facebook.react.views.textinput.ReactTextInputShadowNode>

com.facebook.react.views.textinput.ReactTextInputManager

public class ReactTextInputManager
extends ViewManager<ReactEditText,com.facebook.react.views.textinput.ReactTextInputShadowNode>

Manages instances of TextInput.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PROP_FONT_SIZE
static java.lang.String	PROP_TEST_ID
static java.lang.String	PROP_TEXT_ALIGN
static java.lang.String	PROP_TEXT_ALIGN_VERTICAL
static java.lang.String	PROP_TEXT_INPUT_AUTO_CAPITALIZE
static java.lang.String	PROP_TEXT_INPUT_AUTO_CORRECT
static java.lang.String	PROP_TEXT_INPUT_EDITABLE
static java.lang.String	PROP_TEXT_INPUT_HINT
static java.lang.String	PROP_TEXT_INPUT_HINT_COLOR
static java.lang.String	PROP_TEXT_INPUT_KEYBOARD_TYPE
static java.lang.String	PROP_TEXT_INPUT_MOST_RECENT_EVENT_COUNT
static java.lang.String	PROP_TEXT_INPUT_MULTILINE
static java.lang.String	PROP_TEXT_INPUT_NUMLINES
static java.lang.String	PROP_TEXT_INPUT_PASSWORD
static java.lang.String	PROP_TEXT_INPUT_TEXT
static java.lang.String	PROP_TEXT_INPUT_UNDERLINE_COLOR

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.
com.facebook.react.views.textinput.ReactTextInputShadowNode	createCSSNodeInstance() This method should return a subclass of CSSNode 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()
void	receiveCommand(ReactEditText reactEditText, int commandId, ReadableArray args) Subclasses may use this method to receive events/commands directly from JS through the UIManager.
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).
void	updateView(ReactEditText view, CatalystStylesDiffMap props) Subclass should use this method to populate native view with updated style properties.

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

createView, getExportedCustomDirectEventTypeConstants, getNativeProps, onAfterUpdateTransaction, onDropViewInstance, updateProperties

Methods inherited from class java.lang.Object

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

Field Detail

PROP_TEXT_INPUT_TEXT

public static final java.lang.String PROP_TEXT_INPUT_TEXT

See Also:

Constant Field Values

PROP_TEXT_INPUT_MOST_RECENT_EVENT_COUNT

public static final java.lang.String PROP_TEXT_INPUT_MOST_RECENT_EVENT_COUNT

See Also:

Constant Field Values

PROP_FONT_SIZE

public static final java.lang.String PROP_FONT_SIZE

See Also:

Constant Field Values

PROP_TEXT_INPUT_AUTO_CORRECT

public static final java.lang.String PROP_TEXT_INPUT_AUTO_CORRECT

See Also:

Constant Field Values

PROP_TEXT_INPUT_AUTO_CAPITALIZE

public static final java.lang.String PROP_TEXT_INPUT_AUTO_CAPITALIZE

See Also:

Constant Field Values

PROP_TEXT_ALIGN

public static final java.lang.String PROP_TEXT_ALIGN

See Also:

Constant Field Values

PROP_TEXT_ALIGN_VERTICAL

public static final java.lang.String PROP_TEXT_ALIGN_VERTICAL

See Also:

Constant Field Values

PROP_TEXT_INPUT_HINT

public static final java.lang.String PROP_TEXT_INPUT_HINT

See Also:

Constant Field Values

PROP_TEXT_INPUT_HINT_COLOR

public static final java.lang.String PROP_TEXT_INPUT_HINT_COLOR

See Also:

Constant Field Values

PROP_TEXT_INPUT_NUMLINES

public static final java.lang.String PROP_TEXT_INPUT_NUMLINES

See Also:

Constant Field Values

PROP_TEXT_INPUT_MULTILINE

public static final java.lang.String PROP_TEXT_INPUT_MULTILINE

See Also:

Constant Field Values

PROP_TEXT_INPUT_KEYBOARD_TYPE

public static final java.lang.String PROP_TEXT_INPUT_KEYBOARD_TYPE

See Also:

Constant Field Values

PROP_TEXT_INPUT_PASSWORD

public static final java.lang.String PROP_TEXT_INPUT_PASSWORD

See Also:

Constant Field Values

PROP_TEXT_INPUT_EDITABLE

public static final java.lang.String PROP_TEXT_INPUT_EDITABLE

See Also:

Constant Field Values

PROP_TEXT_INPUT_UNDERLINE_COLOR

public static final java.lang.String PROP_TEXT_INPUT_UNDERLINE_COLOR

See Also:

Constant Field Values

PROP_TEST_ID

public static final java.lang.String PROP_TEST_ID

See Also:

Constant Field Values

Constructor Detail

ReactTextInputManager

public ReactTextInputManager()

Method Detail

getName

public java.lang.String getName()

Specified by:

getName in class ViewManager<ReactEditText,com.facebook.react.views.textinput.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,com.facebook.react.views.textinput.ReactTextInputShadowNode>

createCSSNodeInstance

public com.facebook.react.views.textinput.ReactTextInputShadowNode createCSSNodeInstance()

Description copied from class: ViewManager

This method should return a subclass of CSSNode 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 CSSNode

Specified by:

createCSSNodeInstance in class ViewManager<ReactEditText,com.facebook.react.views.textinput.ReactTextInputShadowNode>

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,com.facebook.react.views.textinput.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,com.facebook.react.views.textinput.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,com.facebook.react.views.textinput.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,com.facebook.react.views.textinput.ReactTextInputShadowNode>

updateView

public void updateView(ReactEditText view,
              CatalystStylesDiffMap props)

Description copied from class: ViewManager

Subclass should use this method to populate native view with updated style properties. In case when a certain property is present in map but the value is null, this property should be reset to the default value TODO(krzysztof) This method should be replaced by updateProperties and removed completely after all view managers adapt @ReactProp

Overrides:

updateView in class ViewManager<ReactEditText,com.facebook.react.views.textinput.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,com.facebook.react.views.textinput.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,com.facebook.react.views.textinput.ReactTextInputShadowNode>