com.sk89q.worldedit.util.formatting

Class StyleSet

java.lang.Object

com.sk89q.worldedit.util.formatting.StyleSet

public class StyleSet
extends Object

Represents set of styles, such as color, bold, etc.

Constructor Summary

Constructors

Constructor and Description
StyleSet() Create a new style set with no properties set.
StyleSet(Style... styles) Create a new style set with the given styles.

Method Summary

Modifier and Type	Method and Description
StyleSet	clone()
StyleSet	extend(StyleSet style) Create a new instance with styles inherited from this one but with new styles from the given style set.
Boolean	getBold() Get whether this style set is bold.
Style	getColor() Get the color of the text.
Boolean	getItalic() Get whether this style set is italicized.
Boolean	getStrikethrough() Get whether this style set is stricken through.
Boolean	getUnderline() Get whether this style set is underlined.
boolean	hasEqualFormatting(StyleSet other) Return where the text formatting of the given style set is different from that assigned to this one.
boolean	hasFormatting() Return whether text formatting (bold, italics, underline, strikethrough) is set.
boolean	isBold() Get whether the text is bold.
boolean	isItalic() Get whether the text is italicized.
boolean	isStrikethrough() Get whether the text is stricken through.
boolean	isUnderline() Get whether the text is underlined.
void	setBold(Boolean bold) Set whether the text is bold.
void	setColor(Style color) Set the color of the text.
void	setItalic(Boolean italic) Set whether the text is italicized.
void	setStrikethrough(Boolean strikethrough) Set whether the text is stricken through.
void	setUnderline(Boolean underline) Set whether the text is underline.

Methods inherited from class java.lang.Object

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

Constructor Detail

StyleSet

public StyleSet()

Create a new style set with no properties set.

StyleSet

public StyleSet(Style... styles)

Create a new style set with the given styles.

Style.RESET will be ignored if provided.

Parameters:

styles - a list of styles

Method Detail

getBold

public Boolean getBold()

Get whether this style set is bold.

Returns:

true, false, or null if unset

isBold

public boolean isBold()

Get whether the text is bold.

Returns:

true if bold

setBold

public void setBold(Boolean bold)

Set whether the text is bold.

Parameters:

bold - true, false, or null to unset

getItalic

public Boolean getItalic()

Get whether this style set is italicized.

Returns:

true, false, or null if unset

isItalic

public boolean isItalic()

Get whether the text is italicized.

Returns:

true if italicized

setItalic

public void setItalic(Boolean italic)

Set whether the text is italicized.

Parameters:

italic - false, or null to unset

getUnderline

public Boolean getUnderline()

Get whether this style set is underlined.

Returns:

true, false, or null if unset

isUnderline

public boolean isUnderline()

Get whether the text is underlined.

Returns:

true if underlined

setUnderline

public void setUnderline(Boolean underline)

Set whether the text is underline.

Parameters:

underline - false, or null to unset

getStrikethrough

public Boolean getStrikethrough()

Get whether this style set is stricken through.

Returns:

true, false, or null if unset

isStrikethrough

public boolean isStrikethrough()

Get whether the text is stricken through.

Returns:

true if there is strikethrough applied

setStrikethrough

public void setStrikethrough(Boolean strikethrough)

Set whether the text is stricken through.

Parameters:

strikethrough - false, or null to unset

getColor

public Style getColor()

Get the color of the text.

Returns:

true, false, or null if unset

setColor

public void setColor(Style color)

Set the color of the text.

Parameters:

color - the color

hasFormatting

public boolean hasFormatting()

Return whether text formatting (bold, italics, underline, strikethrough) is set.

Returns:

true if formatting is set

hasEqualFormatting

public boolean hasEqualFormatting(StyleSet other)

Return where the text formatting of the given style set is different from that assigned to this one.

Parameters:

other - the other style set

Returns:

true if there is a difference

extend

public StyleSet extend(StyleSet style)

Create a new instance with styles inherited from this one but with new styles from the given style set.

Parameters:

style - the style set

Returns:

a new style set instance

clone

public StyleSet clone()

Overrides:

clone in class Object