com.modeliosoft.modelio.api.module.contributor.matrixcreation.standard

Class MatrixWizardStandardContributor

java.lang.Object

org.modelio.api.module.contributor.AbstractWizardContributor

com.modeliosoft.modelio.api.module.contributor.matrixcreation.AbstractMatrixWizardContributor

com.modeliosoft.modelio.api.module.contributor.matrixcreation.standard.MatrixWizardStandardContributor

All Implemented Interfaces:

IMatrixWizardContributor, IWizardContributor

public class MatrixWizardStandardContributor
extends AbstractMatrixWizardContributor

Generic implementation of IMatrixWizardContributor that creates a matrix from the attached matrix descriptor.

Used parameters:

• "stereotype" the stereotype specification.
• the matrix descriptor returned by getDescriptor()
• "use_additions" : whether or not a query can receive manual additions. The parameter value must contain "true" or "false".

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PARAM_QUERY_USE_ADDITIONS

Constructor Summary

Constructors

Constructor and Description
MatrixWizardStandardContributor()

Method Summary

Modifier and Type	Method and Description
MatrixDefinition	actionPerformed(ModelElement matrixContext, java.lang.String matrixName, java.lang.String matrixDescription) 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.
protected MatrixDescriptor	getDescriptor() Get the descriptor associated with this wizard contribution.
void	setDescriptor(MatrixDescriptor desc) initialize the descriptor associated with this wizard contribution.

Methods inherited from class com.modeliosoft.modelio.api.module.contributor.matrixcreation.AbstractMatrixWizardContributor

createExternProcessor, createMatrixValueDefinition, createQueryDefinition

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

Field Detail

PARAM_QUERY_USE_ADDITIONS

public static final java.lang.String PARAM_QUERY_USE_ADDITIONS

See Also:

Constant Field Values

Constructor Detail

MatrixWizardStandardContributor

public MatrixWizardStandardContributor()

Method Detail

actionPerformed

public MatrixDefinition actionPerformed(ModelElement matrixContext,
                                        java.lang.String matrixName,
                                        java.lang.String matrixDescription)

Description copied from class: AbstractWizardContributor

Execute the creation action.

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

Specified by:

actionPerformed in interface IMatrixWizardContributor

Specified by:

actionPerformed in interface IWizardContributor

Specified by:

actionPerformed in class AbstractWizardContributor

Parameters:

matrixContext - the model element on which the wizard is run

matrixName - the name of the element to create.

matrixDescription - the description of the element to create.

Returns:

the created model object.

setDescriptor

public void setDescriptor(MatrixDescriptor desc)

Description copied from interface: IMatrixWizardContributor

initialize the descriptor associated with this wizard contribution.

Parameters:

desc - the matrix descriptor

getDescriptor

protected MatrixDescriptor getDescriptor()

Get the descriptor associated with this wizard contribution.

Returns:

the matrix descriptor

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.

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.