|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.openbp.jaspira.plugin.AbstractPlugin
org.openbp.jaspira.gui.plugin.AbstractVisiblePlugin
org.openbp.cockpit.modeler.Modeler
public class Modeler
The Modeler class is one of the core components of the OpenBP modeler. It is an invisible plugin that contains the drawing for a single OpenBP process.
| Nested Class Summary |
|---|
| Nested classes/interfaces inherited from class org.openbp.jaspira.gui.plugin.AbstractVisiblePlugin |
|---|
AbstractVisiblePlugin.StandardVisiblePluginEvents |
| Nested classes/interfaces inherited from class org.openbp.jaspira.plugin.AbstractPlugin |
|---|
AbstractPlugin.StandardPluginEvents |
| Field Summary | |
|---|---|
static java.lang.String |
ATTRIBUTE_SKELETON
Runtime attribute for items: The item is an item skeleton that is used as a pattern for the creation of new items that are dragged from the standard toolbox. |
| Fields inherited from class org.openbp.jaspira.plugin.AbstractPlugin |
|---|
PROPERTY_CONDITION, PROPERTY_DESCRIPTION, PROPERTY_ICON, PROPERTY_NAME, PROPERTY_SEQUENCE, PROPERTY_TITLE, PROPERTY_VENDOR, PROPERTY_VERSION |
| 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 |
| Constructor Summary | |
|---|---|
Modeler()
|
|
| Method Summary | |
|---|---|
void |
addTrackChangedListener(javax.swing.event.ChangeListener listener)
The listener is registered for all properties as a WEAK listener, i. e. it may be garbage-collected if not referenced otherwise. |
void |
addViewChangeListener(CH.ifa.draw.framework.ViewChangeListener arg0)
|
void |
cancelUndo()
Cancels the current undoable. |
boolean |
canClose()
Checks, whether this plugin can be closed. |
boolean |
canCopy()
Checks if the plugin can copy the selected data to the clipboard. |
boolean |
canCut()
Checks if the plugin can cut the selected data to the clipboard. |
boolean |
canDelete()
Checks if the plugin can delete the selected data. |
boolean |
canDrag()
Checks if the plugin can be dragged. |
boolean |
canPaste(java.awt.datatransfer.Transferable transferable)
Checks if the plugin can paste the data of the given transferable object. |
void |
centerTrackerAt(java.awt.Point p)
Centers the trackable component at the specified point. |
boolean |
convertPlaceholder(NodeFigure nodeFigure,
NodeProvider np,
java.awt.Point p)
|
java.awt.datatransfer.Transferable |
copy()
Copies the selected data from the plugin to the clipboard. |
java.awt.datatransfer.Transferable |
cut()
Cuts the selected data from the plugin to the clipboard. |
void |
delete()
Deletes the selected data, if any. |
void |
endUndo()
Updates the current undoable with the current 'after operation' state and registers it with the undo manager. |
void |
figureSelectionChanged(CH.ifa.draw.framework.DrawingView arg0)
|
void |
fireTrackChangedEvent(javax.swing.event.ChangeEvent event)
Fires an event indicating that the tracker position has changed to the registered track change listeners. |
void |
focusGained(java.awt.event.FocusEvent e)
|
void |
focusLost(java.awt.event.FocusEvent e)
|
Undoable |
getCurrentUndoable()
Gets the current undoable. |
java.awt.Dimension |
getDocumentSize()
Returns the size of the document that is displayed in the view. |
ProcessDrawing |
getDrawing()
Returns the drawing associated with this editor. |
WorkspaceDrawingView |
getDrawingView()
Gets the drawing view that displays the contents of this view plugin. |
protected java.lang.Class[] |
getExternalEventModuleClasses()
Returns the list of external event module classes. |
PluginState |
getPluginState()
Returns the state of this plugin. |
ProcessItem |
getProcess()
Returns the edited process. |
ModelQualifier |
getProcessQualifier()
Returns the model qualifier of the edited process. |
java.lang.String |
getResourceCollectionContainerName()
Gets the name of the resource component the default resource of the plugin belongs to. |
java.util.List |
getSubClients()
Gets the Dnd sub clients of this plugin. |
java.lang.String |
getSubTitle()
Returns the sub title of this plugin. |
java.lang.String |
getTitle()
Gets the title. |
int |
getToolbarType()
Gets the type of the plugin toolbar. |
ModelerToolSupport |
getToolSupport()
Gets the the modeler tool support object holding all tools. |
CH.ifa.draw.util.UndoManager |
getUndoManager()
|
UndoMgr |
getUndoMgr()
Gets the undo manager. |
java.awt.Rectangle |
getVisibleArea()
Returns the area that is currently visible. |
boolean |
hasCloseButton()
Returns true if the plugin should have a close button in its title bar. |
protected void |
initializeComponents()
Init the visual components of the plugin. |
boolean |
isTrackSuspended()
Returns true if the tracking has been suspended. |
boolean |
isUndoRecording()
Checks if currently an undo operation is being recorded. |
void |
moveTrackerBy(int x,
int y)
Moves the tracker by the given distance. |
void |
paste(java.awt.datatransfer.Transferable transferable)
Pastes the given data into the plugin. |
void |
pluginHidden()
Called after the plugin has been hidden. |
void |
pluginShown()
Called after the plugin has been displayed. |
protected void |
pluginUninstalled()
This template method is called before the plugin is uninstalled. |
protected void |
preClose()
This method is called when actual closing is performed. |
void |
removeTrackChangedListener(javax.swing.event.ChangeListener listener)
Removes a change listener from the trackable object. |
void |
removeViewChangeListener(CH.ifa.draw.framework.ViewChangeListener arg0)
|
void |
repairDamage()
Corrects any refresh damage in the view. |
void |
resumeTrack()
Resumes propagation of track change events. |
boolean |
saveProcess()
|
void |
setPluginState(PluginState state)
Rebuilds the state of the plugin using the given state object. |
void |
setProcess(ProcessItem process,
boolean readonly)
Sets the process to be edited. |
void |
setProcessByUndoRedo(ProcessItem process)
Sets the process to be edited due to an undo or redo operation. |
void |
setScaleFactor(double scaleFactor)
Sets the scaling factor of the workspace. |
void |
setVisibleArea(java.awt.Rectangle r)
Sets the area that is currently visible. |
void |
showStatus(java.lang.String arg0)
|
Undoable |
startUndo(java.lang.String displayName)
Creates an undoable object given the display name of the operation that can be undone with this undoable. |
Undoable |
startUndoForAction(JaspiraActionEvent jae)
Creates an undoable object given the name of the action that initiated the operation that can be undone with this undoable. |
Undoable |
startUndoForAction(java.lang.String eventName)
Creates an undoable object given the name of the action that initiated the operation that can be undone with this undoable. |
void |
suspendTrack()
Prevents track change events to be propagated. |
CH.ifa.draw.framework.Tool |
tool()
|
void |
toolDone()
|
CH.ifa.draw.framework.DrawingView |
view()
|
CH.ifa.draw.framework.DrawingView[] |
views()
|
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Methods inherited from interface org.openbp.jaspira.gui.plugin.VisiblePlugin |
|---|
addPluginFocusListener, createToolbar, firePluginFocusGained, firePluginFocusLost, focusPlugin, getPage, getPluginComponent, getPluginFocusComponent, getPluginHolder, getPluginPanel, getSizeBehavior, isPluginFocused, isPluginVisible, postPluginContainerUpdate, removePluginFocusListener, setPluginHolder, showPlugin, updatePluginContainer |
| Methods inherited from interface org.openbp.jaspira.plugin.Plugin |
|---|
addPlugin, addToPeerGroup, containsStackedEvent, fireEvent, fireEvent, fireEvent, getAction, getChildPlugins, getClassName, getCondition, getDescendantPlugins, getDescription, getEventActionNames, getIcon, getLevel, getName, getParentPlugin, getPeerGroup, getPeerGroupNames, getPeerGroups, getPluginResourceCollection, getUniqueId, getVendor, getVersion, handleEvent, inheritEvent, initializePlugin, installFirstPlugin, installPlugin, matchesPeerGroup, matchesPeerGroups, receiveEvent, removeFromPeerGroup, removePlugin, requestClose, setParentPlugin, stackEvent, uninstallLastPlugin, uninstallPlugin |
| Field Detail |
|---|
public static final java.lang.String ATTRIBUTE_SKELETON
| Constructor Detail |
|---|
public Modeler()
| Method Detail |
|---|
public java.lang.String getResourceCollectionContainerName()
AbstractPlugin
getResourceCollectionContainerName in class AbstractPluginprotected void initializeComponents()
initializeComponents in class AbstractVisiblePluginpublic ModelerToolSupport getToolSupport()
getToolSupport in interface DrawingEditorPlugin
public void setProcess(ProcessItem process,
boolean readonly)
process - Process to be editedpublic ProcessItem getProcess()
public WorkspaceDrawingView getDrawingView()
public ProcessDrawing getDrawing()
public ModelQualifier getProcessQualifier()
public boolean saveProcess()
public void repairDamage()
DrawingEditorPlugin
repairDamage in interface DrawingEditorPlugin
public boolean convertPlaceholder(NodeFigure nodeFigure,
NodeProvider np,
java.awt.Point p)
protected java.lang.Class[] getExternalEventModuleClasses()
AbstractPlugin
getExternalEventModuleClasses in class AbstractPluginExternalEventModuleprotected void pluginUninstalled()
AbstractPlugin
pluginUninstalled in class AbstractPluginpublic void setPluginState(PluginState state)
AbstractPlugin
setPluginState in interface PluginsetPluginState in class AbstractPluginpublic PluginState getPluginState()
AbstractPlugin
getPluginState in interface PlugingetPluginState in class AbstractPluginpublic int getToolbarType()
AbstractVisiblePlugin
getToolbarType in interface VisiblePlugingetToolbarType in class AbstractVisiblePluginVisiblePlugin.TOOLBAR_NONE/VisiblePlugin.TOOLBAR_EVENTS/VisiblePlugin.TOOLBAR_DYNAMICpublic boolean canDrag()
VisiblePlugin
canDrag in interface VisiblePlugincanDrag in class AbstractVisiblePluginpublic boolean hasCloseButton()
AbstractVisiblePlugin
hasCloseButton in interface VisiblePluginhasCloseButton in class AbstractVisiblePluginpublic boolean canClose()
AbstractPluginAbstractPlugin.preClose() or AbstractPlugin.closeCanceled().
canClose in interface PlugincanClose in class AbstractPluginprotected void preClose()
AbstractPlugin
preClose in class AbstractPluginpublic void pluginShown()
AbstractVisiblePlugin
pluginShown in interface VisiblePluginpluginShown in class AbstractVisiblePluginpublic void pluginHidden()
AbstractVisiblePlugin
pluginHidden in interface VisiblePluginpluginHidden in class AbstractVisiblePluginpublic java.lang.String getTitle()
AbstractPlugin
getTitle in interface PlugingetTitle in class AbstractPluginpublic java.lang.String getSubTitle()
AbstractPlugin
getSubTitle in interface PlugingetSubTitle in class AbstractPluginpublic java.util.List getSubClients()
AbstractPlugin
getSubClients in interface VisiblePlugingetSubClients in class AbstractVisiblePluginInteractionClient or null otherwisepublic void focusGained(java.awt.event.FocusEvent e)
focusGained in interface java.awt.event.FocusListenerpublic void focusLost(java.awt.event.FocusEvent e)
focusLost in interface java.awt.event.FocusListenerpublic java.awt.Dimension getDocumentSize()
Trackable
getDocumentSize in interface Trackablepublic java.awt.Rectangle getVisibleArea()
Trackable
getVisibleArea in interface Trackablepublic void setVisibleArea(java.awt.Rectangle r)
Trackable
setVisibleArea in interface Trackabler - Rectangle in document coordinatespublic void centerTrackerAt(java.awt.Point p)
Trackable
centerTrackerAt in interface Trackablep - Point in document coordinates
public void moveTrackerBy(int x,
int y)
Trackable
moveTrackerBy in interface Trackablex - Hor. distance in document coordinatesy - Vert. distance in document coordinatespublic void addTrackChangedListener(javax.swing.event.ChangeListener listener)
addTrackChangedListener in interface Trackablepublic void removeTrackChangedListener(javax.swing.event.ChangeListener listener)
Trackable
removeTrackChangedListener in interface Trackablepublic void fireTrackChangedEvent(javax.swing.event.ChangeEvent event)
Trackable
fireTrackChangedEvent in interface Trackableevent - Event to firepublic void suspendTrack()
suspendTrack in interface Trackablepublic void resumeTrack()
resumeTrack in interface Trackablepublic boolean isTrackSuspended()
isTrackSuspended in interface Trackablepublic void setScaleFactor(double scaleFactor)
public boolean canCopy()
VisiblePlugin
canCopy in interface VisiblePlugincanCopy in class AbstractVisiblePluginpublic boolean canDelete()
VisiblePlugin
canDelete in interface VisiblePlugincanDelete in class AbstractVisiblePluginpublic boolean canCut()
VisiblePlugin
canCut in interface VisiblePlugincanCut in class AbstractVisiblePluginpublic boolean canPaste(java.awt.datatransfer.Transferable transferable)
VisiblePlugin
canPaste in interface VisiblePlugincanPaste in class AbstractVisiblePluginpublic java.awt.datatransfer.Transferable copy()
VisiblePlugin
copy in interface VisiblePlugincopy in class AbstractVisiblePluginpublic java.awt.datatransfer.Transferable cut()
VisiblePlugin
cut in interface VisiblePlugincut in class AbstractVisiblePluginpublic void delete()
VisiblePlugin
delete in interface VisiblePlugindelete in class AbstractVisiblePluginpublic void paste(java.awt.datatransfer.Transferable transferable)
VisiblePlugin
paste in interface VisiblePluginpaste in class AbstractVisiblePlugintransferable - Content to pastepublic Undoable startUndo(java.lang.String displayName)
ModelerUndoable that contains a copy of the current process.
The method will also save the returned undoable so it can be retrieved with getCurrentUndoable().
In order to provide the data after the operation and to register the undoable, call the endUndo() method.
startUndo in interface DrawingEditorPlugindisplayName - Display name or nullpublic Undoable startUndoForAction(java.lang.String eventName)
startUndo(java.lang.String).
eventName - Event name of the action event
public Undoable startUndoForAction(JaspiraActionEvent jae)
startUndo(java.lang.String).
jae - Action event
public void endUndo()
startUndo(java.lang.String) method has been called.
endUndo in interface DrawingEditorPluginpublic void cancelUndo()
startUndo(java.lang.String) method has been called.
cancelUndo in interface DrawingEditorPluginpublic boolean isUndoRecording()
isUndoRecording in interface DrawingEditorPluginstartUndo(java.lang.String) was called.public Undoable getCurrentUndoable()
startUndo(java.lang.String) and endUndo()/cancelUndo().public void setProcessByUndoRedo(ProcessItem process)
process - Process to be editedpublic UndoMgr getUndoMgr()
public void addViewChangeListener(CH.ifa.draw.framework.ViewChangeListener arg0)
addViewChangeListener in interface CH.ifa.draw.framework.DrawingEditorpublic void figureSelectionChanged(CH.ifa.draw.framework.DrawingView arg0)
figureSelectionChanged in interface CH.ifa.draw.framework.DrawingEditorfigureSelectionChanged in interface CH.ifa.draw.framework.FigureSelectionListenerpublic CH.ifa.draw.util.UndoManager getUndoManager()
getUndoManager in interface CH.ifa.draw.framework.DrawingEditorpublic void removeViewChangeListener(CH.ifa.draw.framework.ViewChangeListener arg0)
removeViewChangeListener in interface CH.ifa.draw.framework.DrawingEditorpublic void showStatus(java.lang.String arg0)
showStatus in interface CH.ifa.draw.framework.DrawingEditorpublic CH.ifa.draw.framework.Tool tool()
tool in interface CH.ifa.draw.framework.DrawingEditorpublic void toolDone()
toolDone in interface CH.ifa.draw.framework.DrawingEditorpublic CH.ifa.draw.framework.DrawingView view()
view in interface CH.ifa.draw.framework.DrawingEditorpublic CH.ifa.draw.framework.DrawingView[] views()
views in interface CH.ifa.draw.framework.DrawingEditor
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||