EditorSupport (Datasystems API)

java.lang.Object
- org.openide.windows.CloneableOpenSupport
- - org.openide.loaders.OpenSupport
  - - org.openide.text.EditorSupport

All Implemented Interfaces:

org.netbeans.api.actions.Closable, org.netbeans.api.actions.Openable, org.netbeans.api.actions.Printable, org.openide.cookies.CloseCookie, org.openide.cookies.EditorCookie, org.openide.cookies.EditorCookie.Observable, org.openide.cookies.LineCookie, org.openide.cookies.OpenCookie, org.openide.cookies.PrintCookie, org.openide.nodes.Node.Cookie

Deprecated.
Use DataEditorSupport instead
```
@Deprecated
public class EditorSupport
extends OpenSupport
implements org.openide.cookies.EditorCookie.Observable, org.openide.cookies.OpenCookie, org.openide.cookies.CloseCookie, org.openide.cookies.PrintCookie
```
Support for associating an editor and a Swing Document to a data object. Can be assigned as a cookie to any editable data object. Then this data object will be capable of being opened in an editor, and there will be ways of retrieving and acting upon the Swing document which is editing it.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class EditorSupport.Editor
Deprecated.

Cloneable top component to hold the editor kit.
- Nested classes/interfaces inherited from interface org.openide.cookies.EditorCookie
  org.openide.cookies.EditorCookie.Observable
- Nested classes/interfaces inherited from class org.openide.loaders.OpenSupport
  OpenSupport.Env

Nested Classes
Modifier and Type	Class	Description
`static class`	`EditorSupport.Editor`	Deprecated. Cloneable top component to hold the editor kit.

Field Summary

Fields
Modifier and Type	Field	Description
`static java.lang.String`	`EDITOR_MODE`	Deprecated. Use `CloneableEditorSupport.EDITOR_MODE` instead.
`protected java.lang.String`	`modifiedAppendix`	Deprecated. no longer used

Fields inherited from class org.openide.windows.CloneableOpenSupport
allEditors, env

Fields inherited from interface org.openide.cookies.EditorCookie.Observable
PROP_DOCUMENT, PROP_MODIFIED, PROP_OPENED_PANES

Fields inherited from class org.openide.loaders.OpenSupport
entry

Constructor Summary

Constructors
Constructor Description

EditorSupport(MultiDataObject.Entry entry)
Deprecated.

Support an existing loader entry.

Constructors
Constructor	Description
`EditorSupport(MultiDataObject.Entry entry)`	Deprecated. Support an existing loader entry.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`void`	`addChangeListener(javax.swing.event.ChangeListener l)`	Deprecated. Adds a listener for status changes.
`void`	`addPropertyChangeListener(java.beans.PropertyChangeListener l)`	Deprecated.
`protected boolean`	`canClose()`	Deprecated. Should test whether all data is saved, and if not, prompt the user to save.
`boolean`	`close()`	Deprecated. Closes all opened editors (if the user agrees) and flushes content of the document to the file.
`protected boolean`	`close(boolean ask)`	Deprecated. Closes the editor, asks if necessary.
`protected org.openide.windows.CloneableTopComponent`	`createCloneableTopComponent()`	Deprecated.
`protected javax.swing.text.EditorKit`	`createEditorKit()`	Deprecated. Creates editor kit for this source.
`org.openide.text.PositionRef`	`createPositionRef(int offset, javax.swing.text.Position.Bias bias)`	Deprecated. Create a position reference for the given offset.
`protected org.openide.awt.UndoRedo.Manager`	`createUndoRedoManager()`	Deprecated. Create an undo/redo manager.
`protected MultiDataObject`	`findDataObject()`	Deprecated. Finds data object the entry belongs to.
`javax.swing.text.StyledDocument`	`getDocument()`	Deprecated. Get the document.
`org.openide.text.Line.Set`	`getLineSet()`	Deprecated. Get the line set for all paragraphs in the document.
`javax.swing.JEditorPane[]`	`getOpenedPanes()`	Deprecated.
`boolean`	`isDocumentLoaded()`	Deprecated. Test whether the document is in memory, or whether loading is still in progress.
`boolean`	`isModified()`	Deprecated. Test whether the document is modified.
`protected void`	`loadFromStreamToKit(javax.swing.text.StyledDocument doc, java.io.InputStream stream, javax.swing.text.EditorKit kit)`	Deprecated. Actually read file data into an editor kit's document from an input stream.
`protected java.lang.String`	`messageName()`	Deprecated. Constructs message that should be used to name the editor component.
`protected java.lang.String`	`messageOpened()`	Deprecated. Message to display when an object has been opened.
`protected java.lang.String`	`messageOpening()`	Deprecated. Message to display when an object is being opened.
`protected java.lang.String`	`messageSave()`	Deprecated. Constructs message that should be displayed when the data object is modified and is being closed.
`protected java.lang.String`	`messageToolTip()`	Deprecated. Text to use as tooltip for component.
`protected void`	`notifyClosed()`	Deprecated. Called when the document is closed and released from memory.
`protected boolean`	`notifyModified()`	Deprecated. Overrides the super method to add a save cookie if the document has been marked modified.
`protected void`	`notifyUnmodified()`	Deprecated. Notification method called when the document become unmodified.
`void`	`open()`	Deprecated. Passes the actual opening to internal delegate support.
`protected EditorSupport.Editor`	`openAt(org.openide.text.PositionRef pos)`	Deprecated. Forcibly create one editor component.
`javax.swing.text.StyledDocument`	`openDocument()`	Deprecated. Get the document associated with this cookie.
`org.openide.util.Task`	`prepareDocument()`	Deprecated. Load the document into memory.
`void`	`print()`	Deprecated. The implementation of @see org.openide.cookies.PrintCookie#print() method.
`protected void`	`reloadDocument()`	Deprecated. Reload the document in response to external modification.
`protected org.openide.util.Task`	`reloadDocumentTask()`	Deprecated. Starts reloading of document.
`void`	`removeChangeListener(javax.swing.event.ChangeListener l)`	Deprecated. Removes a listener for status changes.
`void`	`removePropertyChangeListener(java.beans.PropertyChangeListener l)`	Deprecated.
`void`	`saveDocument()`	Deprecated. Save the document in this thread.
`protected void`	`saveFromKitToStream(javax.swing.text.StyledDocument doc, javax.swing.text.EditorKit kit, java.io.OutputStream stream)`	Deprecated. Actually write file data to an output stream from an editor kit's document.
`void`	`setActions(org.openide.util.actions.SystemAction[] actions)`	Deprecated. has no effect
`void`	`setMIMEType(java.lang.String s)`	Deprecated. Set the MIME type for the document.
`void`	`setModificationListening(boolean listenToModifs)`	Deprecated. Utility method which enables or disables listening to modifications on asociated document.
`protected void`	`updateTitles()`	Deprecated. Updates titles of all editors.

Methods inherited from class org.openide.windows.CloneableOpenSupport
afterRedirect, edit, openCloneableTopComponent, view

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - EDITOR_MODE
```
@Deprecated
public static final java.lang.String EDITOR_MODE
```
    Deprecated. Use CloneableEditorSupport.EDITOR_MODE instead.
    
    Common name for editor mode.
    
    See Also:
    
    Constant Field Values
  - modifiedAppendix
```
@Deprecated
protected java.lang.String modifiedAppendix
```
    Deprecated. no longer used
- Constructor Detail
  - EditorSupport
```
public EditorSupport(MultiDataObject.Entry entry)
```
    Deprecated.
    
    Support an existing loader entry. The file is taken from the entry and is updated if the entry is moved or renamed.
    
    Parameters:
    
    entry - entry to create instance from
- Method Detail
  - messageOpening
```
protected java.lang.String messageOpening()
```
    Deprecated.
    
    Message to display when an object is being opened.
    
    Overrides:
    
    messageOpening in class OpenSupport
    
    Returns:
    
    the message or null if nothing should be displayed
  - messageOpened
```
protected java.lang.String messageOpened()
```
    Deprecated.
    
    Message to display when an object has been opened.
    
    Overrides:
    
    messageOpened in class OpenSupport
    
    Returns:
    
    the message or null if nothing should be displayed
  - messageSave
```
protected java.lang.String messageSave()
```
    Deprecated.
    
    Constructs message that should be displayed when the data object is modified and is being closed.
    
    Returns:
    
    text to show to the user
  - messageName
```
protected java.lang.String messageName()
```
    Deprecated.
    
    Constructs message that should be used to name the editor component.
    
    Returns:
    
    name of the editor
  - messageToolTip
```
protected java.lang.String messageToolTip()
```
    Deprecated.
    
    Text to use as tooltip for component.
    
    Returns:
    
    text to show to the user
  - updateTitles
```
protected void updateTitles()
```
    Deprecated.
    
    Updates titles of all editors.
  - createCloneableTopComponent
```
protected org.openide.windows.CloneableTopComponent createCloneableTopComponent()
```
    Deprecated.
    
    Specified by:
    
    createCloneableTopComponent in class org.openide.windows.CloneableOpenSupport
  - createUndoRedoManager
```
protected org.openide.awt.UndoRedo.Manager createUndoRedoManager()
```
    Deprecated.
    
    Create an undo/redo manager. This manager is then attached to the document, and listens to all changes made in it.
    The default implementation simply uses UndoRedo.Manager.
    
    Returns:
    
    the undo/redo manager
  - open
```
public void open()
```
    Deprecated.
    
    Passes the actual opening to internal delegate support. Overrides superclass method.
    
    Specified by:
    
    open in interface org.openide.cookies.EditorCookie
    
    Specified by:
    
    open in interface org.netbeans.api.actions.Openable
    
    Overrides:
    
    open in class org.openide.windows.CloneableOpenSupport
  - close
```
public boolean close()
```
    Deprecated.
    
    Closes all opened editors (if the user agrees) and flushes content of the document to the file.
    
    Specified by:
    
    close in interface org.netbeans.api.actions.Closable
    
    Specified by:
    
    close in interface org.openide.cookies.EditorCookie
    
    Overrides:
    
    close in class org.openide.windows.CloneableOpenSupport
    
    Returns:
    
    false if the operation is cancelled
  - close
```
protected boolean close(boolean ask)
```
    Deprecated.
    
    Closes the editor, asks if necessary.
    
    Overrides:
    
    close in class org.openide.windows.CloneableOpenSupport
    
    Parameters:
    
    ask - true if we should ask the user
    
    Returns:
    
    true if succesfully closed
  - prepareDocument
```
public org.openide.util.Task prepareDocument()
```
    Deprecated.
    
    Load the document into memory. This is done in different thread. A task for the thread is returned so anyone may test whether the loading has been finished or is still in process.
    
    Specified by:
    
    prepareDocument in interface org.openide.cookies.EditorCookie
    
    Returns:
    
    task for control over loading
  - openDocument
```
public javax.swing.text.StyledDocument openDocument()
                                             throws java.io.IOException
```
    Deprecated.
    
    Get the document associated with this cookie. It is an instance of Swing's StyledDocument but it should also understand the NetBeans NbDocument.GUARDED to prevent certain lines from being edited by the user.
    If the document is not loaded the method blocks until it is.
    
    Specified by:
    
    openDocument in interface org.openide.cookies.EditorCookie
    
    Returns:
    
    the styled document for this cookie that understands the guarded attribute
    
    Throws:
    
    java.io.IOException - if the document could not be loaded
  - getDocument
```
public javax.swing.text.StyledDocument getDocument()
```
    Deprecated.
    
    Get the document. This method may be called before the document initialization (prepareTask) has been completed, in such a case the document must not be modified.
    
    Specified by:
    
    getDocument in interface org.openide.cookies.EditorCookie
    
    Returns:
    
    document or null if it is not yet loaded
  - isDocumentLoaded
```
public boolean isDocumentLoaded()
```
    Deprecated.
    
    Test whether the document is in memory, or whether loading is still in progress.
    
    Returns:
    
    true if document is loaded
  - saveDocument
```
public void saveDocument()
                  throws java.io.IOException
```
    Deprecated.
    
    Save the document in this thread. Create 'orig' document for the case that the save would fail.
    
    Specified by:
    
    saveDocument in interface org.openide.cookies.EditorCookie
    
    Throws:
    
    java.io.IOException - on I/O error
  - saveFromKitToStream
```
protected void saveFromKitToStream(javax.swing.text.StyledDocument doc,
                                   javax.swing.text.EditorKit kit,
                                   java.io.OutputStream stream)
                            throws java.io.IOException,
                                   javax.swing.text.BadLocationException
```
    Deprecated.
    
    Actually write file data to an output stream from an editor kit's document. Called during a file save by saveDocument().
    The default implementation just calls EditorKit.write(...). Subclasses could override this to provide support for persistent guard blocks, for example.
    
    Parameters:
    
    doc - the document to write from
    
    kit - the associated editor kit
    
    stream - the open stream to write to
    
    Throws:
    
    java.io.IOException - if there was a problem writing the file
    
    javax.swing.text.BadLocationException - should not normally be thrown
    
    See Also:
    
    loadFromStreamToKit(javax.swing.text.StyledDocument, java.io.InputStream, javax.swing.text.EditorKit)
  - isModified
```
public boolean isModified()
```
    Deprecated.
    
    Test whether the document is modified.
    
    Specified by:
    
    isModified in interface org.openide.cookies.EditorCookie
    
    Returns:
    
    true if the document is in memory and is modified; otherwise false
  - findDataObject
```
protected MultiDataObject findDataObject()
```
    Deprecated.
    
    Finds data object the entry belongs to.
    
    Returns:
    
    data object or null
  - createPositionRef
```
public final org.openide.text.PositionRef createPositionRef(int offset,
                                                            javax.swing.text.Position.Bias bias)
```
    Deprecated.
    
    Create a position reference for the given offset. The position moves as the document is modified and reacts to closing and opening of the document.
    
    Parameters:
    
    offset - the offset to create position at
    
    bias - the Position.Bias for new creating position.
    
    Returns:
    
    position reference for that offset
  - getLineSet
```
public org.openide.text.Line.Set getLineSet()
```
    Deprecated.
    
    Get the line set for all paragraphs in the document.
    
    Specified by:
    
    getLineSet in interface org.openide.cookies.LineCookie
    
    Returns:
    
    positions of all paragraphs on last save
  - setMIMEType
```
public void setMIMEType(java.lang.String s)
```
    Deprecated.
    
    Set the MIME type for the document.
    
    Parameters:
    
    s - the new MIME type
  - setActions
```
@Deprecated
public void setActions(org.openide.util.actions.SystemAction[] actions)
```
    Deprecated. has no effect
  - createEditorKit
```
protected javax.swing.text.EditorKit createEditorKit()
```
    Deprecated.
    
    Creates editor kit for this source.
    
    Returns:
    
    editor kit
  - setModificationListening
```
public void setModificationListening(boolean listenToModifs)
```
    Deprecated.
    
    Utility method which enables or disables listening to modifications on asociated document.
    Could be useful if we have to modify document, but do not want the Save and Save All actions to be enabled/disabled automatically. Initially modifications are listened to.
    
    Parameters:
    
    listenToModifs - whether to listen to modifications
  - addChangeListener
```
public void addChangeListener(javax.swing.event.ChangeListener l)
```
    Deprecated.
    
    Adds a listener for status changes. An event is fired when the document is moved or removed from memory.
    
    Parameters:
    
    l - new listener
  - removeChangeListener
```
public void removeChangeListener(javax.swing.event.ChangeListener l)
```
    Deprecated.
    
    Removes a listener for status changes.
    
    Parameters:
    
    l - listener to remove
  - addPropertyChangeListener
```
public final void addPropertyChangeListener(java.beans.PropertyChangeListener l)
```
    Deprecated.
    
    Specified by:
    
    addPropertyChangeListener in interface org.openide.cookies.EditorCookie.Observable
  - removePropertyChangeListener
```
public final void removePropertyChangeListener(java.beans.PropertyChangeListener l)
```
    Deprecated.
    
    Specified by:
    
    removePropertyChangeListener in interface org.openide.cookies.EditorCookie.Observable
  - print
```
public void print()
```
    Deprecated.
    
    The implementation of @see org.openide.cookies.PrintCookie#print() method.
    
    Specified by:
    
    print in interface org.netbeans.api.actions.Printable
  - loadFromStreamToKit
```
protected void loadFromStreamToKit(javax.swing.text.StyledDocument doc,
                                   java.io.InputStream stream,
                                   javax.swing.text.EditorKit kit)
                            throws java.io.IOException,
                                   javax.swing.text.BadLocationException
```
    Deprecated.
    
    Actually read file data into an editor kit's document from an input stream. Called during a file load by prepareDocument().
    The default implementation just calls EditorKit.read(...). Subclasses could override this to provide support for persistent guard blocks, for example.
    
    Parameters:
    
    doc - the document to read into
    
    stream - the open stream to read from
    
    kit - the associated editor kit
    
    Throws:
    
    java.io.IOException - if there was a problem reading the file
    
    javax.swing.text.BadLocationException - should not normally be thrown
    
    See Also:
    
    saveFromKitToStream(javax.swing.text.StyledDocument, javax.swing.text.EditorKit, java.io.OutputStream)
  - reloadDocument
```
protected void reloadDocument()
```
    Deprecated.
    
    Reload the document in response to external modification.
    
    See Also:
    
    reloadDocumentTask()
  - reloadDocumentTask
```
protected org.openide.util.Task reloadDocumentTask()
```
    Deprecated.
    
    Starts reloading of document. Could not be named reloadDocument, because of backward compatibility.
    
    Returns:
    
    task one can listen on when reloading the document
  - openAt
```
protected EditorSupport.Editor openAt(org.openide.text.PositionRef pos)
```
    Deprecated.
    
    Forcibly create one editor component. Then set the caret to the given position.
    
    Parameters:
    
    pos - where to place the caret
    
    Returns:
    
    always non-null editor
  - canClose
```
protected boolean canClose()
```
    Deprecated.
    
    Should test whether all data is saved, and if not, prompt the user to save.
    
    Overrides:
    
    canClose in class org.openide.windows.CloneableOpenSupport
    
    Returns:
    
    true if everything can be closed
  - getOpenedPanes
```
public javax.swing.JEditorPane[] getOpenedPanes()
```
    Deprecated.
    
    Specified by:
    
    getOpenedPanes in interface org.openide.cookies.EditorCookie
  - notifyUnmodified
```
protected void notifyUnmodified()
```
    Deprecated.
    
    Notification method called when the document become unmodified. Called after save or after reload of document.
  - notifyModified
```
protected boolean notifyModified()
```
    Deprecated.
    
    Overrides the super method to add a save cookie if the document has been marked modified.
    
    Returns:
    
    true if the environment accepted being marked as modified or false if it refused it and the document should still be unmodified
  - notifyClosed
```
protected void notifyClosed()
```
    Deprecated.
    
    Called when the document is closed and released from memory.

Class EditorSupport

Nested Class Summary

Nested classes/interfaces inherited from interface org.openide.cookies.EditorCookie

Nested classes/interfaces inherited from class org.openide.loaders.OpenSupport

Field Summary

Fields inherited from class org.openide.windows.CloneableOpenSupport

Fields inherited from interface org.openide.cookies.EditorCookie.Observable

Fields inherited from class org.openide.loaders.OpenSupport

Constructor Summary

Method Summary

Methods inherited from class org.openide.windows.CloneableOpenSupport

Methods inherited from class java.lang.Object

Field Detail

EDITOR_MODE

modifiedAppendix

Constructor Detail

EditorSupport

Method Detail

messageOpening

messageOpened

messageSave

messageName

messageToolTip

updateTitles

createCloneableTopComponent

createUndoRedoManager

open

close

close

prepareDocument

openDocument

getDocument

isDocumentLoaded

saveDocument

saveFromKitToStream

isModified

findDataObject

createPositionRef

getLineSet

setMIMEType

setActions

createEditorKit

setModificationListening

addChangeListener

removeChangeListener

addPropertyChangeListener

removePropertyChangeListener

print

loadFromStreamToKit

reloadDocument

reloadDocumentTask

openAt

canClose

getOpenedPanes

notifyUnmodified

notifyModified

notifyClosed