public class ConfigurationPlugin extends java.lang.Object implements YEditorPlugin
Constructor and Description |
---|
ConfigurationPlugin() |
Modifier and Type | Method and Description |
---|---|
void |
closeSpecification()
Called by the editor when a specification has been closed
(removed from the editor)
|
java.lang.String |
getDescription()
Gets a description of the plugin
|
java.lang.String |
getName()
Gets the name of this plugin
|
javax.swing.JMenu |
getPluginMenu()
Gets an entire menu structure (menu, item and sub-items) that will
appear as a menu tree on the 'Plugins' menu, and that will take the
desired action(s) when selected
|
YAWLSelectedNetAction |
getPluginMenuAction()
Gets a menu action that will appear as a menu item on the 'Plugins'
menu, and that will take the desired action when the action is selected
|
javax.swing.JToolBar |
getToolbar()
Gets a toolbar for the plugin's actions, to be displayed under the
main editor toolbar
|
void |
identifierChanged(java.lang.String oldID,
java.lang.String newID)
Called when a user changes the value of a unique identifier
|
void |
identifiersRationalised(java.util.Map<java.lang.String,java.lang.String> changeMap)
Called when a specification is loaded and it was necessary to update
unique identifiers to the new uniquify naming mechanism.
|
void |
initCompleted()
Notification that the editor has completed initialisation
|
void |
netAdded(NetGraphModel model)
Called by the editor when a net has been added to the current
specification
|
void |
netElementAdded(NetGraphModel model,
YAWLVertex element)
Called by the editor immediately after a task or condition is
added to a net's canvas
|
void |
netElementsRemoved(NetGraphModel model,
java.util.Set<java.lang.Object> cells)
Called by the editor immediately after one or more tasks or conditions
are removed from a net's canvas
|
void |
netRemoved(NetGraphModel model)
Called by the editor when a net has been removed from the current
specification
|
void |
openSpecification()
Called by the editor when a specification has been opened
(loaded into the editor)
|
void |
performPostFileOpenTasks()
Called by the editor immediately after a specification file is saved
|
void |
performPostFileSaveTasks()
Called by the editor immediately after a specification file is saved
|
void |
performPreCellRenderingTasks(java.awt.Graphics2D g2,
VertexView view)
Called by the editor immediately before a task or condition is
rendered on the canvas.
|
void |
performPreFileOpenTasks()
Called by the editor immediately before a specification file is opened
|
void |
performPreFileSaveTasks()
Called by the editor immediately before a specification file is saved
|
void |
performPreFileSaveTasks(java.lang.String fileName) |
void |
portsConnected(NetGraphModel model,
YAWLPort source,
YAWLPort target)
Called by the editor when a flow has been created between two net
elements (i.e.
|
void |
resourcingChanged(YAtomicTask task)
Called by the editor when an atomic task's resourcing has been changed
|
public void initCompleted()
YEditorPlugin
initCompleted
in interface YEditorPlugin
public java.lang.String getName()
YEditorPlugin
getName
in interface YEditorPlugin
public java.lang.String getDescription()
YEditorPlugin
getDescription
in interface YEditorPlugin
public YAWLSelectedNetAction getPluginMenuAction()
YEditorPlugin
getPluginMenuAction
in interface YEditorPlugin
public javax.swing.JMenu getPluginMenu()
YEditorPlugin
getPluginMenu
in interface YEditorPlugin
public javax.swing.JToolBar getToolbar()
YEditorPlugin
getToolbar
in interface YEditorPlugin
public void performPreFileSaveTasks()
YEditorPlugin
performPreFileSaveTasks
in interface YEditorPlugin
public void performPreFileSaveTasks(java.lang.String fileName)
performPreFileSaveTasks
in interface YEditorPlugin
public void performPostFileSaveTasks()
YEditorPlugin
performPostFileSaveTasks
in interface YEditorPlugin
public void performPreFileOpenTasks()
YEditorPlugin
performPreFileOpenTasks
in interface YEditorPlugin
public void performPostFileOpenTasks()
YEditorPlugin
performPostFileOpenTasks
in interface YEditorPlugin
public void identifiersRationalised(java.util.Map<java.lang.String,java.lang.String> changeMap)
YEditorPlugin
identifiersRationalised
in interface YEditorPlugin
changeMap
- a map of [old id -> new id] pairspublic void identifierChanged(java.lang.String oldID, java.lang.String newID)
YEditorPlugin
identifierChanged
in interface YEditorPlugin
oldID
- the previous valuenewID
- the new valuepublic void performPreCellRenderingTasks(java.awt.Graphics2D g2, VertexView view)
YEditorPlugin
performPreCellRenderingTasks
in interface YEditorPlugin
g2
- the graphics object doing the renderingview
- the cell (task or condition) being renderedpublic void netElementAdded(NetGraphModel model, YAWLVertex element)
YEditorPlugin
netElementAdded
in interface YEditorPlugin
model
- a reference to the net model representing the canvaselement
- the task or condition that has been addedpublic void netElementsRemoved(NetGraphModel model, java.util.Set<java.lang.Object> cells)
YEditorPlugin
netElementsRemoved
in interface YEditorPlugin
model
- a reference to the net model representing the netcells
- the set of cells (tasks, conditions and flows)
that have been removedpublic void portsConnected(NetGraphModel model, YAWLPort source, YAWLPort target)
YEditorPlugin
portsConnected
in interface YEditorPlugin
model
- a reference to the net model representing the netsource
- the connecting port of the source elementtarget
- the connecting port of the target elementpublic void closeSpecification()
YEditorPlugin
closeSpecification
in interface YEditorPlugin
public void openSpecification()
YEditorPlugin
openSpecification
in interface YEditorPlugin
public void netAdded(NetGraphModel model)
YEditorPlugin
netAdded
in interface YEditorPlugin
model
- a reference to the net model representing the netpublic void netRemoved(NetGraphModel model)
YEditorPlugin
netRemoved
in interface YEditorPlugin
model
- a reference to the net model representing the netpublic void resourcingChanged(YAtomicTask task)
YEditorPlugin
resourcingChanged
in interface YEditorPlugin
task
- the task