JavaFX 25 · jfx.incubator.scene.control.richtext.model.ContentChange

Contains information about StyledTextModel content change.

This class represents two kinds of changes made to the model: one that modifies the textual content and embedded Nodes, and one that only changes styling of the content.

A content change can be though of as a replacement of content between the two positions start and end with a different styled content (or no content). The change object does not include the actual content, but only the information about inserted symbols:

the number of characters inserted to the first affected paragraph
the number of complete paragraphs inserted
the number of characters inserted into the first paragraph following the inserted lines

The following diagram illustrates the inserted content relative to the start position (S) and the end position (E):

.......STTTTTTT
AAAAAAAAAAAAAAA
AAAAAAAAAAAAAAA
BBBE...........

Where T are the characters inserted following the start position, A are the inserted complete paragraphs, and B are the characters inserted at the beginning of the paragraph that contains the end position.

Modifier and Type	Field and Description
private final TextPos	end
private final TextPos	start

Access	Constructor and Description
private	ContentChange(TextPos start, TextPos end)

Method Summary

Modifier and Type	Method and Description
public int	Returns: the number of characters getCharsAddedBottom() The number of characters added at the beginning of the existing paragraph which contains the end position.
public int	Returns: the number of characters inserted getCharsAddedTop() The number of characters added at the end of the paragraph which contains the start position.
public TextPos	Returns: the end position getEnd() Returns the end position.
public int	Returns: the number of paragraphs getLinesAdded() The number of whole paragraphs inserted.
public TextPos	Returns: the start position getStart() Returns the start position.
public boolean	Returns: true if change is an edit isEdit() Determines whether the change is an edit (`true`) or affects styling only (`false`).
public static ContentChange	Returns: the change instance ofEdit(TextPos the start position start, TextPos the end position end, int the number of characters appended to the paragraph containing the start position charsAddedTop, int the number of full paragraphs inserted linesAdded, int the number of characters inserted at the beginning of the paragraph containing the end position charsAddedBottom) Creates the content change event which represents an edit.
public static ContentChange	Returns: the change instance ofStyleChange(TextPos the start position start, TextPos the end position end) Creates the content change event which represents a styling update.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

end	back to summary
private final TextPos end

start	back to summary
private final TextPos start

Constructor Detail

ContentChange	back to summary
private ContentChange(TextPos start, TextPos end)

Method Detail

getCharsAddedBottom	back to summary
public int getCharsAddedBottom() The number of characters added at the beginning of the existing paragraph which contains the end position. Returns:int the number of characters

getCharsAddedBottom

back to summary

public int getCharsAddedBottom()

The number of characters added at the beginning of the existing paragraph which contains the end position.

Returns:int: the number of characters

getCharsAddedTop	back to summary
public int getCharsAddedTop() The number of characters added at the end of the paragraph which contains the start position. Returns:int the number of characters inserted

getCharsAddedTop

back to summary

public int getCharsAddedTop()

The number of characters added at the end of the paragraph which contains the start position.

Returns:int: the number of characters inserted

getEnd	back to summary
public TextPos getEnd() Returns the end position. Returns:TextPos the end position

getEnd

back to summary

public TextPos getEnd()

Returns the end position.

Returns:TextPos: the end position

getLinesAdded	back to summary
public int getLinesAdded() The number of whole paragraphs inserted. Returns:int the number of paragraphs

getLinesAdded

back to summary

public int getLinesAdded()

The number of whole paragraphs inserted.

Returns:int: the number of paragraphs

getStart	back to summary
public TextPos getStart() Returns the start position. Returns:TextPos the start position

getStart

back to summary

public TextPos getStart()

Returns the start position.

Returns:TextPos: the start position

isEdit back to summary

isEdit	back to summary
public boolean isEdit() Determines whether the change is an edit (`true`) or affects styling only (`false`). Returns:boolean true if change is an edit

public boolean isEdit()

Determines whether the change is an edit (true) or affects styling only (false).

Returns:boolean: true if change is an edit

ofEdit	back to summary
public static ContentChange ofEdit(TextPos start, TextPos end, int charsAddedTop, int linesAdded, int charsAddedBottom) Creates the content change event which represents an edit. Parameters start:TextPos the start position end:TextPos the end position charsAddedTop:int the number of characters appended to the paragraph containing the start position linesAdded:int the number of full paragraphs inserted charsAddedBottom:int the number of characters inserted at the beginning of the paragraph containing the end position Returns:ContentChange the change instance

ofEdit

back to summary

public static ContentChange ofEdit(TextPos start, TextPos end, int charsAddedTop, int linesAdded, int charsAddedBottom)

Creates the content change event which represents an edit.

Parameters

start:TextPos: the start position
end:TextPos: the end position
charsAddedTop:int: the number of characters appended to the paragraph containing the start position
linesAdded:int: the number of full paragraphs inserted
charsAddedBottom:int: the number of characters inserted at the beginning of the paragraph containing the end position

Returns:ContentChange

the change instance

ofStyleChange	back to summary
public static ContentChange ofStyleChange(TextPos start, TextPos end) Creates the content change event which represents a styling update. Parameters start:TextPos the start position end:TextPos the end position Returns:ContentChange the change instance

ofStyleChange

back to summary

public static ContentChange ofStyleChange(TextPos start, TextPos end)

Creates the content change event which represents a styling update.

Parameters

start:TextPos: the start position
end:TextPos: the end position

Returns:ContentChange

the change instance

public abstract Class ContentChange

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail