程序包 ohos.miscservices.inputmethod

类 EditorAttribute

java.lang.Object

ohos.miscservices.inputmethod.EditorAttribute

所有已实现的接口:

Sequenceable

public class EditorAttribute
extends Object
implements Sequenceable

Describes attributes of the text box associated with the input method.

从以下版本开始:

4

SystemCapability

SystemCapability.Miscservices#INPUTMETHOD

嵌套类概要

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

Sequenceable.Producer<T>

字段概要

字段

限定符和类型	字段	说明
static int	ENTER_KEY_TYPE_DONE	Indicates that there is no more context to enter and the input method engine will be closed.
static int	ENTER_KEY_TYPE_GO	Indicates that the content entered in the text box will be searched.
static int	ENTER_KEY_TYPE_NEXT	Indicates that the next text box will be used.
static int	ENTER_KEY_TYPE_PREVIOUS	Indicates that the previous text box will be used.
static int	ENTER_KEY_TYPE_SEARCH	Indicates that a user will be redirected to the address entered in the text box.
static int	ENTER_KEY_TYPE_SEND	Indicates that the content entered in text box will be sent.
static int	ENTER_KEY_TYPE_UNSPECIFIED	Indicates that no action is specified.
static int	OPTION_ASCII	Indicates that ASCII codes can be entered.
static int	OPTION_AUTO_CAP_CHARACTERS	Indicates all caps, for example, "THIS IS THE ALL CAPS STYLE".
static int	OPTION_AUTO_CAP_SENTENCES	Indicates the sentence case, for example, "This is the sentence case style".
static int	OPTION_AUTO_CAP_WORDS	Indicates the title case, for example, "This Is The Title Case Style".
static int	OPTION_MULTI_LINE	Indicates that the text can be displayed in multiple lines.
static int	OPTION_NO_FULLSCREEN	Indicates that the full-screen mode is not supported.
static int	OPTION_NONE	Indicates that there is no specific attribute about the text box action.
static int	PATTERN_DATETIME	Indicates the text box of date and time.
static int	PATTERN_EMAIL	Indicates the plain text box for email addresses.
static int	PATTERN_NULL	Indicates that the text box does not belong to any category.
static int	PATTERN_NUMBER	Indicates the text box of numerics.
static int	PATTERN_PASSWORD	Indicates the plain text box for passwords.
static int	PATTERN_PHONE	Indicates the text box of phone numbers.
static int	PATTERN_TEXT	Indicates the text box of plain texts.
static int	PATTERN_URI	Indicates the plain text box for URIs.

构造器概要

构造器

构造器	说明
EditorAttribute()

方法概要

限定符和类型	方法	说明
int	getEnterKeyType()	Obtains the key type of the text box.
int	getInputOption()	Obtains the text box action.
int	getInputPattern()	Obtains the input pattern of the text box.
boolean	marshalling(Parcel out)	Marshals this Sequenceable object into a Parcel.
void	setEnterKeyType(int type)	Sets a key type of the text box.
void	setInputOption(int option)	Sets the text box action.
void	setInputPattern(int pattern)	Sets an input pattern of the text box.
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

字段详细资料

ENTER_KEY_TYPE_DONE

public static final int ENTER_KEY_TYPE_DONE

Indicates that there is no more context to enter and the input method engine will be closed.

另请参阅:

常量字段值

ENTER_KEY_TYPE_GO

public static final int ENTER_KEY_TYPE_GO

Indicates that the content entered in the text box will be searched. This action is usually used for browser-based search.

另请参阅:

常量字段值

ENTER_KEY_TYPE_NEXT

public static final int ENTER_KEY_TYPE_NEXT

Indicates that the next text box will be used. This action is usually used for a scenario supporting multiple text boxes.

另请参阅:

常量字段值

ENTER_KEY_TYPE_PREVIOUS

public static final int ENTER_KEY_TYPE_PREVIOUS

Indicates that the previous text box will be used.

另请参阅:

常量字段值

ENTER_KEY_TYPE_SEARCH

public static final int ENTER_KEY_TYPE_SEARCH

Indicates that a user will be redirected to the address entered in the text box. This action is usually used when a user enters a URL.

另请参阅:

常量字段值

ENTER_KEY_TYPE_SEND

public static final int ENTER_KEY_TYPE_SEND

Indicates that the content entered in text box will be sent. This action is usually used for a chat application.

另请参阅:

常量字段值

ENTER_KEY_TYPE_UNSPECIFIED

public static final int ENTER_KEY_TYPE_UNSPECIFIED

Indicates that no action is specified.

另请参阅:

常量字段值

OPTION_ASCII

public static final int OPTION_ASCII

Indicates that ASCII codes can be entered.

另请参阅:

常量字段值

OPTION_AUTO_CAP_CHARACTERS

public static final int OPTION_AUTO_CAP_CHARACTERS

Indicates all caps, for example, "THIS IS THE ALL CAPS STYLE".

另请参阅:

常量字段值

OPTION_AUTO_CAP_SENTENCES

public static final int OPTION_AUTO_CAP_SENTENCES

Indicates the sentence case, for example, "This is the sentence case style".

另请参阅:

常量字段值

OPTION_AUTO_CAP_WORDS

public static final int OPTION_AUTO_CAP_WORDS

Indicates the title case, for example, "This Is The Title Case Style".

另请参阅:

常量字段值

OPTION_MULTI_LINE

public static final int OPTION_MULTI_LINE

Indicates that the text can be displayed in multiple lines.

另请参阅:

常量字段值

OPTION_NONE

public static final int OPTION_NONE

Indicates that there is no specific attribute about the text box action.

另请参阅:

常量字段值

OPTION_NO_FULLSCREEN

public static final int OPTION_NO_FULLSCREEN

Indicates that the full-screen mode is not supported.

另请参阅:

常量字段值

PATTERN_DATETIME

public static final int PATTERN_DATETIME

Indicates the text box of date and time.

另请参阅:

常量字段值

PATTERN_EMAIL

public static final int PATTERN_EMAIL

Indicates the plain text box for email addresses.

另请参阅:

常量字段值

PATTERN_NULL

public static final int PATTERN_NULL

Indicates that the text box does not belong to any category.

另请参阅:

常量字段值

PATTERN_NUMBER

public static final int PATTERN_NUMBER

Indicates the text box of numerics.

另请参阅:

常量字段值

PATTERN_PASSWORD

public static final int PATTERN_PASSWORD

Indicates the plain text box for passwords.

另请参阅:

常量字段值

PATTERN_PHONE

public static final int PATTERN_PHONE

Indicates the text box of phone numbers.

另请参阅:

常量字段值

PATTERN_TEXT

public static final int PATTERN_TEXT

Indicates the text box of plain texts.

另请参阅:

常量字段值

PATTERN_URI

public static final int PATTERN_URI

Indicates the plain text box for URIs.

另请参阅:

常量字段值

构造器详细资料

EditorAttribute

public EditorAttribute()

方法详细资料

getInputPattern

public int getInputPattern()

Obtains the input pattern of the text box.

返回:

the inputPattern.

从以下版本开始:

4

setInputPattern

public void setInputPattern(int pattern)

Sets an input pattern of the text box.

参数:

pattern - Indicates the input pattern to set. Available options are as follows: EditorAttribute#PATTERN_NULL EditorAttribute#PATTERN_TEXT EditorAttribute#PATTERN_NUMBER EditorAttribute#PATTERN_PHONE EditorAttribute#PATTERN_DATETIME EditorAttribute#PATTERN_URI EditorAttribute#PATTERN_EMAIL, EditorAttribute#PATTERN_PASSWORD.

从以下版本开始:

4

getEnterKeyType

public int getEnterKeyType()

Obtains the key type of the text box.

返回:

the key type.

从以下版本开始:

4

setEnterKeyType

public void setEnterKeyType(int type)

Sets a key type of the text box.

参数:

type - Indicates the key type to set. For example, to search after pressing the Enter key, set this parameter to EditorAttribute#ENTER_KEY_TYPE_SEARCH. Available options are as follows: EditorAttribute#ENTER_KEY_TYPE_UNSPECIFIED EditorAttribute#ENTER_KEY_TYPE_SEARCH EditorAttribute#ENTER_KEY_TYPE_GO EditorAttribute#ENTER_KEY_TYPE_SEND EditorAttribute#ENTER_KEY_TYPE_DONE EditorAttribute#ENTER_KEY_TYPE_NEXT EditorAttribute#ENTER_KEY_TYPE_PREVIOUS.

从以下版本开始:

4

setInputOption

public void setInputOption(int option)

Sets the text box action.

参数:

option - Indicates the information about the text box action to set. The value can be any of the following constants or the bitwise inclusive OR result of any two of the following constants: EditorAttribute#OPTION_NONE EditorAttribute#OPTION_MULTI_LINE EditorAttribute#OPTION_AUTO_CAP_CHARACTERS EditorAttribute#OPTION_AUTO_CAP_WORDS EditorAttribute#OPTION_AUTO_CAP_SENTENCES EditorAttribute#OPTION_NO_FULLSCREEN EditorAttribute#OPTION_ASCII For example, EditorAttribute#OPTION_NONE | EditorAttribute#OPTION_MULTI_LINE.

从以下版本开始:

4

getInputOption

public int getInputOption()

Obtains the text box action.

返回:

Returns the action.

从以下版本开始:

4

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.