程序包 ohos.global.resource

类 Element

java.lang.Object

ohos.global.resource.Element

public abstract class Element
extends Object

Provides methods for obtaining an Element based on its resource ID.

You can call a specific method of this class to obtain the resource of the specified type associated with the resource ID.

从以下版本开始:

3

构造器概要

构造器

构造器	说明
Element()

方法概要

限定符和类型	方法	说明
abstract boolean	getBoolean()	Obtains a boolean value based on this Element.
abstract int	getColor()	Obtains a color value based on this Element.
abstract String	getConfig()	Gets a config according to a resource ID.
abstract float	getFloat()	Obtains a float value based on this Element.
abstract int[]	getIntArray()	Obtains an integer array based on this Element.
abstract int	getInteger()	Obtains an integer value based on this Element.
abstract Pattern	getPattern()	Obtains a ohos.global.resource.solidxml.Pattern instance associated with this Element.
abstract String	getPluralString(int quantity)	Obtains the string representation of plural rules associated with this Element based on the given quantity.
abstract String	getPluralString(int quantity, Object... formatArgs)	Obtains the string representation of plural rules associated with this Element based on the given quantity, and formats the string based on the specified formatted objects.
abstract String	getString()	Obtains a string value based on this Element.
abstract String	getString(Object... formatArgs)	Obtains the string associated with this Element and formats the string based on the specified formatted objects.
abstract String	getString(Object[] object, Format[] format)	Obtains the string associated with this Element and formats the string based on the specified format array and object array.
abstract String	getString(Object object, Format format)	Obtains the string associated with this Element and formats the string based on the specified format and object.
abstract String[]	getStringArray()	Obtains a string array based on this Element.
abstract Theme	getTheme()	Obtains a Theme instance associated with this Element.

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

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

构造器详细资料

Element

public Element()

方法详细资料

getString

public abstract String getString()
                          throws IOException,
                                 NotExistException,
                                 WrongTypeException

Obtains a string value based on this Element.

返回:

Returns the string value.

抛出:

NotExistException - Throws this exception if the resource ID does not match any resources. The resource ID must be automatically generated by the IDE or resource tool, or provided by the system.

IOException - Throws this exception if an I/O error occurs during resource read.

WrongTypeException - Throws this exception if the resource is not of the string type.

从以下版本开始:

3

getString

public abstract String getString(Object... formatArgs)
                          throws IOException,
                                 NotExistException,
                                 WrongTypeException

Obtains the string associated with this Element and formats the string based on the specified formatted objects.

参数:

formatArgs - Indicates the formatted objects used for substitution.

返回:

Returns the formatted string.

抛出:

NotExistException - Throws this exception if the resource ID does not match any resources. The resource ID must be automatically generated by the IDE or resource tool, or provided by the system.

IOException - Throws this exception if an I/O error occurs during resource read.

WrongTypeException - Throws this exception if the resource is not of the string type.

从以下版本开始:

3

getString

public abstract String getString(Object object,
                                 Format format)
                          throws IOException,
                                 NotExistException,
                                 WrongTypeException

Obtains the string associated with this Element and formats the string based on the specified format and object.

参数:

object - Indicates the object used for substitution.

format - Indicates the format used for formatting the object.

返回:

Returns the formatted string.

抛出:

NotExistException - Throws this exception if the resource ID does not match any resources. The resource ID must be automatically generated by the IDE or resource tool, or provided by the system.

IOException - Throws this exception if an I/O error occurs during resource read.

WrongTypeException - Throws this exception if the resource is not of the string type.

从以下版本开始:

3

getString

public abstract String getString(Object[] object,
                                 Format[] format)
                          throws IOException,
                                 NotExistException,
                                 WrongTypeException

Obtains the string associated with this Element and formats the string based on the specified format array and object array.

参数:

object - Indicates the array of objects used for substitution.

format - Indicates the array of formats used for formatting the object array. Formats and objects are in one-to-one mapping.

返回:

Returns the formatted string.

抛出:

NotExistException - Throws this exception if the resource ID does not match any resources. The resource ID must be automatically generated by the IDE or resource tool, or provided by the system.

IOException - Throws this exception if an I/O error occurs during resource read.

WrongTypeException - Throws this exception if the resource is not of the string type.

从以下版本开始:

3

getBoolean

public abstract boolean getBoolean()
                            throws IOException,
                                   NotExistException,
                                   WrongTypeException

Obtains a boolean value based on this Element.

返回:

Returns the boolean value.

抛出:

NotExistException - Throws this exception if the resource ID does not match any resources. The resource ID must be automatically generated by the IDE or resource tool, or provided by the system.

IOException - Throws this exception if an I/O error occurs during resource read.

WrongTypeException - Throws this exception if the resource is not of the boolean type.

从以下版本开始:

3

getColor

public abstract int getColor()
                      throws IOException,
                             NotExistException,
                             WrongTypeException

Obtains a color value based on this Element.

返回:

Returns an integer reference value representing the color data.

抛出:

NotExistException - Throws this exception if the resource ID does not match any resources. The resource ID must be automatically generated by the IDE or resource tool, or provided by the system.

IOException - Throws this exception if an I/O error occurs during resource read.

WrongTypeException - Throws this exception if the resource is not of the color type.

从以下版本开始:

3

getFloat

public abstract float getFloat()
                        throws IOException,
                               NotExistException,
                               WrongTypeException

Obtains a float value based on this Element.

返回:

Returns a float reference value representing the dimension data.

抛出:

NotExistException - Throws this exception if the resource ID does not match any resources. The resource ID must be automatically generated by the IDE or resource tool, or provided by the system.

IOException - Throws this exception if an I/O error occurs during resource read.

WrongTypeException - Throws this exception if the resource is not of the float type.

从以下版本开始:

3

getConfig

public abstract String getConfig()
                          throws IOException,
                                 NotExistException,
                                 WrongTypeException

Gets a config according to a resource ID.

返回:

Returns a config.

抛出:

NotExistException - Throws this exception if the resource ID does not match any resources. The resource ID must be automatically generated by the IDE or resource tool, or provided by the system.

IOException - Throws this exception if an I/O error occurs during resource read.

WrongTypeException - Throws this exception if the resource is not of the config type.

从以下版本开始:

3

getInteger

public abstract int getInteger()
                        throws IOException,
                               NotExistException,
                               WrongTypeException

Obtains an integer value based on this Element.

返回:

Returns the integer value.

抛出:

NotExistException - Throws this exception if the resource ID does not match any resources. The resource ID must be automatically generated by the IDE or resource tool, or provided by the system.

IOException - Throws this exception if an I/O error occurs during resource read.

WrongTypeException - Throws this exception if the resource is not of the integer type.

从以下版本开始:

3

getStringArray

public abstract String[] getStringArray()
                                 throws IOException,
                                        NotExistException,
                                        WrongTypeException

Obtains a string array based on this Element.

返回:

Returns the string array.

抛出:

NotExistException - Throws this exception if the resource ID does not match any resources. The resource ID must be automatically generated by the IDE or resource tool, or provided by the system.

IOException - Throws this exception if an I/O error occurs during resource read.

WrongTypeException - Throws this exception if the resource is not of the string array type.

从以下版本开始:

3

getIntArray

public abstract int[] getIntArray()
                           throws IOException,
                                  NotExistException,
                                  WrongTypeException

Obtains an integer array based on this Element.

返回:

Returns the integer array.

抛出:

NotExistException - Throws this exception if the resource ID does not match any resources. The resource ID must be automatically generated by the IDE or resource tool, or provided by the system.

IOException - Throws this exception if an I/O error occurs during resource read.

WrongTypeException - Throws this exception if the resource is not of the integer array type.

从以下版本开始:

3

getPluralString

public abstract String getPluralString(int quantity)
                                throws IOException,
                                       NotExistException,
                                       WrongTypeException

Obtains the string representation of plural rules associated with this Element based on the given quantity.

参数:

quantity - Indicates the number used to obtain the string representation for the current language's plural rules.

返回:

Returns the unformatted string representation of plural rules. The string matches the resource ID and quantity.

抛出:

NotExistException - Throws this exception if the resource ID does not match any resources. The resource ID must be automatically generated by the IDE or resource tool, or provided by the system.

IOException - Throws this exception if an I/O error occurs during resource read.

WrongTypeException - Throws this exception if the resource is not of the string type.

从以下版本开始:

3

getPluralString

public abstract String getPluralString(int quantity,
                                       Object... formatArgs)
                                throws IOException,
                                       NotExistException,
                                       WrongTypeException

Obtains the string representation of plural rules associated with this Element based on the given quantity, and formats the string based on the specified formatted objects.

参数:

quantity - Indicates the number used to obtain the string representation for the current language's plural rules.

formatArgs - Indicates the formatted objects used for substitution.

返回:

Returns the formatted string representation of plural rules. The string matches the resource ID and quantity.

抛出:

NotExistException - Throws this exception if the resource ID does not match any resources. The resource ID must be automatically generated by the IDE or resource tool, or provided by the system.

IOException - Throws this exception if an I/O error occurs during resource read.

WrongTypeException - Throws this exception if the resource is not of the string type.

从以下版本开始:

3

getTheme

public abstract Theme getTheme()
                        throws IOException,
                               NotExistException,
                               WrongTypeException

Obtains a Theme instance associated with this Element.

返回:

Returns a Theme instance.

抛出:

NotExistException - Throws this exception if the resource ID does not match any resources. The resource ID must be automatically generated by the IDE or resource tool, or provided by the system.

IOException - Throws this exception if an I/O error occurs during resource read.

WrongTypeException - Throws this exception if the resource is not of the theme type.

从以下版本开始:

3

另请参阅:

Theme

getPattern

public abstract Pattern getPattern()
                            throws IOException,
                                   NotExistException,
                                   WrongTypeException

Obtains a ohos.global.resource.solidxml.Pattern instance associated with this Element.

返回:

Returns the ohos.global.resource.solidxml.Pattern instance.

抛出:

NotExistException - Throws this exception if the resource ID does not match any resources. The resource ID must be automatically generated by the IDE or resource tool, or provided by the system.

IOException - Throws this exception if an I/O error occurs during resource read.

WrongTypeException - Throws this exception if the resource is not of the pattern type.

从以下版本开始:

3