org.modelio.api.module.contributor.diagramcreation.standard

Class GenericDiagramWizardContributor

java.lang.Object

org.modelio.api.module.contributor.AbstractWizardContributor

org.modelio.api.module.contributor.diagramcreation.AbstractDiagramWizardContributor

org.modelio.api.module.contributor.diagramcreation.standard.GenericDiagramWizardContributor

All Implemented Interfaces:

IDiagramWizardContributor, IWizardContributor

public class GenericDiagramWizardContributor
extends AbstractDiagramWizardContributor

Generic diagram wizard contribution class.

Uses the following contribution parameters:

• metaclass
• stereotype
• name
• style

Since:

3.4

Constructor Summary

Constructors

Constructor and Description
GenericDiagramWizardContributor()

Method Summary

Modifier and Type	Method and Description
AbstractDiagram	actionPerformed(ModelElement diagramContext, java.lang.String diagramName, java.lang.String diagramDescription) Execute the creation action.
protected boolean	checkCanCreateIn(ModelElement owner) Called by #accept(MObject) to check whether the given object has sufficient rights to create the wizard new element.
void	dispose() Release resources allocated by this contributor.
ElementDescriptor	getCreatedElementType() Get the type of element which is created by this contributor.

Methods inherited from class org.modelio.api.module.contributor.AbstractWizardContributor

accept, findStereotypeFromSpec, getDetails, getHelpUrl, getIconDescriptor, getIconImage, getInformation, getLabel, getModelViewTemplateId, getModule, getParameters, getPreviewImage, getScopes, getWizardPanel, setDetails, setHelpUrl, setIconDescriptor, setInformation, setLabel, setModelViewTemplateId, setModule, setParameters, setPreviewImage, setScopes

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.modelio.api.module.contributor.IWizardContributor

accept, getDetails, getHelpUrl, getIconDescriptor, getIconImage, getInformation, getLabel, getModelViewTemplateId, getModule, getPreviewImage, getScopes, getWizardPanel, setDetails, setHelpUrl, setIconDescriptor, setInformation, setLabel, setModelViewTemplateId, setModule, setParameters, setPreviewImage, setScopes

Constructor Detail

GenericDiagramWizardContributor

public GenericDiagramWizardContributor()

Method Detail

actionPerformed

public AbstractDiagram actionPerformed(ModelElement diagramContext,
                                       java.lang.String diagramName,
                                       java.lang.String diagramDescription)

Description copied from class: AbstractWizardContributor

Execute the creation action.

Note : a model transaction is already open by the caller.

Specified by:

actionPerformed in interface IDiagramWizardContributor

Specified by:

actionPerformed in interface IWizardContributor

Specified by:

actionPerformed in class AbstractWizardContributor

Parameters:

diagramContext - the model element on which the wizard is run

diagramName - the name of the element to create.

diagramDescription - the description of the element to create.

Returns:

the created model object.

checkCanCreateIn

protected boolean checkCanCreateIn(ModelElement owner)

Description copied from class: AbstractWizardContributor

Called by #accept(MObject) to check whether the given object has sufficient rights to create the wizard new element.

Specified by:

checkCanCreateIn in class AbstractWizardContributor

Parameters:

owner - the new element owner.

Returns:

true if the operation is allowed else false.

getCreatedElementType

public ElementDescriptor getCreatedElementType()

Description copied from interface: IWizardContributor

Get the type of element which is created by this contributor.

Returns:

a descriptor indicating which element type is created by the contribution.

dispose

public void dispose()

Description copied from interface: IWizardContributor

Release resources allocated by this contributor.

Should for example dispose the icon allocated by #getIcon() if any.