edu.ucsb.nceas.morpho.editor
Class EditorPlugin

java.lang.Object
  |
  +--edu.ucsb.nceas.morpho.editor.EditorPlugin

public class EditorPlugin
extends java.lang.Object
implements PluginInterface, ServiceProvider, EditorInterface


Constructor Summary
EditorPlugin()
          Construct the editor plugin.
 
Method Summary
 void fireEditingCanceledEvent(DocFrame doc, java.lang.String xmlString)
          Fire off notifications to EditingCanceledListeners when the editing has been completed
 void fireEditingCompleteEvent(DocFrame doc, java.lang.String xmlString)
          Fire off notifications to EditingCompleteListeners when the editing has been completed
 java.lang.Object getClipboardObject()
           
 void initialize(ClientFramework cf)
          The plugin must store a reference to the ClientFramework in order to be able to call the services available through the framework.
 void openEditor(java.lang.String xmlText)
          This method is called to open a XML editor that resides either
 void openEditor(java.lang.String xmlText, EditingCompleteListener listener)
           
 void openEditor(java.lang.String xmlText, java.lang.String id, java.lang.String location, EditingCompleteListener listener)
          This method is called to open a XML editor with the indicated xmltext and an editingCompletedListener to be notified when the editing is completed
 void openEditor(java.lang.String xmlText, java.lang.String id, java.lang.String location, java.lang.String nodeName, java.lang.String nodeValue, EditingCompleteListener listener)
          This method is called to open a XML editor with the indicated xmltext and an editingCompletedListener to be notified when the editing is completed, the nodename and nodevalue parameters indicated node to be selected when documement is opened
 void openEditor(java.util.Vector xmlDocs, java.lang.String id, java.lang.String location, java.lang.String nodeName, java.lang.String nodeValue, EditingCompleteListener listener)
           
 void setClipboardObject(java.lang.Object node)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

EditorPlugin

public EditorPlugin()
Construct the editor plugin. Initialize our one tab for the plugin plus any menus and toolbars.
Method Detail

initialize

public void initialize(ClientFramework cf)
The plugin must store a reference to the ClientFramework in order to be able to call the services available through the framework. This is also the time to register menus and toolbars with the framework.
Specified by:
initialize in interface PluginInterface

fireEditingCompleteEvent

public void fireEditingCompleteEvent(DocFrame doc,
                                     java.lang.String xmlString)
Fire off notifications to EditingCompleteListeners when the editing has been completed

fireEditingCanceledEvent

public void fireEditingCanceledEvent(DocFrame doc,
                                     java.lang.String xmlString)
Fire off notifications to EditingCanceledListeners when the editing has been completed

openEditor

public void openEditor(java.lang.String xmlText)
Description copied from interface: EditorInterface
This method is called to open a XML editor that resides either
Specified by:
openEditor in interface EditorInterface
Tags copied from interface: EditorInterface
Parameters:
xmltext - is the xml to be edited in the form of a String

openEditor

public void openEditor(java.lang.String xmlText,
                       java.lang.String id,
                       java.lang.String location,
                       EditingCompleteListener listener)
Description copied from interface: EditorInterface
This method is called to open a XML editor with the indicated xmltext and an editingCompletedListener to be notified when the editing is completed
Specified by:
openEditor in interface EditorInterface

openEditor

public void openEditor(java.lang.String xmlText,
                       EditingCompleteListener listener)

openEditor

public void openEditor(java.lang.String xmlText,
                       java.lang.String id,
                       java.lang.String location,
                       java.lang.String nodeName,
                       java.lang.String nodeValue,
                       EditingCompleteListener listener)
Description copied from interface: EditorInterface
This method is called to open a XML editor with the indicated xmltext and an editingCompletedListener to be notified when the editing is completed, the nodename and nodevalue parameters indicated node to be selected when documement is opened
Specified by:
openEditor in interface EditorInterface

openEditor

public void openEditor(java.util.Vector xmlDocs,
                       java.lang.String id,
                       java.lang.String location,
                       java.lang.String nodeName,
                       java.lang.String nodeValue,
                       EditingCompleteListener listener)
Specified by:
openEditor in interface EditorInterface

getClipboardObject

public java.lang.Object getClipboardObject()

setClipboardObject

public void setClipboardObject(java.lang.Object node)


Copyright © 2000 National Center for Ecological Analysis and Synthesis. All Rights Reserved.