IMdac.ImageType, IMdac.MdacState
Modifier and Type | Field and Description |
---|---|
protected IParameterEditionModel |
parameterEditionModel |
protected List<IMdacPropertyPage> |
propertyPages |
Constructor and Description |
---|
AbstractJavaMdac(IModelingSession modelingSession,
IModule mdacHandle,
IMdacConfiguration mdacConfiguration)
Main constructor, to instantiate a new module.
|
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object obj) |
List<IMdacAction> |
getActions(ActionLocation location)
Returns the collection of
IMdacAction associated with passed location. |
IMdacConfiguration |
getConfiguration()
Get the configuration associated to this module.
|
String |
getDescription()
Used to return the module description.
|
long |
getHid()
Returns the high internal identifier of the module
|
org.eclipse.swt.graphics.Image |
getImage(IStereotype stereotype,
IMdac.ImageType type)
Get the image provided by the module for a given stereotype.
|
org.eclipse.jface.resource.ImageDescriptor |
getImageDescriptor(IStereotype stereotype,
IMdac.ImageType imageType)
Get the image descriptor provided by the module for a given stereotype.
|
ScriptEngine |
getJythonEngine()
Get the Jython scripting engine configured for having access to all the module classes and the public classes of
all required modules.
|
String |
getLabel()
Get the module label that is displayed in dialog boxes and other GUIU parts.
|
long |
getLid()
Returns the low internal identifier of the module
|
Collection<IMdacAction> |
getMdacActions(ActionLocation location)
Deprecated.
|
String |
getMdacImage()
Get the path to the image representing the mdac.
|
org.eclipse.jface.resource.ImageDescriptor |
getMdacImageDescriptor()
Returns an ImageDescriptor for this module.
|
IModule |
getModel()
Returns the
IModule model associated with this module. |
IModelComponentContributor |
getModelComponentContributor()
Get the configuration associated to this module.
|
IModelingSession |
getModelingSession()
Returns the modeling session this module is loaded into.
|
String |
getName()
Used to return the module name.
|
IParameterEditionModel |
getParametersEditionModel()
Get the parameters model as it must be shown in the module parameters edition dialog.
|
Collection<IMdacPropertyPage> |
getPropertyPages()
Return the defined property pages
|
Version |
getRequiredModelioVersion()
Returns the minimum Modelio version that authorize the MDAC to be activated.
|
IMdac.MdacState |
getState()
Returns current runtime state of this module.
|
Version |
getVersion()
Used to return the module version.
|
Collection<IWorkbenchAction> |
getWorkbenchActions(WorkbenchActionLocation location)
Deprecated.
not used anymore, kept for compatibility reasons only.
|
int |
hashCode() |
void |
init()
Method automatically called just after the creation of the mdac.
|
void |
registerAction(ActionLocation location,
IMdacAction action)
Register a module action for the contextual popupmenu(s) of the application.
|
void |
setState(IMdac.MdacState runtimeState)
Sets the runtime state of this module.
|
String |
toString() |
void |
uninit()
Method automatically called just before the disposal of the mdac.
|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
getPeerMdac, getSession
protected IParameterEditionModel parameterEditionModel
protected List<IMdacPropertyPage> propertyPages
public AbstractJavaMdac(IModelingSession modelingSession, IModule mdacHandle, IMdacConfiguration mdacConfiguration)
modelingSession
- the current session.mdacHandle
- the IModule representing this module in the model.mdacConfiguration
- the configuration of this module.public List<IMdacAction> getActions(ActionLocation location)
IMdacAction
associated with passed location.getActions
in interface IMdac
location
- the location for which actions are to be returned.IMdacAction
associated with passed location.public IMdacConfiguration getConfiguration()
getConfiguration
in interface IMdac
IMdacConfiguration
public String getDescription()
getDescription
in interface IMdac
public long getHid()
public org.eclipse.swt.graphics.Image getImage(IStereotype stereotype, IMdac.ImageType type)
public org.eclipse.jface.resource.ImageDescriptor getImageDescriptor(IStereotype stereotype, IMdac.ImageType imageType)
getImageDescriptor
in interface IMdac
stereotype
- a stereotypeimageType
- the image typepublic ScriptEngine getJythonEngine()
IMdac
MODULE : this moduleClassLoader
CLASSLOADER : the class loader of the modulegetJythonEngine
in interface IMdac
public String getLabel()
public long getLid()
@Deprecated public Collection<IMdacAction> getMdacActions(ActionLocation location)
IMdacAction
associated with passed location.getMdacActions
in interface IMdac
location
- the location for which actions are to be returned.IMdacAction
associated with passed location.public String getMdacImage()
public org.eclipse.jface.resource.ImageDescriptor getMdacImageDescriptor()
getMdacImageDescriptor
in interface IMdac
public IModelingSession getModelingSession()
getModelingSession
in interface IMdac
public String getName()
The module name corresponds to the name of the module, as defined in the MDA Designer tool.
public IParameterEditionModel getParametersEditionModel()
getParametersEditionModel
in interface IMdac
public Collection<IMdacPropertyPage> getPropertyPages()
getPropertyPages
in interface IMdac
public IModelComponentContributor getModelComponentContributor()
getModelComponentContributor
in interface IMdac
IMdacConfiguration
public Version getRequiredModelioVersion()
getRequiredModelioVersion
in interface IMdac
public Version getVersion()
getVersion
in interface IMdac
@Deprecated public Collection<IWorkbenchAction> getWorkbenchActions(WorkbenchActionLocation location)
IMdacAction
associated with passed workbench location.getWorkbenchActions
in interface IMdac
location
- the workbench location for which actions are to be returned.IMdacAction
associated with passed workbench location.public void init()
The mdac is automatically instantiated at the beginning of the mda lifecycle and the constructor implementation is not accessible to the mdac developer.
The init
method allows the developer to execute the desired initialization code at this step. For
example, this is the perfect place to register any IViewpoint this mdac provides.
This method should never be called by the developer because it is already invoked by the tool.
public void registerAction(ActionLocation location, IMdacAction action)
registerAction
in interface IMdac
location
- The action insertion point in the popupmenu (see ActionLocation
)action
- Action to storepublic IMdac.MdacState getState()
public void setState(IMdac.MdacState runtimeState)
This method is not meant to be called by clients. Use of this method can result in unspecified behaviours.
runtimeState
- the new runtime state of this module.public void uninit()
The uninit
method allows the developer to execute the desired un-initialization code at this step.
For example, if IViewpoints have been registered in the init()
method, this method is the perfect place
to remove them.
This method should never be called by the developer because it is already invoked by the tool.