java.lang.Object
- net.officefloor.gef.ide.editor.AbstractAdaptedIdeEditor<R,RE,O>

Direct Known Subclasses:: ActivityEditor, SectionEditor, WoofEditor

public abstract class AbstractAdaptedIdeEditor<R extends Model,RE extends java.lang.Enum<RE>,O>
extends java.lang.Object

Abstract adapted IDE editor.

Author:: Daniel Sagenschneider

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class AbstractAdaptedIdeEditor.ViewManager<R extends Model>
View manager.

Constructor Summary

Constructors
Constructor	Description
`AbstractAdaptedIdeEditor(java.lang.Class<R> rootModelType, java.util.function.Function<R,O> createOperations, EnvironmentBridge envBridge)`	Instantiate to capture `AdaptedEditorModule`.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`O`	`createOperations(R model)`	Creates the operations for the root `Model`.
`java.lang.String`	`editorStyle()`	Allows overriding the editor styling.
`abstract java.lang.String`	`fileName()`	Obtains the default file name for the editor.
`AbstractItem.ConfigurableContext<R,O>`	`getConfigurableContext()`	Obtains the `AbstractItem.ConfigurableContext`
`java.lang.String`	`getEditorStyleId()`	Obtains the preference identifier for the editor styling.
`java.lang.String`	`getPaletteIndicatorStyleId()`	Obtains the preference identifier for the palette indicator styling.
`java.lang.String`	`getPaletteStyleId()`	Obtains the preference identifier for the palette styling.
`AbstractConfigurableItem<R,RE,O,?,?,?>[]`	`getParents()`	Obtains the `AbstractConfigurableItem` instances.
`void`	`init(com.google.inject.Module overrideModule, java.util.function.Function<com.google.inject.Injector,org.eclipse.gef.mvc.fx.domain.IDomain> initialiser)`	Initialise the `AbstractAdaptedIdeEditor`.
`protected void`	`init(AbstractItem.ConfigurableContext<R,O> context)`	Allows overriding to initialise the `AbstractAdaptedIdeEditor`.
`void`	`initNonOsgiEnvironment()`	Initialises for non OSGi environment.
`protected abstract void`	`loadParents(java.util.List<AbstractConfigurableItem<R,RE,O,?,?,?>> parents)`	Loads the `AbstractConfigurableItem` instances.
`protected abstract R`	`loadRootModel(ConfigurationItem configurationItem)`	Creates the root `Model` from the `ConfigurationItem`.
`AbstractAdaptedIdeEditor.ViewManager<R>`	`loadView(java.util.function.Consumer<javafx.scene.layout.Pane> viewLoader)`	Loads the view.
`java.lang.String`	`newFileContent()`	Obtains the new file content.
`abstract R`	`newFileRoot()`	Provides root `Model` for new file.
`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, WritableConfigurationItem configurationItem)`	Writes the root `Model` to the `WritableConfigurationItem`.
`void`	`setConfigurationItem(WritableConfigurationItem configurationItem)`	Specifies the `WritableConfigurationItem`.
`void`	`setDragLatency(int dragLatency)`	Specifies the drag latency.
`void`	`setModel(R model)`	Specifies the `Model`.
`void`	`setSelectOnly(SelectOnly selectOnly)`	Instantiate.
`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 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AbstractAdaptedIdeEditor
```
public AbstractAdaptedIdeEditor(java.lang.Class<R> rootModelType,
                                java.util.function.Function<R,O> createOperations,
                                EnvironmentBridge envBridge)
```
    Instantiate to capture AdaptedEditorModule.
    Allows for alternate AdaptedEditorModule implementation.
    
    Parameters:
    
    rootModelType - Root Model type.
    
    createOperations - Function to create the operations from the root Model.
    
    envBridge - EnvironmentBridge.
- 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.
  - getConfigurableContext
```
public AbstractItem.ConfigurableContext<R,O> getConfigurableContext()
```
    Obtains the AbstractItem.ConfigurableContext
    
    Returns:
  - getPaletteIndicatorStyleId
```
public java.lang.String getPaletteIndicatorStyleId()
```
    Obtains the preference identifier for the palette indicator styling.
    
    Returns:
    
    Preference identifier for the palette indicator styling.
  - getPaletteStyleId
```
public java.lang.String getPaletteStyleId()
```
    Obtains the preference identifier for the palette styling.
    
    Returns:
    
    Preference identifier for the palette styling.
  - getEditorStyleId
```
public java.lang.String getEditorStyleId()
```
    Obtains the preference identifier for the editor styling.
    
    Returns:
    
    Preference identifier for the editor styling.
  - setDragLatency
```
public void setDragLatency(int dragLatency)
```
    Specifies the drag latency.
    
    Parameters:
    
    dragLatency - Drag latency.
  - setSelectOnly
```
public void setSelectOnly(SelectOnly selectOnly)
```
    Instantiate.
    
    Parameters:
    
    selectOnly - SelectOnly.
  - setConfigurationItem
```
public void setConfigurationItem(WritableConfigurationItem configurationItem)
```
    Specifies the WritableConfigurationItem.
    
    Parameters:
    
    configurationItem - WritableConfigurationItem.
  - setModel
```
public void setModel(R model)
```
    Specifies the Model.
    
    Parameters:
    
    model - Model.
  - init
```
protected void init(AbstractItem.ConfigurableContext<R,O> context)
```
    Allows overriding to initialise the AbstractAdaptedIdeEditor.
    
    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.
  - newFileRoot
```
public abstract R newFileRoot()
```
    Provides root Model for new file.
    
    Returns:
    
    Root Model for new file.
  - newFileContent
```
public java.lang.String newFileContent()
                                throws java.lang.Exception
```
    Obtains the new file content.
    
    Returns:
    
    New file content.
    
    Throws:
    
    java.lang.Exception - If fails to generate new file content.
  - 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(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,
                                   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.
  - initNonOsgiEnvironment
```
public void initNonOsgiEnvironment()
```
    Initialises for non OSGi environment.
  - init
```
public void init(com.google.inject.Module overrideModule,
                 java.util.function.Function<com.google.inject.Injector,org.eclipse.gef.mvc.fx.domain.IDomain> initialiser)
```
    Initialise the AbstractAdaptedIdeEditor.
    
    Parameters:
    
    overrideModule - Optional override Module.
    
    initialiser - Initialiser with the Injector to return the IDomain.
  - loadView
```
public AbstractAdaptedIdeEditor.ViewManager<R> loadView(java.util.function.Consumer<javafx.scene.layout.Pane> viewLoader)
```
    Loads the view.
    
    Parameters:
    
    viewLoader - Receives the view.
    
    Returns:
    
    AbstractAdaptedIdeEditor.ViewManager.

Class AbstractAdaptedIdeEditor<R extends Model,​RE extends java.lang.Enum<RE>,​O>

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AbstractAdaptedIdeEditor

Method Detail

translateStyle

getConfigurableContext

getPaletteIndicatorStyleId

getPaletteStyleId

getEditorStyleId

setDragLatency

setSelectOnly

setConfigurationItem

setModel

init

getParents

fileName

newFileRoot

newFileContent

prototype

loadParents

loadRootModel

saveRootModel

paletteStyle

paletteIndicatorStyle

editorStyle

createOperations

initNonOsgiEnvironment

init

loadView

Class AbstractAdaptedIdeEditor<R extends Model,RE extends java.lang.Enum<RE>,O>