org.modelio.api.module.contributor

Interface IWizardContributor

All Known Subinterfaces:

IDiagramWizardContributor, IMatrixWizardContributor

All Known Implementing Classes:

AbstractDiagramWizardContributor, AbstractMatrixWizardContributor, AbstractWizardContributor, GenericDiagramWizardContributor, MatrixWizardStandardContributor

public interface IWizardContributor

This is the contract to be honored by a contributor to the Creation Wizard.

• Getters are used by the wizard to display information about the element to create
• Setters are used to initialize the data structure when loading a module providing the contributor
• The actionPerformed(ModelElement, String, String) method is in charge of creating the element from the provided data.

Since:

3.4.0

Method Summary

Modifier and Type	Method and Description
boolean	accept(ModelElement main) This method checks if an element is accepted.
MObject	actionPerformed(ModelElement context, java.lang.String name, java.lang.String description) Execute the creation action.
void	dispose() Release resources allocated by this contributor.
ElementDescriptor	getCreatedElementType() Get the type of element which is created by this contributor.
java.lang.String	getDetails() Get a complete textual explanation of the contributior's role or function.
java.lang.String	getHelpUrl() Get a URL to some 'help' or 'documentation' page about the behavior and usage of the contributor.
ImageDescriptor	getIconDescriptor() The contributor's icon.
Image	getIconImage() The contributor's icon.
java.lang.String	getInformation() Get a short textual explanation of the contributor's role or function.
java.lang.String	getLabel() Get the label to be displayed for the contributor by the Creation Wizard in its "type" browser.
java.lang.String	getModelViewTemplateId() Get the id of the creator that is used by this contributor IModelViewTemplate.
IModule	getModule() Get the module that is providing this contributor.
ImageDescriptor	getPreviewImage() Get the preview image of this contributor.
java.util.List<ElementScope>	getScopes() Get the valid scopes for this contributor, ie the (metaclass+stereotype) combinations which are accepted as 'context' in #accept(MObject) and actionPerformed(ModelElement, String, String)
IPanelProvider	getWizardPanel() Get the GUI panel to display in the wizard.
void	setDetails(java.lang.String details) Set a textual explanation of the contribution's role or function.
void	setHelpUrl(java.lang.String helpUrl)
void	setIconDescriptor(ImageDescriptor iconDescriptor) Sets the contributor icon.
void	setInformation(java.lang.String information) Get a short textual explanation of the contribution's role or function.
void	setLabel(java.lang.String label)
void	setModelViewTemplateId(java.lang.String id) Sets the id of the creator that is used by this contributor IModelViewTemplate.
void	setModule(IModule module)
void	setParameters(java.util.Map<java.lang.String,java.lang.String> parameters)
void	setPreviewImage(ImageDescriptor descriptor)
void	setScopes(java.util.List<ElementScope> scopes)

Method Detail

actionPerformed

MObject actionPerformed(ModelElement context,
                        java.lang.String name,
                        java.lang.String description)

Execute the creation action.

Parameters:

context - the model element on which the wizard is run

name - the name of the element to create.

description - the description of the element to create.

Returns:

the created model object.

getDetails

java.lang.String getDetails()

Get a complete textual explanation of the contributior's role or function.

Returns:

the contribution's role or function.

getHelpUrl

java.lang.String getHelpUrl()

Get a URL to some 'help' or 'documentation' page about the behavior and usage of the contributor. The URL is relative to the help system 'root'.

Returns:

the help URL.

getIconImage

Image getIconImage()

The contributor's icon. Lifecycle: the image lifecycle is not dealt with at all by the wizard for this image.

Returns:

the contributor small icon

getInformation

java.lang.String getInformation()

Get a short textual explanation of the contributor's role or function.

This text is displayed in the panel header. Must be short (one line). Must be I18n'ed.

Returns:

the short explanation.

getLabel

java.lang.String getLabel()

Get the label to be displayed for the contributor by the Creation Wizard in its "type" browser. Must be I18n'ed.

Returns:

the label to be displayed

getModule

IModule getModule()

Get the module that is providing this contributor.

Returns:

the module that contributed this contribution, or null if the contributor was not provided by a Module.

getPreviewImage

ImageDescriptor getPreviewImage()

Get the preview image of this contributor. The

Returns:

a preview image to display in the wizard or null.

getScopes

java.util.List<ElementScope> getScopes()

Get the valid scopes for this contributor, ie the (metaclass+stereotype) combinations which are accepted as 'context' in #accept(MObject) and actionPerformed(ModelElement, String, String)

Returns:

the scopes this wizard applies to

setDetails

void setDetails(java.lang.String details)

Set a textual explanation of the contribution's role or function.

Parameters:

details - a textual explanation

setHelpUrl

void setHelpUrl(java.lang.String helpUrl)

Parameters:

helpUrl - the help URL

setInformation

void setInformation(java.lang.String information)

Get a short textual explanation of the contribution's role or function.

This text is displayed in the panel header.

Parameters:

information - the short explanation.

setLabel

void setLabel(java.lang.String label)

Parameters:

label - this contribution label.

setModule

void setModule(IModule module)

Parameters:

module - the module that provides this wizard contribution.

setParameters

void setParameters(java.util.Map<java.lang.String,java.lang.String> parameters)

Parameters:

parameters - the wizard parameters

setScopes

void setScopes(java.util.List<ElementScope> scopes)

Parameters:

scopes - the wizard scope

accept

boolean accept(ModelElement main)

This method checks if an element is accepted.

Parameters:

main - the model element to check.

Returns:

true if the element is accepted.

getWizardPanel

IPanelProvider getWizardPanel()

Get the GUI panel to display in the wizard.

Returns:

the wizard panel to display.

Since:

3.4

dispose

void dispose()

Release resources allocated by this contributor.

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

setPreviewImage

void setPreviewImage(ImageDescriptor descriptor)

Parameters:

descriptor - a descriptor for the wizard preview image

getCreatedElementType

ElementDescriptor getCreatedElementType()

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

Returns:

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

setIconDescriptor

void setIconDescriptor(ImageDescriptor iconDescriptor)

Sets the contributor icon. Lifecycle: the actual image for the icon is created by the Wizard GUI from the given descriptor and freed when necessary.

Parameters:

iconDescriptor - this wizard contribution icon

getModelViewTemplateId

java.lang.String getModelViewTemplateId()

Get the id of the creator that is used by this contributor IModelViewTemplate. Optional, empty string means no creator defined.

Returns:

the creator id or an empty string if the contributor is not using a predefined creator.

Since:

4.1.0

setModelViewTemplateId

void setModelViewTemplateId(java.lang.String id)

Sets the id of the creator that is used by this contributor IModelViewTemplate.

Since:

4.1.0

getIconDescriptor

ImageDescriptor getIconDescriptor()

The contributor's icon. Lifecycle: the image is created by the Wizard GUI from the given descriptor and freed when necessary.

Returns:

the contributor small icon