net.officefloor.eclipse.ide.editor

Class AbstractIdeEditor<R extends net.officefloor.model.Model,RE extends java.lang.Enum<RE>,O>

java.lang.Object

org.eclipse.core.commands.common.EventManager

org.eclipse.ui.part.WorkbenchPart

org.eclipse.ui.part.EditorPart

org.eclipse.gef.mvc.fx.ui.parts.AbstractFXEditor

net.officefloor.eclipse.ide.editor.AbstractIdeEditor<R,RE,O>

Type Parameters:

R - Root Model type.

O - Change operations type.

All Implemented Interfaces:

org.eclipse.core.runtime.IAdaptable, org.eclipse.core.runtime.IExecutableExtension, org.eclipse.ui.IEditorPart, org.eclipse.ui.ISaveablePart, org.eclipse.ui.IWorkbenchPart, org.eclipse.ui.IWorkbenchPart2, org.eclipse.ui.IWorkbenchPart3, org.eclipse.ui.part.IWorkbenchPartOrientation

public abstract class AbstractIdeEditor<R extends net.officefloor.model.Model,RE extends java.lang.Enum<RE>,O>
extends org.eclipse.gef.mvc.fx.ui.parts.AbstractFXEditor

OfficeFloorModel editor.

Author:

Daniel Sagenschneider

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AbstractIdeEditor.OutsideWorkbenchLauncher Logic to launch outside the IWorkbench.

Field Summary

Fields inherited from interface org.eclipse.ui.IEditorPart

PROP_DIRTY, PROP_INPUT

Fields inherited from interface org.eclipse.ui.IWorkbenchPart

PROP_TITLE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractIdeEditor(AdaptedEditorModule module, java.lang.Class<R> rootModelType, java.util.function.Function<R,O> createOperations) Instantiate to capture AdaptedEditorModule.
	AbstractIdeEditor(java.lang.Class<R> rootModelType, java.util.function.Function<R,O> createOperations) Instantiate with default AdaptedEditorModule.

Method Summary

Modifier and Type	Method and Description
protected void	activate()
O	createOperations(R model) Creates the operations for the root Model.
void	dispose()
void	doSave(org.eclipse.core.runtime.IProgressMonitor monitor)
void	doSaveAs()
java.lang.String	editorStyle() Allows overriding the editor styling.
abstract java.lang.String	fileName() Obtains the default file name for the editor.
FXCanvas	getCanvas()
org.eclipse.gef.mvc.fx.viewer.IViewer	getContentViewer()
java.lang.String	getEditorStyleId() Obtains the IPreferenceStore identifier for the editor styling.
protected OfficeFloorOsgiBridge	getOsgiBridge() Obtains the OfficeFloorOsgiBridge.
java.lang.String	getPaletteIndicatorStyleId() Obtains the IPreferenceStore identifier for the palette indicator styling.
java.lang.String	getPaletteStyleId() Obtains the IPreferenceStore identifier for the palette styling.
AbstractConfigurableItem<R,RE,O,?,?,?>[]	getParents() Obtains the AbstractConfigurableItem instances.
protected void	hookViewers()
protected void	init(AbstractItem.ConfigurableContext<R,O> context) Allows overriding to initialise the AbstractIdeEditor.
boolean	isSaveAsAllowed()
static void	launch(java.io.File configurationFile) Convenience method to launch the AbstractIdeEditor implementation outside the IWorkbench.
static void	launch(java.lang.String configuration) Convenience method to launch the AbstractIdeEditor implementation outside the IWorkbench.
static void	launchOutsideWorkbench(AbstractIdeEditor.OutsideWorkbenchLauncher launcher) Enables running the AbstractIdeEditor outside of the IWorkbench.
protected abstract void	loadParents(java.util.List<AbstractConfigurableItem<R,RE,O,?,?,?>> parents) Loads the AbstractConfigurableItem instances.
protected abstract R	loadRootModel(net.officefloor.configuration.ConfigurationItem configurationItem) Creates the root Model from the ConfigurationItem.
java.lang.String	paletteIndicatorStyle() Allows overriding the palette indicator styling.
java.lang.String	paletteStyle() Allows overriding the palette styling.
abstract R	prototype() Obtains root prototype.
abstract void	saveRootModel(R model, net.officefloor.configuration.WritableConfigurationItem configurationItem) Writes the root Model to the WritableConfigurationItem.
protected void	setInput(org.eclipse.ui.IEditorInput input)
void	setSelectOnly(SelectOnly selectOnly) Instantiate.
protected void	setSite(org.eclipse.ui.IWorkbenchPartSite site)
static java.lang.String	translateStyle(java.lang.String rawStyle, AbstractItem<?,?,?,?,?,?> item) Translates the style with the details of the item being rendered.

Methods inherited from class org.eclipse.gef.mvc.fx.ui.parts.AbstractFXEditor

createActions, createPartControl, deactivate, disposeActions, getAdapter, getDomain, init, isDirty, markNonDirty, setFocus, unhookViewers

Methods inherited from class org.eclipse.ui.part.EditorPart

checkSite, getEditorInput, getEditorSite, getTitleToolTip, isSaveOnCloseNeeded, setContentDescription, setInitializationData, setInputWithNotify, setPartName

Methods inherited from class org.eclipse.ui.part.WorkbenchPart

addPartPropertyListener, addPropertyListener, firePartPropertyChanged, firePropertyChange, getConfigurationElement, getContentDescription, getDefaultImage, getOrientation, getPartName, getPartProperties, getPartProperty, getSite, getTitle, getTitleImage, removePartPropertyListener, removePropertyListener, setPartProperty, setTitle, setTitleImage, setTitleToolTip, showBusy

Methods inherited from class org.eclipse.core.commands.common.EventManager

addListenerObject, clearListeners, getListeners, isListenerAttached, removeListenerObject

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.ui.IWorkbenchPart

addPropertyListener, getSite, getTitle, getTitleImage, removePropertyListener

Constructor Detail

AbstractIdeEditor

protected AbstractIdeEditor(AdaptedEditorModule module,
                            java.lang.Class<R> rootModelType,
                            java.util.function.Function<R,O> createOperations)

Instantiate to capture AdaptedEditorModule.

Allows for alternate AdaptedEditorModule implementation.

Parameters:

module - AdaptedEditorModule.

rootModelType - Root Model type.

createOperations - Function to create the operations from the root Model.

AbstractIdeEditor

public AbstractIdeEditor(java.lang.Class<R> rootModelType,
                         java.util.function.Function<R,O> createOperations)

Instantiate with default AdaptedEditorModule.

Parameters:

rootModelType - Root Model type.

createOperations - Function to create the operations from the root Model.

Method Detail

translateStyle

public static java.lang.String translateStyle(java.lang.String rawStyle,
                                              AbstractItem<?,?,?,?,?,?> item)

Translates the style with the details of the item being rendered.

Parameters:

rawStyle - Raw style to be translated.

item - AbstractItem.

Returns:

Ready to use translate.

launchOutsideWorkbench

public static void launchOutsideWorkbench(AbstractIdeEditor.OutsideWorkbenchLauncher launcher)

Enables running the AbstractIdeEditor outside of the IWorkbench.

Parameters:

launcher - AbstractIdeEditor.OutsideWorkbenchLauncher.

launch

public static void launch(java.io.File configurationFile)

Convenience method to launch the AbstractIdeEditor implementation outside the IWorkbench.

Parameters:

configurationFile - File containing the configuration.

launch

public static void launch(java.lang.String configuration)

Convenience method to launch the AbstractIdeEditor implementation outside the IWorkbench.

Parameters:

configuration - Configuration of ConfigurationItem to launch the AbstractIdeEditor.

getPaletteIndicatorStyleId

public java.lang.String getPaletteIndicatorStyleId()

Obtains the IPreferenceStore identifier for the palette indicator styling.

Returns:

IPreferenceStore identifier for the palette indicator styling.

getPaletteStyleId

public java.lang.String getPaletteStyleId()

Obtains the IPreferenceStore identifier for the palette styling.

Returns:

IPreferenceStore identifier for the palette styling.

getEditorStyleId

public java.lang.String getEditorStyleId()

Obtains the IPreferenceStore identifier for the editor styling.

Returns:

IPreferenceStore identifier for the editor styling.

setSelectOnly

public void setSelectOnly(SelectOnly selectOnly)

Instantiate.

Parameters:

selectOnly - SelectOnly.

init

protected void init(AbstractItem.ConfigurableContext<R,O> context)

Allows overriding to initialise the AbstractIdeEditor.

Parameters:

context - AbstractItem.ConfigurableContext.

getParents

public final AbstractConfigurableItem<R,RE,O,?,?,?>[] getParents()

Obtains the AbstractConfigurableItem instances.

Returns:

AbstractConfigurableItem instances.

fileName

public abstract java.lang.String fileName()

Obtains the default file name for the editor.

Returns:

Default file name for the editor.

See Also:

AbstractNewWizard

prototype

public abstract R prototype()

Obtains root prototype.

Returns:

Root prototype.

loadParents

protected abstract void loadParents(java.util.List<AbstractConfigurableItem<R,RE,O,?,?,?>> parents)

Loads the AbstractConfigurableItem instances.

Parameters:

parents - List to be populated with the AbstractConfigurableItem instances.

loadRootModel

protected abstract R loadRootModel(net.officefloor.configuration.ConfigurationItem configurationItem)
                            throws java.lang.Exception

Creates the root Model from the ConfigurationItem.

Parameters:

configurationItem - ConfigurationItem containing the configuration of the Model.

Returns:

Root Model within the ConfigurationItem.

Throws:

java.lang.Exception - If fails to load the root Model from the ConfigurationItem.

saveRootModel

public abstract void saveRootModel(R model,
                                   net.officefloor.configuration.WritableConfigurationItem configurationItem)
                            throws java.lang.Exception

Writes the root Model to the WritableConfigurationItem.

Parameters:

model - Root Model to be saved.

configurationItem - WritableConfigurationItem.

Throws:

java.lang.Exception - If fails to save the root Model into the WritableConfigurationItem.

paletteStyle

public java.lang.String paletteStyle()

Allows overriding the palette styling.

Returns:

Palette styling. May be null for default styling.

paletteIndicatorStyle

public java.lang.String paletteIndicatorStyle()

Allows overriding the palette indicator styling.

Returns:

Palette indicator styling. May be null for default styling.

editorStyle

public java.lang.String editorStyle()

Allows overriding the editor styling.

Returns:

Editor styling. May be null for defaulting styling.

createOperations

public O createOperations(R model)

Creates the operations for the root Model.

Parameters:

model - Root Model.

Returns:

Operations.

getOsgiBridge

protected final OfficeFloorOsgiBridge getOsgiBridge()
                                             throws java.lang.Exception

Obtains the OfficeFloorOsgiBridge.

Returns:

OfficeFloorOsgiBridge.

Throws:

java.lang.Exception - If fails to obtain the OfficeFloorOsgiBridge.

getCanvas

public FXCanvas getCanvas()

Overrides:

getCanvas in class org.eclipse.gef.mvc.fx.ui.parts.AbstractFXEditor

getContentViewer

public final org.eclipse.gef.mvc.fx.viewer.IViewer getContentViewer()

Overrides:

getContentViewer in class org.eclipse.gef.mvc.fx.ui.parts.AbstractFXEditor

hookViewers

protected final void hookViewers()

Overrides:

hookViewers in class org.eclipse.gef.mvc.fx.ui.parts.AbstractFXEditor

activate

protected final void activate()

Overrides:

activate in class org.eclipse.gef.mvc.fx.ui.parts.AbstractFXEditor

setInput

protected final void setInput(org.eclipse.ui.IEditorInput input)

Overrides:

setInput in class org.eclipse.ui.part.EditorPart

setSite

protected final void setSite(org.eclipse.ui.IWorkbenchPartSite site)

Overrides:

setSite in class org.eclipse.ui.part.WorkbenchPart

doSave

public final void doSave(org.eclipse.core.runtime.IProgressMonitor monitor)

Specified by:

doSave in interface org.eclipse.ui.ISaveablePart

Specified by:

doSave in class org.eclipse.ui.part.EditorPart

isSaveAsAllowed

public boolean isSaveAsAllowed()

Specified by:

isSaveAsAllowed in interface org.eclipse.ui.ISaveablePart

Specified by:

isSaveAsAllowed in class org.eclipse.ui.part.EditorPart

doSaveAs

public void doSaveAs()

Specified by:

doSaveAs in interface org.eclipse.ui.ISaveablePart

Specified by:

doSaveAs in class org.eclipse.ui.part.EditorPart

dispose

public void dispose()

Specified by:

dispose in interface org.eclipse.ui.IWorkbenchPart

Overrides:

dispose in class org.eclipse.gef.mvc.fx.ui.parts.AbstractFXEditor