Field Detail

• EDITOR_MODE

  public static final java.lang.String EDITOR_MODE

  Common name for editor mode.

  See Also:

  Constant Field Values

• BEGIN_COMMIT_GROUP

  public static final javax.swing.undo.UndoableEdit BEGIN_COMMIT_GROUP

  Start a group of edits which will be committed as a single edit for purpose of undo/redo. Nesting semantics are that any BEGIN_COMMIT_GROUP and END_COMMIT_GROUP delimits a commit-group, unless the group is empty in which case the begin/end is ignored. While coalescing edits, any undo/redo/save implicitly delimits a commit-group.

  Since:

  6.34

• END_COMMIT_GROUP

  public static final javax.swing.undo.UndoableEdit END_COMMIT_GROUP

  End a group of edits.

  Since:

  6.34

• MARK_COMMIT_GROUP

  public static final javax.swing.undo.UndoableEdit MARK_COMMIT_GROUP

  Any coalesced edits become a commit-group and a new commit-group is started.

  Since:

  6.40

Constructor Detail

• CloneableEditorSupport

  public CloneableEditorSupport​(CloneableEditorSupport.Env env)

  Creates new CloneableEditorSupport attached to given environment.

  Parameters:

  env - environment that is source of all actions around the data object

• CloneableEditorSupport

  public CloneableEditorSupport​(CloneableEditorSupport.Env env,
                                org.openide.util.Lookup l)

  Creates new CloneableEditorSupport attached to given environment.

  Parameters:

  env - environment that is source of all actions around the data object

  l - the context that will be passed to each Line produced by this support's Line.Set. The line will return it from Line.getLookup call

Method Detail

• messageSave

  protected abstract java.lang.String messageSave​()

  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 abstract java.lang.String messageName​()

  Constructs message that should be used to name the editor component.

  Returns:

  name of the editor

• messageHtmlName

  protected java.lang.String messageHtmlName​()

  Constructs message that should be used to name the editor component in html fashion, with possible coloring, text styles etc. May return null if no html name is needed or available.

  Returns:

  html name of the editor component or null

  Since:

  6.8

• documentID

  protected java.lang.String documentID​()

  Constructs the ID used for persistence of opened editors. Should be overridden to return sane ID of the underlying document, like the name of the disk file.

  Returns:

  ID of the document

  Since:

  4.24

• messageToolTip

  protected abstract java.lang.String messageToolTip​()

  Text to use as tooltip for component.

  Returns:

  text to show to the user

• messageLine

  protected java.lang.String messageLine​(Line line)

  Computes display name for a line produced by this getLineSet(). The default implementation reuses messageName and line number of the line.

  Parameters:

  line - the line object to compute display name for

  Returns:

  display name for the line like "MyFile.java:243"

  Since:

  4.3

• getUndoRedo

  protected final org.openide.awt.UndoRedo.Manager getUndoRedo​()

  Gets the undo redo manager.

  Returns:

  the manager

• asynchronousOpen

  protected boolean asynchronousOpen​()

  Controls behavior of method open. If it returns false method open will load document synchronously and process UserQuestionException. If it returns true document will be loaded in CloneableEditor creation ie. asynchronously and UserQuestionException will be processed there. Asynchronous loading is added to avoid blocking AWT thread when method open is called in AWT thread - issue #171713 Subclasses should override this method. Warning is logged if subclass does not override this method.

  Returns:

  default implementation returns false to keep original behavior of CloneableEditorSupport.open()

  Since:

  6.26

• open

  public void open​()

  Overrides superclass method, first processes document preparation.

  Overrides:

  open in class org.openide.windows.CloneableOpenSupport

  See Also:

  prepareDocument()

• addPropertyChangeListener

  public final void addPropertyChangeListener​(java.beans.PropertyChangeListener l)

  Add a PropertyChangeListener to the listener list. See EditorCookie.Observable.

  Parameters:

  l - the PropertyChangeListener to be added

  Since:

  3.40

• removePropertyChangeListener

  public final void removePropertyChangeListener​(java.beans.PropertyChangeListener l)

  Remove a PropertyChangeListener from the listener list. See EditorCookie.Observable.

  Parameters:

  l - the PropertyChangeListener to be removed

  Since:

  3.40

• firePropertyChange

  protected final void firePropertyChange​(java.lang.String propertyName,
                                          java.lang.Object oldValue,
                                          java.lang.Object newValue)

  Report a bound property update to any registered listeners.

  Parameters:

  propertyName - the programmatic name of the property that was changed.

  oldValue - rhe old value of the property.

  newValue - the new value of the property.

  Since:

  3.40

• prepareDocument

  public org.openide.util.Task prepareDocument​()

  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.

  Returns:

  task for control over loading

• openDocument

  public javax.swing.text.StyledDocument openDocument​()
                                               throws java.io.IOException

  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.

  Method will throw UserQuestionException exception if file size is too big. This exception could be caught and its method UserQuestionException.confirmed() can be used for confirmation. You need to call openDocument()} one more time after confirmation.

  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​()

  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.

  Returns:

  document or null if it is not yet loaded

• isModified

  public boolean isModified​()

  Test whether the document is modified.

  Returns:

  true if the document is in memory and is modified; otherwise false

• saveDocument

  public void saveDocument​()
                    throws java.io.IOException

  Save the document in this thread. Create 'orig' document for the case that the save would fail.

  Throws:

  java.io.IOException - on I/O error

• getOpenedPanes

  public javax.swing.JEditorPane[] getOpenedPanes​()

  Gets editor panes opened by this support. Can be called from AWT event thread only.

  Returns:

  a non-empty array of panes, or null

  See Also:

  EditorCookie.getOpenedPanes()

• afterRedirect

  protected void afterRedirect​(org.openide.windows.CloneableOpenSupport redirectedTo)

  Overrides:

  afterRedirect in class org.openide.windows.CloneableOpenSupport

• getLineSet

  public Line.Set getLineSet​()

  Get the line set for all paragraphs in the document.

  Returns:

  positions of all paragraphs on last save

• print

  public void print​()

  A printing implementation suitable for PrintCookie.

• createCloneableTopComponent

  protected org.openide.windows.CloneableTopComponent createCloneableTopComponent​()

  Prepares document, creates and initializes new CloneableEditor component. Typically do not override this method. For creating your own CloneableEditor type component override createCloneableEditor() method.

  Specified by:

  createCloneableTopComponent in class org.openide.windows.CloneableOpenSupport

  Returns:

  the CloneableEditor for this support

• createPane

  protected CloneableEditorSupport.Pane createPane​()

  Creates and initializes new CloneableEditor component. Typically do not override this method (unless you are dealing with multiviews). For creating your own CloneableEditor type component override createCloneableEditor() method.

  Returns:

  the CloneableEditorSupport.Pane for this support

• wrapEditorComponent

  protected java.awt.Component wrapEditorComponent​(java.awt.Component editorComponent)

  Wraps the editor component in a custom component, allowing for creating more complicated user interfaces which contain the editor UI in an arbitrary place.

  The default implementation merely returns the passed editorComponent parameter.

  Parameters:

  editorComponent - the component containing the editor (usually not the JEditorPane, but some its ancestor).

  Returns:

  a component containing editorComponent or editorComponent itself.

  Since:

  6.3

• canClose

  protected boolean canClose​()

  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

• isDocumentLoaded

  public boolean isDocumentLoaded​()

  Test whether the document is in memory, or whether loading is still in progress.

  Returns:

  true if document is loaded

• setMIMEType

  public void setMIMEType​(java.lang.String s)

  Set the MIME type for the document.

  Parameters:

  s - the new MIME type

• addChangeListener

  @Deprecated
  public void addChangeListener​(javax.swing.event.ChangeListener l)

  Deprecated. Deprecated since 3.40. Use addPropertyChangeListener(java.beans.PropertyChangeListener) instead. See also EditorCookie.Observable.
  Adds a listener for status changes. An event is fired when the document is moved or removed from memory.

  Parameters:

  l - new listener

• removeChangeListener

  @Deprecated
  public void removeChangeListener​(javax.swing.event.ChangeListener l)

  Deprecated. Deprecated since 3.40. Use removePropertyChangeListener(java.beans.PropertyChangeListener) instead. See also EditorCookie.Observable.
  Removes a listener for status changes.

  Parameters:

  l - listener to remove

• createPositionRef

  public final PositionRef createPositionRef​(int offset,
                                             javax.swing.text.Position.Bias bias)

  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

• createCloneableEditor

  protected CloneableEditor createCloneableEditor​()

  Allows subclasses to create their own version of CloneableEditor component.

  Returns:

  the CloneableEditor for this support

• initializeCloneableEditor

  protected void initializeCloneableEditor​(CloneableEditor editor)

  Initialize the editor. This method is called after the editor component is deserialized and also when the component is created. It allows the subclasses to annotate the component with icon, selected nodes, etc.

  Parameters:

  editor - the editor that has been created and should be annotated

• createUndoRedoManager

  protected org.openide.awt.UndoRedo.Manager createUndoRedoManager​()

  Create an undo/redo manager. This manager is then attached to the document, and listens to all changes made in it.

  The default implementation uses improved UndoRedo.Manager, with support for various extensions (including BEGIN_COMMIT_GROUP and END_COMMIT_GROUP). It is not wise to override this method without delegating to super.createUndoRedoManager.

  Returns:

  the undo/redo manager

• getInputStream

  public java.io.InputStream getInputStream​()
                                     throws java.io.IOException

  Returns an InputStream which reads the current data from this editor, taking into account the encoding of the file. The returned InputStream will be useful for example when passing the file to an external compiler or other tool, which expects an input stream and which deals with encoding internally.
  See also saveFromKitToStream(javax.swing.text.StyledDocument, javax.swing.text.EditorKit, java.io.OutputStream).

  Returns:

  input stream for the file. If the file is open in the editor (and possibly modified), then the returned InputStream will contain the same data as if the file was written out to the CloneableEditorSupport.Env (usually disk). So it will contain guarded block markers etc. If the document is not loaded, then the InputStream will be taken from the CloneableEditorSupport.Env.

  Throws:

  java.io.IOException - if saving the document to a virtual stream or other IO operation fails

  Since:

  4.7

• 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

  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)

• 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

  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 org.openide.util.Task reloadDocument​()

  Reload the document in response to external modification.

  Returns:

  task that reloads the document or an empty task if there's currently no reload scheduled.

• getEditorKit

  public static javax.swing.text.EditorKit getEditorKit​(java.lang.String mimePath)

  Gets an EditorKit from Netbeans registry. The method looks in the MimeLookup for EditorKits registered for the mime-path passed in and returns the first one it finds. If there is no EditorKit registered for the mime-path it will fall back to the 'text/plain' EditorKit and eventually to its own default kit.

  A mime-path is a concatenation of one or more mime-types allowing to address fragments of text with a different mime-type than the mime-type of a document that contains those fragments. As an example you can use a JSP page containing a java scriplet. The JSP page is a document of 'text/x-jsp' mime-type, while the mime-type of the java scriplet is 'text/x-java'. When accessing settings or services such as an 'EditorKit' for java scriplets embedded in a JSP page the scriplet's mime-path 'text/x-jsp/text/x-java' should be used.

  If you are trying to get an 'EditorKit' for the whole document you can simply pass in the document's mime-type (e.g. 'text/x-java'). For the main document its mime-type and mime-path are the same.

  Parameters:

  mimePath - The mime-path to find an EditorKit for.

  Returns:

  The EditorKit implementation registered for the given mime-path.

  Since:

  org.openide.text 6.12

  See Also:

  MimeLookup

• createEditorKit

  protected javax.swing.text.EditorKit createEditorKit​()

  Creates editor kit for this source.

  Returns:

  editor kit

• createStyledDocument

  protected javax.swing.text.StyledDocument createStyledDocument​(javax.swing.text.EditorKit kit)

  Method that can be overriden by children to create empty styled document or attach additional document properties to it.

  Parameters:

  kit - the kit to use

  Returns:

  styled document to use

• notifyUnmodified

  protected void notifyUnmodified​()

  Notification method called when the document become unmodified. Called after save or after reload of document.

  This implementation simply marks the associated environement unmodified and updates titles of all components.

• notifyModified

  protected boolean notifyModified​()

  Called when the document is being modified. The responsibility of this method is to inform the environment that its document is modified. Current implementation Just calls env.setModified (true) to notify it about modification.

  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​()

  Method that is called when all components of the support are closed. The default implementation closes the document.

• close

  protected boolean close​(boolean ask)

  Closes all opened editors (if the user agrees) and flushes content of the document to the file.

  Overrides:

  close in class org.openide.windows.CloneableOpenSupport

  Parameters:

  ask - ask whether to save the document or not?

  Returns:

  false if the operation is cancelled

• updateTitles

  protected void updateTitles​()

  Updates titles of all editors.

• openAt

  protected final CloneableEditorSupport.Pane openAt​(PositionRef pos,
                                                     int column)

  Forcibly create one editor component. Then set the caret to the given position.

  Parameters:

  pos - where to place the caret

  column - where to place the caret

  Returns:

  always non-null editor

  Since:

  5.2

• toString

  public java.lang.String toString​()

  Overrides:

  toString in class java.lang.Object