Interface to describe a sequence of character content that can be edited. Implementations may or may not support a history mechanism which will be reflected by whether or not mutations return an UndoableEdit implementation.
Interface to describe a sequence of character content that can be edited. Implementations may or may not support a history mechanism which will be reflected by whether or not mutations return an UndoableEdit implementation.
(create-position this offset)
Creates a position within the content that will track change as the content is mutated.
offset - the offset in the content >= 0 - int
returns: a Position - javax.swing.text.Position
throws: javax.swing.text.BadLocationException - for an invalid offset
Creates a position within the content that will track change as the content is mutated. offset - the offset in the content >= 0 - `int` returns: a Position - `javax.swing.text.Position` throws: javax.swing.text.BadLocationException - for an invalid offset
(get-chars this where len txt)
Gets a sequence of characters and copies them into a Segment.
where - the starting offset >= 0 - int
len - the number of characters >= 0 - int
txt - the target location to copy into - javax.swing.text.Segment
throws: javax.swing.text.BadLocationException - Thrown if the area covered by the arguments is not contained in the character sequence.
Gets a sequence of characters and copies them into a Segment. where - the starting offset >= 0 - `int` len - the number of characters >= 0 - `int` txt - the target location to copy into - `javax.swing.text.Segment` throws: javax.swing.text.BadLocationException - Thrown if the area covered by the arguments is not contained in the character sequence.
(get-string this where len)
Fetches a string of characters contained in the sequence.
where - Offset into the sequence to fetch >= 0. - int
len - number of characters to copy >= 0. - int
returns: the string - java.lang.String
throws: javax.swing.text.BadLocationException - Thrown if the area covered by the arguments is not contained in the character sequence.
Fetches a string of characters contained in the sequence. where - Offset into the sequence to fetch >= 0. - `int` len - number of characters to copy >= 0. - `int` returns: the string - `java.lang.String` throws: javax.swing.text.BadLocationException - Thrown if the area covered by the arguments is not contained in the character sequence.
(insert-string this where str)
Inserts a string of characters into the sequence.
where - offset into the sequence to make the insertion >= 0 - int
str - string to insert - java.lang.String
returns: if the implementation supports a history mechanism,
a reference to an Edit implementation will be returned,
otherwise returns null - javax.swing.undo.UndoableEdit
throws: javax.swing.text.BadLocationException - thrown if the area covered by the arguments is not contained in the character sequence
Inserts a string of characters into the sequence. where - offset into the sequence to make the insertion >= 0 - `int` str - string to insert - `java.lang.String` returns: if the implementation supports a history mechanism, a reference to an Edit implementation will be returned, otherwise returns null - `javax.swing.undo.UndoableEdit` throws: javax.swing.text.BadLocationException - thrown if the area covered by the arguments is not contained in the character sequence
(length this)
Current length of the sequence of character content.
returns: the length >= 0 - int
Current length of the sequence of character content. returns: the length >= 0 - `int`
(remove this where nitems)
Removes some portion of the sequence.
where - The offset into the sequence to make the insertion >= 0. - int
nitems - The number of items in the sequence to remove >= 0. - int
returns: If the implementation supports a history mechanism,
a reference to an Edit implementation will be returned,
otherwise null. - javax.swing.undo.UndoableEdit
throws: javax.swing.text.BadLocationException - Thrown if the area covered by the arguments is not contained in the character sequence.
Removes some portion of the sequence. where - The offset into the sequence to make the insertion >= 0. - `int` nitems - The number of items in the sequence to remove >= 0. - `int` returns: If the implementation supports a history mechanism, a reference to an Edit implementation will be returned, otherwise null. - `javax.swing.undo.UndoableEdit` throws: javax.swing.text.BadLocationException - Thrown if the area covered by the arguments is not contained in the character sequence.
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close