loci.ome.editor

Class MetadataEditor

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Frame

javax.swing.JFrame

loci.ome.editor.MetadataEditor

All Implemented Interfaces:

ActionListener, ItemListener, ImageObserver, MenuContainer, Serializable, Runnable, EventListener, Accessible, RootPaneContainer, WindowConstants

public class MetadataEditor
extends JFrame
implements ActionListener, ItemListener, Runnable

An user-friendly application for displaying and editing OME-XML metadata.

Source code:

Trac, Gitweb

Author:

Christopher Peterson crpeterson2 at wisc.edu

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JFrame

JFrame.AccessibleJFrame

Nested classes/interfaces inherited from class java.awt.Frame

Frame.AccessibleAWTFrame

Nested classes/interfaces inherited from class java.awt.Window

Window.AccessibleAWTWindow, Window.Type

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field and Description
protected JCheckBoxMenuItem	advView The checkboxes that switch between the four views.
protected File	currentFile Holds the current file being displayed.
protected JMenuItem	fileNew The File>New menu item.
protected JMenuItem	fileSave The File>Save menu item.
protected MetadataPane	mdp Holds the xml viewer that displays xml data in a JTree.
static int	MENU_MASK Key mask for use with keyboard shortcuts on this operating system.
protected MetadataPane	metadata The MetadataPane used to display/edit OMEXML content.
protected JCheckBoxMenuItem	normView The checkboxes that switch between the four views.
protected NotePane	noteP The NotePane that displays a comprehensive list of all notes.
protected JCheckBoxMenuItem	noteView The checkboxes that switch between the four views.
protected ExtensionFileFilter	omeFilter Format filters for saver JFileChooser.
protected JFileChooser	opener The file chooser used to save and open files.
protected boolean	opening Signifies whether we're opening(true) or saving(false) a file.
protected JFileChooser	saver The file chooser used to save and open files.
protected WiscScanPane	scanP The WiscScan emulator that mimics the GUI of the WiscScan program for ease of use by our in-house biologists.
protected JCheckBoxMenuItem	scanView The checkboxes that switch between the four views.
protected JCheckBoxMenuItem	showID The checkboxes that switch between the four views.
protected JMenu	tabsMenu The "Tabs" menu.
protected ExtensionFileFilter	tiffFilter Format filters for saver JFileChooser.
static String	URL_OME_METADATA_EDITOR URL of OME Metadata Editor web page.

Fields inherited from class javax.swing.JFrame

accessibleContext, EXIT_ON_CLOSE, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Frame

CROSSHAIR_CURSOR, DEFAULT_CURSOR, E_RESIZE_CURSOR, HAND_CURSOR, ICONIFIED, MAXIMIZED_BOTH, MAXIMIZED_HORIZ, MAXIMIZED_VERT, 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

Fields inherited from interface javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, HIDE_ON_CLOSE

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
MetadataEditor()
MetadataEditor(String[] args) Create a default editor window with save function and editing enabled.
MetadataEditor(String[] args, org.openmicroscopy.xml.OMENode ome, String title, boolean addSave, boolean editable) Create an editor window with specified save and editing policies.

Method Summary

Methods

Modifier and Type	Method and Description
void	actionPerformed(ActionEvent e) Handles menu commands.
void	changeTabMenu(String[] tabs) Given an array of Strings of appropriate tab names, this method sets up the tab menu accordingly.
void	itemStateChanged(ItemEvent e) Handles the checkbox menuitems that change the view.
static void	main(String[] args) Test method for debug uses, or simply to bring up an editor window from the console or whatever.
void	openFile(File file) Opens a file, sets the title of the frame to reflect the current file.
void	run() Opens a file in a separate thread.
void	saveCompanionFile(File file) Saves to a companion file, same path with .meta extenstion, pure ome.
void	saveFile(File file) Saves to a file, sets title of frame to reflect the current file.
void	saveTiffFile(File file)
void	saveTiffFile(File file, String outPath)
protected void	setCurrentFile(File aFile) Sets the current file being displayed to this file.
protected void	wait(boolean wait) Toggles wait cursor.

Methods inherited from class javax.swing.JFrame

addImpl, createRootPane, frameInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setIconImage, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update

Methods inherited from class java.awt.Frame

addNotify, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, remove, removeNotify, setBackground, setCursor, setExtendedState, setMaximizedBounds, setMenuBar, setOpacity, setResizable, setShape, setState, setTitle, setUndecorated

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBackground, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOpacity, getOwnedWindows, getOwner, getOwnerlessWindows, getShape, getToolkit, getType, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, hide, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, setVisible, show, toBack, toFront

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, 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, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.awt.MenuContainer

getFont, postEvent

Field Detail

URL_OME_METADATA_EDITOR

public static final String URL_OME_METADATA_EDITOR

URL of OME Metadata Editor web page.

See Also:

Constant Field Values

MENU_MASK

public static final int MENU_MASK

Key mask for use with keyboard shortcuts on this operating system.

opener

protected JFileChooser opener

The file chooser used to save and open files.

saver

protected JFileChooser saver

The file chooser used to save and open files.

tiffFilter

protected ExtensionFileFilter tiffFilter

Format filters for saver JFileChooser.

omeFilter

protected ExtensionFileFilter omeFilter

Format filters for saver JFileChooser.

metadata

protected MetadataPane metadata

The MetadataPane used to display/edit OMEXML content.

currentFile

protected File currentFile

Holds the current file being displayed.

tabsMenu

protected JMenu tabsMenu

The "Tabs" menu.

opening

protected boolean opening

Signifies whether we're opening(true) or saving(false) a file.

mdp

protected MetadataPane mdp

Holds the xml viewer that displays xml data in a JTree.

fileNew

protected JMenuItem fileNew

The File>New menu item.

fileSave

protected JMenuItem fileSave

The File>Save menu item.

noteP

protected NotePane noteP

The NotePane that displays a comprehensive list of all notes.

scanP

protected WiscScanPane scanP

The WiscScan emulator that mimics the GUI of the WiscScan program for ease of use by our in-house biologists.

advView

protected JCheckBoxMenuItem advView

The checkboxes that switch between the four views.

noteView

protected JCheckBoxMenuItem noteView

The checkboxes that switch between the four views.

normView

protected JCheckBoxMenuItem normView

The checkboxes that switch between the four views.

scanView

protected JCheckBoxMenuItem scanView

The checkboxes that switch between the four views.

showID

protected JCheckBoxMenuItem showID

The checkboxes that switch between the four views.

Constructor Detail

MetadataEditor

public MetadataEditor()

MetadataEditor

public MetadataEditor(String[] args)

Create a default editor window with save function and editing enabled.

MetadataEditor

public MetadataEditor(String[] args,
              org.openmicroscopy.xml.OMENode ome,
              String title,
              boolean addSave,
              boolean editable)

Create an editor window with specified save and editing policies.

Parameters:

args - an array of strings the first entry of which should be a filename, otherwise, send a (String[]) null as this parameter.

ome - An OMENode xml root to be launched if a filename is not appropriate, for instance when in the LociDataBrowser we have a FilePattern if using a FileStitcher. Thus, send ome instead. Note that this is a temporary fix. If your file is OME-Tiff there's going to be a problem if saving is enabled and you try to save to it, since we're circumventing the code that flags TIFF files.

title - Sets the title of the editor window, which is done by default if a file URL is given in args, but otherwise should be set using this String parameter.

addSave - whether or not saving should be enabled

editable - whether or not users should be able to edit the xml

Method Detail

setCurrentFile

protected void setCurrentFile(File aFile)

Sets the current file being displayed to this file.

openFile

public void openFile(File file)

Opens a file, sets the title of the frame to reflect the current file.

saveFile

public void saveFile(File file)

Saves to a file, sets title of frame to reflect the current file.

saveCompanionFile

public void saveCompanionFile(File file)

Saves to a companion file, same path with .meta extenstion, pure ome.

saveTiffFile

public void saveTiffFile(File file)

saveTiffFile

public void saveTiffFile(File file,
                String outPath)

changeTabMenu

public void changeTabMenu(String[] tabs)

Given an array of Strings of appropriate tab names, this method sets up the tab menu accordingly.

actionPerformed

public void actionPerformed(ActionEvent e)

Handles menu commands.

Specified by:

actionPerformed in interface ActionListener

itemStateChanged

public void itemStateChanged(ItemEvent e)

Handles the checkbox menuitems that change the view.

Specified by:

itemStateChanged in interface ItemListener

run

public void run()

Opens a file in a separate thread.

Specified by:

run in interface Runnable

wait

protected void wait(boolean wait)

Toggles wait cursor.

main

public static void main(String[] args)

Test method for debug uses, or simply to bring up an editor window from the console or whatever.