public class DataEditorSupport extends CloneableEditorSupport
Document to a data object.| Modifier and Type | Class and Description |
|---|---|
static class |
DataEditorSupport.Env
Environment that connects the data object and the CloneableEditorSupport.
|
CloneableEditorSupport.PaneBEGIN_COMMIT_GROUP, EDITOR_MODE, END_COMMIT_GROUPallEditors, env| Constructor and Description |
|---|
DataEditorSupport(DataObject obj,
CloneableEditorSupport.Env env)
Editor support for a given data object.
|
| Modifier and Type | Method and Description |
|---|---|
static String |
annotateName(String label,
boolean html,
boolean modified,
boolean readOnly)
Marks up a tab name according to modified and read-only status.
|
protected boolean |
canClose()
Checks whether is possible to close support components.
|
static CloneableEditorSupport |
create(DataObject obj,
MultiDataObject.Entry entry,
CookieSet set)
Factory method to create simple CloneableEditorSupport for a given
entry of a given DataObject.
|
protected StyledDocument |
createStyledDocument(EditorKit kit)
Let's the super method create the document and also annotates it
with Title and StreamDescription properties.
|
protected String |
documentID() |
static DataObject |
findDataObject(Line l)
Support method that extracts a DataObject from a Line.
|
DataObject |
getDataObject()
Getter of the data object that this support is associated with.
|
protected void |
initializeCloneableEditor(CloneableEditor editor)
Annotates the editor with icon from the data object and also sets
appropriate selected node.
|
protected void |
loadFromStreamToKit(StyledDocument doc,
InputStream stream,
EditorKit kit) |
protected String |
messageHtmlName() |
protected String |
messageLine(Line line)
Computes display name for a line based on the
name of the associated DataObject and the line number.
|
protected String |
messageName()
Constructs message that should be used to name the editor component.
|
protected String |
messageOpened()
Message to display when an object has been opened.
|
protected String |
messageOpening()
Message to display when an object is being opened.
|
protected String |
messageSave()
Constructs message that should be displayed when the data object
is modified and is being closed.
|
protected String |
messageToolTip()
Text to use as tooltip for component.
|
protected void |
notifyClosed()
Called when closed all components.
|
StyledDocument |
openDocument() |
void |
saveAs(FileObject folder,
String fileName)
Save the document under a new file name and/or extension.
|
void |
saveDocument()
Saves document.
|
protected void |
saveFromKitToStream(StyledDocument doc,
EditorKit kit,
OutputStream stream) |
static String |
toolTip(FileObject file,
boolean modified,
boolean readOnly)
Constructs a tool tip possibly marked up with document modified and read-only status.
|
addChangeListener, addPropertyChangeListener, asynchronousOpen, close, createCloneableEditor, createCloneableTopComponent, createEditorKit, createPane, createPositionRef, createUndoRedoManager, firePropertyChange, getDocument, getEditorKit, getInputStream, getLineSet, getOpenedPanes, getUndoRedo, isDocumentLoaded, isModified, notifyModified, notifyUnmodified, open, openAt, prepareDocument, print, reloadDocument, removeChangeListener, removePropertyChangeListener, setMIMEType, updateTitles, wrapEditorComponentclose, edit, openCloneableTopComponent, viewpublic DataEditorSupport(DataObject obj, CloneableEditorSupport.Env env)
obj - object to work withenv - environment to pass topublic static CloneableEditorSupport create(DataObject obj, MultiDataObject.Entry entry, CookieSet set)
getCookieSet().add((Node.Cookie) DataEditorSupport.create(this, getPrimaryEntry(), getCookieSet()));
obj - the data objectentry - the entry to read and write fromset - cookie set to add remove additional cookies (currently only SaveCookie)OpenCookie,
EditCookie,
EditorCookie.Observable,
PrintCookie,
CloseCookiepublic final DataObject getDataObject()
protected String messageOpening()
messageOpening in class CloneableOpenSupportprotected String messageOpened()
messageOpened in class CloneableOpenSupportprotected String messageSave()
messageSave in class CloneableEditorSupportpublic static String annotateName(String label, boolean html, boolean modified, boolean readOnly)
messageName() and messageHtmlName()
but useful for other editor-like windows.
Behavior currently varies according to the system property nb.tabnames.html.
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 wellmodified - mark up the label as for a document which is modified in memoryreadOnly - mark up the label as for a document based on a read-only fileprotected String messageName()
messageName in class CloneableEditorSupportprotected String messageHtmlName()
messageHtmlName in class CloneableEditorSupportprotected String documentID()
documentID in class CloneableEditorSupportpublic static String toolTip(FileObject file, boolean modified, boolean readOnly)
messageToolTip() but useful for other editor-like windows.
Behavior currently varies according to the system property nb.tabnames.html.
file - a file representing the tabmodified - mark up the tool tip as for a document which is modified in memoryreadOnly - mark up the tool tip as for a document based on a read-only fileprotected String messageToolTip()
messageToolTip in class CloneableEditorSupportprotected String messageLine(Line line)
messageLine in class CloneableEditorSupportline - the line object to compute display name forprotected void initializeCloneableEditor(CloneableEditor editor)
initializeCloneableEditor in class CloneableEditorSupporteditor - the editor that has been created and should be annotatedprotected void notifyClosed()
notifyClosed in class CloneableEditorSupportprotected StyledDocument createStyledDocument(EditorKit kit)
createStyledDocument in class CloneableEditorSupportkit - kit to user to create the documentprotected boolean canClose()
canClose in class CloneableEditorSupportprotected void loadFromStreamToKit(StyledDocument doc, InputStream stream, EditorKit kit) throws IOException, BadLocationException
loadFromStreamToKit in class CloneableEditorSupportIOExceptionBadLocationExceptionprotected void saveFromKitToStream(StyledDocument doc, EditorKit kit, OutputStream stream) throws IOException, BadLocationException
saveFromKitToStream in class CloneableEditorSupportIOExceptionBadLocationExceptionpublic StyledDocument openDocument() throws IOException
openDocument in class CloneableEditorSupportIOExceptionpublic void saveDocument()
throws IOException
saveDocument in class CloneableEditorSupportIOExceptionpublic static DataObject findDataObject(Line l)
l - line objectpublic void saveAs(FileObject folder, String fileName) throws IOException
folder - New folder to save the DataObject to.fileName - New file name to save the DataObject to.IOException - If the operation failedBuilt on August 24 2014. | Portions Copyright 1997-2014 Sun Microsystems, Inc. All rights reserved.