com.groupdocs.editor.htmlcss.css.properties

Class TextDecorationLineType

java.lang.Object

com.groupdocs.editor.htmlcss.css.properties.TextDecorationLineType

public class TextDecorationLineType
extends Object

Represents types of the text decoration line: underline (underscore), overline, and line-through (strikethrough)

Immutable struct. Similar to the https://developer.mozilla.org/en-US/docs/Web/CSS/text-decoration-line

Field Summary

Fields

Modifier and Type	Field and Description
static TextDecorationLineType	LineThrough Each line of text has a line through the middle.
static TextDecorationLineType	None Produces no text decoration.
static TextDecorationLineType	Overline Each line of text has a line above it.
static TextDecorationLineType	Underline Each line of text is underlined.

Constructor Summary

Constructors

Constructor and Description
TextDecorationLineType()
TextDecorationLineType(int value)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object other) Indicates whether this TextDecorationLineType instance is equal to specified uncasted
boolean	equals(TextDecorationLineType other) Indicates whether this TextDecorationLineType instance is equal to specified
static TextDecorationLineType	fromFlags(boolean isUnderline, boolean isOverline, boolean isLineThrough) Creates and returns a TextDecorationLineType instance with flags, defined by the specified parameters
String	getValue() Returns a value of all flags in this instance as text
int	hashCode() Returns a hash-code of this instance
boolean	isInitial() Indicates whether this instance has an initial value — None
boolean	isLineThrough() Indicates whether line-through (strikethrough) is enabled
boolean	isOverline() Indicates whether overline is enabled
boolean	isUnderline() Indicates whether underline (underscore) is enabled
static TextDecorationLineType	op_Addition(TextDecorationLineType first, TextDecorationLineType second) Combines (merges) two specified line types and produces new resultant line type, where flags are merged (union)
static TextDecorationLineType	op_Division(TextDecorationLineType first, TextDecorationLineType second) Returns an intersection between first and second line types, where only those flags are enabled, which are enabled simultaneously in both operands.
static boolean	op_Equality(TextDecorationLineType first, TextDecorationLineType second) Checks whether two "TextDecorationLineType" values are equal
static boolean	op_Inequality(TextDecorationLineType first, TextDecorationLineType second) Checks whether two "TextDecorationLineType" values are not equal
static TextDecorationLineType	op_Subtraction(TextDecorationLineType first, TextDecorationLineType second) Subtracts second specified line type from the first specified line type and produces new resultant line type, where are present only those flags from the first operand, which are not found in the second operand (difference)
static TextDecorationLineType	to_TextDecorationLineType(byte octet) Casts specific byte (8-bit octet) to the corresponding TextDecorationLineType, throws exception if casting is invalid
String	toString() Returns a value of all flags in this instance as text
static boolean	tryParse(String input, TextDecorationLineType[] output) Tries to parse a specified string and return a valid TextDecorationLineType instance

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

LineThrough

public static final TextDecorationLineType LineThrough

Each line of text has a line through the middle.

None

public static final TextDecorationLineType None

Produces no text decoration. Initial value.

Overline

public static final TextDecorationLineType Overline

Each line of text has a line above it.

Underline

public static final TextDecorationLineType Underline

Each line of text is underlined.

Constructor Detail

TextDecorationLineType

public TextDecorationLineType()

TextDecorationLineType

public TextDecorationLineType(int value)

Method Detail

equals

public boolean equals(Object other)

Indicates whether this TextDecorationLineType instance is equal to specified uncasted

Overrides:

equals in class Object

Parameters:

other - Other TextDecorationLineType instance, casted to object

Returns:

true if are equal, false otherwise

equals

public final boolean equals(TextDecorationLineType other)

Indicates whether this TextDecorationLineType instance is equal to specified

Parameters:

other - Other TextDecorationLineType instance

Returns:

true if are equal, false otherwise

fromFlags

public static TextDecorationLineType fromFlags(boolean isUnderline,
                                               boolean isOverline,
                                               boolean isLineThrough)

Creates and returns a TextDecorationLineType instance with flags, defined by the specified parameters

Parameters:

isUnderline - Determines whether an underline flag is enabled or not

isOverline - Determines whether an overline flag is enabled or not

isLineThrough - Determines whether an line-through flag is enabled or not

Returns:

New TextDecorationLineType instance

getValue

public final String getValue()

Returns a value of all flags in this instance as text

hashCode

public int hashCode()

Returns a hash-code of this instance

Overrides:

hashCode in class Object

Returns:

Signed integer hash-code

isInitial

public final boolean isInitial()

Indicates whether this instance has an initial value — None

isLineThrough

public final boolean isLineThrough()

Indicates whether line-through (strikethrough) is enabled

isOverline

public final boolean isOverline()

Indicates whether overline is enabled

isUnderline

public final boolean isUnderline()

Indicates whether underline (underscore) is enabled

op_Addition

public static TextDecorationLineType op_Addition(TextDecorationLineType first,
                                                 TextDecorationLineType second)

Combines (merges) two specified line types and produces new resultant line type, where flags are merged (union)

Parameters:

first - First line type operand

second - Second line type operand

Returns:

Result of the union between specified operands

op_Division

public static TextDecorationLineType op_Division(TextDecorationLineType first,
                                                 TextDecorationLineType second)

Returns an intersection between first and second line types, where only those flags are enabled, which are enabled simultaneously in both operands. Has the highest priority between all operators (higher than union and difference)

Parameters:

first - First line type operand

second - Second line type operand

Returns:

Result of the intersection between specified operands

op_Equality

public static boolean op_Equality(TextDecorationLineType first,
                                  TextDecorationLineType second)

Checks whether two "TextDecorationLineType" values are equal

Parameters:

first - First operand to check

second - Second operand to check

Returns:

true if are equal, false otherwise

op_Inequality

public static boolean op_Inequality(TextDecorationLineType first,
                                    TextDecorationLineType second)

Checks whether two "TextDecorationLineType" values are not equal

Parameters:

first - First operand to check

second - Second operand to check

Returns:

true if are unequal, false otherwise

op_Subtraction

public static TextDecorationLineType op_Subtraction(TextDecorationLineType first,
                                                    TextDecorationLineType second)

Subtracts second specified line type from the first specified line type and produces new resultant line type, where are present only those flags from the first operand, which are not found in the second operand (difference)

Parameters:

first - First line type operand

second - Second line type operand

Returns:

Result of the difference between the first (minuend) and second (subtrahend) operands

to_TextDecorationLineType

public static TextDecorationLineType to_TextDecorationLineType(byte octet)

Casts specific byte (8-bit octet) to the corresponding TextDecorationLineType, throws exception if casting is invalid

Parameters:

octet - A 8-bit octet (bitfield), where 5 leading bits are zeros, while last 3 indicate flags

Throws:

com.aspose.ms.System.ArgumentOutOfRangeException - Specified octet has invalid value

toString

public String toString()

Returns a value of all flags in this instance as text

Overrides:

toString in class Object

tryParse

public static boolean tryParse(String input,
                               TextDecorationLineType[] output)

Tries to parse a specified string and return a valid TextDecorationLineType instance

Parameters:

input - Input string

output - Result. If parsing is invalid, it is a None value

Returns:

true if parsing was successful, false on failure