com.partnersoft.workbench.model

Class AbstractWorkbenchModuleSettingsEditor

java.lang.Object

com.partnersoft.workbench.model.AbstractWorkbenchModuleSettingsEditor

All Implemented Interfaces:

SettingsEditor, WorkbenchEditor, WorkbenchFileEditor, WorkbenchSettingsEditor

Direct Known Subclasses:

WorkbenchModuleSettingsEditor

public abstract class AbstractWorkbenchModuleSettingsEditor
extends java.lang.Object
implements WorkbenchSettingsEditor

Abstract implementation of WorkbenchSettingsEditor
Copyright 2013 Partner Software, Inc.

Author:

Jeremy Tarver

Field Summary

Fields

Modifier and Type	Field and Description
protected ActionBureau	actionBureau
protected VfsFile	file
protected javax.swing.JComponent	gui
protected Module	module
protected ModuleSettings	moduleSettings
protected java.lang.String	name
protected ModuleSettingsStore	settingsStore
protected WorkbenchApp	workbench

Constructor Summary

Constructors

Constructor and Description
AbstractWorkbenchModuleSettingsEditor()

Method Summary

Methods

Modifier and Type	Method and Description
void	doAction(java.lang.String actionName)
void	doAction(java.lang.String actionName, java.lang.String... args) Perform an action with optional arguments.
VfsFile	getFile()
javax.swing.JComponent	getGui()
java.lang.String	getName()
CoggableSettings	getSettings() Marker method used to require implementing classes to have a CoggableSettings field
SettingsStore	getSettingsStore() Marker method used to require implementing classes to have a SettingsStore field
WorkbenchApp	getWorkbench()
protected void	initializeEditor()
void	load() Initializes editor by loading the module associated with the WorkbenchFile.
void	reloadFromStore() Reloads settings object from the ModuleSettingsStore
void	save() Invokes saveToStore.
void	saveToStore() Reloads the ModuleSettings from the edited cog then stores it.
void	setFile(VfsFile newFile)
void	setLine(int line)
void	setWorkbench(WorkbenchApp workbench)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.partnersoft.settings.framework.model.SettingsEditor

edit, getSettingsGui

Field Detail

workbench

protected WorkbenchApp workbench

name

protected java.lang.String name

module

protected Module module

file

protected VfsFile file

gui

protected javax.swing.JComponent gui

actionBureau

protected ActionBureau actionBureau

moduleSettings

protected ModuleSettings moduleSettings

settingsStore

protected ModuleSettingsStore settingsStore

Constructor Detail

AbstractWorkbenchModuleSettingsEditor

public AbstractWorkbenchModuleSettingsEditor()

Method Detail

initializeEditor

protected void initializeEditor()

saveToStore

public void saveToStore()

Reloads the ModuleSettings from the edited cog then stores it.

Specified by:

saveToStore in interface SettingsEditor

See Also:

SettingsEditor.saveToStore()

reloadFromStore

public void reloadFromStore()

Reloads settings object from the ModuleSettingsStore

Specified by:

reloadFromStore in interface SettingsEditor

See Also:

SettingsEditor.reloadFromStore()

getSettings

public CoggableSettings getSettings()

Description copied from interface: SettingsEditor

Marker method used to require implementing classes to have a CoggableSettings field

Specified by:

getSettings in interface SettingsEditor

Returns:

CoggableSettings

See Also:

SettingsEditor.getSettings()

getSettingsStore

public SettingsStore getSettingsStore()

Description copied from interface: SettingsEditor

Marker method used to require implementing classes to have a SettingsStore field

Specified by:

getSettingsStore in interface SettingsEditor

Returns:

SettingsStore

See Also:

SettingsEditor.getSettingsStore()

getFile

public VfsFile getFile()

Specified by:

getFile in interface WorkbenchFileEditor

See Also:

WorkbenchFileEditor.getFile()

setFile

public void setFile(VfsFile newFile)

Specified by:

setFile in interface WorkbenchFileEditor

See Also:

WorkbenchFileEditor.setFile(com.partnersoft.io.vfs.VfsFile)

setLine

public void setLine(int line)

Specified by:

setLine in interface WorkbenchFileEditor

See Also:

WorkbenchFileEditor.setLine(int)

load

public void load()
          throws java.io.IOException

Initializes editor by loading the module associated with the WorkbenchFile. Creates ModuleSettings and ModuleSettingsStore, then invokes edit method defined in subclass.

Specified by:

load in interface WorkbenchEditor

Throws:

java.io.IOException

See Also:

SettingsGui.edit(java.awt.Container, CoggableSettings), WorkbenchEditor.load()

save

public void save()
          throws java.io.IOException

Invokes saveToStore.

Specified by:

save in interface WorkbenchEditor

Throws:

java.io.IOException

See Also:

WorkbenchEditor.save()

getName

public java.lang.String getName()

Specified by:

getName in interface WorkbenchEditor

See Also:

WorkbenchEditor.getName()

setWorkbench

public void setWorkbench(WorkbenchApp workbench)

Specified by:

setWorkbench in interface WorkbenchEditor

See Also:

WorkbenchEditor.setWorkbench(com.partnersoft.workbench.app.WorkbenchApp)

getWorkbench

public WorkbenchApp getWorkbench()

Specified by:

getWorkbench in interface WorkbenchEditor

See Also:

WorkbenchEditor.getWorkbench()

getGui

public javax.swing.JComponent getGui()

Specified by:

getGui in interface WorkbenchEditor

See Also:

WorkbenchEditor.getGui()

doAction

public void doAction(java.lang.String actionName)

Specified by:

doAction in interface WorkbenchEditor

See Also:

WorkbenchEditor.doAction(java.lang.String)

doAction

public void doAction(java.lang.String actionName,
            java.lang.String... args)

Description copied from interface: WorkbenchEditor

Perform an action with optional arguments. The first argument is the name of the action.

Specified by:

doAction in interface WorkbenchEditor

See Also:

WorkbenchEditor.doAction(java.lang.String, java.lang.String[])