edu.ucsb.nceas.morpho.editor
Class DocFrame

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--java.awt.Window
                    |
                    +--java.awt.Frame
                          |
                          +--javax.swing.JFrame
                                |
                                +--edu.ucsb.nceas.morpho.editor.DocFrame

public class DocFrame
extends javax.swing.JFrame

DocFrame is a container for an XML editor which shows combined outline and nested panel views of an XML document. This class uses a DTDParser to 'merge' an existing XML instance with a template created from its DTD. This merging adds optional nodes missing from the original document. Help information and special custom node editors are also loaded from a 'template'.

Author:
higgins
See Also:
Serialized Form

Inner classes inherited from class javax.swing.JFrame
javax.swing.JFrame.AccessibleJFrame
 
Field Summary
static int counter
          counter for name
 DTDTree dtdtree
          Description of the Field
static java.util.Hashtable helpTrees
          a hashtable for saving trees with help and formatting info assume that the key is the name of the rootnode
 javax.swing.tree.DefaultMutableTreeNode rootNode
          Description of the Field
 javax.swing.JTree tree
          Description of the Field
 javax.swing.tree.DefaultTreeModel treeModel
          Description of the Field
 
Fields inherited from class javax.swing.JFrame
accessibleContext, rootPane, rootPaneCheckingEnabled
 
Fields inherited from class java.awt.Frame
CROSSHAIR_CURSOR, DEFAULT_CURSOR, E_RESIZE_CURSOR, HAND_CURSOR, ICONIFIED, MOVE_CURSOR, N_RESIZE_CURSOR, NE_RESIZE_CURSOR, NORMAL, NW_RESIZE_CURSOR, S_RESIZE_CURSOR, SE_RESIZE_CURSOR, SW_RESIZE_CURSOR, TEXT_CURSOR, W_RESIZE_CURSOR, WAIT_CURSOR
 
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
 
Constructor Summary
DocFrame()
          This constructor builds the contents of the DocFrame Display
DocFrame(java.io.File file)
          Constructor for the DocFrame object
DocFrame(Morpho morpho, java.lang.String sTitle, java.lang.String doctext, boolean flag)
          This constructor actual handles the creation of a tree and panel for displaying and editing the information is an XML document, as represented in the String 'doctext'
DocFrame(Morpho morpho, java.lang.String sTitle, java.lang.String doctext, java.lang.String id, java.lang.String location)
          this version of the constructor is needed so that each DocFrame can 'remember' the id and location parameters used to create it
DocFrame(Morpho morpho, java.lang.String sTitle, java.lang.String doctext, java.lang.String id, java.lang.String location, boolean templFlag)
          this version of the constructor is needed so that each DocFrame can 'remember' the id and location parameters used to create it; includes template flag
DocFrame(Morpho morpho, java.lang.String sTitle, java.lang.String doctext, java.lang.String id, java.lang.String location, java.lang.String nodeName, java.lang.String nodeValue)
          this version allows one to create a new DocFrame and set the initially selected nodename/nodetext
DocFrame(java.lang.String sTitle)
          Constructor which adds a title string to the Frame
DocFrame(java.lang.String sTitle, java.lang.String doctext)
          Constructor which adds a title and passes the xml to display as a string; puts XML into tree
 
Method Summary
 java.lang.String getIdString()
          Gets the IdString attribute of the DocFrame object
 java.lang.String getLocationString()
          Gets the LocationString attribute of the DocFrame object
 void initDoc(Morpho finalMorpho, java.lang.String doctext, boolean flag)
          Description of the Method
static void main(java.lang.String[] args)
          Description of the Method
 void setController(EditorPlugin con)
          Sets the Controller attribute of the DocFrame object
 void setDoctype(java.lang.String doctype)
          Sets the Doctype attribute of the DocFrame object
 void setFile(java.io.File f)
          Sets the File attribute of the DocFrame object
 void setTreeValueFlag(boolean flg)
          Sets the TreeValueFlag attribute of the DocFrame object
 void setVisible(boolean b)
          Sets the Visible attribute of the DocFrame object
 java.lang.String validate(java.lang.String xml)
           
 
Methods inherited from class javax.swing.JFrame
addImpl, createRootPane, frameInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getJMenuBar, getLayeredPane, getRootPane, isRootPaneCheckingEnabled, paramString, processKeyEvent, processWindowEvent, remove, setContentPane, setDefaultCloseOperation, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, update
 
Methods inherited from class java.awt.Frame
addNotify, finalize, getCursorType, getFrames, getIconImage, getMenuBar, getState, getTitle, isResizable, remove, removeNotify, setCursor, setIconImage, setMenuBar, setResizable, setState, setTitle
 
Methods inherited from class java.awt.Window
addWindowListener, applyResourceBundle, applyResourceBundle, dispose, getFocusOwner, getInputContext, getLocale, getOwnedWindows, getOwner, getToolkit, getWarningString, hide, isShowing, pack, postEvent, processEvent, removeWindowListener, setCursor, show, toBack, toFront
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getInsets, getLayout, getMaximumSize, getMinimumSize, getPreferredSize, insets, invalidate, isAncestorOf, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setFont, validate, validateTree
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addPropertyChangeListener, addPropertyChangeListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, getBackground, getBounds, getBounds, getColorModel, getComponentOrientation, getCursor, getDropTarget, getFont, getFontMetrics, getForeground, getGraphics, getHeight, getInputMethodRequests, getLocation, getLocation, getLocationOnScreen, getName, getParent, getPeer, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isDisplayable, isDoubleBuffered, isEnabled, isFocusTraversable, isLightweight, isOpaque, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processInputMethodEvent, processMouseEvent, processMouseMotionEvent, removeComponentListener, removeFocusListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, reshape, resize, resize, setBackground, setBounds, setBounds, setComponentOrientation, setDropTarget, setEnabled, setForeground, setLocale, setLocation, setLocation, setName, setSize, setSize, show, size, toString, transferFocus
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

treeModel

public javax.swing.tree.DefaultTreeModel treeModel
Description of the Field

rootNode

public javax.swing.tree.DefaultMutableTreeNode rootNode
Description of the Field

dtdtree

public DTDTree dtdtree
Description of the Field

tree

public javax.swing.JTree tree
Description of the Field

helpTrees

public static java.util.Hashtable helpTrees
a hashtable for saving trees with help and formatting info assume that the key is the name of the rootnode

counter

public static int counter
counter for name
Constructor Detail

DocFrame

public DocFrame()
This constructor builds the contents of the DocFrame Display

DocFrame

public DocFrame(java.lang.String sTitle)
Constructor which adds a title string to the Frame
Parameters:
sTitle - Description of Parameter

DocFrame

public DocFrame(java.lang.String sTitle,
                java.lang.String doctext)
Constructor which adds a title and passes the xml to display as a string; puts XML into tree
Parameters:
sTitle - title string
doctext - XML document as a string

DocFrame

public DocFrame(java.io.File file)
Constructor for the DocFrame object
Parameters:
file - Description of Parameter

DocFrame

public DocFrame(Morpho morpho,
                java.lang.String sTitle,
                java.lang.String doctext,
                boolean flag)
This constructor actual handles the creation of a tree and panel for displaying and editing the information is an XML document, as represented in the String 'doctext'
Parameters:
morpho - the main morpho object controller
sTitle - window title string
doctext - xml document as a string
flag - only the template based on the DocType is displayed (i.e. no merging with existing data) For use in creating new docs.

DocFrame

public DocFrame(Morpho morpho,
                java.lang.String sTitle,
                java.lang.String doctext,
                java.lang.String id,
                java.lang.String location)
this version of the constructor is needed so that each DocFrame can 'remember' the id and location parameters used to create it
Parameters:
morpho - the main morpho object controller
sTitle - window title string
doctext - xml document as a string
id - document id
location - i.e. local or metacat

DocFrame

public DocFrame(Morpho morpho,
                java.lang.String sTitle,
                java.lang.String doctext,
                java.lang.String id,
                java.lang.String location,
                boolean templFlag)
this version of the constructor is needed so that each DocFrame can 'remember' the id and location parameters used to create it; includes template flag
Parameters:
morpho - the main morpho object controller
sTitle - window title string
doctext - xml document as a string
id - document id
location - i.e. local or metacat
templFlag - only the template based on the DocType is displayed (i.e. no merging with existing data) For use in creating new docs.

DocFrame

public DocFrame(Morpho morpho,
                java.lang.String sTitle,
                java.lang.String doctext,
                java.lang.String id,
                java.lang.String location,
                java.lang.String nodeName,
                java.lang.String nodeValue)
this version allows one to create a new DocFrame and set the initially selected nodename/nodetext
Parameters:
morpho - the main morpho object controller
sTitle - window title string
doctext - xml document as a string
id - document id
location - i.e. local or metacat
nodeName - node name
nodeValue - value of node name
Method Detail

setFile

public void setFile(java.io.File f)
Sets the File attribute of the DocFrame object
Parameters:
f - The new File value

setDoctype

public void setDoctype(java.lang.String doctype)
Sets the Doctype attribute of the DocFrame object
Parameters:
doctype - The new Doctype value

setVisible

public void setVisible(boolean b)
Sets the Visible attribute of the DocFrame object
Overrides:
setVisible in class java.awt.Component
Parameters:
b - The new Visible value

setTreeValueFlag

public void setTreeValueFlag(boolean flg)
Sets the TreeValueFlag attribute of the DocFrame object
Parameters:
flg - The new TreeValueFlag value

setController

public void setController(EditorPlugin con)
Sets the Controller attribute of the DocFrame object
Parameters:
con - The new Controller value

getIdString

public java.lang.String getIdString()
Gets the IdString attribute of the DocFrame object
Returns:
The IdString value

getLocationString

public java.lang.String getLocationString()
Gets the LocationString attribute of the DocFrame object
Returns:
The LocationString value

initDoc

public void initDoc(Morpho finalMorpho,
                    java.lang.String doctext,
                    boolean flag)
Description of the Method
Parameters:
finalMorpho - Description of Parameter
doctext - Description of Parameter
flag - Description of Parameter

main

public static void main(java.lang.String[] args)
Description of the Method
Parameters:
args - Description of Parameter

validate

public java.lang.String validate(java.lang.String xml)


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