Most visited

Recently visited

RatingCompat

public final class RatingCompat
extends Object implements Parcelable

java.lang.Object
   ↳ android.support.v4.media.RatingCompat


封装用作内容元数据的评级信息的类。 评级是由它的等级风格定义(参见RATING_HEARTRATING_THUMB_UP_DOWNRATING_3_STARSRATING_4_STARSRATING_5_STARSRATING_PERCENTAGE )和实际的评价值(其可以被定义为“未分级”),当评价实例通过构造这两者都定义工厂方法之一。

Summary

Constants

int RATING_3_STARS

评分风格为0至3星。

int RATING_4_STARS

0到4星评级风格。

int RATING_5_STARS

评分风格为0至5星。

int RATING_HEART

具有单一评级的评级风格,“心”与“无心”。

int RATING_NONE

表示不支持评分风格。

int RATING_PERCENTAGE

评分风格以百分比表示。

int RATING_THUMB_UP_DOWN

“大拇指”与“拇指向下”的评分风格。

Inherited constants

From interface android.os.Parcelable

Fields

public static final Creator<RatingCompat> CREATOR

Public methods

int describeContents()

描述此Parcelable实例的封送表示中包含的特殊对象的种类。

static RatingCompat fromRating(Object ratingObj)

从框架 Rating对象创建一个实例。

float getPercentRating()

返回基于百分比的评分值。

Object getRating()

获取底层框架 Rating对象。

int getRatingStyle()

返回评分风格。

float getStarRating()

返回基于星级的评分值。

boolean hasHeart()

返回评分是否为“选择心脏”。

boolean isRated()

返回是否有评级值可用。

boolean isThumbUp()

返回评分是否“大拇指”。

static RatingCompat newHeartRating(boolean hasHeart)

以心脏评级返回评级实例。

static RatingCompat newPercentageRating(float percent)

以基于百分比的评分返回评分实例。

static RatingCompat newStarRating(int starRatingStyle, float starRating)

以星级评分返回评分实例。

static RatingCompat newThumbRating(boolean thumbIsUp)

使用基于拇指的评级返回评级实例。

static RatingCompat newUnratedRating(int ratingStyle)

返回没有评级的评级实例。

String toString()

返回对象的字符串表示形式。

void writeToParcel(Parcel dest, int flags)

将此对象平铺到一个包裹中。

Inherited methods

From class java.lang.Object
From interface android.os.Parcelable

Constants

RATING_3_STARS

int RATING_3_STARS

评分风格为0至3星。

常量值:3(0x00000003)

RATING_4_STARS

int RATING_4_STARS

0到4星评级风格。

常量值:4(0x00000004)

RATING_5_STARS

int RATING_5_STARS

评分风格为0至5星。

常量值:5(0x00000005)

RATING_HEART

int RATING_HEART

具有单一评级的评级风格,“心”与“无心”。 可以用来指示所引用的内容是最喜欢的(或不)。

常数值:1(0x00000001)

RATING_NONE

int RATING_NONE

表示不支持评分风格。 评级将永远不会有这种类型,但可以被其他类别用来表示他们不支持评级。

常量值:0(0x00000000)

RATING_PERCENTAGE

int RATING_PERCENTAGE

评分风格以百分比表示。

常数值:6(0x00000006)

RATING_THUMB_UP_DOWN

int RATING_THUMB_UP_DOWN

“大拇指”与“拇指向下”的评分风格。

常量值:2(0x00000002)

Fields

CREATOR

Creator<RatingCompat> CREATOR

Public methods

describeContents

int describeContents ()

描述此Parcelable实例的封送表示中包含的特殊对象的种类。 例如,如果对象将在writeToParcel(Parcel, int)的输出中包含writeToParcel(Parcel, int) ,则此方法的返回值必须包含CONTENTS_FILE_DESCRIPTOR位。

Returns
int a bitmask indicating the set of special object types marshaled by this Parcelable object instance.

fromRating

RatingCompat fromRating (Object ratingObj)

从框架 Rating对象创建一个实例。

此方法仅在API 19+上受支持。

Parameters
ratingObj Object: A Rating object, or null if none.
Returns
RatingCompat An equivalent RatingCompat object, or null if none.

getPercentRating

float getPercentRating ()

返回基于百分比的评分值。

Returns
float a rating value greater or equal to 0.0f, or a negative value if the rating style is not percentage-based, or if it is unrated.

getRating

Object getRating ()

获取底层框架 Rating对象。

此方法仅在API 19+上受支持。

Returns
Object An equivalent Rating object, or null if none.

getRatingStyle

int getRatingStyle ()

返回评分风格。

Returns
int one of RATING_HEART, RATING_THUMB_UP_DOWN, RATING_3_STARS, RATING_4_STARS, RATING_5_STARS, or RATING_PERCENTAGE.

getStarRating

float getStarRating ()

返回基于星级的评分值。

Returns
float a rating value greater or equal to 0.0f, or a negative value if the rating style is not star-based, or if it is unrated.

hasHeart

boolean hasHeart ()

返回评分是否为“选择心脏”。

Returns
boolean true if the rating is "heart selected", false if the rating is "heart unselected", if the rating style is not RATING_HEART or if it is unrated.

isRated

boolean isRated ()

返回是否有评级值可用。

Returns
boolean true if the instance was not created with newUnratedRating(int).

isThumbUp

boolean isThumbUp ()

返回评分是否“大拇指”。

Returns
boolean true if the rating is "thumb up", false if the rating is "thumb down", if the rating style is not RATING_THUMB_UP_DOWN or if it is unrated.

newHeartRating

RatingCompat newHeartRating (boolean hasHeart)

以心脏评级返回评级实例。 创建并返回评级风格为RATING_HEART的新评级实例和基于心脏的评级。

Parameters
hasHeart boolean: true for a "heart selected" rating, false for "heart unselected".
Returns
RatingCompat a new Rating instance.

newPercentageRating

RatingCompat newPercentageRating (float percent)

以基于百分比的评分返回评分实例。 使用RATING_PERCENTAGE评分风格创建并返回一个新评级实例,并对给定百分比进行评分。

Parameters
percent float: the value of the rating
Returns
RatingCompat null if the rating is out of range, a new Rating instance otherwise.

newStarRating

RatingCompat newStarRating (int starRatingStyle, 
                float starRating)

以星级评分返回评分实例。 创建并返回一个新的评级实例,其中包含星级评分样式和给定的整数或分数星号。 例如,非整数值可用于表示平均评分值,该值可能不是恒星的整数。

Parameters
starRatingStyle int: one of RATING_3_STARS, RATING_4_STARS, RATING_5_STARS.
starRating float: a number ranging from 0.0f to 3.0f, 4.0f or 5.0f according to the rating style.
Returns
RatingCompat null if the rating style is invalid, or the rating is out of range, a new Rating instance otherwise.

newThumbRating

RatingCompat newThumbRating (boolean thumbIsUp)

使用基于拇指的评级返回评级实例。 RATING_THUMB_UP_DOWN评级风格创建并返回一个新评级实例,并以“拇指向上”或“拇指向下”评级。

Parameters
thumbIsUp boolean: true for a "thumb up" rating, false for "thumb down".
Returns
RatingCompat a new Rating instance.

newUnratedRating

RatingCompat newUnratedRating (int ratingStyle)

返回没有评级的评级实例。 创建并返回一个新评级实例,该评级实例对于给定评级风格没有已知的评级。

Parameters
ratingStyle int: one of RATING_HEART, RATING_THUMB_UP_DOWN, RATING_3_STARS, RATING_4_STARS, RATING_5_STARS, or RATING_PERCENTAGE.
Returns
RatingCompat null if an invalid rating style is passed, a new Rating instance otherwise.

toString

String toString ()

返回对象的字符串表示形式。 通常, toString方法将返回一个“文本表示”此对象的字符串。 结果应该是一个简洁但内容丰富的表述,对于一个人来说很容易阅读。 建议所有子类重写此方法。

ObjecttoString方法返回一个字符串,其中包含对象为实例的类的名称,符号字符“ @ ”以及对象的哈希代码的无符号十六进制表示形式。 换句话说,这个方法返回一个字符串,其值等于:

 getClass().getName() + '@' + Integer.toHexString(hashCode())
 

Returns
String a string representation of the object.

writeToParcel

void writeToParcel (Parcel dest, 
                int flags)

将此对象平铺到一个包裹中。

Parameters
dest Parcel: The Parcel in which the object should be written.
flags int: Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE.

Hooray!