public interface YEditorPlugin
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> cellsAndTheirEdges)
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 cell)
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()
Deprecated.
use performPreFileSaveTasks(String fileName)
|
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
|
java.lang.String getName()
java.lang.String getDescription()
YAWLSelectedNetAction getPluginMenuAction()
javax.swing.JMenu getPluginMenu()
javax.swing.JToolBar getToolbar()
void initCompleted()
void performPreFileSaveTasks()
void performPreFileSaveTasks(java.lang.String fileName)
void performPostFileSaveTasks()
void performPreFileOpenTasks()
void performPostFileOpenTasks()
void identifiersRationalised(java.util.Map<java.lang.String,java.lang.String> changeMap)
changeMap
- a map of [old id -> new id] pairsvoid identifierChanged(java.lang.String oldID, java.lang.String newID)
oldID
- the previous valuenewID
- the new valuevoid performPreCellRenderingTasks(java.awt.Graphics2D g2, VertexView cell)
g2
- the graphics object doing the renderingcell
- the cell (task or condition) being renderedvoid netElementAdded(NetGraphModel model, YAWLVertex element)
model
- a reference to the net model representing the canvaselement
- the task or condition that has been addedvoid netElementsRemoved(NetGraphModel model, java.util.Set<java.lang.Object> cellsAndTheirEdges)
model
- a reference to the net model representing the netcellsAndTheirEdges
- the set of cells (tasks, conditions and flows)
that have been removedvoid portsConnected(NetGraphModel model, YAWLPort source, YAWLPort target)
model
- a reference to the net model representing the netsource
- the connecting port of the source elementtarget
- the connecting port of the target elementvoid closeSpecification()
void openSpecification()
void netAdded(NetGraphModel model)
model
- a reference to the net model representing the netvoid netRemoved(NetGraphModel model)
model
- a reference to the net model representing the netvoid resourcingChanged(YAtomicTask task)
task
- the task