org.openbp.cockpit.modeler
Class ModelerPage

java.lang.Object
  org.openbp.jaspira.plugin.AbstractPlugin
      org.openbp.jaspira.gui.plugin.AbstractVisiblePlugin
          org.openbp.jaspira.gui.plugin.JaspiraPage
              org.openbp.cockpit.modeler.ModelerPage

All Implemented Interfaces:

java.awt.event.HierarchyListener, java.util.EventListener, PluginContainer, VisiblePlugin, Plugin

public class ModelerPage
extends JaspiraPage

Jaspira page that hosts the Modeler.

Author:

Jens Ferchland

Nested Class Summary

class

ModelerPage.Events EventModule responsible for opening new modelers.

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 int

MAX_HISTORY_SIZE Maximum history size

Fields inherited from class org.openbp.jaspira.gui.plugin.JaspiraPage

focusedPluginRef

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.PluginContainer

CENTER, EAST, NORTH, REGION_CENTER, REGION_EAST, REGION_NORTH, REGION_SOUTH, REGION_WEST, SOUTH, WEST

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

ModelerPage()
Creates a new view using a given modeler.

Method Summary

protected Modeler	addModelerView(ProcessItem process, boolean readOnly) Creates a new Modeler and adds it to the modeler page.
protected void	addQualifierToHistory(ModelQualifier qualifier) Adds the given process path to the process history.
protected boolean	canGoBackward() Checks if we can execute the goBackward() function.
protected boolean	canGoForward() Checks if we can execute the goForward() function.
protected void	displayProcess(ModelQualifier qualifier) Open the given process.
void	displayWelcomePage() Displays a welcome page in the internal browser.
protected ModelQualifier	getHistoryEntryAt(int index) Gets the history entry at the specified index.
int	getHistoryIndex() Gets the current position in history list.
java.lang.String	getResourceCollectionContainerName() Gets the name of the resource component the default resource of the plugin belongs to.
protected void	goBackward() Goes to previous page in history.
protected void	goForward() Goes to next page in history.
void	layoutDefaultContent() Performs the layout of the initial default plugins (toolboxes, property browser, browsers etc.)
protected void	pluginInstalled() This template method is called after the plugin has been installed.
protected void	pluginUninstalled() This template method is called before the plugin is uninstalled.
protected void	updateNavigationButtons() Updates the back and forward navigation buttons.

Methods inherited from class org.openbp.jaspira.gui.plugin.JaspiraPage

addPlugin, advanceFocus, getActivePlugin, getParentContainer, getPluginDivider, getPluginFocusComponent, getPlugins, getVisiblePlugins, getWindow, initializeComponents, removePlugin, restoreFocus, setFocusedPlugin, setPluginDivider, setupKeyBindings, showPlugin, sliceContainer, toString

Methods inherited from class org.openbp.jaspira.gui.plugin.AbstractVisiblePlugin

addPluginFocusListener, applicationReady, canCopy, canCut, canDelete, canDrag, canPageChange, canPaste, copy, createToolbar, cut, delete, firePluginFocusGained, firePluginFocusLost, focusPlugin, getContentPane, getPage, getPluginComponent, getPluginFromComponentHierarchy, getPluginHolder, getPluginPanel, getSizeBehavior, getSubClients, getToolbarType, hasCloseButton, hierarchyChanged, initializeResources, installPlugin, installPluginContent, isPluginFocused, isPluginVisible, paste, pluginHidden, pluginShown, postPluginContainerUpdate, removePluginFocusListener, setPluginHolder, stackEvent, uninstallPlugin, updatePluginContainer

Methods inherited from class org.openbp.jaspira.plugin.AbstractPlugin

addActionKeySequence, addPlugin, addToPeerGroup, canClose, closeCanceled, containsStackedEvent, fireEvent, fireEvent, fireEvent, getAction, getChildPlugins, getClassName, getCondition, getDescendantPlugins, getDescription, getEventActionNames, getEventModules, getExternalActions, getExternalEventModuleClasses, getExternalOptionModuleClasses, getIcon, getIcon, getLevel, getName, getOptionModules, getParentPlugin, getPeerGroup, getPeerGroupNames, getPeerGroups, getPluginResourceCollection, getPluginState, getSubTitle, getTitle, getUniqueId, getVendor, getVersion, handleEvent, handleKeySequence, inheritEvent, initializeFromPluginProfile, initializePlugin, installFirstPlugin, matchesPeerGroup, matchesPeerGroups, passDown, preClose, receiveEvent, removeFromPeerGroup, removePlugin, removeStackedEvent, requestClose, setDescription, setIcon, setName, setParentPlugin, setPluginState, setResourceCollection, setTitle, uninstallLastPlugin

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.PluginContainer

getPage

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, matchesPeerGroup, matchesPeerGroups, receiveEvent, removeFromPeerGroup, removePlugin, requestClose, setParentPlugin, setPluginState, uninstallLastPlugin

Field Detail

MAX_HISTORY_SIZE

public static final int MAX_HISTORY_SIZE

Maximum history size

See Also:

Constant Field Values

Constructor Detail

ModelerPage

public ModelerPage()

Creates a new view using a given modeler.

Method Detail

getResourceCollectionContainerName

public java.lang.String getResourceCollectionContainerName()

Description copied from class: AbstractPlugin

Gets the name of the resource component the default resource of the plugin belongs to.

Specified by:

getResourceCollectionContainerName in class AbstractPlugin

Returns:

The container name

layoutDefaultContent

public void layoutDefaultContent()

Performs the layout of the initial default plugins (toolboxes, property browser, browsers etc.) and their containers within this view.

Overrides:

layoutDefaultContent in class JaspiraPage

displayWelcomePage

public void displayWelcomePage()

Displays a welcome page in the internal browser.

pluginInstalled

protected void pluginInstalled()

Description copied from class: AbstractPlugin

This template method is called after the plugin has been installed.

Overrides:

pluginInstalled in class AbstractPlugin

pluginUninstalled

protected void pluginUninstalled()

Description copied from class: AbstractPlugin

This template method is called before the plugin is uninstalled.

Overrides:

pluginUninstalled in class JaspiraPage

addModelerView

protected Modeler addModelerView(ProcessItem process,
                                 boolean readOnly)

Creates a new Modeler and adds it to the modeler page.

Parameters:

process - Process to display in the new view

readOnly - true: Open the process in read-only mode
false: Open the process in edit mode

Returns:

The new modeler

updateNavigationButtons

protected void updateNavigationButtons()

Updates the back and forward navigation buttons.

addQualifierToHistory

protected void addQualifierToHistory(ModelQualifier qualifier)

Adds the given process path to the process history.

Parameters:

qualifier - Model qualifier to add

getHistoryEntryAt

protected ModelQualifier getHistoryEntryAt(int index)

Gets the history entry at the specified index.

Parameters:

index - History index

Returns:

The model qualifier or null if the index is out of bounds

getHistoryIndex

public int getHistoryIndex()

Gets the current position in history list.

canGoBackward

protected boolean canGoBackward()

Checks if we can execute the goBackward() function.

canGoForward

protected boolean canGoForward()

Checks if we can execute the goForward() function.

goBackward

protected void goBackward()

Goes to previous page in history.

goForward

protected void goForward()

Goes to next page in history.

displayProcess

protected void displayProcess(ModelQualifier qualifier)

Open the given process.

Parameters:

qualifier - Process qualifier