Class besiex.FrIJDE.AbstractClasses.FrIJDEDocumentManager
All Packages Class Hierarchy This Package Previous Next Index
Class besiex.FrIJDE.AbstractClasses.FrIJDEDocumentManager
java.lang.Object
|
+----besiex.FrIJDE.AbstractClasses.FrIJDETool
|
+----besiex.FrIJDE.AbstractClasses.FrIJDEDocumentManager
- public class FrIJDEDocumentManager
- extends FrIJDETool
Any document manager (multiple document editor) used with FrIJDE must extend this class.
This class defines all the most basic requirements that other tools would have for
a multiple document editor.
- Version:
- 1.00, 21 February 1996
Changes from last version
- Author:
- Benjamin "Quincy" Cabell V, Besiex Software
-
FrIJDEDocumentManager()
-
-
CloseAllDocuments()
- The document manager closes all open files (if any).
-
CloseDocument(String)
- The document manager closes (if open) the editor file with file name and path theFileNameWithPath.
-
GotoLineInDocument(String, int)
- The document manager opens (if not already opened) the file with the file name and path theFileNameWithPath,
makes it visible and maximized within the editor-space, gives it focus, jumps to the line number theLineNumber,
highlights the line, and sets the caret to the beginning of the line.
-
GotoLineInDocument(String, int, int)
- The document manager opens (if not already opened) the file with the file name and path theFileNameWithPath,
makes it visible and maximized within the editor-space, gives it focus, jumps to the line number theLineNumber,
highlights the line, and sets the caret at character position theCharacterPosition.
-
NewDocument()
- The document manager creates a new, empty, visible and untitled document.
-
NewDocumentWithFileNameWithPath(String)
- The document manager creates a new, empty, visible document preset with file name and path
theFileNameWithPath.
-
OpenDocument(String)
- The document manager opens and makes visible the document with file name and path theFileNameWithPath.
FrIJDEDocumentManager
public FrIJDEDocumentManager()
NewDocument
public abstract boolean NewDocument()
- The document manager creates a new, empty, visible and untitled document. This document
appears maximized within the editor-space and is given focus.
NewDocumentWithFileNameWithPath
public abstract boolean NewDocumentWithFileNameWithPath(String theFileNameWithPath)
- The document manager creates a new, empty, visible document preset with file name and path
theFileNameWithPath. This document appears maximized within the editor-space and is given focus.
- Parameters:
- theFileNameWithPath - The name and path to give the document created.
- Returns:
- True if successful, false if unsuccessful.
OpenDocument
public abstract boolean OpenDocument(String theFileNameWithPath)
- The document manager opens and makes visible the document with file name and path theFileNameWithPath.
This document appears maximized within the editor-space and is given focus.
- Parameters:
- theFileNameWithPath - The name and path of the file to open.
- Returns:
- True if successful, false if unsuccessful.
CloseDocument
public abstract boolean CloseDocument(String theFileNameWithPath)
- The document manager closes (if open) the editor file with file name and path theFileNameWithPath.
If the document has been modified since last saved (and the document manager is coded with awareness of
this) the user should be asked if he/she would like to save the document before it is closed). Focus changes
only if it is on the document which is to be closed (it should change to the next document in the open document
list).
- Parameters:
- theFileNameWithPath - The name and path of the file to close.
- Returns:
- False if unable to close the document (e.g. user cancel from save query), true otherwise.
CloseAllDocuments
public abstract boolean CloseAllDocuments()
- The document manager closes all open files (if any). If any documents have been modified since last saved
(and the document manager is coded with awareness of this) the user should be asked if he/she would like to
save the documents before they are closed); this should be done via CloseDocument(String). Focus changes to
FrIJDEMainFrame.
- Returns:
- False if unable to close any documents (e.g. user cancel from save query), true otherwise.
GotoLineInDocument
public abstract boolean GotoLineInDocument(String theFileNameWithPath,
int theLineNumber)
- The document manager opens (if not already opened) the file with the file name and path theFileNameWithPath,
makes it visible and maximized within the editor-space, gives it focus, jumps to the line number theLineNumber,
highlights the line, and sets the caret to the beginning of the line.
- Parameters:
- theFileNameWithPath - The name and path of the file containing the line to go to.
- theLineNumber - The number of the line to go to.
- Returns:
- False if unable to open the file or unable to go the line, true otherwise.
GotoLineInDocument
public abstract boolean GotoLineInDocument(String theFileNameWithPath,
int theLineNumber,
int theCharacterPosition)
- The document manager opens (if not already opened) the file with the file name and path theFileNameWithPath,
makes it visible and maximized within the editor-space, gives it focus, jumps to the line number theLineNumber,
highlights the line, and sets the caret at character position theCharacterPosition.
- Parameters:
- theFileNameWithPath - The name and path of the file containing the line to go to.
- theLineNumber - The number of the line to go to.
- theCharacterPosition - The character position (number of characters from the beginning of the line)
at which to place the caret.
- Returns:
- False if unable to open the file or unable to go the line, true otherwise.
All Packages Class Hierarchy This Package Previous Next Index