Package com.inductiveautomation.ignition.designer.mvvm.binders.swing

Record Class AttributedText

java.lang.Object

java.lang.Record

com.inductiveautomation.ignition.designer.mvvm.binders.swing.AttributedText

Record Components:

text - The text to be displayed

attributes - The attributes to be applied to segments of the text

timestamp - The time when the text was last modified. This is optional, and can be null.

public record AttributedText(String text, List<AttributeSpan> attributes, @Nullable LocalDateTime timestamp)
extends Record

The text can have multiple segments with different attributes applied to them. Those segments are defined by the attributes list which specifies what attributes should be applied to what segments of the text using AttributeSpans.

Field Summary

Fields

Modifier and Type	Field	Description
static AttributedText	EMPTY

Constructor Summary

Constructors

Constructor	Description
AttributedText(String text, List<AttributeSpan> attributes)
AttributedText(String text, List<AttributeSpan> attributes, LocalDateTime timestamp)	Creates an instance of a AttributedText record class.

Method Summary

Modifier and Type	Method	Description
List<AttributeSpan>	attributes()	Returns the value of the attributes record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
String	text()	Returns the value of the text record component.
LocalDateTime	timestamp()	Returns the value of the timestamp record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

EMPTY

public static AttributedText EMPTY

Constructor Details

AttributedText

public AttributedText(String text,
 List<AttributeSpan> attributes)

AttributedText

public AttributedText(String text,
 List<AttributeSpan> attributes,
 @Nullable
 LocalDateTime timestamp)

Creates an instance of a AttributedText record class.

Parameters:

text - the value for the text record component

attributes - the value for the attributes record component

timestamp - the value for the timestamp record component

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

text

public String text()

Returns the value of the text record component.

Returns:

the value of the text record component

attributes

public List<AttributeSpan> attributes()

Returns the value of the attributes record component.

Returns:

the value of the attributes record component

timestamp

@Nullable
public LocalDateTime timestamp()

Returns the value of the timestamp record component.

Returns:

the value of the timestamp record component