org.modelio.api.module.contributor

Class AbstractWizardContributor

java.lang.Object

org.modelio.api.module.contributor.AbstractWizardContributor

All Implemented Interfaces:

IWizardContributor

Direct Known Subclasses:

AbstractDiagramWizardContributor, AbstractMatrixWizardContributor

public abstract class AbstractWizardContributor
extends java.lang.Object
implements IWizardContributor

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

Note to contributor implementors:
By inheriting from this abstract class you only have to provide implementations for the two abstract methods:

• checkCanCreateIn(ModelElement)
• actionPerformed(ModelElement, String, String)
• IWizardContributor.dispose()

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
boolean	accept(ModelElement main) Default implementation that deals with checking the scopes and requires an abstract delegated method to be provided by implementors.
abstract MObject	actionPerformed(ModelElement diagramContext, java.lang.String diagramName, java.lang.String diagramDescription) Execute the creation action.
protected abstract boolean	checkCanCreateIn(ModelElement owner) Called by #accept(MObject) to check whether the given object has sufficient rights to create the wizard new element.
Stereotype	findStereotypeFromSpec(MClass metaclass, java.lang.String stereotypeSpec) Find the stereotype from a stereotype specification.
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() Default implementation returning null.
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.
java.util.Map<java.lang.String,java.lang.String>	getParameters()
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 IWizardContributor.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 previewDescriptor)
void	setScopes(java.util.List<ElementScope> scopes)

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

dispose, getCreatedElementType

Constructor Detail

AbstractWizardContributor

public AbstractWizardContributor()

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

Method Detail

getLabel

public final java.lang.String getLabel()

Description copied from interface: IWizardContributor

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

Specified by:

getLabel in interface IWizardContributor

Returns:

the label to be displayed

setLabel

public final void setLabel(java.lang.String label)

Specified by:

setLabel in interface IWizardContributor

Parameters:

label - this contribution label.

getInformation

public final java.lang.String getInformation()

Description copied from interface: IWizardContributor

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.

Specified by:

getInformation in interface IWizardContributor

Returns:

the short explanation.

setInformation

public final void setInformation(java.lang.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 final java.lang.String getHelpUrl()

Description copied from interface: IWizardContributor

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'.

Specified by:

getHelpUrl in interface IWizardContributor

Returns:

the help URL.

setHelpUrl

public final void setHelpUrl(java.lang.String helpUrl)

Specified by:

setHelpUrl in interface IWizardContributor

Parameters:

helpUrl - the help URL

getDetails

public final java.lang.String getDetails()

Description copied from interface: IWizardContributor

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

Specified by:

getDetails in interface IWizardContributor

Returns:

the contribution's role or function.

setDetails

public final void setDetails(java.lang.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

getIconDescriptor

public final ImageDescriptor getIconDescriptor()

Description copied from interface: IWizardContributor

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

Specified by:

getIconDescriptor in interface IWizardContributor

Returns:

the contributor small icon

setIconDescriptor

public final void setIconDescriptor(ImageDescriptor iconDescriptor)

Description copied from interface: IWizardContributor

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.

Specified by:

setIconDescriptor in interface IWizardContributor

Parameters:

iconDescriptor - this wizard contribution icon

getParameters

public final java.util.Map<java.lang.String,java.lang.String> getParameters()

Returns:

the wizard contribution parameters.

setParameters

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

Specified by:

setParameters in interface IWizardContributor

Parameters:

parameters - the wizard parameters

getScopes

public java.util.List<ElementScope> getScopes()

Description copied from interface: IWizardContributor

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

Specified by:

getScopes in interface IWizardContributor

Returns:

the scopes this wizard applies to

setScopes

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

Specified by:

setScopes in interface IWizardContributor

Parameters:

scopes - the wizard scope

accept

public boolean accept(ModelElement main)

Default implementation that deals with checking the scopes and requires an abstract delegated method to be provided by implementors.

Specified by:

accept in interface IWizardContributor

Parameters:

main - the model element to check.

Returns:

true if the element is accepted.

actionPerformed

public abstract MObject actionPerformed(ModelElement diagramContext,
                                        java.lang.String diagramName,
                                        java.lang.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 final IModule getModule()

Description copied from interface: IWizardContributor

Get the module that is providing this contributor.

Specified by:

getModule in interface IWizardContributor

Returns:

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

setModule

public final void setModule(IModule module)

Specified by:

setModule in interface IWizardContributor

Parameters:

module - the module that provides this wizard contribution.

getPreviewImage

public final ImageDescriptor getPreviewImage()

Description copied from interface: IWizardContributor

Get the preview image of this contributor. The

Specified by:

getPreviewImage in interface IWizardContributor

Returns:

a preview image to display in the wizard or null.

findStereotypeFromSpec

public final Stereotype findStereotypeFromSpec(MClass metaclass,
                                               java.lang.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.

setPreviewImage

public final void setPreviewImage(ImageDescriptor previewDescriptor)

Specified by:

setPreviewImage in interface IWizardContributor

Parameters:

previewDescriptor - a descriptor for the wizard preview image

getModelViewTemplateId

public final java.lang.String getModelViewTemplateId()

Description copied from interface: IWizardContributor

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

Specified by:

getModelViewTemplateId in interface IWizardContributor

Returns:

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

setModelViewTemplateId

public final void setModelViewTemplateId(java.lang.String id)

Description copied from interface: IWizardContributor

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

Specified by:

setModelViewTemplateId in interface IWizardContributor

checkCanCreateIn

protected abstract boolean checkCanCreateIn(ModelElement owner)

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

Parameters:

owner - the new element owner.

Returns:

true if the operation is allowed else false.

getIconImage

public Image getIconImage()

Default implementation returning null.

Specified by:

getIconImage in interface IWizardContributor

Returns:

the contributor small icon