targetClasses;
private String targetVoice;
// Style properties.
@Nullable private String fontFamily;
private int fontColor;
private boolean hasFontColor;
private int backgroundColor;
private boolean hasBackgroundColor;
@OptionalBoolean private int linethrough;
@OptionalBoolean private int underline;
@OptionalBoolean private int bold;
@OptionalBoolean private int italic;
@FontSizeUnit private int fontSizeUnit;
private float fontSize;
@Nullable private Layout.Alignment textAlign;
// Calling reset() is forbidden because `this` isn't initialized. This can be safely suppressed
// because reset() only assigns fields, it doesn't read any.
@SuppressWarnings("nullness:method.invocation.invalid")
public WebvttCssStyle() {
reset();
}
@EnsuresNonNull({"targetId", "targetTag", "targetClasses", "targetVoice"})
public void reset() {
targetId = "";
targetTag = "";
targetClasses = Collections.emptyList();
targetVoice = "";
fontFamily = null;
hasFontColor = false;
hasBackgroundColor = false;
linethrough = UNSPECIFIED;
underline = UNSPECIFIED;
bold = UNSPECIFIED;
italic = UNSPECIFIED;
fontSizeUnit = UNSPECIFIED;
textAlign = null;
}
public void setTargetId(String targetId) {
this.targetId = targetId;
}
public void setTargetTagName(String targetTag) {
this.targetTag = targetTag;
}
public void setTargetClasses(String[] targetClasses) {
this.targetClasses = Arrays.asList(targetClasses);
}
public void setTargetVoice(String targetVoice) {
this.targetVoice = targetVoice;
}
/**
* Returns a value in a score system compliant with the CSS Specificity rules.
*
* @see CSS Cascading
* The score works as follows:
*
* - Id match adds 0x40000000 to the score.
*
- Each class and voice match adds 4 to the score.
*
- Tag matching adds 2 to the score.
*
- Universal selector matching scores 1.
*
*
* @param id The id of the cue if present, {@code null} otherwise.
* @param tag Name of the tag, {@code null} if it refers to the entire cue.
* @param classes An array containing the classes the tag belongs to. Must not be null.
* @param voice Annotated voice if present, {@code null} otherwise.
* @return The score of the match, zero if there is no match.
*/
public int getSpecificityScore(
@Nullable String id, @Nullable String tag, String[] classes, @Nullable String voice) {
if (targetId.isEmpty() && targetTag.isEmpty() && targetClasses.isEmpty()
&& targetVoice.isEmpty()) {
// The selector is universal. It matches with the minimum score if and only if the given
// element is a whole cue.
return TextUtils.isEmpty(tag) ? 1 : 0;
}
int score = 0;
score = updateScoreForMatch(score, targetId, id, 0x40000000);
score = updateScoreForMatch(score, targetTag, tag, 2);
score = updateScoreForMatch(score, targetVoice, voice, 4);
if (score == -1 || !Arrays.asList(classes).containsAll(targetClasses)) {
return 0;
} else {
score += targetClasses.size() * 4;
}
return score;
}
/**
* Returns the style or {@link #UNSPECIFIED} when no style information is given.
*
* @return {@link #UNSPECIFIED}, {@link #STYLE_NORMAL}, {@link #STYLE_BOLD}, {@link #STYLE_BOLD}
* or {@link #STYLE_BOLD_ITALIC}.
*/
@StyleFlags public int getStyle() {
if (bold == UNSPECIFIED && italic == UNSPECIFIED) {
return UNSPECIFIED;
}
return (bold == ON ? STYLE_BOLD : STYLE_NORMAL)
| (italic == ON ? STYLE_ITALIC : STYLE_NORMAL);
}
public boolean isLinethrough() {
return linethrough == ON;
}
public WebvttCssStyle setLinethrough(boolean linethrough) {
this.linethrough = linethrough ? ON : OFF;
return this;
}
public boolean isUnderline() {
return underline == ON;
}
public WebvttCssStyle setUnderline(boolean underline) {
this.underline = underline ? ON : OFF;
return this;
}
public WebvttCssStyle setBold(boolean bold) {
this.bold = bold ? ON : OFF;
return this;
}
public WebvttCssStyle setItalic(boolean italic) {
this.italic = italic ? ON : OFF;
return this;
}
@Nullable
public String getFontFamily() {
return fontFamily;
}
public WebvttCssStyle setFontFamily(@Nullable String fontFamily) {
this.fontFamily = Util.toLowerInvariant(fontFamily);
return this;
}
public int getFontColor() {
if (!hasFontColor) {
throw new IllegalStateException("Font color not defined");
}
return fontColor;
}
public WebvttCssStyle setFontColor(int color) {
this.fontColor = color;
hasFontColor = true;
return this;
}
public boolean hasFontColor() {
return hasFontColor;
}
public int getBackgroundColor() {
if (!hasBackgroundColor) {
throw new IllegalStateException("Background color not defined.");
}
return backgroundColor;
}
public WebvttCssStyle setBackgroundColor(int backgroundColor) {
this.backgroundColor = backgroundColor;
hasBackgroundColor = true;
return this;
}
public boolean hasBackgroundColor() {
return hasBackgroundColor;
}
@Nullable
public Layout.Alignment getTextAlign() {
return textAlign;
}
public WebvttCssStyle setTextAlign(@Nullable Layout.Alignment textAlign) {
this.textAlign = textAlign;
return this;
}
public WebvttCssStyle setFontSize(float fontSize) {
this.fontSize = fontSize;
return this;
}
public WebvttCssStyle setFontSizeUnit(short unit) {
this.fontSizeUnit = unit;
return this;
}
@FontSizeUnit public int getFontSizeUnit() {
return fontSizeUnit;
}
public float getFontSize() {
return fontSize;
}
public void cascadeFrom(WebvttCssStyle style) {
if (style.hasFontColor) {
setFontColor(style.fontColor);
}
if (style.bold != UNSPECIFIED) {
bold = style.bold;
}
if (style.italic != UNSPECIFIED) {
italic = style.italic;
}
if (style.fontFamily != null) {
fontFamily = style.fontFamily;
}
if (linethrough == UNSPECIFIED) {
linethrough = style.linethrough;
}
if (underline == UNSPECIFIED) {
underline = style.underline;
}
if (textAlign == null) {
textAlign = style.textAlign;
}
if (fontSizeUnit == UNSPECIFIED) {
fontSizeUnit = style.fontSizeUnit;
fontSize = style.fontSize;
}
if (style.hasBackgroundColor) {
setBackgroundColor(style.backgroundColor);
}
}
private static int updateScoreForMatch(
int currentScore, String target, @Nullable String actual, int score) {
if (target.isEmpty() || currentScore == -1) {
return currentScore;
}
return target.equals(actual) ? currentScore + score : -1;
}
}