org.kepler.gui.kar

Class OpenArchiveAction

java.lang.Object

javax.swing.AbstractAction

ptolemy.vergil.toolbox.FigureAction

org.kepler.gui.kar.OpenArchiveAction

All Implemented Interfaces:

java.awt.event.ActionListener, java.io.Serializable, java.lang.Cloneable, java.util.EventListener, javax.swing.Action

public class OpenArchiveAction
extends FigureAction

This action opens a kar file to the system. It is called from File -> Open.

Since:

05/28/2009

Author:

Ben Leinfelder, Christopher Brooks

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class ptolemy.vergil.toolbox.FigureAction

FigureAction.SourceType

Field Summary

Fields inherited from class ptolemy.vergil.toolbox.FigureAction

CANVAS_TYPE, CONTEXTMENU_TYPE, HOTKEY_TYPE, MENUBAR_TYPE, PASTE_OFFSET, TOOLBAR_TYPE

Fields inherited from class javax.swing.AbstractAction

changeSupport, enabled

Fields inherited from interface javax.swing.Action

ACCELERATOR_KEY, ACTION_COMMAND_KEY, DEFAULT, DISPLAYED_MNEMONIC_INDEX_KEY, LARGE_ICON_KEY, LONG_DESCRIPTION, MNEMONIC_KEY, NAME, SELECTED_KEY, SHORT_DESCRIPTION, SMALL_ICON

Constructor Summary

Constructors

Constructor and Description
OpenArchiveAction(TableauFrame parent) Constructor

Method Summary

Modifier and Type	Method and Description
protected void	_open(java.io.File file) Open a file dialog to identify a file to be opened, and then call _read() to open the file.
protected void	_read(java.net.URL url) Read the specified URL.
void	actionPerformed(java.awt.event.ActionEvent e) Attempt to open the KAR.
java.lang.Exception	getOpenException() Return any exception generated while trying to open the KAR.
void	openKAR(java.io.File karFile, boolean forceOpen, boolean updateHistory) Process the new kar file into the actor library.
void	setArchiveFileToOpen(java.io.File archiveFile) Explicitly set the Archive file that the action will open.
void	updateHistoryAndLastDirectory(boolean updateHistoryAndLastDirectory) Change whether or not to update Kepler's Recent Files menu, and last directory setting.

Methods inherited from class ptolemy.vergil.toolbox.FigureAction

getFigure, getFrame, getSourceType, getTarget, getX, getY, offsetFigure

Methods inherited from class javax.swing.AbstractAction

addPropertyChangeListener, clone, firePropertyChange, getKeys, getPropertyChangeListeners, getValue, isEnabled, putValue, removePropertyChangeListener, setEnabled

Methods inherited from class java.lang.Object

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

Constructor Detail

OpenArchiveAction

public OpenArchiveAction(TableauFrame parent)

Constructor

Parameters:

parent - the "frame" (derived from ptolemy.gui.Top) where the menu is being added.

Method Detail

setArchiveFileToOpen

public void setArchiveFileToOpen(java.io.File archiveFile)

Explicitly set the Archive file that the action will open. If not file is set a File chooser dialog is displayed to the user.

Parameters:

archiveFile -

updateHistoryAndLastDirectory

public void updateHistoryAndLastDirectory(boolean updateHistoryAndLastDirectory)

Change whether or not to update Kepler's Recent Files menu, and last directory setting. Default is true.

Parameters:

updateHistoryAndLastDirectory -

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent e)

Attempt to open the KAR. Any exception that is generated can be retrieved with getOpenException().

Specified by:

actionPerformed in interface java.awt.event.ActionListener

Overrides:

actionPerformed in class FigureAction

Parameters:

e - ActionEvent

getOpenException

public java.lang.Exception getOpenException()

Return any exception generated while trying to open the KAR.

openKAR

public void openKAR(java.io.File karFile,
                    boolean forceOpen,
                    boolean updateHistory)
             throws java.lang.Exception

Process the new kar file into the actor library.

Parameters:

karFile - the file to process

forceOpen -

Throws:

java.lang.Exception

_open

protected void _open(java.io.File file)

Open a file dialog to identify a file to be opened, and then call _read() to open the file.

_read

protected void _read(java.net.URL url)
              throws java.lang.Exception

Read the specified URL. This delegates to the ModelDirectory to ensure that the preferred tableau of the model is opened, and that a model is not opened more than once.

Parameters:

url - The URL to read.

Throws:

java.lang.Exception - If the URL cannot be read, or if there is no tableau.