Constructor Detail

• DataEditorSupport

  public DataEditorSupport​(DataObject obj,
                           org.openide.text.CloneableEditorSupport.Env env)

  Editor support for a given data object. The file is taken from the data object and is updated if the object moves or renames itself.

  Parameters:

  obj - object to work with

  env - environment to pass to

• DataEditorSupport

  public DataEditorSupport​(DataObject obj,
                           @NullAllowed
                           org.openide.util.Lookup lkp,
                           org.openide.text.CloneableEditorSupport.Env env)

  Editor support for given data object. The content of editor is taken from the primary file of the data object. The lookup can be anything, but it is recommended to use DataObject.getLookup().

  Parameters:

  obj - object to create editor for

  lkp - lookup to use. if null, then DataObject.getLookup() is used.

  env - environment responsible for loading/storing the strams

  Since:

  7.28

Method Detail

• create

  public static org.openide.text.CloneableEditorSupport create​(DataObject obj,
                                                               MultiDataObject.Entry entry,
                                                               org.openide.nodes.CookieSet set)

  Factory method to create simple CloneableEditorSupport for a given entry of a given DataObject. The common use inside DataObject looks like this:

    getCookieSet().add((Node.Cookie) DataEditorSupport.create(this, getPrimaryEntry(), getCookieSet()));
   

  Parameters:

  obj - the data object

  entry - the entry to read and write from

  set - cookie set to add remove additional cookies (currently only SaveCookie)

  Returns:

  a subclass of DataEditorSupport that implements at least OpenCookie, EditCookie, EditorCookie.Observable, PrintCookie, CloseCookie

  Since:

  5.2

• create

  public static org.openide.text.CloneableEditorSupport create​(DataObject obj,
                                                               MultiDataObject.Entry entry,
                                                               org.openide.nodes.CookieSet set,
                                                               @NullAllowed
                                                               java.util.concurrent.Callable<org.openide.text.CloneableEditorSupport.Pane> paneFactory)

  Factory method to create a bit more complicated CloneableEditorSupport for a given entry of a given DataObject. The common use inside DataObject looks like this:

    getCookieSet().add((Node.Cookie) DataEditorSupport.create(
      this, getPrimaryEntry(), getCookieSet(),
      new Callable() { 
        public Pane call() {
          return new YourSubclassOfCloneableEditor(support);
        }
      }
    ));
   

  The method can be used to instantiate multi view editor by returning MultiViews.createCloneableMultiView("text/yourmime", this).

  Parameters:

  obj - the data object

  entry - the entry to read and write from

  set - cookie set to add remove additional cookies (currently only SaveCookie)

  paneFactory - callback to create editor(s) for this support (if null CloneableEditor will be created)

  Returns:

  a subclass of DataEditorSupport that implements at least OpenCookie, EditCookie, EditorCookie.Observable, PrintCookie, CloseCookie

  Since:

  7.21

• getDataObject

  public final DataObject getDataObject​()

  Getter of the data object that this support is associated with.

  Returns:

  data object passed in constructor

• messageOpening

  protected java.lang.String messageOpening​()

  Message to display when an object is being opened.

  Specified by:

  messageOpening in class org.openide.windows.CloneableOpenSupport

  Returns:

  the message or null if nothing should be displayed

• messageOpened

  protected java.lang.String messageOpened​()

  Message to display when an object has been opened.

  Specified by:

  messageOpened in class org.openide.windows.CloneableOpenSupport

  Returns:

  the message or null if nothing should be displayed

• messageSave

  protected java.lang.String messageSave​()

  Constructs message that should be displayed when the data object is modified and is being closed.

  Specified by:

  messageSave in class org.openide.text.CloneableEditorSupport

  Returns:

  text to show to the user

• annotateName

  public static java.lang.String annotateName​(java.lang.String label,
                                              boolean html,
                                              boolean modified,
                                              boolean readOnly)

  Marks up a tab name according to modified and read-only status. Done for subclasses automatically in messageName() and messageHtmlName() but useful for other editor-like windows.

  Behavior currently varies according to the system property nb.tabnames.html.

  Parameters:

  label - incoming label (null not permitted, so take care with Node.getHtmlDisplayName())

  html - if true, label may include HTML markup (with or without initial <html>), and result may as well

  modified - mark up the label as for a document which is modified in memory

  readOnly - mark up the label as for a document based on a read-only file

  Returns:

  a possibly marked-up label

  Since:

  org.openide.loaders 7.7

• messageName

  protected java.lang.String messageName​()

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

  Specified by:

  messageName in class org.openide.text.CloneableEditorSupport

  Returns:

  name of the editor

• messageHtmlName

  protected java.lang.String messageHtmlName​()

  Overrides:

  messageHtmlName in class org.openide.text.CloneableEditorSupport

• documentID

  protected java.lang.String documentID​()

  Overrides:

  documentID in class org.openide.text.CloneableEditorSupport

• toolTip

  public static java.lang.String toolTip​(org.openide.filesystems.FileObject file,
                                         boolean modified,
                                         boolean readOnly)

  Constructs a tool tip possibly marked up with document modified and read-only status. Done for subclasses automatically in messageToolTip() but useful for other editor-like windows.

  Behavior currently varies according to the system property nb.tabnames.html.

  Parameters:

  file - a file representing the tab

  modified - mark up the tool tip as for a document which is modified in memory

  readOnly - mark up the tool tip as for a document based on a read-only file

  Returns:

  a tool tip

  Since:

  org.openide.loaders 7.7

• messageToolTip

  protected java.lang.String messageToolTip​()

  Text to use as tooltip for component.

  Specified by:

  messageToolTip in class org.openide.text.CloneableEditorSupport

  Returns:

  text to show to the user

• messageLine

  protected java.lang.String messageLine​(org.openide.text.Line line)

  Computes display name for a line based on the name of the associated DataObject and the line number.

  Overrides:

  messageLine in class org.openide.text.CloneableEditorSupport

  Parameters:

  line - the line object to compute display name for

  Returns:

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

  Since:

  4.3

• initializeCloneableEditor

  protected void initializeCloneableEditor​(org.openide.text.CloneableEditor editor)

  Annotates the editor with icon from the data object and also sets appropriate selected node. But only in the case the data object is valid. This implementation also listen to display name and icon changes of the node and keeps editor top component up-to-date. If you override this method and not call super, please note that you will have to keep things synchronized yourself.

  Overrides:

  initializeCloneableEditor in class org.openide.text.CloneableEditorSupport

  Parameters:

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

• notifyClosed

  protected void notifyClosed​()

  Called when closed all components. Overrides superclass method, also unregisters listening on node delegate.

  Overrides:

  notifyClosed in class org.openide.text.CloneableEditorSupport

• createStyledDocument

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

  Let's the super method create the document and also annotates it with Title and StreamDescription properties.

  Overrides:

  createStyledDocument in class org.openide.text.CloneableEditorSupport

  Parameters:

  kit - kit to user to create the document

  Returns:

  the document annotated by the properties

• canClose

  protected boolean canClose​()

  Checks whether is possible to close support components. Overrides superclass method, adds checking for read-only property of saving file and warns user in that case.

  Overrides:

  canClose in class org.openide.text.CloneableEditorSupport

• 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

  Overrides:

  loadFromStreamToKit in class org.openide.text.CloneableEditorSupport

  Throws:

  java.io.IOException

  javax.swing.text.BadLocationException

• 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

  Overrides:

  saveFromKitToStream in class org.openide.text.CloneableEditorSupport

  Throws:

  java.io.IOException

  javax.swing.text.BadLocationException

• openDocument

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

  Overrides:

  openDocument in class org.openide.text.CloneableEditorSupport

  Throws:

  java.io.IOException

• saveDocument

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

  Saves document. Overrides superclass method, adds checking for read-only property of saving file and warns user in that case.

  Overrides:

  saveDocument in class org.openide.text.CloneableEditorSupport

  Throws:

  java.io.IOException

• findDataObject

  public static DataObject findDataObject​(org.openide.text.Line l)

  Support method that extracts a DataObject from a Line. If the line is created by a DataEditorSupport then associated DataObject can be accessed by this method.

  Parameters:

  l - line object

  Returns:

  data object or null

  Since:

  4.3

• saveAs

  public void saveAs​(org.openide.filesystems.FileObject folder,
                     java.lang.String fileName)
              throws java.io.IOException

  Save the document under a new file name and/or extension.

  Parameters:

  folder - New folder to save the DataObject to.

  fileName - New file name to save the DataObject to.

  Throws:

  java.io.IOException - If the operation failed

  Since:

  6.3