程序包 ohos.global.resource.solidxml

类 Theme

java.lang.Object

ohos.global.resource.solidxml.Theme

public abstract class Theme
extends Object

Provides resource attributes for a specific theme.

A hash map returned by Theme#getThemeHash stores the theme attributes. You can call ResourceManager.getTheme(int) to obtain the Theme instance based on the resource ID.

从以下版本开始:

3

构造器概要

构造器

构造器	说明
Theme()

方法概要

限定符和类型	方法	说明
abstract boolean	getBooleanValue(String key, boolean defValue)	Obtains a boolean value of the attribute matching the key in this Theme.
abstract int	getColorValue(String key)	Obtains a color value of the attribute matching the key in this Theme.
abstract Theme	getCombinedTheme(Theme child)	Obtains a combined theme formed by this Theme and another theme, which will act as a child theme.
abstract float	getFloatValue(String key, float defValue)	Obtains a float value of the attribute matching the key in this Theme.
abstract int	getIntegerValue(String key, int defValue)	Obtains an integer value of the attribute matching the key in this Theme.
abstract Resource	getMediaValue(String key, ResourceManager resManager)	Obtains media resources matching the key in this Theme.
abstract Pattern	getPatternValue(String key)	Obtains the Pattern instance matching the key in this Theme.
abstract int	getPixelValue(String key, boolean truncate)	Obtains the pixel value matching the key in this Theme.
abstract String	getStringValue(String key)	Obtains a string value of the attribute matching the key in this Theme.
abstract HashMap<String,TypedAttribute>	getThemeHash()	Obtains the hash map of this Theme.
abstract HashMap<String,TypedAttribute>	getThemeHash(String[] selected)	Obtains a hash map that contains selected attributes of this Theme.
abstract TypedAttribute	getValue(String key)	Obtains the TypedAttribute instance matching the key in this Theme.
abstract void	set(Theme theme)	Sets this Theme to hold all the attribute values of an existing Theme instance.
abstract int	size()	Obtains the number of attributes in this Theme.

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

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

构造器详细资料

Theme

public Theme()

方法详细资料

getThemeHash

public abstract HashMap<String,TypedAttribute> getThemeHash()

Obtains the hash map of this Theme. The hash map stores the theme attributes, containing theme names as keys and associated TypedAttribute as values.

返回:

Returns the hash map of this Theme.

从以下版本开始:

3

getCombinedTheme

public abstract Theme getCombinedTheme(Theme child)

Obtains a combined theme formed by this Theme and another theme, which will act as a child theme.

The attributes of the child theme will overwrite those of this Theme.

参数:

child - Indicates the child theme.

返回:

Returns the combined theme.

从以下版本开始:

3

set

public abstract void set(Theme theme)

Sets this Theme to hold all the attribute values of an existing Theme instance.

参数:

theme - Indicates the Theme instance whose attribute values are to be assigned to this Theme.

从以下版本开始:

4

getThemeHash

public abstract HashMap<String,TypedAttribute> getThemeHash(String[] selected)

Obtains a hash map that contains selected attributes of this Theme.

参数:

selected - Indicates the set of selected attribute names.

返回:

Returns the hash map that contains selected attributes of this Theme.

从以下版本开始:

4

getStringValue

public abstract String getStringValue(String key)
                               throws IOException,
                                      NotExistException,
                                      WrongTypeException

Obtains a string value of the attribute matching the key in this Theme.

参数:

key - Indicates the key in the theme.

返回:

Returns the string value matching the key.

抛出:

NotExistException - Throws this exception if the key is not found, or the obtained value is null or another invalid value.

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

WrongTypeException - Throws this exception if the attribute value matching the key is not a string value.

从以下版本开始:

5

getBooleanValue

public abstract boolean getBooleanValue(String key,
                                        boolean defValue)
                                 throws IOException,
                                        NotExistException,
                                        WrongTypeException

Obtains a boolean value of the attribute matching the key in this Theme.

参数:

key - Indicates the key in the theme.

defValue - Indicates the default value.

返回:

Returns the boolean value matching the key if obtained; returns the default value if the key is not found.

抛出:

NotExistException - Throws this exception if the obtained value is null or another invalid value.

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

WrongTypeException - Throws this exception if the attribute value matching the key is not a boolean value.

从以下版本开始:

5

getColorValue

public abstract int getColorValue(String key)
                           throws IOException,
                                  NotExistException,
                                  WrongTypeException

Obtains a color value of the attribute matching the key in this Theme.

参数:

key - Indicates the key in the theme.

返回:

Returns an integer representing the color value matching the key.

抛出:

NotExistException - Throws this exception if the key is not found, or the obtained value is null or another invalid value.

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

WrongTypeException - Throws this exception if the attribute value matching the key is not a color value.

从以下版本开始:

5

getIntegerValue

public abstract int getIntegerValue(String key,
                                    int defValue)
                             throws IOException,
                                    NotExistException,
                                    WrongTypeException

Obtains an integer value of the attribute matching the key in this Theme.

参数:

key - Indicates the key in the theme.

defValue - Indicates the default value.

返回:

Returns the integer value matching the key if obtained; returns the default value if the key is not found.

抛出:

NotExistException - Throws this exception if the obtained value is null or another invalid value.

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

WrongTypeException - Throws this exception if the attribute value matching the key is not an integer value.

从以下版本开始:

5

getFloatValue

public abstract float getFloatValue(String key,
                                    float defValue)
                             throws IOException,
                                    NotExistException,
                                    WrongTypeException

Obtains a float value of the attribute matching the key in this Theme.

参数:

key - Indicates the key in the theme.

defValue - Indicates the default value.

返回:

Returns the float value matching the key if obtained; returns the default value if the key is not found.

抛出:

NotExistException - Throws this exception if the obtained value is null or another invalid value.

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

WrongTypeException - Throws this exception if the attribute value matching the key is not a float value.

从以下版本开始:

5

getPixelValue

public abstract int getPixelValue(String key,
                                  boolean truncate)
                           throws IOException,
                                  NotExistException,
                                  WrongTypeException

Obtains the pixel value matching the key in this Theme. This method is equivalent to getFloatValue(java.lang.String,float) except that its return value is an integer rounded from the original value.

参数:

key - Indicates the key in the theme.

truncate - Specifies whether the returned result is truncated. The value true indicates that the decimal part of the float value is truncated, and false indicates that the float value is rounded off.

返回:

Returns the pixel value matching the key.

抛出:

NotExistException - Throws this exception if the key is not found, or the obtained value is null or another invalid value.

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

WrongTypeException - Throws this exception if the attribute value matching the key is not a pixel value.

从以下版本开始:

5

getMediaValue

public abstract Resource getMediaValue(String key,
                                       ResourceManager resManager)
                                throws IOException,
                                       NotExistException,
                                       WrongTypeException

Obtains media resources matching the key in this Theme.

参数:

key - Indicates the key in the theme.

resManager - Indicates the ResourceManager instance used to obtain the media resource stream.

返回:

Returns the media resources matching the key.

抛出:

NotExistException - Throws this exception if the key is not found, or the obtained value is null or another invalid value.

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

WrongTypeException - Throws this exception if the key does not match any media resources.

从以下版本开始:

5

getValue

public abstract TypedAttribute getValue(String key)
                                 throws NotExistException

Obtains the TypedAttribute instance matching the key in this Theme.

参数:

key - Indicates the key in the theme.

返回:

Returns the TypedAttribute instance.

抛出:

NotExistException - Throws this exception if the key is not found.

从以下版本开始:

5

size

public abstract int size()

Obtains the number of attributes in this Theme.

返回:

Returns the number of attributes.

从以下版本开始:

5

getPatternValue

public abstract Pattern getPatternValue(String key)
                                 throws IOException,
                                        NotExistException,
                                        WrongTypeException

Obtains the Pattern instance matching the key in this Theme.

参数:

key - Indicates the key in the theme.

返回:

Returns the Pattern instance.

抛出:

NotExistException - Throws this exception if the key is not found, or the obtained value is null or another invalid value.

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

WrongTypeException - Throws this exception if the key does not match any Pattern instance.

从以下版本开始:

5