public interface EditorInterface
Modifier and Type | Method and Description |
---|---|
logical |
deleteLine()
Implements the DELETE-LINE() method which deletes the line of text in which the cursor is
positioned.
|
integer |
getCursorChar()
Get the value of the CURSOR-CHAR attribute which is the current cursor position as a
1-based index on the current line.
|
integer |
getCursorLine()
Get the value of the CURSOR-LINE attribute which is the current cursor position as a
1-based line number.
|
integer |
getLength()
Get the value of the LENGTH attribute
|
integer |
getNumLines()
Get the value of the NUM-LINES attribute which is the number of lines of text in the
editor.
|
logical |
insertFile(character file)
Attempts to insert the content of a text file at the current position of the caret.
|
logical |
insertFile(java.lang.String file)
Attempts to insert the content of a text file at the current position of the caret.
|
logical |
insertString(character txt)
Implements the INSERT-STRING() method which inserts the given text into the editor at the
location at which the cursor is positioned.
|
logical |
insertString(java.lang.String txt)
Implements the INSERT-STRING() method which inserts the given text into the editor at the
location at which the cursor is positioned.
|
logical |
isReturnInserted()
Get the value of the RETURN-INSERTED attribute
|
logical |
isWordWrap()
Get the value of the WORD-WRAP attribute
|
logical |
moveCaretToEof()
Moves the caret position at the end of the current text
|
logical |
readFile(character name)
Implements the READ-FILE() method which replaces the editor's contents with those read
from the specified file.
|
logical |
readFile(java.lang.String name)
Implements the READ-FILE() method which replaces the editor's contents with those read
from the specified file.
|
logical |
replaceSelectionText(character txt)
Implements the REPLACE-SELECTION-TEXT() method which replaces the editor's currently
selected text with the given text.
|
logical |
replaceSelectionText(java.lang.String txt)
Implements the REPLACE-SELECTION-TEXT() method which replaces the editor's currently
selected text with the given text.
|
logical |
saveFile(character name)
Implements the SAVE-FILE() method which write the editor's contents to the specified file.
|
logical |
saveFile(java.lang.String name)
Implements the SAVE-FILE() method which write the editor's contents to the specified file.
|
logical |
search(character pattern,
int64 mode)
Searches for a specified string starting from the current text caret position.
|
logical |
search(character pattern,
long mode)
Searches for a specified string starting from the current text caret position.
|
logical |
search(java.lang.String pattern,
int64 mode)
Searches for a specified string starting from the current text caret position.
|
logical |
search(java.lang.String pattern,
long mode)
Searches for a specified string starting from the current text caret position.
|
void |
setCursorChar(double idx)
Set the value of the CURSOR-CHAR attribute which moves the cursor position to the
specified 1-based index on the current line.
|
void |
setCursorChar(NumberType idx)
Set the value of the CURSOR-CHAR attribute which moves the cursor position to the
specified 1-based index on the current line.
|
void |
setCursorLine(double line)
Set the value of the CURSOR-LINE attribute which moves the cursor position to the
specified 1-based line number.
|
void |
setCursorLine(NumberType line)
Set the value of the CURSOR-LINE attribute which moves the cursor position to the
specified 1-based line number.
|
void |
setReturnInserted(boolean value)
Set the value of the RETURN-INSERTED attribute
|
void |
setReturnInserted(logical value)
Set the value of the RETURN-INSERTED attribute
|
void |
setWordWrap(boolean value)
Set the value of the WORD-WRAP attribute
|
void |
setWordWrap(logical value)
Set the value of the WORD-WRAP attribute
|
logical deleteLine()
true
if the line was deleted.logical insertString(character txt)
txt
- The text to be inserted.true
if the text was inserted.logical insertString(java.lang.String txt)
txt
- The text to be inserted.true
if the text was inserted.logical readFile(character name)
name
- The relative or absolute file name.true
if the file was successfully read.logical readFile(java.lang.String name)
name
- The relative or absolute file name.true
if the file was successfully read.logical replaceSelectionText(character txt)
txt
- The replacement text.true
if the text was successfully replaced.logical replaceSelectionText(java.lang.String txt)
txt
- The replacement text.true
if the text was successfully replaced.logical saveFile(java.lang.String name)
name
- The relative or absolute file name.true
if the file was successfully written.logical saveFile(character name)
name
- The relative or absolute file name.true
if the file was successfully written.integer getCursorChar()
void setCursorChar(double idx)
idx
- The position to which to move.void setCursorChar(NumberType idx)
idx
- The position to which to move.integer getCursorLine()
void setCursorLine(double line)
line
- The line to which to move.void setCursorLine(NumberType line)
line
- The line to which to move.integer getNumLines()
logical isReturnInserted()
void setReturnInserted(logical value)
value
- the new value of the attributevoid setReturnInserted(boolean value)
value
- the new value of the attributelogical isWordWrap()
void setWordWrap(logical value)
value
- the new value of the attributevoid setWordWrap(boolean value)
value
- the new value of the attributeinteger getLength()
logical insertFile(java.lang.String file)
file
- The file whose content should be inserted. Full or relative path may be used. In
latter case, the PROPATH
is used to find the file.yes
.logical insertFile(character file)
file
- The file whose content should be inserted. Full or relative path may be used. In
latter case, the PROPATH
is used to find the file.yes
.logical search(java.lang.String pattern, long mode)
pattern
- The string to be search. No wildcard allowed.mode
- a combinations of flags that specifies the type of search to be performed. The
following values are accepted:
Type of search | Flag value |
---|---|
FIND-NEXT-OCCURRENCE | 1 |
FIND-PREV-OCCURRENCE | 2 |
FIND-CASE-SENSITIVE | 4 |
FIND-WRAP-AROUND | 16 |
FIND-SELECT | 32 |
yes
.logical search(character pattern, long mode)
pattern
- The string to be search. No wildcard allowed.mode
- a combinations of flags that specifies the type of search to be performed. The
following values are accepted:
Type of search | Flag value |
---|---|
FIND-NEXT-OCCURRENCE | 1 |
FIND-PREV-OCCURRENCE | 2 |
FIND-CASE-SENSITIVE | 4 |
FIND-WRAP-AROUND | 16 |
FIND-SELECT | 32 |
yes
.logical search(java.lang.String pattern, int64 mode)
pattern
- The string to be search. No wildcard allowed.mode
- a combinations of flags that specifies the type of search to be performed. The
following values are accepted:
Type of search | Flag value |
---|---|
FIND-NEXT-OCCURRENCE | 1 |
FIND-PREV-OCCURRENCE | 2 |
FIND-CASE-SENSITIVE | 4 |
FIND-WRAP-AROUND | 16 |
FIND-SELECT | 32 |
yes
.logical search(character pattern, int64 mode)
pattern
- The string to be search. No wildcard allowed.mode
- a combinations of flags that specifies the type of search to be performed. The
following values are accepted:
Type of search | Flag value |
---|---|
FIND-NEXT-OCCURRENCE | 1 |
FIND-PREV-OCCURRENCE | 2 |
FIND-CASE-SENSITIVE | 4 |
FIND-WRAP-AROUND | 16 |
FIND-SELECT | 32 |
yes
.logical moveCaretToEof()
yes