com.goldencode.p2j.ui

Interface EditorInterface

All Known Subinterfaces:

HandleCommon

All Known Implementing Classes:

EditorWidget

public interface EditorInterface

Define all EDITOR-specific widget attributes and methods which can be accessed via a handle instance. Attributes and methods shared by multiple widget types will be defined elsewhere.

Method Summary

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	isAutoIndent() Get the value of the AUTO-INDENT attribute.
logical	isLarge() Get the EDITOR's LARGE attribute.
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	setAutoIndent(boolean autoIndent) Set the value of the AUTO-INDENT attribute.
void	setAutoIndent(logical autoIndent) Set the value of the AUTO-INDENT attribute.
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	setLarge(boolean large) Mark this EDITOR widget as EDITOR LARGE, which can be used to display a value of type LONGCHAR.
void	setLarge(logical large) Mark this EDITOR widget as EDITOR LARGE, which can be used to display a value of type LONGCHAR.
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

Method Detail

isAutoIndent

logical isAutoIndent()

Get the value of the AUTO-INDENT attribute. When true a new line in the editor will be indented to the same column as the previous line.

Returns:

The value of the attribute.

setAutoIndent

void setAutoIndent(logical autoIndent)

Set the value of the AUTO-INDENT attribute.

Parameters:

autoIndent - When true a new line in the editor will be indented to the same column as the previous line.

setAutoIndent

void setAutoIndent(boolean autoIndent)

Set the value of the AUTO-INDENT attribute.

Parameters:

autoIndent - When true a new line in the editor will be indented to the same column as the previous line.

deleteLine

logical deleteLine()

Implements the DELETE-LINE() method which deletes the line of text in which the cursor is positioned.

Returns:

true if the line was deleted.

insertString

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.

Parameters:

txt - The text to be inserted.

Returns:

true if the text was inserted.

insertString

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.

Parameters:

txt - The text to be inserted.

Returns:

true if the text was inserted.

readFile

logical readFile(character name)

Implements the READ-FILE() method which replaces the editor's contents with those read from the specified file.

Parameters:

name - The relative or absolute file name.

Returns:

true if the file was successfully read.

readFile

logical readFile(java.lang.String name)

Implements the READ-FILE() method which replaces the editor's contents with those read from the specified file.

Parameters:

name - The relative or absolute file name.

Returns:

true if the file was successfully read.

replaceSelectionText

logical replaceSelectionText(character txt)

Implements the REPLACE-SELECTION-TEXT() method which replaces the editor's currently selected text with the given text.

Parameters:

txt - The replacement text.

Returns:

true if the text was successfully replaced.

replaceSelectionText

logical replaceSelectionText(java.lang.String txt)

Implements the REPLACE-SELECTION-TEXT() method which replaces the editor's currently selected text with the given text.

Parameters:

txt - The replacement text.

Returns:

true if the text was successfully replaced.

saveFile

logical saveFile(java.lang.String name)

Implements the SAVE-FILE() method which write the editor's contents to the specified file.

Parameters:

name - The relative or absolute file name.

Returns:

true if the file was successfully written.

saveFile

logical saveFile(character name)

Implements the SAVE-FILE() method which write the editor's contents to the specified file.

Parameters:

name - The relative or absolute file name.

Returns:

true if the file was successfully written.

getCursorChar

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.

Returns:

The current position of the cursor on the current line.

setCursorChar

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.

Parameters:

idx - The position to which to move.

setCursorChar

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.

Parameters:

idx - The position to which to move.

getCursorLine

integer getCursorLine()

Get the value of the CURSOR-LINE attribute which is the current cursor position as a 1-based line number.

Returns:

The current position of the cursor on the current line.

setCursorLine

void setCursorLine(double line)

Set the value of the CURSOR-LINE attribute which moves the cursor position to the specified 1-based line number.

Parameters:

line - The line to which to move.

setCursorLine

void setCursorLine(NumberType line)

Set the value of the CURSOR-LINE attribute which moves the cursor position to the specified 1-based line number.

Parameters:

line - The line to which to move.

getNumLines

integer getNumLines()

Get the value of the NUM-LINES attribute which is the number of lines of text in the editor.

Returns:

The number of lines in the editor.

isReturnInserted

logical isReturnInserted()

Get the value of the RETURN-INSERTED attribute

Returns:

the value of the attribute

setReturnInserted

void setReturnInserted(logical value)

Set the value of the RETURN-INSERTED attribute

Parameters:

value - the new value of the attribute

setReturnInserted

void setReturnInserted(boolean value)

Set the value of the RETURN-INSERTED attribute

Parameters:

value - the new value of the attribute

isWordWrap

logical isWordWrap()

Get the value of the WORD-WRAP attribute

Returns:

the value of the attribute

setWordWrap

void setWordWrap(logical value)

Set the value of the WORD-WRAP attribute

Parameters:

value - the new value of the attribute

setWordWrap

void setWordWrap(boolean value)

Set the value of the WORD-WRAP attribute

Parameters:

value - the new value of the attribute

getLength

integer getLength()

Get the value of the LENGTH attribute

Returns:

the value of the attribute

insertFile

logical insertFile(java.lang.String file)

Attempts to insert the content of a text file at the current position of the caret.

Parameters:

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.

Returns:

if the text insertion succeeded, the method returns yes.

insertFile

logical insertFile(character file)

Attempts to insert the content of a text file at the current position of the caret.

Parameters:

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.

Returns:

if the text insertion succeeded, the method returns yes.

search

logical search(java.lang.String pattern,
               long mode)

Searches for a specified string starting from the current text caret position.

Parameters:

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

Returns:

if the text is found and caret moved, the method returns yes.

search

logical search(character pattern,
               long mode)

Searches for a specified string starting from the current text caret position.

Parameters:

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

Returns:

if the text is found and caret moved, the method returns yes.

search

logical search(java.lang.String pattern,
               int64 mode)

Searches for a specified string starting from the current text caret position.

Parameters:

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

Returns:

if the text is found and caret moved, the method returns yes.

search

logical search(character pattern,
               int64 mode)

Searches for a specified string starting from the current text caret position.

Parameters:

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

Returns:

if the text is found and caret moved, the method returns yes.

moveCaretToEof

logical moveCaretToEof()

Moves the caret position at the end of the current text

Returns:

if the operation is successful, the method returns yes

setLarge

void setLarge(boolean large)

Mark this EDITOR widget as EDITOR LARGE, which can be used to display a value of type LONGCHAR.

Parameters:

large - When true, this is a EDITOR LARGE widget.

setLarge

void setLarge(logical large)

Mark this EDITOR widget as EDITOR LARGE, which can be used to display a value of type LONGCHAR.

Parameters:

large - When true, this is a EDITOR LARGE widget.

isLarge

logical isLarge()

Get the EDITOR's LARGE attribute.

Returns:

When true, this is a EDITOR LARGE widget.