org.openbp.cockpit.modeler.drawing
Interface DrawingEditorPlugin

All Superinterfaces:

CH.ifa.draw.framework.DrawingEditor, CH.ifa.draw.framework.FigureSelectionListener, Plugin, VisiblePlugin

All Known Implementing Classes:

Modeler, NodeItemEditorPlugin

public interface DrawingEditorPlugin
extends VisiblePlugin, CH.ifa.draw.framework.DrawingEditor

Combination of DrawingEditor and VisiblePlugin.

Author:

Stephan Moritz

Field Summary

Fields inherited from interface org.openbp.jaspira.gui.plugin.VisiblePlugin

GER, GEU, SIZE_VARIABLE_BOTH, SIZE_VARIABLE_HEIGHT, SIZE_VARIABLE_NONE, SIZE_VARIABLE_WIDTH, TOOLBAR_DYNAMIC, TOOLBAR_EVENTS, TOOLBAR_NONE

Fields inherited from interface org.openbp.jaspira.plugin.Plugin

ID_DELIMETER, LEVEL_APPLICATION, LEVEL_FRAME, LEVEL_PAGE, LEVEL_PLUGIN

Method Summary

void	cancelUndo() Cancels the current undoable.
void	endUndo() Updates the current undoable with the current 'after operation' state and registers it with the undo manager.
ModelerToolSupport	getToolSupport() Gets the the modeler tool support object holding all tools.
boolean	isUndoRecording() Checks if currently an undo operation is being recorded.
void	repairDamage() Corrects any refresh damage in the view.
Undoable	startUndo(java.lang.String displayName) Creates an undoable object given the display name of the operation that can be undone with this undoable.

Methods inherited from interface org.openbp.jaspira.gui.plugin.VisiblePlugin

addPluginFocusListener, canCopy, canCut, canDelete, canDrag, canPaste, copy, createToolbar, cut, delete, firePluginFocusGained, firePluginFocusLost, focusPlugin, getPage, getPluginComponent, getPluginFocusComponent, getPluginHolder, getPluginPanel, getSizeBehavior, getSubClients, getToolbarType, hasCloseButton, isPluginFocused, isPluginVisible, paste, pluginHidden, pluginShown, postPluginContainerUpdate, removePluginFocusListener, setPluginHolder, showPlugin, updatePluginContainer

Methods inherited from interface org.openbp.jaspira.plugin.Plugin

addPlugin, addToPeerGroup, canClose, containsStackedEvent, fireEvent, fireEvent, fireEvent, getAction, getChildPlugins, getClassName, getCondition, getDescendantPlugins, getDescription, getEventActionNames, getIcon, getLevel, getName, getParentPlugin, getPeerGroup, getPeerGroupNames, getPeerGroups, getPluginResourceCollection, getPluginState, getSubTitle, getTitle, getUniqueId, getVendor, getVersion, handleEvent, inheritEvent, initializePlugin, installFirstPlugin, installPlugin, matchesPeerGroup, matchesPeerGroups, receiveEvent, removeFromPeerGroup, removePlugin, requestClose, setParentPlugin, setPluginState, stackEvent, uninstallLastPlugin, uninstallPlugin

Methods inherited from interface CH.ifa.draw.framework.DrawingEditor

addViewChangeListener, figureSelectionChanged, getUndoManager, removeViewChangeListener, showStatus, tool, toolDone, view, views

Method Detail

repairDamage

void repairDamage()

Corrects any refresh damage in the view.

startUndo

Undoable startUndo(java.lang.String displayName)

Creates an undoable object given the display name of the operation that can be undone with this undoable. The undoable returned will be a ModelerUndoable that contains a copy of the current process. The method will also save the returned undoable so it can be retrieved with the getCurrentUndoable method. In order to provide the data after the operation and to register the undoable, call the endUndo() method.

Parameters:

displayName - Display name or null
This text will appear after the 'undo: ' text in the edit menu.

Returns:

The new undoable

endUndo

void endUndo()

Updates the current undoable with the current 'after operation' state and registers it with the undo manager. This method may be called only after the startUndo(java.lang.String) method has been called.

cancelUndo

void cancelUndo()

Cancels the current undoable. This method may be called only after the startUndo(java.lang.String) method has been called.

isUndoRecording

boolean isUndoRecording()

Checks if currently an undo operation is being recorded.

Returns:

true: startUndo(java.lang.String) was called.
false: No current undoable is present.

getToolSupport

ModelerToolSupport getToolSupport()

Gets the the modeler tool support object holding all tools.