Package ca.phon.app.session.editor

Class SessionEditor

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Frame

javax.swing.JFrame

ca.phon.ui.CommonModuleFrame

ca.phon.app.project.ProjectFrame

ca.phon.app.session.editor.SessionEditor

All Implemented Interfaces:

IExtendable, ClipboardOwner, ImageObserver, MenuContainer, Serializable, Accessible, RootPaneContainer, WindowConstants

Direct Known Subclasses:

CorpusTemplateEditor

public class SessionEditor
extends ProjectFrame
implements ClipboardOwner

Main UI for the application. This window provides the interface for creating and modifying Phon Sessions.

This window supports plug-ins. Plug-ins can provide custom EditorViews.

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	Description
static final String	BACKUP_WHEN_SAVING

Fields inherited from class ca.phon.ui.CommonModuleFrame

DEFAULT_MACOS_ENABLE_FULLSCREEN, MACOS_ENABLE_FULLSCREEN, title

Fields inherited from class javax.swing.JFrame

accessibleContext, 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 java.awt.image.ImageObserver

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

Fields inherited from interface javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE

Constructor Summary

Constructors

Constructor	Description
SessionEditor(Project project, Session session, Transcriber transcriber)	Constructor

Method Summary

Modifier and Type	Method	Description
Record	currentRecord()	Return the current record
void	dispose()
int	getCurrentRecordIndex()	Return the index of the current record.
EditorDataModel	getDataModel()	Retrieve the data model
EditorEventManager	getEventManager()	Get the event manager
SessionMediaModel	getMediaModel()	Get the media model
EditorSelectionModel	getSelectionModel()	Get the selection model
Session	getSession()	Get session
SessionEditorStatusBar	getStatusBar()	Get the editor status bar
String	getTitle()	Overridden to provide consistent naming in all windows.
SessionEditorToolbar	getToolbar()	Get the editor toolbar.
UndoManager	getUndoManager()	Get undo manager for the editor
SessionEditorUndoSupport	getUndoSupport()	Get undo support for the editor
EditorViewModel	getViewModel()	Retrieve the view model
void	lostOwnership(Clipboard clipboard, Transferable contents)
boolean	saveData()	Save window changes
void	setCurrentRecordIndex(int index)	Set the index of the current record.
void	setJMenuBar(JMenuBar menuBar)	Setup editor window menu
void	setModified(boolean modified)	Set the modified flag
void	setupMenu(JMenuBar menuBar)

Methods inherited from class ca.phon.app.project.ProjectFrame

getProject, setProject

Methods inherited from class ca.phon.ui.CommonModuleFrame

addNewWindowListener, cascadeWindow, centerWindow, close, display, getCurrentFrame, getExtension, getExtensions, getOpenWindows, getParentFrame, getProjectWindows, getUnsavedChangesMessage, getUnsavedChangesTitle, getWindowName, hasUnsavedChanges, hideStatusComponent, isShowInWindowMenu, placeTopRight, positionRelativeTo, putExtension, removeExtension, resetStatusComponent, saveAndClose, setParentFrame, setShowInWindowMenu, setUnsavedChangesMessage, setUnsavedChangesTitle, setWindowName, showErrorMessage, showMessageDialog, showOkCancelDialog, showOkDialog, showStatusMessage, showYesNoCancelDialog, showYesNoDialog

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, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update

Methods inherited from class java.awt.Frame

addNotify, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, 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, 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, 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, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setMixingCutoutShape, 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 Details

BACKUP_WHEN_SAVING

public static final String BACKUP_WHEN_SAVING

Constructor Details

SessionEditor

public SessionEditor(Project project,
 Session session,
 Transcriber transcriber)

Constructor

Method Details

getTitle

public String getTitle()

Description copied from class: CommonModuleFrame

Overridden to provide consistent naming in all windows. Use setWindowName() to setup the custom name for the window.

Overrides:

getTitle in class CommonModuleFrame

dispose

public void dispose()

Overrides:

dispose in class Window

getToolbar

public SessionEditorToolbar getToolbar()

Get the editor toolbar.

Returns:

toolbar

getStatusBar

public SessionEditorStatusBar getStatusBar()

Get the editor status bar

Returns:

statusBar

setJMenuBar

public void setJMenuBar(JMenuBar menuBar)

Setup editor window menu

Overrides:

setJMenuBar in class JFrame

Parameters:

menuBar -

setupMenu

public void setupMenu(JMenuBar menuBar)

getDataModel

public EditorDataModel getDataModel()

Retrieve the data model

Returns:

the editor data model

getViewModel

public EditorViewModel getViewModel()

Retrieve the view model

Returns:

the editor view model

getEventManager

public EditorEventManager getEventManager()

Get the event manager

Returns:

the editor event model

getSelectionModel

public EditorSelectionModel getSelectionModel()

Get the selection model

Returns:

editor selection model

getMediaModel

public SessionMediaModel getMediaModel()

Get the media model

Returns:

session media model

getSession

public Session getSession()

Get session

Returns:

session

getCurrentRecordIndex

public int getCurrentRecordIndex()

Return the index of the current record.

Returns:

index of current record

setCurrentRecordIndex

public void setCurrentRecordIndex(int index)

Set the index of the current record.

Throws:

ArrayIndexOutOfBoundsException

currentRecord

public Record currentRecord()

Return the current record

Returns:

current record

getUndoSupport

public SessionEditorUndoSupport getUndoSupport()

Get undo support for the editor

Returns:

undo support

getUndoManager

public UndoManager getUndoManager()

Get undo manager for the editor

Returns:

undo manager

setModified

public void setModified(boolean modified)

Set the modified flag

Overrides:

setModified in class CommonModuleFrame

Parameters:

modified -

saveData

public boolean saveData()
                 throws IOException

Description copied from class: CommonModuleFrame

Save window changes

Overrides:

saveData in class CommonModuleFrame

Throws:

IOException

lostOwnership

public void lostOwnership(Clipboard clipboard,
 Transferable contents)

Specified by:

lostOwnership in interface ClipboardOwner