Module atlantafx.base

Package atlantafx.base.util

Record Class BBCodeHandler.Block

java.lang.Object

java.lang.Record

atlantafx.base.util.BBCodeHandler.Block

Record Components:

node - The node that represents the block.

text - The text content.

Enclosing interface:

BBCodeHandler

public static record BBCodeHandler.Block(javafx.scene.layout.Pane node, @Nullable javafx.scene.text.TextFlow text)
extends Record

A generic block record.

Constructor Summary

Constructors

Constructor	Description
Block(javafx.scene.layout.Pane node, @Nullable javafx.scene.text.TextFlow text)	Creates an instance of a Block record class.

Method Summary

Modifier and Type	Method	Description
void	addText(javafx.scene.Node child)
boolean	canContainText()
List<javafx.scene.Node>	children()
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.
boolean	isEmpty()
javafx.scene.layout.Pane	node()	Returns the value of the node record component.
int	size()
@Nullable javafx.scene.text.TextFlow	text()	Returns the value of the text 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

Constructor Details

Block

public Block(javafx.scene.layout.Pane node,
 @Nullable
 @Nullable javafx.scene.text.TextFlow text)

Creates an instance of a Block record class.

Parameters:

node - the value for the node record component

text - the value for the text record component

Method Details

addText

public void addText(javafx.scene.Node child)

children

public List<javafx.scene.Node> children()

size

public int size()

isEmpty

public boolean isEmpty()

canContainText

public boolean canContainText()

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.

node

public javafx.scene.layout.Pane node()

Returns the value of the node record component.

Returns:

the value of the node record component

text

@Nullable
public @Nullable javafx.scene.text.TextFlow text()

Returns the value of the text record component.

Returns:

the value of the text record component