VdexReload 1.1.3 API

uk.ac.reload.editor.metadata
Class MetadataEditorFrame

java.lang.Object
  extended byjava.awt.Component
      extended byjava.awt.Container
          extended byjavax.swing.JComponent
              extended byjavax.swing.JInternalFrame
                  extended byuk.ac.reload.dweezil.gui.ReloadInternalFrame
                      extended byuk.ac.reload.editor.metadata.MetadataEditorFrame
All Implemented Interfaces:
javax.accessibility.Accessible, ApplicationListener, java.awt.image.ImageObserver, java.awt.MenuContainer, ReloadDocumentListener, javax.swing.RootPaneContainer, java.io.Serializable, javax.swing.WindowConstants

public class MetadataEditorFrame
extends ReloadInternalFrame
implements ApplicationListener, ReloadDocumentListener

The Metadata Editor Frame

See Also:
Serialized Form

Nested Class Summary
 
Nested classes inherited from class javax.swing.JInternalFrame
javax.swing.JInternalFrame.AccessibleJInternalFrame, javax.swing.JInternalFrame.JDesktopIcon
 
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
protected  MetadataEditor _mdEditor
          The Metadata Editor
protected  uk.ac.reload.editor.metadata.MetadataEditorFrame.ProxySaveHandler _saveAsHandler
          Handles Save and SaveAs Events
protected  uk.ac.reload.editor.metadata.MetadataEditorFrame.ProxySaveHandler _saveHandler
          Handles Save and SaveAs Events
 
Fields inherited from class uk.ac.reload.dweezil.gui.ReloadInternalFrame
_menuItem
 
Fields inherited from class javax.swing.JInternalFrame
closable, CONTENT_PANE_PROPERTY, desktopIcon, FRAME_ICON_PROPERTY, frameIcon, GLASS_PANE_PROPERTY, iconable, IS_CLOSED_PROPERTY, IS_ICON_PROPERTY, IS_MAXIMUM_PROPERTY, IS_SELECTED_PROPERTY, isClosed, isIcon, isMaximum, isSelected, LAYERED_PANE_PROPERTY, maximizable, MENU_BAR_PROPERTY, resizable, ROOT_PANE_PROPERTY, rootPane, rootPaneCheckingEnabled, title, TITLE_PROPERTY
 
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 javax.swing.WindowConstants
DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE
 
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
 
Constructor Summary
MetadataEditorFrame()
          Default constructor
 
Method Summary
 boolean applicationClosing()
          We have been told by the Application that it is closing.
protected  boolean checkNeedsSaving()
          We can check if the File needs saving
 void dispose()
          Dispose of this Window and clean up
 void documentSaved(ReloadSchemaDocument doc)
          Handling the document saved event from the ReloadDocument
 void elementAdded(ReloadDocumentListenerEvent e)
          Handling the element added event from the ReloadDocument
 void elementChanged(ReloadDocumentListenerEvent e)
          Handling the element changed event from the ReloadDocument
 void elementRemoved(ReloadDocumentListenerEvent e)
          Handling the element removed event from the ReloadDocument
 void newDocument(MetadataSchemaController schemaController)
          Create a new Metadata JDOM Document
protected  boolean saveAsDocument()
          Save As...
protected  boolean saveDocument()
          If the Metadata file has been edited, ask whether we should save it
 void setDocument(java.io.File file, org.jdom.Document doc, MetadataSchemaController schemaController)
          Set a Metadata JDOM Document - this will be standalone
protected  void setFocusGained()
          We got the focus
protected  void setFocusLost()
          We lost the focus
 void show()
          Over-ride this so we can set view stuff
 
Methods inherited from class uk.ac.reload.dweezil.gui.ReloadInternalFrame
getMenuItem, setFrameIcon, setTitle
 
Methods inherited from class javax.swing.JInternalFrame
addImpl, addInternalFrameListener, createRootPane, doDefaultCloseAction, fireInternalFrameEvent, getAccessibleContext, getContentPane, getDefaultCloseOperation, getDesktopIcon, getDesktopPane, getFocusCycleRootAncestor, getFocusOwner, getFrameIcon, getGlassPane, getInternalFrameListeners, getJMenuBar, getLayer, getLayeredPane, getMenuBar, getMostRecentFocusOwner, getNormalBounds, getRootPane, getTitle, getUI, getUIClassID, getWarningString, hide, isClosable, isClosed, isFocusCycleRoot, isIcon, isIconifiable, isMaximizable, isMaximum, isResizable, isRootPaneCheckingEnabled, isSelected, moveToBack, moveToFront, pack, paintComponent, paramString, remove, removeInternalFrameListener, reshape, restoreSubcomponentFocus, setClosable, setClosed, setContentPane, setDefaultCloseOperation, setDesktopIcon, setFocusCycleRoot, setFrameIcon, setGlassPane, setIcon, setIconifiable, setJMenuBar, setLayer, setLayer, setLayeredPane, setLayout, setMaximizable, setMaximum, setMenuBar, setNormalBounds, setResizable, setRootPane, setRootPaneCheckingEnabled, setSelected, setUI, toBack, toFront, 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, 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, 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, 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, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, removeAll, removeContainerListener, setFocusTraversalKeys, setFocusTraversalPolicy, 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, 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, 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, size, toString, transferFocus, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

_mdEditor

protected MetadataEditor _mdEditor
The Metadata Editor


_saveHandler

protected uk.ac.reload.editor.metadata.MetadataEditorFrame.ProxySaveHandler _saveHandler
Handles Save and SaveAs Events


_saveAsHandler

protected uk.ac.reload.editor.metadata.MetadataEditorFrame.ProxySaveHandler _saveAsHandler
Handles Save and SaveAs Events

Constructor Detail

MetadataEditorFrame

public MetadataEditorFrame()
Default constructor

Method Detail

newDocument

public void newDocument(MetadataSchemaController schemaController)
                 throws ReloadEditorException
Create a new Metadata JDOM Document

Parameters:
schemaController - the MetadataSchemaController
Throws:
ReloadEditorException

setDocument

public void setDocument(java.io.File file,
                        org.jdom.Document doc,
                        MetadataSchemaController schemaController)
                 throws ReloadEditorException
Set a Metadata JDOM Document - this will be standalone

Parameters:
file - the Metadata XML file doc the Metadata JDOM document schemaController the MetadataSchemaController
Throws:
ReloadEditorException

show

public void show()
Over-ride this so we can set view stuff


elementAdded

public void elementAdded(ReloadDocumentListenerEvent e)
Handling the element added event from the ReloadDocument

Specified by:
elementAdded in interface ReloadDocumentListener
Parameters:
e - the ReloadDocumentListenerEvent

elementChanged

public void elementChanged(ReloadDocumentListenerEvent e)
Handling the element changed event from the ReloadDocument

Specified by:
elementChanged in interface ReloadDocumentListener
Parameters:
e - the ReloadDocumentListenerEvent

elementRemoved

public void elementRemoved(ReloadDocumentListenerEvent e)
Handling the element removed event from the ReloadDocument

Specified by:
elementRemoved in interface ReloadDocumentListener
Parameters:
e - the ReloadDocumentListenerEvent

documentSaved

public void documentSaved(ReloadSchemaDocument doc)
Handling the document saved event from the ReloadDocument

Specified by:
documentSaved in interface ReloadDocumentListener
Parameters:
doc - the ReloadDocument concerned

setFocusGained

protected void setFocusGained()
We got the focus


setFocusLost

protected void setFocusLost()
We lost the focus


applicationClosing

public boolean applicationClosing()
We have been told by the Application that it is closing. Here we can save if need be.

Specified by:
applicationClosing in interface ApplicationListener
Returns:
true if all is OK, false if not.

checkNeedsSaving

protected boolean checkNeedsSaving()
We can check if the File needs saving

Returns:
true if all is OK, false if not

dispose

public void dispose()
Dispose of this Window and clean up


saveDocument

protected boolean saveDocument()
If the Metadata file has been edited, ask whether we should save it

Returns:
true if OK, false if not

saveAsDocument

protected boolean saveAsDocument()
Save As...

Returns:
true if OK, false if not

VdexReload 1.1.3 API