org.argouml.uml.ui.behavior.use_cases
Class PropPanelInclude

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--javax.swing.JPanel
                          |
                          +--org.argouml.ui.TabSpawnable
                                |
                                +--org.argouml.uml.ui.PropPanel
                                      |
                                      +--org.argouml.uml.ui.foundation.core.PropPanelModelElement
                                            |
                                            +--org.argouml.uml.ui.behavior.use_cases.PropPanelInclude
All Implemented Interfaces:
javax.accessibility.Accessible, java.lang.Cloneable, java.util.EventListener, java.awt.image.ImageObserver, ru.novosoft.uml.MElementListener, java.awt.MenuContainer, NavigationListener, Orientable, java.io.Serializable, TabModelTarget, UMLUserInterfaceContainer

public class PropPanelInclude
extends PropPanelModelElement

Builds the property panel for an Include relationship.

This is a type of Relationship, but, since Relationship has no semantic meaning of its own, we derive directly from PropPanelModelElement (as other children of Relationship do).

See Also:
Serialized Form

Inner classes inherited from class javax.swing.JPanel
javax.swing.JPanel.AccessibleJPanel
 
Inner classes inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent
 
Inner classes inherited from class java.awt.Container
java.awt.Container.AccessibleAWTContainer
 
Inner classes inherited from class java.awt.Component
java.awt.Component.AccessibleAWTComponent
 
Fields inherited from class org.argouml.uml.ui.foundation.core.PropPanelModelElement
_actionIcon, _actorIcon, _addAssocIcon, _addAttrIcon, _addOpIcon, _assocEndIcon, _assocEndRoleIcon, _associationIcon, _associationRoleIcon, _callActionIcon, _classIcon, _classifierRoleIcon, _collaborationIcon, _commentIcon, _componentIcon, _componentInstanceIcon, _dataTypeIcon, _dependencyIcon, _extendIcon, _extensionPointIcon, _flowIcon, _generalizationIcon, _guardIcon, _includeIcon, _innerClassIcon, _instanceIcon, _interactionIcon, _interfaceIcon, _linkIcon, _messageIcon, _modelIcon, _nodeIcon, _nodeInstanceIcon, _objectIcon, _operationIcon, _packageIcon, _parameterIcon, _permissionIcon, _realizationIcon, _receptionIcon, _signalIcon, _stateMachineIcon, _stereotypeIcon, _stimulusIcon, _transitionIcon, _usageIcon, _useCaseIcon
 
Fields inherited from class org.argouml.uml.ui.PropPanel
_deleteIcon, _navBackIcon, _navForwardIcon, _navUpIcon, buttonPanel, smallFont
 
Fields inherited from class org.argouml.ui.TabSpawnable
cat, orientation, OVERLAPP
 
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
PropPanelInclude()
          Constructor.
 
Method Summary
 ru.novosoft.uml.behavior.use_cases.MUseCase getAddition()
          Get the current addition use case of the include relationship. Note.
 ru.novosoft.uml.behavior.use_cases.MUseCase getBase()
          Get the current base use case of the include relationship. Note.
 boolean isAcceptableUseCase(ru.novosoft.uml.foundation.core.MModelElement modElem)
          Predicate to test if a model element may appear in the list of potential use cases. Note.
 void setAddition(ru.novosoft.uml.behavior.use_cases.MUseCase addition)
          Set the addition use case of the include relationship. Note.
 void setBase(ru.novosoft.uml.behavior.use_cases.MUseCase base)
          Set the base use case of the include relationship. Note.
 
Methods inherited from class org.argouml.uml.ui.foundation.core.PropPanelModelElement
getClientDependencyScroll, getConstraintScroll, getElementResidenceScroll, getModulePopUpActions, getNameDocument, getNamespaceComboBox, getNamespaceScroll, getNamespaceVisibilityPanel, getNameTextField, getPropertyPanel, getSourceFlowScroll, getSpecializationCheckBox, getStereotypeBox, getSupplierDependencyScroll, getTargetFlowScroll, inContext, initializeModule, isModuleEnabled, navigateNamespace, navigateUp, setModuleEnabled, shutdownModule
 
Methods inherited from class org.argouml.uml.ui.PropPanel
addCaption, addCaption, addField, addField, addFieldAfter, addFieldBefore, addLinkField, addLinkField, addMElementListener, addNavigationListener, formatCollection, formatElement, formatNamespace, getDisplayNamespace, getModelElement, getProfile, getResourceBundle, getTarget, isNavigateBackEnabled, isNavigateForwardEnabled, isRemovableElement, listRoleItemSet, localize, navigateBack, navigateBackAction, navigateForward, navigateForwardAction, navigateTo, open, propertySet, recovered, refresh, removed, removeElement, removeMElementListener, removeNavigationListener, roleAdded, roleRemoved, setNameEventListening, setOrientation, setTarget, shouldBeEnabled
 
Methods inherited from class org.argouml.ui.TabSpawnable
clone, getTitle, setTitle, spawn
 
Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUIClassID, paramString, updateUI
 
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, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getVerifyInputWhenFocusTarget, getVisibleRect, getWidth, getX, getY, grabFocus, hasFocus, hide, isDoubleBuffered, isFocusCycleRoot, isFocusTraversable, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processFocusEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDoubleBuffered, setEnabled, setFont, setForeground, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addImpl, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getLayout, insets, invalidate, isAncestorOf, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setLayout, validate, validateTree
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, getBackground, getBounds, getColorModel, getComponentOrientation, getCursor, getDropTarget, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getInputContext, getInputMethodRequests, getLocale, getLocation, getLocationOnScreen, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, imageUpdate, inside, isDisplayable, isEnabled, isLightweight, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

PropPanelInclude

public PropPanelInclude()
Constructor. Builds up the various fields required.
Method Detail

getBase

public ru.novosoft.uml.behavior.use_cases.MUseCase getBase()

Get the current base use case of the include relationship.

Note. There is a bug in NSUML, where the "include" and "include2" associations of a use case are back to front, i.e "include" is used as the opposite end of "addition" to point to an including use case, rather than an included use case. Fixed within the include relationship, rather than the use case, by reversing the use of access functions for the "base" and "addition" associations in the code.

Returns:
The MUseCase that is the base of this include relationship or null if there is none. Returned as type MUseCase to fit in with the type specified for the UMLComboBoxModel.

setBase

public void setBase(ru.novosoft.uml.behavior.use_cases.MUseCase base)

Set the base use case of the include relationship.

Note. There is a bug in NSUML, where the "include" and "include2" associations of a use case are back to front, i.e "include" is used as the opposite end of "addition" to point to an including use case, rather than an included use case. Fixed within the include relationship, rather than the use case, by reversing the use of access functions for the "base" and "addition" associations in the code.

Parameters:
base - The MUseCase to set as the base of this include relationship. Supplied as type MUseCase to fit in with the type specified for the UMLComboBoxModel.

getAddition

public ru.novosoft.uml.behavior.use_cases.MUseCase getAddition()

Get the current addition use case of the include relationship.

Note. There is a bug in NSUML, where the "include" and "include2" associations of a use case are back to front, i.e "include" is used as the opposite end of "addition" to point to an including use case, rather than an included use case. Fixed within the include relationship, rather than the use case, by reversing the use of access functions for the "base" and "addition" associations in the code.

Returns:
The MUseCase that is the addition of this include relationship or null if there is none. Returned as type MUseCase to fit in with the type specified for the UMLComboBoxModel.

setAddition

public void setAddition(ru.novosoft.uml.behavior.use_cases.MUseCase addition)

Set the addition use case of the include relationship.

Note. There is a bug in NSUML, where the "include" and "include2" associations of a use case are back to front, i.e "include" is used as the opposite end of "addition" to point to an including use case, rather than an included use case. Fixed within the include relationship, rather than the use case, by reversing the use of access functions for the "base" and "addition" associations in the code.

Parameters:
addition - The MUseCase to set as the addition of this include relationship. Supplied as type MUseCase to fit in with the type specified for the UMLComboBoxModel.

isAcceptableUseCase

public boolean isAcceptableUseCase(ru.novosoft.uml.foundation.core.MModelElement modElem)

Predicate to test if a model element may appear in the list of potential use cases.

Note. We don't try to prevent the user setting up circular include relationships. This may be necessary temporarily, for example while reversing a relationship. It is up to a critic to track this.

Parameters:
modElem - the MModelElement to test.
Returns:
true if modElem is a use case, false otherwise.


ArgoUML (c) 1996-2002
ArgoUML Project Home
ArgoUML Cookbook