org.merlotxml.merlot
Class XerlinPanel

java.lang.Object
  extended byjava.awt.Component
      extended byjava.awt.Container
          extended byjavax.swing.JComponent
              extended byjavax.swing.JPanel
                  extended byorg.merlotxml.merlot.XerlinPanel
All Implemented Interfaces:
javax.accessibility.Accessible, java.awt.datatransfer.ClipboardOwner, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable

public class XerlinPanel
extends javax.swing.JPanel
implements java.awt.datatransfer.ClipboardOwner

XerlinPanel is a JComponent containing an editor panel. This panel can be integrated into other applications.

Author:
justin
See Also:
Serialized Form

Nested Class Summary
 
Nested classes inherited from class javax.swing.JPanel
javax.swing.JPanel.AccessibleJPanel
 
Nested classes inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent
 
Nested classes inherited from class java.awt.Container
java.awt.Container.AccessibleAWTContainer
 
Nested classes inherited from class java.awt.Component
java.awt.Component.AccessibleAWTComponent, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy
 
Field Summary
 
Fields inherited from class javax.swing.JComponent
accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
 
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
 
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
 
Constructor Summary
XerlinPanel()
          Constructor for the XerlinPanel object
XerlinPanel(java.io.File f)
          Constructor for the XerlinPanel object
XerlinPanel(java.lang.String rootname, java.lang.String publicid, java.lang.String systemid)
          Constructor for the XerlinPanel object
 
Method Summary
 void addEnityResolver(org.xml.sax.EntityResolver resolver)
          Add a custom entity resolver
protected  void build()
          Builds the XerlinPanel
 java.awt.datatransfer.Clipboard getClipboard()
          Returns the text clipboard
 org.w3c.dom.Document getDOMDocument()
          Returns the DOMDocument - the modified DOM from the panel
 org.w3c.dom.Node getRoot()
          Get the root node of the DOM If the node has been set it will return it otherwise the document element is returned
 java.awt.datatransfer.Clipboard getTreeClipboard()
          Returns the DOMTree clipboard
 XMLEditorDoc getXMLEditorDoc()
          Returns the XMLEditorDoc
 XMLEditorDocUI getXMLEditorDocUI()
          Gets the XMLEditorDocUI attribute of the XerlinPanel object
 XMLFile getXMLFile()
          Returns the XMLFile
 boolean isDirty()
          Returns true if this document is marked as dirty (needs saving)
 void load(java.io.File f)
          Loads an XML file into the XerlinPanel
 void lostOwnership(java.awt.datatransfer.Clipboard c, java.awt.datatransfer.Transferable t)
          Notification that we lost ownership of a clipboard item
 void newFile(java.lang.String rootnode, java.lang.String publicid, java.lang.String systemid)
          Starts a brand new XML document in the XerlinPanel
 void removeAllResolvers()
          Remove all entity resolvers
 boolean removeEnityResolver(org.xml.sax.EntityResolver resolver)
          Remove a custom EntityResolver from the list of custom reolvers
 boolean save()
          Saves in the same file we opened
 boolean saveAs(java.io.File f)
          Saves to a new file
 boolean setRoot(org.w3c.dom.Node root)
          Set the root node of the DOM tree to be displayed If not set the entire DOM will be displayed
 
Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI
 
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFont, setForeground, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addImpl, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setLayout, transferFocusBackward, transferFocusDownCycle, validate, validateTree
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

XerlinPanel

public XerlinPanel()
            throws MerlotException
Constructor for the XerlinPanel object

Throws:
MerlotException - Any config/setup issues
Since:

XerlinPanel

public XerlinPanel(java.io.File f)
            throws MerlotException
Constructor for the XerlinPanel object

Parameters:
f - The file to be edited
Throws:
MerlotException - Any config/setup issues
Since:

XerlinPanel

public XerlinPanel(java.lang.String rootname,
                   java.lang.String publicid,
                   java.lang.String systemid)
            throws MerlotException
Constructor for the XerlinPanel object

Parameters:
rootname - The name of the root node
publicid - The PUBLIC id or null
systemid - The SYSTEM id or null
Throws:
MerlotException - Any config/setup issues
Since:
Method Detail

addEnityResolver

public void addEnityResolver(org.xml.sax.EntityResolver resolver)
Add a custom entity resolver

Parameters:
resolver - Custom EntityResolver to be added
Since:

setRoot

public boolean setRoot(org.w3c.dom.Node root)
Set the root node of the DOM tree to be displayed If not set the entire DOM will be displayed

Parameters:
root - the root Node of the subtree
Returns:
success
Since:

getRoot

public org.w3c.dom.Node getRoot()
Get the root node of the DOM If the node has been set it will return it otherwise the document element is returned

Returns:
root the root Node of the tree
Since:

removeEnityResolver

public boolean removeEnityResolver(org.xml.sax.EntityResolver resolver)
Remove a custom EntityResolver from the list of custom reolvers

Returns:
successful removal
Since:

removeAllResolvers

public void removeAllResolvers()
Remove all entity resolvers

Since:

getDOMDocument

public org.w3c.dom.Document getDOMDocument()
Returns the DOMDocument - the modified DOM from the panel

Returns:
the DOM Document for this panel
Since:

getXMLEditorDoc

public XMLEditorDoc getXMLEditorDoc()
Returns the XMLEditorDoc

Returns:
the XMLEditorDoc for this panel
Since:

getXMLFile

public XMLFile getXMLFile()
Returns the XMLFile

Returns:
the XMLFile for this panel
Since:

isDirty

public boolean isDirty()
Returns true if this document is marked as dirty (needs saving)

Returns:
the dirtiness state of the DOM object

save

public boolean save()
             throws MerlotException
Saves in the same file we opened

Returns:
Description of the Return Value
Throws:
MerlotException - Description of the Exception

saveAs

public boolean saveAs(java.io.File f)
               throws MerlotException
Saves to a new file

Parameters:
f - Description of the Parameter
Returns:
Description of the Return Value
Throws:
MerlotException - Description of the Exception

getXMLEditorDocUI

public XMLEditorDocUI getXMLEditorDocUI()
Gets the XMLEditorDocUI attribute of the XerlinPanel object

Returns:
The XMLEditorDocUI value
Since:

load

public void load(java.io.File f)
          throws MerlotException
Loads an XML file into the XerlinPanel

Parameters:
f - The file to be loaded
Throws:
MerlotException - Any config/setup issues
Since:

newFile

public void newFile(java.lang.String rootnode,
                    java.lang.String publicid,
                    java.lang.String systemid)
             throws MerlotException
Starts a brand new XML document in the XerlinPanel

Parameters:
publicid - The PUBLIC id or null
systemid - The SYSTEM id or null
rootnode - Description of the Parameter
Throws:
MerlotException - Any config/setup issues
Since:

getClipboard

public java.awt.datatransfer.Clipboard getClipboard()
Returns the text clipboard

Returns:
The Clipboard value
Since:

getTreeClipboard

public java.awt.datatransfer.Clipboard getTreeClipboard()
Returns the DOMTree clipboard

Returns:
the TreeClipboard
Since:

lostOwnership

public void lostOwnership(java.awt.datatransfer.Clipboard c,
                          java.awt.datatransfer.Transferable t)
Notification that we lost ownership of a clipboard item

Specified by:
lostOwnership in interface java.awt.datatransfer.ClipboardOwner
Parameters:
c - Clipboard
t - Transferable
Since:

build

protected void build()
Builds the XerlinPanel

Since: