Class SessionEditor

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

ca.phon.app.session.editor.SessionEditor

All Implemented Interfaces:

IExtendable, ClipboardOwner, ImageObserver, MenuContainer, Serializable, Accessible

Direct Known Subclasses:

CorpusTemplateEditor

public class SessionEditor
extends JPanel
implements IExtendable, 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.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	Description
static final String	BACKUP_WHEN_SAVING

Fields inherited from class javax.swing.JComponent

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

accessibleContext, 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	Description
SessionEditor(Project project, Session session, Transcriber transcriber)	Constructor

Method Summary

Modifier and Type	Method	Description
Record	currentRecord()	Return the current record
String	generateTitle()	Generate the window title
int	getCurrentRecordIndex()	Return the index of the current record.
EditorDataModel	getDataModel()	Retrieve the data model
EditorEventManager	getEventManager()	Get the event manager
<T> T	getExtension(Class<T> cap)	Get the requested extension if available.
Set<Class<?>>	getExtensions()	Return all extension types supported
SessionMediaModel	getMediaModel()	Get the media model
Project	getProject()
EditorSelectionModel	getSelectionModel()	Get the selection model
Session	getSession()	Get session
SessionEditorStatusBar	getStatusBar()	Get the editor status bar
String	getTitle()
UndoManager	getUndoManager()	Get undo manager for the editor
SessionEditUndoSupport	getUndoSupport()	Get undo support for the editor
EditorViewModel	getViewModel()	Retrieve the view model
boolean	isFinishedLoading()	Has the editor finished loading all initial views
boolean	isModified()
void	lostOwnership(Clipboard clipboard, Transferable contents)
void	onSessionMediaChanged(EditorEvent<EditorEventType.SessionMediaChangedData> ee)
<T> T	putExtension(Class<T> cap, T impl)	Add a new extension.
<T> T	removeExtension(Class<T> cap)	Remove a capability.
boolean	saveData()
void	setCurrentRecordIndex(int index)	Set the index of the current record.
void	setCurrentRecordIndex(int index, Component source)	Set current record index and indicate a different source for the event
void	setModified(boolean modified)	Set the modified flag
void	setTitle(String title)
void	setupMenu(JMenuBar menuBar)

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, 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 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, 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, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, 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 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()

isFinishedLoading

public boolean isFinishedLoading()

Has the editor finished loading all initial views

Returns:

true if EditorEventType.EditorFinishedLoading has been called

setTitle

public void setTitle(String title)

getStatusBar

public SessionEditorStatusBar getStatusBar()

Get the editor status bar

Returns:

statusBar

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

getProject

public Project getProject()

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

setCurrentRecordIndex

public void setCurrentRecordIndex(int index,
 Component source)

Set current record index and indicate a different source for the event

Parameters:

index -

source -

Throws:

ArrayIndexOutOfBoundsException

currentRecord

public Record currentRecord()

Return the current record

Returns:

current record

getUndoSupport

public SessionEditUndoSupport 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

Parameters:

modified -

isModified

public boolean isModified()

generateTitle

public String generateTitle()

Generate the window title

Returns:

window title

onSessionMediaChanged

public void onSessionMediaChanged(EditorEvent<EditorEventType.SessionMediaChangedData> ee)

setupMenu

public void setupMenu(JMenuBar menuBar)

saveData

public boolean saveData()
                 throws IOException

Throws:

IOException

lostOwnership

public void lostOwnership(Clipboard clipboard,
 Transferable contents)

Specified by:

lostOwnership in interface ClipboardOwner

getExtensions

public Set<Class<?>> getExtensions()

Description copied from interface: IExtendable

Return all extension types supported

Specified by:

getExtensions in interface IExtendable

getExtension

public <T> T getExtension(Class<T> cap)

Description copied from interface: IExtendable

Get the requested extension if available.

Specified by:

getExtension in interface IExtendable

Returns:

the capability object or null if the cability is not available

putExtension

public <T> T putExtension(Class<T> cap,
 T impl)

Description copied from interface: IExtendable

Add a new extension.

Specified by:

putExtension in interface IExtendable

Parameters:

cap - the extension to add

Returns:

the added extension implementation

removeExtension

public <T> T removeExtension(Class<T> cap)

Description copied from interface: IExtendable

Remove a capability.

Specified by:

removeExtension in interface IExtendable

Parameters:

cap - the capability to remove