loci.ome.viewer

Class MetadataPane

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

loci.ome.viewer.MetadataPane

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Runnable, EventListener, Accessible, TreeSelectionListener

public class MetadataPane
extends JPanel
implements Runnable, TreeSelectionListener

MetadataPane is a panel that displays OME-XML metadata.

Source code:

Trac, Gitweb

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	MetadataPane.ElementWrapper Helper class for OME-XML metadata tree view.

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

JPanel.AccessibleJPanel

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

JComponent.AccessibleJComponent

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 JTextArea	cdata Field listing CDATA for the given XML element.
protected boolean	raw Whether XML is being displayed in raw form.
protected JPanel	rawPanel Panel containing raw XML dump.
protected JTextArea	rawText Text area displaying raw XML.
protected JTree	tree Tree displaying metadata in OME-XML format.
protected static String[]	TREE_COLUMNS Column headings for OME-XML attributes table.
protected JTable	treeTable Table listing OME-XML attributes.
protected DefaultTableModel	treeTableModel Table model backing OME-XML attributes table.
protected JSplitPane	xmlTree Pane containing XML tree.

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

Constructors

Constructor and Description
MetadataPane() Constructs widget for displaying OME-XML metadata.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	buildTree(Element el, DefaultMutableTreeNode node) Builds a tree by wrapping XML elements with JTree nodes.
static void	expandTree(JTree tree, DefaultMutableTreeNode node) Fully expands the given JTree from the specified node.
Dimension	getPreferredSize() Sets the initial size of the metadata pane to be reasonable.
void	run() Shows or hides the proper subpanes.
boolean	setOMEXML(File file) Sets the displayed OME-XML metadata to correspond to the given OME-XML or OME-TIFF file.
void	setOMEXML(org.openmicroscopy.xml.OMENode ome) Sets the displayed OME-XML metadata.
void	setOMEXML(String xml) Sets the displayed OME-XML metadata to correspond to the given character string of XML.
void	valueChanged(TreeSelectionEvent e) Called when the OME-XML tree selection changes.

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, 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, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, 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, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, 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, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

TREE_COLUMNS

protected static final String[] TREE_COLUMNS

Column headings for OME-XML attributes table.

xmlTree

protected JSplitPane xmlTree

Pane containing XML tree.

tree

protected JTree tree

Tree displaying metadata in OME-XML format.

cdata

protected JTextArea cdata

Field listing CDATA for the given XML element.

treeTable

protected JTable treeTable

Table listing OME-XML attributes.

treeTableModel

protected DefaultTableModel treeTableModel

Table model backing OME-XML attributes table.

rawPanel

protected JPanel rawPanel

Panel containing raw XML dump.

rawText

protected JTextArea rawText

Text area displaying raw XML.

raw

protected boolean raw

Whether XML is being displayed in raw form.

Constructor Detail

MetadataPane

public MetadataPane()

Constructs widget for displaying OME-XML metadata.

Method Detail

setOMEXML

public void setOMEXML(String xml)

Sets the displayed OME-XML metadata to correspond to the given character string of XML.

setOMEXML

public boolean setOMEXML(File file)

Sets the displayed OME-XML metadata to correspond to the given OME-XML or OME-TIFF file.

Returns:

true if the operation was successful

setOMEXML

public void setOMEXML(org.openmicroscopy.xml.OMENode ome)

Sets the displayed OME-XML metadata.

getPreferredSize

public Dimension getPreferredSize()

Sets the initial size of the metadata pane to be reasonable.

Overrides:

getPreferredSize in class JComponent

run

public void run()

Shows or hides the proper subpanes.

Specified by:

run in interface Runnable

valueChanged

public void valueChanged(TreeSelectionEvent e)

Called when the OME-XML tree selection changes.

Specified by:

valueChanged in interface TreeSelectionListener

buildTree

protected void buildTree(Element el,
             DefaultMutableTreeNode node)

Builds a tree by wrapping XML elements with JTree nodes.

expandTree

public static void expandTree(JTree tree,
              DefaultMutableTreeNode node)

Fully expands the given JTree from the specified node.