EditingText

java.lang.Object
- ohos.miscservices.inputmethod.EditingText

所有已实现的接口:

Sequenceable
```
public class EditingText
extends Object
implements Sequenceable
```
Transfers all or updated text in the application editor to the input method.
The content to be transferred to the input method can be all or updated text in the application editor. If all texts are transferred, the input method only needs to display the text directly in its UI. If updated text are transferred, the input method needs to update the content displayed in its UI in accordance with the transferred text. This class ensures the content consistency between the application editor and the input method.

从以下版本开始:

3

SystemCapability

SystemCapability.Miscservices#INPUTMETHOD

嵌套类概要
- 从接口继承的嵌套类/接口 ohos.utils.Sequenceable
  Sequenceable.Producer<T>

字段概要

字段
限定符和类型	字段	说明
`static int`	`FLAG_SELECTING`	Indicates that the text are selected.
`static int`	`FLAG_SINGLE_LINE`	Indicates that the text can be edited only in a single line.

构造器概要

构造器
构造器说明

EditingText()

构造器
构造器	说明
`EditingText()`

方法概要

所有方法实例方法具体方法
限定符和类型	方法	说明
`int`	`getChangedEnd()`	Obtains the end index of the changed text in the content of the application editor.
`int`	`getChangedStart()`	Obtains the start index of the changed text in the content of the application editor.
`int`	`getFlags()`	Obtains the additional bit flags of the `EditingText#getTextContent()` text.
`int`	`getOffset()`	Obtains the start index of the `EditingText#getTextContent()` text in the content of the application editor.
`String`	`getPrompt()`	Obtains the default hint text displayed in the application editor.
`int`	`getSelectionEnd()`	Obtains the end index of the selected text in the `EditingText#getTextContent()` text.
`int`	`getSelectionStart()`	Obtains the start index of the selected text in the `EditingText#getTextContent()` text.
`String`	`getTextContent()`	Obtains all or updated text in the application editor.
`boolean`	`marshalling(Parcel out)`	Marshals this `Sequenceable` object into a `Parcel`.
`void`	`setChangedEnd(int changedEnd)`	Sets the end index of the changed text in the content of the application editor.
`void`	`setChangedStart(int changedStart)`	Sets the start index of the changed text in the content of the application editor.
`void`	`setFlags(int flags)`	Sets the additional bit flags of the `EditingText#getTextContent()` text.
`void`	`setOffset(int offset)`	Sets the start index of the `EditingText#getTextContent()` text in the content of the application editor.
`void`	`setPrompt(String prompt)`	Sets the default hint text displayed in the application editor.
`void`	`setSelectionEnd(int selectionEnd)`	Sets the end index of the selected text in the `EditingText#getTextContent()` text.
`void`	`setSelectionStart(int selectionStart)`	Sets the start index of the selected text in the `EditingText#getTextContent()` text.
`void`	`setTextContent(String textContent)`	Sets all or updated text in the application editor.
`boolean`	`unmarshalling(Parcel in)`	Unmarshals this `Sequenceable` object from a `Parcel`.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

从接口继承的方法 ohos.utils.Sequenceable
hasFileDescriptor

- 字段详细资料
  - FLAG_SELECTING
```
public static final int FLAG_SELECTING
```
    Indicates that the text are selected.
    
    另请参阅:
    
    常量字段值
  - FLAG_SINGLE_LINE
```
public static final int FLAG_SINGLE_LINE
```
    Indicates that the text can be edited only in a single line.
    
    另请参阅:
    
    常量字段值
- 构造器详细资料
  - EditingText
```
public EditingText()
```
- 方法详细资料
  - marshalling
```
public boolean marshalling(Parcel out)
```
    从接口复制的说明: Sequenceable
    
    Marshals this Sequenceable object into a Parcel.
    
    指定者:
    
    marshalling 在接口中 Sequenceable
    
    参数:
    
    out - Indicates the Parcel object to which the Sequenceable object will be marshaled..
    
    返回:
    
    Returns true if the marshalling is successful; returns false otherwise.
  - unmarshalling
```
public boolean unmarshalling(Parcel in)
```
    从接口复制的说明: Sequenceable
    
    Unmarshals this Sequenceable object from a Parcel.
    
    指定者:
    
    unmarshalling 在接口中 Sequenceable
    
    参数:
    
    in - Indicates the Parcel object into which the Sequenceable object has been marshaled.
    
    返回:
    
    Returns true if the unmarshalling is successful; returns false otherwise.
  - getTextContent
```
public String getTextContent()
```
    Obtains all or updated text in the application editor.
    
    返回:
    
    Returns all or updated text in the application editor.
    
    从以下版本开始:
    
    3
  - setTextContent
```
public void setTextContent(String textContent)
```
    Sets all or updated text in the application editor.
    
    参数:
    
    textContent - Indicates the text to transfer.
    
    从以下版本开始:
    
    3
  - getOffset
```
public int getOffset()
```
    Obtains the start index of the EditingText#getTextContent() text in the content of the application editor.
    
    返回:
    
    Returns the start index of the EditingText#getTextContent() text in the content of the application editor.
    
    从以下版本开始:
    
    3
  - setOffset
```
public void setOffset(int offset)
```
    Sets the start index of the EditingText#getTextContent() text in the content of the application editor.
    
    参数:
    
    offset - Indicates the start index to set for the EditingText#getTextContent() text. The value cannot be smaller than 0. If a value smaller than 0 is set, 0 is used. The default value is 0.
    
    从以下版本开始:
    
    3
  - getChangedStart
```
public int getChangedStart()
```
    Obtains the start index of the changed text in the content of the application editor.
    
    返回:
    
    Returns the start index of the changed text; returns -1 if all the text are changed.
    
    从以下版本开始:
    
    3
  - setChangedStart
```
public void setChangedStart(int changedStart)
```
    Sets the start index of the changed text in the content of the application editor.
    
    参数:
    
    changedStart - Indicates the start index to set for the changed text. Set this parameter to -1 if all the text are changed.
    
    从以下版本开始:
    
    3
  - getChangedEnd
```
public int getChangedEnd()
```
    Obtains the end index of the changed text in the content of the application editor.
    
    返回:
    
    Returns the end index of the changed text.
    
    从以下版本开始:
    
    3
  - setChangedEnd
```
public void setChangedEnd(int changedEnd)
```
    Sets the end index of the changed text in the content of the application editor.
    
    参数:
    
    changedEnd - Indicates the end index to set for the changed text.
    
    从以下版本开始:
    
    3
  - getSelectionStart
```
public int getSelectionStart()
```
    Obtains the start index of the selected text in the EditingText#getTextContent() text.
    The actual start index of the selected text in the application editor is the sum of the EditingText#getOffset() value and the return value of this method.
    
    返回:
    
    Returns the start index of the selected text in the EditingText#getTextContent() text.
    
    从以下版本开始:
    
    3
  - setSelectionStart
```
public void setSelectionStart(int selectionStart)
```
    Sets the start index of the selected text in the EditingText#getTextContent() text.
    
    参数:
    
    selectionStart - Indicates the start index to set for the selected text in the EditingText#getTextContent() text.
    
    从以下版本开始:
    
    3
  - getSelectionEnd
```
public int getSelectionEnd()
```
    Obtains the end index of the selected text in the EditingText#getTextContent() text.
    The actual end index of the selected text in the application editor is the sum of the the return value of EditingText#getOffset() and the return value of this method.
    
    返回:
    
    Returns the end index of the selected text in the EditingText#getTextContent() text.
    
    从以下版本开始:
    
    3
  - setSelectionEnd
```
public void setSelectionEnd(int selectionEnd)
```
    Sets the end index of the selected text in the EditingText#getTextContent() text.
    
    参数:
    
    selectionEnd - Indicates the end index to set for the selected texts in the EditingText#getTextContent() text.
    
    从以下版本开始:
    
    3
  - getFlags
```
public int getFlags()
```
    Obtains the additional bit flags of the EditingText#getTextContent() text.
    
    返回:
    
    Returns the additional bit flags of the EditingText#getTextContent() text.
    
    从以下版本开始:
    
    3
  - setFlags
```
public void setFlags(int flags)
```
    Sets the additional bit flags of the EditingText#getTextContent() text.
    
    参数:
    
    flags - Indicates the additional bit flags to set. The value is determined by the static member variables FLAG_SINGLE_LINE and FLAG_SELECTING in this class. When bit 0 of flags is 1, the current text can be edited only in a single line. When bit 1 of flags is 1, the current text enter the selection mode, which is possible only when the hardware keyboard is connected and the Shift key is latched.
    
    从以下版本开始:
    
    3
  - getPrompt
```
public String getPrompt()
```
    Obtains the default hint text displayed in the application editor.
    
    返回:
    
    Returns the default hint text.
    
    从以下版本开始:
    
    3
  - setPrompt
```
public void setPrompt(String prompt)
```
    Sets the default hint text displayed in the application editor.
    
    参数:
    
    prompt - Indicates the default hint text to set.
    
    从以下版本开始:
    
    3

类 EditingText

嵌套类概要

从接口继承的嵌套类/接口 ohos.utils.Sequenceable

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

从接口继承的方法 ohos.utils.Sequenceable

字段详细资料

FLAG_SELECTING

FLAG_SINGLE_LINE

构造器详细资料

EditingText

方法详细资料

marshalling

unmarshalling

getTextContent

setTextContent

getOffset

setOffset

getChangedStart

setChangedStart

getChangedEnd

setChangedEnd

getSelectionStart

setSelectionStart

getSelectionEnd

setSelectionEnd

getFlags

setFlags

getPrompt

setPrompt