hdf.view

Class DefaultTreeView

Object

Component

Container

JComponent

JPanel

hdf.view.DefaultTreeView

All Implemented Interfaces:

TreeView, ActionListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible

public class DefaultTreeView
extends JPanel
implements TreeView, ActionListener

TreeView defines APIs for opening files and displaying the file structure in a tree structure.

TreeView uses folders and leaf items to represent groups and data objects in the file. You can expand or collapse folders to navigate data objects in the file.

From the TreeView, you can open data content or metadata of the selected object. You can select object(s) to delete or add new objects to the file.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class JPanel

JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class Component

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

Field Summary

Fields inherited from class JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface ImageObserver

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

Constructor Summary

Constructors

Constructor and Description
DefaultTreeView(ViewManager theView)

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(ActionEvent e)
void	addObject(HObject newObject, Group parentGroup) Adds a new data object to the file.
void	closeFile(FileFormat file) Close a file
TreeNode	findTreeNode(HObject obj) Returns the tree node that contains the given data object.
List<FileFormat>	getCurrentFiles()
HObject	getCurrentObject()
FileFormat	getSelectedFile() Gets the selected file.
List<Object>	getSelectedObjects() Gets a list of selected object in the tree.
JTree	getTree() Returns the JTree which holds the file structure.
FileFormat	openFile(String filename, int accessID) Opens a file and retrieves the file structure of the file.
FileFormat	reopenFile(FileFormat fileFormat)
void	saveFile(FileFormat file) Save a file
DataView	showDataContent(HObject dataObject) Display the content of a data object.
MetaDataView	showMetaData(HObject dataObject) Displays the meta data of a data object.

Methods inherited from class JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class 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, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, 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 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 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, 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 Object

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

Constructor Detail

DefaultTreeView

public DefaultTreeView(ViewManager theView)

Method Detail

actionPerformed

public void actionPerformed(ActionEvent e)

Specified by:

actionPerformed in interface ActionListener

addObject

public void addObject(HObject newObject,
                      Group parentGroup)
               throws Exception

Adds a new data object to the file.

Specified by:

addObject in interface TreeView

Parameters:

newObject - the object to add.

parentGroup - the parent group to add the object to.

Throws:

Exception - if an exception occurs while adding a new data object to the file

openFile

public FileFormat openFile(String filename,
                           int accessID)
                    throws Exception

Opens a file and retrieves the file structure of the file. It also can be used to create a new file by setting the accessID to FileFormat.CREATE.

Subclasses must implement this function to take appropriate steps to open a file.

Specified by:

openFile in interface TreeView

Parameters:

filename - the name of the file to open.

accessID - identifier for the file access. Valid value of accessID is:

• FileFormat.READ --- allow read-only access to file.
• FileFormat.WRITE --- allow read and write access to file.
• FileFormat.CREATE --- create a new file.

Returns:

the FileFormat of this file if successful; otherwise returns null.

Throws:

Exception - if a failure occurred

reopenFile

public FileFormat reopenFile(FileFormat fileFormat)
                      throws Exception

Specified by:

reopenFile in interface TreeView

Throws:

Exception

closeFile

public void closeFile(FileFormat file)
               throws Exception

Close a file

Specified by:

closeFile in interface TreeView

Parameters:

file - the file to close

Throws:

Exception - if a failure occurred

saveFile

public void saveFile(FileFormat file)
              throws Exception

Save a file

Specified by:

saveFile in interface TreeView

Parameters:

file - the file to save

Throws:

Exception - if a failure occurred

findTreeNode

public TreeNode findTreeNode(HObject obj)

Returns the tree node that contains the given data object.

Specified by:

findTreeNode in interface TreeView

Parameters:

obj - the object to find

Returns:

the tree node that contains the given data object.

getSelectedFile

public FileFormat getSelectedFile()

Gets the selected file. When multiple files are open, we need to know which file is currently selected.

Specified by:

getSelectedFile in interface TreeView

Returns:

the FileFormat of the currently selected file.

getSelectedObjects

public List<Object> getSelectedObjects()

Gets a list of selected object in the tree. Obtaining a list of current selected objects is necessary for copy/paste/delete objects.

Specified by:

getSelectedObjects in interface TreeView

Returns:

a list of selected object in the tree.

getCurrentObject

public HObject getCurrentObject()

Specified by:

getCurrentObject in interface TreeView

Returns:

the currently selected object in the tree.

getTree

public JTree getTree()

Description copied from interface: TreeView

Returns the JTree which holds the file structure.

Specified by:

getTree in interface TreeView

Returns:

the JTree which holds the file structure.

getCurrentFiles

public List<FileFormat> getCurrentFiles()

Specified by:

getCurrentFiles in interface TreeView

Returns:

the list of currently open files.

showDataContent

public DataView showDataContent(HObject dataObject)
                         throws Exception

Display the content of a data object.

Specified by:

showDataContent in interface TreeView

Parameters:

dataObject - the data object

Returns:

the DataView that displays the data content

Throws:

Exception - if a failure occurred

showMetaData

public MetaDataView showMetaData(HObject dataObject)
                          throws Exception

Displays the meta data of a data object.

Specified by:

showMetaData in interface TreeView

Parameters:

dataObject - the data object

Returns:

the MetaDataView that displays the MetaData of the data object

Throws:

Exception - if a failure occurred