|
Modelers | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.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.GraphicalEditorWithPalette
org.topcased.modeler.editor.Modeler
public abstract class Modeler
Basic EMF modeler.
creation : 30 nov. 2004
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 | |
---|---|
Modeler()
Constructor. |
Method Summary | |
---|---|
void |
addSelectionChangedListener(org.eclipse.jface.viewers.ISelectionChangedListener listener)
Delegates the method to the graphical viewer |
protected void |
asyncSave(org.eclipse.core.runtime.IProgressMonitor monitor)
Effective save action : Save the diagram state Save the palette state Save the active diagram Check the model integrity Save the models in the right files If one of these tasks fails, the save is cancelled and a message is send to the user. |
void |
close(boolean save)
Close the editor |
void |
commandStackChanged(java.util.EventObject event)
|
protected void |
configureGraphicalViewer()
|
protected void |
configurePaletteViewer()
|
protected void |
createActions()
Creates actions for the modeler. |
protected ComposedAdapterFactory |
createAdapterFactory()
This method creates the ComposedAdapterFactory that groups all the factories used by the editor. |
protected MixedEditDomain |
createEditDomain()
Create and initialize the GEF-EMF EditDomain |
protected void |
createGraphicalViewer(org.eclipse.swt.widgets.Composite parent)
Creates the GraphicalViewer on the specified Composite . |
protected org.eclipse.ui.views.contentoutline.IContentOutlinePage |
createOutlinePage()
Create the outline for this editor. |
void |
createPartControl(org.eclipse.swt.widgets.Composite parent)
|
void |
dispose()
|
void |
doSave(org.eclipse.core.runtime.IProgressMonitor monitor)
|
void |
doSaveAs()
|
protected void |
doSetInput(org.eclipse.ui.IEditorInput input)
|
IConfiguration |
getActiveConfiguration()
Returns the active diagram configuration, given by the configuration manager. |
Diagram |
getActiveDiagram()
Returns the currently edited diagram. |
java.lang.Object |
getAdapter(java.lang.Class type)
The modeler can be adapted into a IPropertySheetPage or a IContentOutline. |
protected java.util.List<AdapterFactory> |
getAdapterFactories()
This method creates the list of factories used by the editor. |
AdapterFactory |
getAdapterFactory()
Returns the global adapter factory used by the editor |
protected ModelerConfigurationManager |
getConfigurationManager()
Returns the manager for the different diagram configurations. |
protected org.eclipse.gef.ContextMenuProvider |
getContextMenuProvider(ModelerGraphicalViewer viewer)
Subclass should override this method to instantiate their own ContextMenu |
java.lang.String |
getContributorId()
|
Diagrams |
getDiagrams()
Returns the global edited model. |
EditingDomain |
getEditingDomain()
|
abstract java.lang.String |
getId()
Return the editorID associated with this Topcased modeler. |
NavigationManager |
getNavigationManager()
Returns the diagram navigation |
protected org.eclipse.gef.palette.PaletteRoot |
getPaletteRoot()
Returns the current palette root. |
org.eclipse.jface.preference.IPreferenceStore |
getPreferenceStore()
Get the preference store to use for this modeler. |
org.eclipse.gef.ui.actions.ActionRegistry |
getPublicActionRegistry()
Increase the access to the action registry to public |
ResourceSet |
getResourceSet()
Get the ResourceSet |
org.eclipse.gef.RootEditPart |
getRootEditPart()
Returns the main edit part of the editor |
org.eclipse.jface.viewers.ISelection |
getSelection()
Delegates the method to the graphical viewer |
void |
gotoEObject(EObject eObject)
Sets the selection state for an editor to reveal the position of the given EObject. |
void |
gotoMarker(org.eclipse.core.resources.IMarker marker)
|
protected void |
initializeGraphicalViewer()
|
boolean |
isDirty()
|
boolean |
isSaveAsAllowed()
|
protected boolean |
needCheckIntegrity()
Check whether it is necessary to check the model integrity on the ResourceSet. |
protected EObject |
openFile(org.eclipse.core.resources.IFile file)
Return the EObject root of a File |
protected EObject |
openFile(org.eclipse.core.resources.IFile file,
boolean resolve)
Return the EObject root of a File |
protected void |
registerSelectionChangedActions(org.eclipse.gef.GraphicalViewer viewer)
Register actions that listen to selection |
void |
removeSelectionChangedListener(org.eclipse.jface.viewers.ISelectionChangedListener listener)
Delegates the method to the graphical viewer |
protected void |
restoreActiveDiagram()
Restore the active diagram stored the Diagrams model |
protected void |
restoreDiagramSettings()
Restore the settings (viewport, zoom...) for the current diagram |
protected void |
restorePaletteState()
Restore the state of the diagram palette (pinned, expanded...) |
protected void |
safeCommandStackChanged(java.util.EventObject event)
Handle the event in the UI thread |
protected void |
saveActiveDiagram()
Save the active diagram in the Diagrams model |
protected void |
saveDiagramSettings()
Save the settings (viewport, zoom...) for the current diagram |
protected void |
savePaletteState()
Save the state of the diagram palette (pinned, expanded...) |
protected void |
saveResources(org.eclipse.core.runtime.IProgressMonitor monitor)
Save the resources from the current ResourceSet and add UUIDs if the preference is set |
void |
setActiveDiagram(Diagram diagram)
Set the currently edited diagram |
protected void |
setDiagrams(Diagrams diag)
Sets the Diagrams model |
protected void |
setInput(org.eclipse.ui.IEditorInput input)
|
void |
setSelection(org.eclipse.jface.viewers.ISelection selection)
Delegates the method to the graphical viewer |
protected void |
updateConfiguration()
Notify the configuration manager that the active diagram changed. |
protected void |
updateEditPartFactory()
Update the EditPartFactory used by the viewer to map Model element with edit parts. |
protected void |
updatePaletteRoot()
Update the palette contents with objects of the model that can be displayed in the current diagram. |
Methods inherited from class org.eclipse.gef.ui.parts.GraphicalEditorWithPalette |
---|
createPaletteViewer, getInitialPaletteSize, getPaletteViewer, handlePaletteResized, hookPaletteViewer, initializePaletteViewer, setEditDomain, setPaletteViewer |
Methods inherited from class org.eclipse.gef.ui.parts.GraphicalEditor |
---|
firePropertyChange, getActionRegistry, getCommandStack, getEditDomain, getGraphicalViewer, getPropertyActions, getSelectionActions, getSelectionSynchronizer, getStackActions, hookGraphicalViewer, init, initializeActionRegistry, 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 |
---|
public Modeler()
Method Detail |
---|
public void dispose()
dispose
in interface org.eclipse.ui.IWorkbenchPart
dispose
in class org.eclipse.gef.ui.parts.GraphicalEditor
GraphicalEditor.dispose()
public void commandStackChanged(java.util.EventObject event)
commandStackChanged
in interface org.eclipse.gef.commands.CommandStackListener
commandStackChanged
in class org.eclipse.gef.ui.parts.GraphicalEditor
CommandStackListener.commandStackChanged(java.util.EventObject)
protected void safeCommandStackChanged(java.util.EventObject event)
event
- the command stack eventprotected void createGraphicalViewer(org.eclipse.swt.widgets.Composite parent)
Composite
.
createGraphicalViewer
in class org.eclipse.gef.ui.parts.GraphicalEditor
parent
- the parent compositeGraphicalEditor.createGraphicalViewer(org.eclipse.swt.widgets.Composite)
protected org.eclipse.gef.ContextMenuProvider getContextMenuProvider(ModelerGraphicalViewer viewer)
viewer
- the GraphicalViewer
protected void configureGraphicalViewer()
configureGraphicalViewer
in class org.eclipse.gef.ui.parts.GraphicalEditor
GraphicalEditor.configureGraphicalViewer()
protected void configurePaletteViewer()
configurePaletteViewer
in class org.eclipse.gef.ui.parts.GraphicalEditorWithPalette
GraphicalEditorWithPalette.configurePaletteViewer()
protected void registerSelectionChangedActions(org.eclipse.gef.GraphicalViewer viewer)
viewer
- the graphical viewer : emitter of the selection changed eventsprotected void createActions()
createActions
in class org.eclipse.gef.ui.parts.GraphicalEditor
GraphicalEditor.createActions()
protected java.util.List<AdapterFactory> getAdapterFactories()
protected ComposedAdapterFactory createAdapterFactory()
public AdapterFactory getAdapterFactory()
public IConfiguration getActiveConfiguration()
public Diagrams getDiagrams()
public org.eclipse.gef.ui.actions.ActionRegistry getPublicActionRegistry()
public org.eclipse.gef.RootEditPart getRootEditPart()
public java.lang.Object getAdapter(java.lang.Class type)
getAdapter
in interface org.eclipse.core.runtime.IAdaptable
getAdapter
in class org.eclipse.gef.ui.parts.GraphicalEditor
IAdaptable.getAdapter(java.lang.Class)
protected org.eclipse.ui.views.contentoutline.IContentOutlinePage createOutlinePage()
protected org.eclipse.gef.palette.PaletteRoot getPaletteRoot()
getPaletteRoot
in class org.eclipse.gef.ui.parts.GraphicalEditorWithPalette
GraphicalEditorWithPalette.getPaletteRoot()
public void doSave(org.eclipse.core.runtime.IProgressMonitor monitor)
doSave
in interface org.eclipse.ui.ISaveablePart
doSave
in class org.eclipse.ui.part.EditorPart
ISaveablePart.doSave(org.eclipse.core.runtime.IProgressMonitor)
protected void asyncSave(org.eclipse.core.runtime.IProgressMonitor monitor) throws org.topcased.modeler.internal.exceptions.IntegrityException, java.io.IOException
monitor
-
org.topcased.modeler.internal.exceptions.IntegrityException
- The model is not valid
java.io.IOException
- An error occurred during saveprotected boolean needCheckIntegrity()
true
if the integrity check is necessaryprotected void saveResources(org.eclipse.core.runtime.IProgressMonitor monitor) throws java.io.IOException
monitor
- The progress monitor
java.io.IOException
- throws if a resource cannot be savedpublic void doSaveAs()
doSaveAs
in interface org.eclipse.ui.ISaveablePart
doSaveAs
in class org.eclipse.gef.ui.parts.GraphicalEditor
EditorPart.doSaveAs()
protected void initializeGraphicalViewer()
initializeGraphicalViewer
in class org.eclipse.gef.ui.parts.GraphicalEditor
GraphicalEditor.initializeGraphicalViewer()
protected void updatePaletteRoot()
protected void updateEditPartFactory()
protected void updateConfiguration()
public void setActiveDiagram(Diagram diagram)
diagram
- the diagram to editpublic NavigationManager getNavigationManager()
protected void saveActiveDiagram()
protected void restoreActiveDiagram()
protected void saveDiagramSettings()
protected void savePaletteState()
protected void restorePaletteState()
protected void restoreDiagramSettings()
public Diagram getActiveDiagram()
public boolean isDirty()
isDirty
in interface org.eclipse.ui.ISaveablePart
isDirty
in class org.eclipse.gef.ui.parts.GraphicalEditor
ISaveablePart.isDirty()
public boolean isSaveAsAllowed()
isSaveAsAllowed
in interface org.eclipse.ui.ISaveablePart
isSaveAsAllowed
in class org.eclipse.gef.ui.parts.GraphicalEditor
EditorPart.isSaveAsAllowed()
public ResourceSet getResourceSet()
protected EObject openFile(org.eclipse.core.resources.IFile file)
file
- the file to read
protected EObject openFile(org.eclipse.core.resources.IFile file, boolean resolve)
file
- the file to readresolve
- indicates that all the references must be resolved
protected MixedEditDomain createEditDomain()
protected void setInput(org.eclipse.ui.IEditorInput input)
setInput
in class org.eclipse.ui.part.EditorPart
EditorPart.setInput(org.eclipse.ui.IEditorInput)
protected void doSetInput(org.eclipse.ui.IEditorInput input)
input
- the IEditorInputEditorPart.setInput(org.eclipse.ui.IEditorInput)
protected void setDiagrams(Diagrams diag)
diag
- the model object Diagramspublic void close(boolean save)
save
- public void createPartControl(org.eclipse.swt.widgets.Composite parent)
createPartControl
in interface org.eclipse.ui.IWorkbenchPart
createPartControl
in class org.eclipse.gef.ui.parts.GraphicalEditorWithPalette
IWorkbenchPart.createPartControl(org.eclipse.swt.widgets.Composite)
public void addSelectionChangedListener(org.eclipse.jface.viewers.ISelectionChangedListener listener)
addSelectionChangedListener
in interface org.eclipse.jface.viewers.ISelectionProvider
ISelectionProvider.addSelectionChangedListener(org.eclipse.jface.viewers.ISelectionChangedListener)
public org.eclipse.jface.viewers.ISelection getSelection()
getSelection
in interface org.eclipse.jface.viewers.ISelectionProvider
ISelectionProvider.getSelection()
public void removeSelectionChangedListener(org.eclipse.jface.viewers.ISelectionChangedListener listener)
removeSelectionChangedListener
in interface org.eclipse.jface.viewers.ISelectionProvider
ISelectionProvider.removeSelectionChangedListener(org.eclipse.jface.viewers.ISelectionChangedListener)
public void setSelection(org.eclipse.jface.viewers.ISelection selection)
setSelection
in interface org.eclipse.jface.viewers.ISelectionProvider
ISelectionProvider.setSelection(org.eclipse.jface.viewers.ISelection)
public org.eclipse.jface.preference.IPreferenceStore getPreferenceStore()
null
.ModelerPreferenceConstants
.
public EditingDomain getEditingDomain()
getEditingDomain
in interface IEditingDomainProvider
IEditingDomainProvider.getEditingDomain()
public void gotoMarker(org.eclipse.core.resources.IMarker marker)
gotoMarker
in interface org.eclipse.ui.ide.IGotoMarker
IGotoMarker.gotoMarker(org.eclipse.core.resources.IMarker)
public void gotoEObject(EObject eObject)
eObject
- the EObject to selectprotected ModelerConfigurationManager getConfigurationManager()
public java.lang.String getContributorId()
getContributorId
in interface org.eclipse.ui.views.properties.tabbed.ITabbedPropertySheetPageContributor
ITabbedPropertySheetPageContributor.getContributorId()
public abstract java.lang.String getId()
|
Modelers | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright (c) 2005 TOPCASED Contributors 2005 - 2007. All rights reserved.