net.officefloor.eclipse.conform

Class ConformEditor

java.lang.Object

org.eclipse.core.commands.common.EventManager

org.eclipse.ui.part.WorkbenchPart

org.eclipse.ui.part.EditorPart

org.eclipse.gef.ui.parts.GraphicalEditor

org.eclipse.gef.ui.parts.GraphicalEditorWithFlyoutPalette

net.officefloor.eclipse.common.editor.AbstractOfficeFloorEditor<Model,Object>

net.officefloor.eclipse.conform.ConformEditor

All Implemented Interfaces:

EventListener, org.eclipse.core.runtime.IAdaptable, org.eclipse.core.runtime.IExecutableExtension, org.eclipse.gef.commands.CommandStackListener, org.eclipse.gef.EditPartFactory, org.eclipse.ui.IEditorPart, org.eclipse.ui.ISaveablePart, org.eclipse.ui.ISelectionListener, org.eclipse.ui.IWorkbenchPart, org.eclipse.ui.IWorkbenchPart2, org.eclipse.ui.IWorkbenchPart3, org.eclipse.ui.part.IWorkbenchPartOrientation

public class ConformEditor
extends AbstractOfficeFloorEditor<Model,Object>

AbstractOfficeFloorEditor for a Dialog Control.

Author:

Daniel Sagenschneider

Nested Class Summary

Nested classes/interfaces inherited from class org.eclipse.gef.ui.parts.GraphicalEditorWithFlyoutPalette

org.eclipse.gef.ui.parts.GraphicalEditorWithFlyoutPalette.CustomPalettePage

Field Summary

Fields inherited from class net.officefloor.eclipse.common.editor.AbstractOfficeFloorEditor

paletteRoot

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

Constructor and Description
ConformEditor(org.eclipse.gef.RootEditPart rootEditPart, org.eclipse.swt.widgets.Shell shell) Initialise.

Method Summary

Modifier and Type	Method and Description
protected Object	createModelChanges(Model model) Creates the Model change functionality.
org.eclipse.gef.RootEditPart	getRootEditPart() Obtains the RootEditPart.
void	mapModelToEditPart(Class<?> modelType, Class<? extends org.eclipse.gef.EditPart> editPartType) Maps a Model type to its respective EditPart type.
void	messageStatus(org.eclipse.core.runtime.IStatus status, String title) Displays a Dialog for the IStatus.
protected void	populateEditPartTypes(Map<Class<?>,Class<? extends org.eclipse.gef.EditPart>> map) Populates the EditPart types for their respective model.
protected void	populateGraphicalEditPolicy(OfficeFloorGraphicalNodeEditPolicy policy) Populates the OfficeFloorGraphicalNodeEditPolicy.
protected void	populateLayoutEditPolicy(OfficeFloorLayoutEditPolicy policy) Populates the OfficeFloorLayoutEditPolicy.
protected void	populateOperations(List<Operation> list) Populates the listing of Operation instances.
protected Model	retrieveModel(ConfigurationItem configuration) Retrieves the Model.
protected void	storeModel(Model model, ConfigurationItem configuration) Stores the Model.

Methods inherited from class net.officefloor.eclipse.common.editor.AbstractOfficeFloorEditor

createEditPart, createGraphicalEditPolicy, createLayoutEditPolicy, doSave, doSaveAs, getCastedModel, getModelChanges, getPalettePreferences, getPaletteRoot, initialiseContextMenu, initialisePaletteRoot, initializeGraphicalViewer, isSaveAsAllowed, loadEditPartTypes, messageError, messageError, messageError, messageError, messageWarning, setCastedModel, setInput

Methods inherited from class org.eclipse.gef.ui.parts.GraphicalEditorWithFlyoutPalette

createPaletteComposite, createPalettePage, createPaletteViewerProvider, createPartControl, getAdapter, getGraphicalControl, getPaletteViewerProvider, setEditDomain

Methods inherited from class org.eclipse.gef.ui.parts.GraphicalEditor

commandStackChanged, configureGraphicalViewer, createActions, createGraphicalViewer, dispose, firePropertyChange, getActionRegistry, getCommandStack, getEditDomain, getGraphicalViewer, getPropertyActions, getSelectionActions, getSelectionSynchronizer, getStackActions, hookGraphicalViewer, init, initializeActionRegistry, isDirty, selectionChanged, setActionRegistry, setFocus, setGraphicalViewer, updateActions

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, getConfigurationElement, getContentDescription, getDefaultImage, getOrientation, getPartName, getPartProperties, getPartProperty, getSite, getTitle, getTitleImage, removePartPropertyListener, removePropertyListener, setPartProperty, setSite, 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

ConformEditor

public ConformEditor(org.eclipse.gef.RootEditPart rootEditPart,
                     org.eclipse.swt.widgets.Shell shell)

Initialise.

Parameters:

rootEditPart - RootEditPart.

shell - Shell.

Method Detail

mapModelToEditPart

public void mapModelToEditPart(Class<?> modelType,
                               Class<? extends org.eclipse.gef.EditPart> editPartType)

Maps a Model type to its respective EditPart type.

Parameters:

modelType - Model type.

editPartType - EditPart type.

getRootEditPart

public org.eclipse.gef.RootEditPart getRootEditPart()

Description copied from class: AbstractOfficeFloorEditor

Obtains the RootEditPart.

Overrides:

getRootEditPart in class AbstractOfficeFloorEditor<Model,Object>

Returns:

RootEditPart.

messageStatus

public void messageStatus(org.eclipse.core.runtime.IStatus status,
                          String title)

Description copied from class: AbstractOfficeFloorEditor

Displays a Dialog for the IStatus.

Overrides:

messageStatus in class AbstractOfficeFloorEditor<Model,Object>

Parameters:

status - IStatus.

title - Title for Dialog.

createModelChanges

protected Object createModelChanges(Model model)

Description copied from class: AbstractOfficeFloorEditor

Creates the Model change functionality.

Specified by:

createModelChanges in class AbstractOfficeFloorEditor<Model,Object>

Parameters:

model - Root Model.

Returns:

Model change functionality.

populateEditPartTypes

protected void populateEditPartTypes(Map<Class<?>,Class<? extends org.eclipse.gef.EditPart>> map)

Description copied from class: AbstractOfficeFloorEditor

Populates the EditPart types for their respective model.

Specified by:

populateEditPartTypes in class AbstractOfficeFloorEditor<Model,Object>

Parameters:

map - Registry to load the mappings.

populateGraphicalEditPolicy

protected void populateGraphicalEditPolicy(OfficeFloorGraphicalNodeEditPolicy policy)

Description copied from class: AbstractOfficeFloorEditor

Populates the OfficeFloorGraphicalNodeEditPolicy.

Specified by:

populateGraphicalEditPolicy in class AbstractOfficeFloorEditor<Model,Object>

Parameters:

policy - OfficeFloorGraphicalNodeEditPolicy.

populateLayoutEditPolicy

protected void populateLayoutEditPolicy(OfficeFloorLayoutEditPolicy policy)

Description copied from class: AbstractOfficeFloorEditor

Populates the OfficeFloorLayoutEditPolicy.

Specified by:

populateLayoutEditPolicy in class AbstractOfficeFloorEditor<Model,Object>

Parameters:

policy - OfficeFloorLayoutEditPolicy.

populateOperations

protected void populateOperations(List<Operation> list)

Description copied from class: AbstractOfficeFloorEditor

Populates the listing of Operation instances.

Specified by:

populateOperations in class AbstractOfficeFloorEditor<Model,Object>

Parameters:

list - Listing to add Operation instances.

retrieveModel

protected Model retrieveModel(ConfigurationItem configuration)
                       throws Exception

Description copied from class: AbstractOfficeFloorEditor

Retrieves the Model.

Specified by:

retrieveModel in class AbstractOfficeFloorEditor<Model,Object>

Parameters:

configuration - Configuration of the Model.

Returns:

Model to be edited.

Throws:

Exception - If fails to obtain the Model.

storeModel

protected void storeModel(Model model,
                          ConfigurationItem configuration)
                   throws Exception

Description copied from class: AbstractOfficeFloorEditor

Stores the Model.

Specified by:

storeModel in class AbstractOfficeFloorEditor<Model,Object>

Parameters:

model - Model to be stored.

configuration - Configuration of the Model.

Throws:

Exception - If fails to store the Model.