Uses of Class org.gjt.sp.jedit.Buffer (jEdit API Documentation)
Date: 2015-02-03

## Uses of Class
org.gjt.sp.jedit.Buffer

- Packages that use Buffer
  Package | Description
  --- | ---
  org.gjt.sp.jedit | This package contains jEdit's core classes.
  org.gjt.sp.jedit.bufferio | Classes related to loading, saving, autosaving buffers.
  org.gjt.sp.jedit.bufferset | Classes related to implementation of the BufferSets feature of jEdit.
  org.gjt.sp.jedit.gui | Various GUI controls and dialog boxes.
  org.gjt.sp.jedit.io | Virtual file system and multi-threaded I/O.
  org.gjt.sp.jedit.msg | EditBus messages.
  org.gjt.sp.jedit.print | Printing.
  org.gjt.sp.jedit.search | Search and replace classes.
  org.jedit.keymap | Named sets of keyboard shortcuts

- - ### Uses of Buffer in org.gjt.sp.jedit

    Methods in org.gjt.sp.jedit that return Buffer
    Modifier and Type | Method and Description
    --- | ---
    `static Buffer` | jEdit.`_getBuffer(java.lang.String path)` Returns the buffer with the specified path name.
    `Buffer` | View.`getBuffer()` Returns the current edit pane's buffer.
    `Buffer` | EditPane.`getBuffer()` Returns the current buffer.
    `static Buffer` | jEdit.`getBuffer(java.lang.String path)` Returns the buffer with the specified path name.
    `Buffer[]` | View.`getBuffers()` Returns all Buffers opened in this View, sorted according to View options.
    `static Buffer[]` | jEdit.`getBuffers()` Returns an array of all open buffers from any View.
    `static Buffer` | jEdit.`getFirstBuffer()` Returns the first buffer.
    `static Buffer` | jEdit.`getLastBuffer()` Returns the last buffer.
    `Buffer` | Buffer.`getNext()` Returns the next buffer in the list.
    `Buffer` | Buffer.`getPrev()` Returns the previous buffer in the list.
    `static Buffer` | EditServer.`handleClient(boolean restore, boolean newView, boolean newPlainView, java.lang.String parent, java.lang.String[] args)`
    `static Buffer` | jEdit.`newFile(EditPane editPane)` Creates a new `untitled' file.
    `static Buffer` | jEdit.`newFile(EditPane editPane, java.lang.String dir)` Creates a new `untitled' file.
    `static Buffer` | jEdit.`newFile(View view)` Creates a new `untitled' file.
    `static Buffer` | jEdit.`newFile(View view, java.lang.String dir)` Creates a new `untitled' file.
    `static Buffer` | jEdit.`openFile(EditPane editPane, java.lang.String path)` Opens a file.
    `static Buffer` | jEdit.`openFile(EditPane editPane, java.lang.String parent, java.lang.String path, boolean newFile, java.util.Hashtable<java.lang.String,java.lang.Object> props)` Opens a file.
    `static Buffer` | jEdit.`openFile(View view, java.lang.String path)` Opens a file.
    `static Buffer` | jEdit.`openFile(View view, java.lang.String parent, java.lang.String path, boolean newFile, java.util.Hashtable<java.lang.String,java.lang.Object> props)` Opens a file.
    `static Buffer` | jEdit.`openFileAfterStartup(java.lang.String path)` Opens a file, either immediately if the application is finished starting up, or after the first view has been created if not.
    `static Buffer` | jEdit.`openFiles(View view, java.lang.String parent, java.lang.String[] args)` Opens the file names specified in the argument array.
    `static Buffer` | jEdit.`openTemporary(View view, java.lang.String parent, java.lang.String path, boolean newFile)` Opens a temporary buffer.
    `static Buffer` | jEdit.`openTemporary(View view, java.lang.String parent, java.lang.String path, boolean newFile, java.util.Hashtable<java.lang.String,java.lang.Object> props)` Opens a temporary buffer.

    Methods in org.gjt.sp.jedit with parameters of type Buffer
    Modifier and Type | Method and Description
    --- | ---
    `static void` | jEdit.`_closeBuffer(View view, Buffer buffer)` Closes the buffer, even if it has unsaved changes.
    `static java.io.Reader` | MiscUtilities.`autodetect(java.io.InputStream in, Buffer buffer)` Tries to detect if the stream is gzipped, and if it has an encoding specified with an XML PI.
    `void` | EditPane.`bufferAdded(Buffer buffer, int index)` A buffer was added in the bufferSet.
    `void` | EditPane.`bufferMoved(Buffer buffer, int oldIndex, int newIndex)` A buffer was moved in the BufferSet.
    `void` | EditPane.`bufferRemoved(Buffer buffer, int index)` A buffer was removed from the bufferSet.
    `static void` | jEdit.`closeBuffer(EditPane editPane, Buffer buffer)` Close a buffer.
    `static boolean` | jEdit.`closeBuffer(View view, Buffer buffer)` Closes a buffer.
    `static void` | jEdit.`commitTemporary(Buffer buffer)` Adds a temporary buffer to the buffer list.
    `EditPane` | View.`goToBuffer(Buffer buffer)` If this buffer is open in one of the view's edit panes, sets focus to that edit pane.
    `static View` | jEdit.`newView(View view, Buffer buffer)` Creates a new view of a buffer.
    `static View` | jEdit.`newView(View view, Buffer buffer, boolean plainView)` Creates a new view of a buffer.
    `static View` | jEdit.`newView(View view, Buffer buffer, View.ViewConfig config)` Creates a new view.
    `void` | View.`setBuffer(Buffer buffer)` Sets the current edit pane's buffer.
    `void` | EditPane.`setBuffer(Buffer buffer)` Sets the current buffer.
    `void` | EditPane.`setBuffer(Buffer buffer, boolean requestFocus)` Sets the current buffer.
    `void` | View.`setSplitConfig(Buffer buffer, java.lang.String splitConfig)` sets the split configuration as per the splitConfig.
    `EditPane` | View.`showBuffer(Buffer buffer)` If this buffer is open in one of the view's edit panes, activates that edit pane.

    Constructors in org.gjt.sp.jedit with parameters of type Buffer
    Constructor and Description
    `Macros.Recorder(View view, Buffer buffer, boolean temporary)`

  - ### Uses of Buffer in org.gjt.sp.jedit.bufferio

    Fields in org.gjt.sp.jedit.bufferio declared as Buffer
    Modifier and Type | Field and Description
    --- | ---
    `protected Buffer` | MarkersSaveRequest.`buffer`
    `protected Buffer` | BufferIORequest.`buffer`

    Methods in org.gjt.sp.jedit.bufferio with parameters of type Buffer
    Modifier and Type | Method and Description
    --- | ---
    `protected void` | BufferIORequest.`write(Buffer buffer, java.io.OutputStream out)`

    Constructors in org.gjt.sp.jedit.bufferio with parameters of type Buffer
    Constructor and Description
    `BufferAutosaveRequest(View view, Buffer buffer, java.lang.Object session, VFS vfs, java.lang.String path)` Creates a new buffer I/O request.
    `BufferInsertRequest(View view, Buffer buffer, java.lang.Object session, VFS vfs, java.lang.String path)` Creates a new buffer I/O request.
    `BufferIORequest(View view, Buffer buffer, java.lang.Object session, VFS vfs, java.lang.String path)` Creates a new buffer I/O request.
    `BufferLoadRequest(View view, Buffer buffer, java.lang.Object session, VFS vfs, java.lang.String path)` Creates a new buffer I/O request.
    `BufferSaveRequest(View view, Buffer buffer, java.lang.Object session, VFS vfs, java.lang.String path)` Creates a new buffer I/O request.
    `MarkersSaveRequest(View view, Buffer buffer, java.lang.Object session, VFS vfs, java.lang.String path)` Creates a new I/O request for markers.

  - ### Uses of Buffer in org.gjt.sp.jedit.bufferset

    Methods in org.gjt.sp.jedit.bufferset that return Buffer
    Modifier and Type | Method and Description
    --- | ---
    `static Buffer` | BufferSetManager.`createUntitledBuffer()` Create an untitled buffer
    `Buffer[]` | BufferSet.`getAllBuffers()` Returns an array of all buffers in this bufferSet.
    `Buffer` | BufferSet.`getBuffer(int index)` Returns the Buffer at the given index.
    `Buffer` | BufferSet.`getNextBuffer(int index)`
    `Buffer` | BufferSet.`getPreviousBuffer(int index)`

    Methods in org.gjt.sp.jedit.bufferset that return types with arguments of type Buffer
    Modifier and Type | Method and Description
    --- | ---
    `java.util.Comparator<Buffer>` | BufferSet.`getSorter()`

    Methods in org.gjt.sp.jedit.bufferset with parameters of type Buffer
    Modifier and Type | Method and Description
    --- | ---
    `void` | BufferSet.`addBuffer(Buffer buffer)` Internal use only, use `BufferSetManager.addBuffer(org.gjt.sp.jedit.View, org.gjt.sp.jedit.Buffer)` or `BufferSetManager.addBuffer(org.gjt.sp.jedit.EditPane, org.gjt.sp.jedit.Buffer)`
    `void` | BufferSetManager.`addBuffer(EditPane editPane, Buffer buffer)` Add a buffer into the current editPane of the given editPane.
    `void` | BufferSetManager.`addBuffer(View view, Buffer buffer)` Add a buffer into the current editPane of the given view.
    `void` | BufferSet.`addBufferAt(Buffer buffer, int position)` Internal use only, use `BufferSetManager.addBuffer(org.gjt.sp.jedit.View, org.gjt.sp.jedit.Buffer)` or `BufferSetManager.addBuffer(org.gjt.sp.jedit.EditPane, org.gjt.sp.jedit.Buffer)`
    `void` | BufferSetListener.`bufferAdded(Buffer buffer, int index)` A buffer was added in the bufferSet.
    `void` | BufferSetAdapter.`bufferAdded(Buffer buffer, int index)`
    `void` | BufferSetListener.`bufferMoved(Buffer buffer, int oldIndex, int newIndex)` A buffer was moved in the BufferSet.
    `void` | BufferSetAdapter.`bufferMoved(Buffer buffer, int oldIndex, int newIndex)`
    `void` | BufferSetListener.`bufferRemoved(Buffer buffer, int index)` A buffer was removed from the bufferSet.
    `void` | BufferSetAdapter.`bufferRemoved(Buffer buffer, int index)`
    `int` | BufferSet.NameSorter.`compare(Buffer o1, Buffer o2)`
    `int` | BufferSet.PathSorter.`compare(Buffer o1, Buffer o2)`
    `int` | BufferSetManager.`countBufferSets(Buffer buffer)` Count the bufferSets in which the buffer is.
    `java.util.Set<BufferSet>` | BufferSetManager.`getOwners(Buffer buffer)`
    `int` | BufferSet.`indexOf(Buffer buffer)`
    `void` | BufferSetManager.`removeBuffer(Buffer buffer)` remove a buffer from all bufferSets.
    `void` | BufferSetManager.`removeBuffer(EditPane editPane, Buffer buffer)` Remove a buffer from the EditPane's bufferSet.

  - ### Uses of Buffer in org.gjt.sp.jedit.gui

    Constructors in org.gjt.sp.jedit.gui with parameters of type Buffer
    Constructor and Description
    `BufferOptions(View view, Buffer buffer)`
    `GrabKeyDialog(java.awt.Dialog parent, GrabKeyDialog.KeyBinding binding, java.util.List<GrabKeyDialog.KeyBinding> allBindings, Buffer debugBuffer)` Create and show a new modal dialog.
    `GrabKeyDialog(java.awt.Frame parent, GrabKeyDialog.KeyBinding binding, java.util.List<GrabKeyDialog.KeyBinding> allBindings, Buffer debugBuffer)` Create and show a new modal dialog.

    Constructor parameters in org.gjt.sp.jedit.gui with type arguments of type Buffer
    Constructor and Description
    `CloseDialog(View view, java.util.Collection<Buffer> buffers)`

  - ### Uses of Buffer in org.gjt.sp.jedit.io

    Methods in org.gjt.sp.jedit.io with parameters of type Buffer
    Modifier and Type | Method and Description
    --- | ---
    `void` | VFS.`_finishTwoStageSave(java.lang.Object session, Buffer buffer, java.lang.String path, java.awt.Component comp)` Called after a file has been saved and we use twoStageSave (first saving to another file).
    `void` | VFS.`_saveComplete(java.lang.Object session, Buffer buffer, java.lang.String path, java.awt.Component comp)` Called after a file has been saved.
    `void` | FileVFS.`_saveComplete(java.lang.Object session, Buffer buffer, java.lang.String path, java.awt.Component comp)`
    `boolean` | VFS.`insert(View view, Buffer buffer, java.lang.String path)` Inserts a file into the specified buffer.
    `boolean` | FileVFS.`insert(View view, Buffer buffer, java.lang.String path)`
    `boolean` | VFS.`load(View view, Buffer buffer, java.lang.String path)` Loads the specified buffer.
    `boolean` | VFS.`save(View view, Buffer buffer, java.lang.String path)` Saves the specifies buffer.
    `boolean` | FileVFS.`save(View view, Buffer buffer, java.lang.String path)`

  - ### Uses of Buffer in org.gjt.sp.jedit.msg

    Methods in org.gjt.sp.jedit.msg that return Buffer
    Modifier and Type | Method and Description
    --- | ---
    `Buffer` | BufferUpdate.`getBuffer()` Returns the buffer involved.
    `Buffer` | BufferChanging.`getBuffer()`

    Constructors in org.gjt.sp.jedit.msg with parameters of type Buffer
    Constructor and Description
    `BufferChanging(EditPane editPane, Buffer newBuffer)`
    `BufferUpdate(Buffer buffer, View view, java.lang.Object what)` Creates a new buffer update message.

  - ### Uses of Buffer in org.gjt.sp.jedit.print

    Methods in org.gjt.sp.jedit.print with parameters of type Buffer
    Modifier and Type | Method and Description
    --- | ---
    `static void` | BufferPrinter1_4.`print(View view, Buffer buffer, boolean selection)`
    `static void` | BufferPrinter1_3.`print(View view, Buffer buffer, boolean selection)`

  - ### Uses of Buffer in org.gjt.sp.jedit.search

    Fields in org.gjt.sp.jedit.search declared as Buffer
    Modifier and Type | Field and Description
    --- | ---
    `Buffer` | HyperSearchResult.`buffer`

    Methods in org.gjt.sp.jedit.search that return Buffer
    Modifier and Type | Method and Description
    --- | ---
    `Buffer` | HyperSearchResult.`getBuffer(View view)`
    `Buffer` | HyperSearchNode.`getBuffer(View view)`
    `Buffer` | HyperSearchFileNode.`getBuffer(View view)`

    Methods in org.gjt.sp.jedit.search with parameters of type Buffer
    Modifier and Type | Method and Description
    --- | ---
    `static boolean` | SearchAndReplace.`find(View view, Buffer buffer, int start)` Finds the next instance of the search string in the specified buffer.
    `static boolean` | SearchAndReplace.`find(View view, Buffer buffer, int start, boolean firstTime, boolean reverse)` Finds the next instance of the search string in the specified buffer.
    `static boolean` | SearchAndReplace.`replace(View view, Buffer buffer, int start, int end)` Replaces text in the specified range with the replacement string.

  - ### Uses of Buffer in org.jedit.keymap

    Methods in org.jedit.keymap with parameters of type Buffer
    Modifier and Type | Method and Description
    --- | ---
    `int` | EmacsUtil.`getMark(Buffer buffer)`
    `java.lang.String` | EmacsUtil.`makeBufferPropertyName(Buffer theBuffer, java.lang.String prefix)`
    `void` | EmacsUtil.`setMark(Buffer buffer, int pos)`