com.yworks.yfiles.bpmn.view
Class BpmnPalette

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              com.yworks.yfiles.bpmn.view.BpmnPalette

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable

public class BpmnPalette

extends JComponent

A component that represents a palette of BPMN nodes or edges and allows to drag them into a Graph2DView.

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields inherited from class javax.swing.JComponent

accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

BpmnPalette(Graph2DView view)
Initializes a new BpmnPalette.

Method Summary

protected void	addActivities(List realizers) Adds templates for BPMN activities to the list of available BPMN templates.
protected void	addArtifacts(List realizers) Adds templates for BPMN artifacts to the list of available BPMN templates.
protected void	addChoreographies(List realizers) Adds templates for BPMN choreographies to the list of available BPMN templates.
protected void	addConversations(List realizers) Adds templates for BPMN conversations to the list of available BPMN templates.
protected void	addDefaultTemplates(List realizers) Adds default BPMN templates to the palette list.
protected void	addEvents(List realizers) Adds templates for BPMN events to the list of available BPMN templates.
protected void	addGateways(List realizers) Adds templates for BPMN gateways to the list of available BPMN templates.
protected void	addPools(List realizers) Adds templates for BPMN pools to the list of available BPMN templates.
protected void	addRelations(List realizers) Adds templates for BPMN relations to the list of available BPMN templates.
void	addTemplate(NodeRealizer realizer) Appends the specified template to the palette.
protected void	initializeDefaultRealizers(Graph2DView view) Initializes default realizers for group and folder nodes for graph associated with the specified graph view.
boolean	isEventPortCreationEnabled() Determines whether or not automatic creation of attached events is enabled.
boolean	isSnappingEnabled() Returns whether or not snapping is enabled when creating nodes via drag and drop.
void	removeTemplate(NodeRealizer realizer) Removes the specified template from the palette.
void	setEventPortCreationEnabled(boolean enabled) Specifies whether or not automatic creation of attached events is enabled.
void	setSnappingEnabled(boolean enabled) Specifies whether or not nodes created via drag and drop should snap to other graph elements or grid points.

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getAccessibleContext, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, paramString, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFont, setForeground, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update, updateUI

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setLayout, transferFocusBackward, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

BpmnPalette

public BpmnPalette(Graph2DView view)

Initializes a new BpmnPalette. The following node and edge realizers will be available by default:

• BPMN Events
• BPMN Gateways
• BPMN Conversations
• BPMN Artifacts
• BPMN Activities
• BPMN Choreographies
• BPMN Pools
• BPMN Relations

Parameters:

view - the Graph2DView onto which elements from this palette may be dropped.

Method Detail

isSnappingEnabled

public boolean isSnappingEnabled()

Returns whether or not snapping is enabled when creating nodes via drag and drop.

By default, this feature is enabled.

Returns:

true if snapping is enabled; false otherwise.

See Also:

setSnappingEnabled(boolean)

setSnappingEnabled

public void setSnappingEnabled(boolean enabled)

Specifies whether or not nodes created via drag and drop should snap to other graph elements or grid points.

By default, this feature is enabled.

Parameters:

enabled - if true snapping is enabled.

See Also:

isSnappingEnabled()

isEventPortCreationEnabled

public boolean isEventPortCreationEnabled()

Determines whether or not automatic creation of attached events is enabled. If this feature is enabled, dropping an event node template on the border of an activity node will create an event node port instead of an event node.

By default, this feature is enabled.

Returns:

true if events are automatically attached to activity nodes; false otherwise.

See Also:

EventPortSupport.convertToPort(y.view.NodeRealizer, y.view.NodeRealizer, y.geom.YPoint), setEventPortCreationEnabled(boolean)

setEventPortCreationEnabled

public void setEventPortCreationEnabled(boolean enabled)

Specifies whether or not automatic creation of attached events is enabled. If this feature is enabled, dropping an event node template on the border of an activity node will create an event node port instead of an event node.

By default, this feature is enabled.

Parameters:

enabled - if true events are automatically attached to activity nodes.

See Also:

EventPortSupport.convertToPort(y.view.NodeRealizer, y.view.NodeRealizer, y.geom.YPoint), isEventPortCreationEnabled()

initializeDefaultRealizers

protected void initializeDefaultRealizers(Graph2DView view)

Initializes default realizers for group and folder nodes for graph associated with the specified graph view.

Parameters:

view - The Graph2DView instance associated with this BpmnPalette.

addTemplate

public void addTemplate(NodeRealizer realizer)

Appends the specified template to the palette.

Parameters:

realizer - The template node realizer that is added to the palette.

removeTemplate

public void removeTemplate(NodeRealizer realizer)

Removes the specified template from the palette.

Parameters:

realizer - The template node realizer that is removed from the palette.

addDefaultTemplates

protected void addDefaultTemplates(List realizers)

Adds default BPMN templates to the palette list.

This method will call the following methods:

• addEvents(java.util.List)
• addGateways(java.util.List)
• addConversations(java.util.List) (java.util.List)}
• addArtifacts(java.util.List)
• addActivities(java.util.List)
• addChoreographies(java.util.List)
• addPools(java.util.List)
• addRelations(java.util.List)

Parameters:

realizers - The list to which the template realizers are added.

addChoreographies

protected void addChoreographies(List realizers)

Adds templates for BPMN choreographies to the list of available BPMN templates. Callback method for addDefaultTemplates(java.util.List).

Parameters:

realizers - The list to which the template realizers are added.

addPools

protected void addPools(List realizers)

Adds templates for BPMN pools to the list of available BPMN templates. Callback method for addDefaultTemplates(java.util.List).

Parameters:

realizers - The list to which the template realizers are added.

addRelations

protected void addRelations(List realizers)

Adds templates for BPMN relations to the list of available BPMN templates. Callback method for addDefaultTemplates(java.util.List).

Parameters:

realizers - The list to which the template realizers are added.

addArtifacts

protected void addArtifacts(List realizers)

Adds templates for BPMN artifacts to the list of available BPMN templates. Callback method for addDefaultTemplates(java.util.List).

Parameters:

realizers - The list to which the template realizers are added.

addEvents

protected void addEvents(List realizers)

Adds templates for BPMN events to the list of available BPMN templates. Callback method for addDefaultTemplates(java.util.List).

Parameters:

realizers - The list to which the template realizers are added.

addGateways

protected void addGateways(List realizers)

Adds templates for BPMN gateways to the list of available BPMN templates. Callback method for addDefaultTemplates(java.util.List).

Parameters:

realizers - The list to which the template realizers are added.

addActivities

protected void addActivities(List realizers)

Adds templates for BPMN activities to the list of available BPMN templates. Callback method for addDefaultTemplates(java.util.List).

Parameters:

realizers - The list to which the template realizers are added.

addConversations

protected void addConversations(List realizers)

Adds templates for BPMN conversations to the list of available BPMN templates. Callback method for addDefaultTemplates(java.util.List).

Parameters:

realizers - The list to which the template realizers are added.