org.modelio.api.module.contributor

Class AbstractWizardContributor

java.lang.Object

org.modelio.api.module.contributor.AbstractWizardContributor

All Implemented Interfaces:

IWizardContributor

Direct Known Subclasses:

AbstractDiagramWizardContributor

public abstract class AbstractWizardContributor
extends Object
implements IWizardContributor

Convenience class that provides an abstract implementation of IDiagramWizardContributor that only provides useful fields and their getters/setters.

Since:

3.4.0

Constructor Summary

Constructors

Constructor and Description
AbstractWizardContributor() Default constructor that ensure getParameters() and getScopes() won't return null.

Method Summary

Modifier and Type	Method and Description
abstract boolean	accept(MObject element) This method checks if an element is accepted.
abstract MObject	actionPerformed(ModelElement diagramContext, String diagramName, String diagramDescription) Execute the creation action.
void	dispose() Disposes the icon set by setIcon(Image).
Stereotype	findStereotypeFromSpec(MClass metaclass, String stereotypeSpec) Find the stereotype from a stereotype specification.
String	getDetails() Get a complete textual explanation of the contribution's role or function.
String	getHelpUrl() Get a URL to some 'help' or 'documentation' page about the contribution.
org.eclipse.swt.graphics.Image	getIcon()
String	getInformation() Get a short textual explanation of the contribution's role or function.
String	getLabel() Get the label to be displayed for the contribution by the Creation Wizard in the "type" browser.
IModule	getModule()
Map<String,String>	getParameters()
org.eclipse.jface.resource.ImageDescriptor	getPreviewImage()
List<ElementScope>	getScopes()
IPanelProvider	getWizardPanel() Get the GUI panel to display in the wizard.
void	setDetails(String details) Set a textual explanation of the contribution's role or function.
void	setHelpUrl(String helpUrl)
void	setIcon(org.eclipse.swt.graphics.Image icon)
void	setInformation(String information) Get a short textual explanation of the contribution's role or function.
void	setLabel(String label)
void	setModule(IModule module)
void	setParameters(Map<String,String> parameters)
void	setPreviewImage(org.eclipse.jface.resource.ImageDescriptor previewDescriptor)
void	setScopes(List<ElementScope> scopes)

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractWizardContributor

public AbstractWizardContributor()

Default constructor that ensure getParameters() and getScopes() won't return null.

Method Detail

getLabel

public String getLabel()

Description copied from interface: IWizardContributor

Get the label to be displayed for the contribution by the Creation Wizard in the "type" browser.

Specified by:

getLabel in interface IWizardContributor

Returns:

the label to be displayed

setLabel

public void setLabel(String label)

Specified by:

setLabel in interface IWizardContributor

Parameters:

label - this contribution label.

getInformation

public String getInformation()

Description copied from interface: IWizardContributor

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

This text is displayed in the panel header.

Specified by:

getInformation in interface IWizardContributor

Returns:

the short explanation.

setInformation

public void setInformation(String information)

Description copied from interface: IWizardContributor

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

This text is displayed in the panel header.

Specified by:

setInformation in interface IWizardContributor

Parameters:

information - the short explanation.

getHelpUrl

public String getHelpUrl()

Description copied from interface: IWizardContributor

Get a URL to some 'help' or 'documentation' page about the contribution.

Specified by:

getHelpUrl in interface IWizardContributor

Returns:

the help URL.

setHelpUrl

public void setHelpUrl(String helpUrl)

Specified by:

setHelpUrl in interface IWizardContributor

Parameters:

helpUrl - the help URL

getDetails

public String getDetails()

Description copied from interface: IWizardContributor

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

Specified by:

getDetails in interface IWizardContributor

Returns:

the contribution's role or function.

setDetails

public void setDetails(String details)

Description copied from interface: IWizardContributor

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

Specified by:

setDetails in interface IWizardContributor

Parameters:

details - a textual explanation

getIcon

public org.eclipse.swt.graphics.Image getIcon()

Specified by:

getIcon in interface IWizardContributor

Returns:

the wizard small icon

setIcon

public void setIcon(org.eclipse.swt.graphics.Image icon)

Specified by:

setIcon in interface IWizardContributor

Parameters:

icon - this wizard contribution icon

getParameters

public Map<String,String> getParameters()

Returns:

the wizard contribution parameters.

setParameters

public void setParameters(Map<String,String> parameters)

Specified by:

setParameters in interface IWizardContributor

Parameters:

parameters - the wizard parameters

getScopes

public List<ElementScope> getScopes()

Specified by:

getScopes in interface IWizardContributor

Returns:

the scopes this wizard applies to

setScopes

public void setScopes(List<ElementScope> scopes)

Specified by:

setScopes in interface IWizardContributor

Parameters:

scopes - the wizard scope

accept

public abstract boolean accept(MObject element)

Description copied from interface: IWizardContributor

This method checks if an element is accepted.

Specified by:

accept in interface IWizardContributor

Parameters:

element - the model element to check.

Returns:

true if the element is accepted.

actionPerformed

public abstract MObject actionPerformed(ModelElement diagramContext,
                                        String diagramName,
                                        String diagramDescription)

Execute the creation action.

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

Specified by:

actionPerformed in interface IWizardContributor

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.

getModule

public IModule getModule()

Specified by:

getModule in interface IWizardContributor

Returns:

the module that contributed this contribution.

setModule

public void setModule(IModule module)

Specified by:

setModule in interface IWizardContributor

Parameters:

module - the module that provides this wizard contribution.

getPreviewImage

public org.eclipse.jface.resource.ImageDescriptor getPreviewImage()

Specified by:

getPreviewImage in interface IWizardContributor

Returns:

a preview image to display in the wizard.

findStereotypeFromSpec

public final Stereotype findStereotypeFromSpec(MClass metaclass,
                                               String stereotypeSpec)

Find the stereotype from a stereotype specification.

The stereotype specification may have one of the following formats:

• stereotype name
• module name#stereotype name
• module regex#stereotype name
• module regex#stereotype regex

Returns null if the specification is null or the stereotype is not found.

Parameters:

metaclass - the metaclass to look from

stereotypeSpec - the stereotype specification

Returns:

the found stereotype or null.

getWizardPanel

public IPanelProvider getWizardPanel()

Description copied from interface: IWizardContributor

Get the GUI panel to display in the wizard.

Specified by:

getWizardPanel in interface IWizardContributor

Returns:

the wizard panel to display.

dispose

public void dispose()

Disposes the icon set by setIcon(Image).

Specified by:

dispose in interface IWizardContributor

setPreviewImage

public void setPreviewImage(org.eclipse.jface.resource.ImageDescriptor previewDescriptor)

Specified by:

setPreviewImage in interface IWizardContributor

Parameters:

previewDescriptor - a descriptor for the wizard preview image