Class WorkingAreaEditorViewModel

java.lang.Object

ca.phon.app.session.editor.WorkingAreaEditorViewModel

All Implemented Interfaces:

EditorViewModel

public class WorkingAreaEditorViewModel
extends Object
implements EditorViewModel

View model for the session editor window. This view model keeps a centralized work area for the TranscriptView. Other views are placed in one of the other pre-defined ViewPositions:

• left-top
• left-bottom
• right-top
• right-bottom
• bottom-left
• bottom-right

Constructor Summary

Constructors

Constructor	Description
WorkingAreaEditorViewModel(SessionEditor editor)

Method Summary

Modifier and Type	Method	Description
void	addEditorViewModelListener(EditorViewModelListener listener)	Add a listener to this model
void	applyPerspective(RecordEditorPerspective editorPerspective)	Setup views based on the given perspective
void	cleanup()	Remove all view references and cleanup resources.
CommonModuleFrame	createAccessoryWindow(UUID uuid)
void	fireViewExternalized(String viewName)
void	fireViewFocused(String viewName)
void	fireViewHidden(String viewName)
void	fireViewMaximized(String viewName)
void	fireViewMinimized(String viewName)
void	fireViewNormalized(String viewName)
void	fireViewShown(String viewName)
Action	getCloseAction(String viewName)	Get the close action for a view
JComponent	getDynamicView(String viewName)	Get dynamic view component with the given name.
List<EditorViewModelListener>	getEditorViewModelListeners()	Get view model listeners
EditorView	getFocusedView()	Return focused view
Container	getRoot()	Get the view root for the editor.
EditorView	getView(String viewName)	Get the view specified by the given name.
ImageIcon	getViewIcon(String viewName)	Get the icon associated with the view.
Set<String>	getViewNames()	Get the list of view names handeled by this model
Map<EditorViewCategory,List<String>>	getViewsByCategory()	Get the set of available views organized by category.
void	hideView(String viewName)	Hide the specified view
boolean	isShowing(String viewName)	Is the specified view showing in the current layout.
boolean	isShowingInStack(String viewName)	Is the specified view top-most in its stack.
void	loadPerspective(RecordEditorPerspective editorPerspective)
void	onDeletePerspective(RecordEditorPerspective perspective)	Delete given perspective.
void	onSaveLayout()
void	onShowLayoutFolder()
void	removeEditorViewModelListener(EditorViewModelListener listener)	Remove a listener from this model
void	removePrespective(RecordEditorPerspective editorPerspective)	Remove prespective from dock control
void	savePerspective(RecordEditorPerspective editorPerspective)	Save the current view perspective as the specified editor perspective
void	setupDefaultPerspective()	Setup default perspective
void	setupLayoutMenu(MenuElement menu)	Adds a menu item for all available editor perspectives.
void	setupPerspectiveMenu(MenuElement menuElement)	Setup perspective menu.
void	setupViewMenu(MenuElement ele)	Setup view menu
void	setupWindows(RecordEditorPerspective editorPerspective)	Setup windows using the given perspective
void	showDynamicDockable(String title, JComponent comp, ViewPosition position)	Show the given component as a new dockable at the given position.
void	showDynamicFloatingDockable(String title, JComponent comp, int x, int y, int w, int h)	Show the specified view as a new dynamic floating view.
void	showView(String viewName)	Show the specified view.

Methods inherited from class java.lang.Object

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

Constructor Details

WorkingAreaEditorViewModel

public WorkingAreaEditorViewModel(SessionEditor editor)

Method Details

getRoot

public Container getRoot()

Description copied from interface: EditorViewModel

Get the view root for the editor. This is the component that will be displayed in the root pane of the editor window.

Specified by:

getRoot in interface EditorViewModel

Returns:

the root container for the editor

getFocusedView

public EditorView getFocusedView()

Return focused view

Specified by:

getFocusedView in interface EditorViewModel

Returns:

currently focused view or null

getView

public EditorView getView(String viewName)

Description copied from interface: EditorViewModel

Get the view specified by the given name.

Specified by:

getView in interface EditorViewModel

Parameters:

viewName -

Returns:

specified editor view or null if view was not found

getDynamicView

public JComponent getDynamicView(String viewName)

Description copied from interface: EditorViewModel

Get dynamic view component with the given name. This method is used for getting references to components displayed with the EditorViewModel.showDynamicFloatingDockable(String, JComponent, int, int, int, int) method.

Specified by:

getDynamicView in interface EditorViewModel

Parameters:

viewName -

Returns:

specified view component or null if view was not found

getCloseAction

public Action getCloseAction(String viewName)

Description copied from interface: EditorViewModel

Get the close action for a view

Specified by:

getCloseAction in interface EditorViewModel

Parameters:

viewName -

Returns:

the close action for the view

getViewIcon

public ImageIcon getViewIcon(String viewName)

Description copied from interface: EditorViewModel

Get the icon associated with the view. This information comes from the view itself if the view is loaded, otherwise information is obtained from the EditorViewInfo annotation on the extension point.

Specified by:

getViewIcon in interface EditorViewModel

Returns:

view icon

getViewNames

public Set<String> getViewNames()

Description copied from interface: EditorViewModel

Get the list of view names handeled by this model

Specified by:

getViewNames in interface EditorViewModel

Returns:

list of available view names

getViewsByCategory

public Map<EditorViewCategory,List<String>> getViewsByCategory()

Description copied from interface: EditorViewModel

Get the set of available views organized by category.

Specified by:

getViewsByCategory in interface EditorViewModel

Returns:

editor views by category

isShowing

public boolean isShowing(String viewName)

Description copied from interface: EditorViewModel

Is the specified view showing in the current layout.

Specified by:

isShowing in interface EditorViewModel

Returns:

true if the given view is part of the current dock control, false otherwise

isShowingInStack

public boolean isShowingInStack(String viewName)

Description copied from interface: EditorViewModel

Is the specified view top-most in its stack.

Specified by:

isShowingInStack in interface EditorViewModel

Returns:

true if the view is showing and topmost in its stack

addEditorViewModelListener

public void addEditorViewModelListener(EditorViewModelListener listener)

Description copied from interface: EditorViewModel

Add a listener to this model

Specified by:

addEditorViewModelListener in interface EditorViewModel

Parameters:

listener -

removeEditorViewModelListener

public void removeEditorViewModelListener(EditorViewModelListener listener)

Description copied from interface: EditorViewModel

Remove a listener from this model

Specified by:

removeEditorViewModelListener in interface EditorViewModel

Parameters:

listener -

getEditorViewModelListeners

public List<EditorViewModelListener> getEditorViewModelListeners()

Description copied from interface: EditorViewModel

Get view model listeners

Specified by:

getEditorViewModelListeners in interface EditorViewModel

Returns:

list of listeners

fireViewShown

public void fireViewShown(String viewName)

fireViewHidden

public void fireViewHidden(String viewName)

fireViewMinimized

public void fireViewMinimized(String viewName)

fireViewMaximized

public void fireViewMaximized(String viewName)

fireViewNormalized

public void fireViewNormalized(String viewName)

fireViewExternalized

public void fireViewExternalized(String viewName)

fireViewFocused

public void fireViewFocused(String viewName)

cleanup

public void cleanup()

Description copied from interface: EditorViewModel

Remove all view references and cleanup resources.

Specified by:

cleanup in interface EditorViewModel

showView

public void showView(String viewName)

Description copied from interface: EditorViewModel

Show the specified view.

Specified by:

showView in interface EditorViewModel

Parameters:

viewName -

hideView

public void hideView(String viewName)

Description copied from interface: EditorViewModel

Hide the specified view

Specified by:

hideView in interface EditorViewModel

Parameters:

viewName -

showDynamicFloatingDockable

public void showDynamicFloatingDockable(String title,
 JComponent comp,
 int x,
 int y,
 int w,
 int h)

Description copied from interface: EditorViewModel

Show the specified view as a new dynamic floating view. These views are not saved in layouts.

Specified by:

showDynamicFloatingDockable in interface EditorViewModel

Parameters:

title -

comp -

x -

y -

w -

h -

showDynamicDockable

public void showDynamicDockable(String title,
 JComponent comp,
 ViewPosition position)

Description copied from interface: EditorViewModel

Show the given component as a new dockable at the given position.

Specified by:

showDynamicDockable in interface EditorViewModel

Parameters:

title -

comp -

position -

setupWindows

public void setupWindows(RecordEditorPerspective editorPerspective)

Description copied from interface: EditorViewModel

Setup windows using the given perspective

Specified by:

setupWindows in interface EditorViewModel

Parameters:

editorPerspective -

setupDefaultPerspective

public void setupDefaultPerspective()

Description copied from interface: EditorViewModel

Setup default perspective

Specified by:

setupDefaultPerspective in interface EditorViewModel

applyPerspective

public void applyPerspective(RecordEditorPerspective editorPerspective)

Description copied from interface: EditorViewModel

Setup views based on the given perspective

Specified by:

applyPerspective in interface EditorViewModel

Parameters:

editorPerspective -

savePerspective

public void savePerspective(RecordEditorPerspective editorPerspective)

Description copied from interface: EditorViewModel

Save the current view perspective as the specified editor perspective

Specified by:

savePerspective in interface EditorViewModel

Parameters:

editorPerspective -

onDeletePerspective

public void onDeletePerspective(RecordEditorPerspective perspective)

Delete given perspective.

Parameters:

perspective -

loadPerspective

public void loadPerspective(RecordEditorPerspective editorPerspective)

removePrespective

public void removePrespective(RecordEditorPerspective editorPerspective)

Description copied from interface: EditorViewModel

Remove prespective from dock control

Specified by:

removePrespective in interface EditorViewModel

Parameters:

editorPerspective -

setupViewMenu

public void setupViewMenu(MenuElement ele)

Description copied from interface: EditorViewModel

Setup view menu

Specified by:

setupViewMenu in interface EditorViewModel

Parameters:

ele -

setupPerspectiveMenu

public void setupPerspectiveMenu(MenuElement menuElement)

Description copied from interface: EditorViewModel

Setup perspective menu.

Specified by:

setupPerspectiveMenu in interface EditorViewModel

Parameters:

menuElement -

setupLayoutMenu

public void setupLayoutMenu(MenuElement menu)

Adds a menu item for all available editor perspectives.

Specified by:

setupLayoutMenu in interface EditorViewModel

Parameters:

menu -

onShowLayoutFolder

public void onShowLayoutFolder()

onSaveLayout

public void onSaveLayout()

createAccessoryWindow

public CommonModuleFrame createAccessoryWindow(UUID uuid)