Interface MMMenuItem

All Superinterfaces:

ADClientAble, ADM2AttrModifyAble, ELContAsgnAble, ELDeleteAble, ELElement, ELObject, ELUUIDAble, MMMetamodelElement

public interface MMMenuItem
extends MMMetamodelElement

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	MMMenuItem.VAttr

Method Summary

Modifier and Type	Method	Description
List<ADClientAble>	evaluateAdd(List<? extends ADClientAble> seqSel, List<? extends ADClientAble> seqReq, Point position, Point size, Point offset)	Adds elements as nodes to the diagram where this menu item is executed.
ADClientAble	evaluateTemplate(List<? extends ADClientAble> seqSel, List<? extends ADClientAble> seqReq, Point position, Point size, Point offset)	Evaluates the create template of this menu item.
DGSelection	getDGSelection()	Gets the documentation selection associated with this menu item.
ARG_MMEvalSequence	getEvaluateAction()	Evaluates the sequence of engineering actions of this menu item.
MMMenu	getMenu()	The menu owning this menu item.
MMMenuItemAble	getMenuItemAble()	The corresponding entity of this menu item.
boolean	getUseIcon()	True, if this menu item is displayed in the icon bar.
void	setUseIcon(boolean value)	Set the value of Attribut UseIcon.

Methods inherited from interface ADClientAble

getAnnotation, getEndAnalysisDia, getLogic, getLogic, getPresentationContext, getSection, getStartAnalysisDia

Methods inherited from interface ADM2AttrModifyAble

getTabCell, getTabCellObjectList, getTabCreateTemplate, getTabCreateTemplateObjectList, getTabElement, getTabElementRelshipTypeList, getTabElementRowList, getTabElementRowTypeList, getTabRelshipList, getTabRowList, tabCellModify, tabCreateTemplate, tabElementModify

Methods inherited from interface ELContAsgnAble

getAsgnKind, getContSortOrder, getFirstOwnerWhichIsConformTo, getOwner, getOwnerTransitive, getOwnerTransitive, getSelfAndOwnerTransitive, getSelfAndOwnerTransitive, getVersionRoot, isTransitiveChildOf, setAsgnKind, setContSortOrder, setOwner

Methods inherited from interface ELDeleteAble

delete

Methods inherited from interface ELElement

duplicateElement, getAssignAbleToVattr, getAssignAbleToVattr, getClientId, getCreateTemplateOfInstance, getDisplayBitmap, getDisplayColor, getDisplayFont, getDisplayLine, getDisplayName, getDisplayNameShort, getDisplayNSName, getElementCache, getElementMappingInformation, getNotificationElement, getQualifiedNamespaceName, getRelshipBinDir, getRelshipBinDir, getRelshipBinDirTarget, getUnitToLock, getValSpecElement, isContainedInProfile, isUnresolved, lockUnit, setUnresolved, unlockUnit

Methods inherited from interface ELObject

getId, getLongId, getMetaClass, getMetaName, getOclClass, getSrvCon, hasRead

Methods inherited from interface ELUUIDAble

getHyperlinkReferenceAble, getInnoRef, getNotToTranslateAttribute, getTranslatedValue, getUUID, setUUID

Methods inherited from interface MMMetamodelElement

getIgnoringProfile

Method Details

getUseIcon

boolean getUseIcon()
            throws InoNetException,
SrvErrorException

True, if this menu item is displayed in the icon bar.

Throws:

InoNetException

SrvErrorException

setUseIcon

void setUseIcon(boolean value)
         throws InoNetException,
SrvErrorException

Set the value of Attribut UseIcon.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getEvaluateAction

ARG_MMEvalSequence getEvaluateAction()
                              throws InoNetException,
SrvErrorException

Evaluates the sequence of engineering actions of this menu item.

Throws:

InoNetException

SrvErrorException

getDGSelection

DGSelection getDGSelection()
                    throws InoNetException,
SrvErrorException

Gets the documentation selection associated with this menu item.

Throws:

InoNetException

SrvErrorException

evaluateAdd

List<ADClientAble> evaluateAdd(List<? extends ADClientAble> seqSel,
 List<? extends ADClientAble> seqReq,
 Point position,
 Point size,
 Point offset)
                        throws InoNetException,
SrvErrorException

Adds elements as nodes to the diagram where this menu item is executed.

Parameters:

seqSel - List of selected elements

seqReq - List of additional requirements

position - Position in diagram

size - Size in diagram

offset - Position offset, if more than one node is added

Throws:

InoNetException

SrvErrorException

evaluateTemplate

ADClientAble evaluateTemplate(List<? extends ADClientAble> seqSel,
 List<? extends ADClientAble> seqReq,
 Point position,
 Point size,
 Point offset)
                       throws InoNetException,
SrvErrorException

Evaluates the create template of this menu item.

Parameters:

seqSel - List of selected elements

seqReq - List of additional requirements

position - Position in diagram

size - Size in diagram

offset - Position offset, if more than one node is added

Throws:

InoNetException

SrvErrorException

getMenuItemAble

MMMenuItemAble getMenuItemAble()
                        throws InoNetException,
SrvErrorException

The corresponding entity of this menu item.

Throws:

InoNetException

SrvErrorException

getMenu

MMMenu getMenu()
        throws InoNetException,
SrvErrorException

The menu owning this menu item.

Throws:

InoNetException

SrvErrorException