org.modelio.api.module.propertiesPage

Class ModuleMultiVariantPropertyPanel

java.lang.Object

org.modelio.api.module.propertiesPage.ModuleMultiVariantPropertyPanel

All Implemented Interfaces:

IModulePropertyCustomPanel, IModulePropertyPanel

public class ModuleMultiVariantPropertyPanel
extends java.lang.Object
implements IModulePropertyCustomPanel

The ModuleMultiVariantPropertyPanel is an implementation of IModulePropertyCustomPanel that supports different GUI depending on the element to display.
For this purpose, the developer is invited to register different IPanelProvider instances associated to selection conditions.
The conditions for a IPanelProvider instance to be used for a given element are made of two criteria:

• an ElementScope criterion where the given element must satisfy the ElementScope.isMatching(MObject) method
• an optional IElementFilter where the given element must satisfy the the IElementFilter.accept(MObject) method

IPanelProvider instances are registered along with their applicability conditions in a map where they are looked up for when the setInput(Object) is called. The ModuleMultiVariantPropertyPanel chooses the first condition matching IPanelProvider which becomes the activePanelProvider that is in charge of displaying the element properties. When no matching IPanelProvider is found a statically predefined "empty" panel provider is used EMPTYPANELPROVIDER that simply display an empty GUI.

Since:

4.1

Constructor Summary

Constructors

Constructor and Description
ModuleMultiVariantPropertyPanel(IModule module, java.lang.String name, java.lang.String label, java.lang.String icon) Constructors of this property page.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	createPanel(Composite parent) From interface IPanelProvider Create the GUI for the ModuleMultiVariantPropertyPanel.
void	dispose() From IPanelProvider
protected IPanelProvider	getActivePanelProvider()
java.lang.String	getHelpTopic() From interface IPanelProvider.
java.nio.file.Path	getIcon() Get the icon path for this property page.
java.lang.Object	getInput() From interface IPanelProvider
java.lang.String	getLabel() from IModulePropertyPanel
IModule	getModule() from IModulePropertyPanel
java.lang.String	getName() from IModulePropertyPanel
java.lang.Object	getPanel() From interface IPanelProvider
boolean	isRelevantFor(java.lang.Object proposedInput) From interface IPanelProvider.
void	register(IPanelProvider panelProvider, ElementScope scope) Register an IPanelProvider for the given scope.
void	register(IPanelProvider panelProvider, ElementScope scope, IElementFilter filter) Register an IPanelProvider for the given scope and under the additional filter condition.
void	setInput(java.lang.Object input) From interface IPanelProvider.
void	setLabel(java.lang.String label) from IModulePropertyPanel
void	setModule(IModule mdac) from IModulePropertyPanel
void	setName(java.lang.String name) from IModulePropertyPanel

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.propertiesPage.IModulePropertyPanel

getRelevance

Constructor Detail

ModuleMultiVariantPropertyPanel

public ModuleMultiVariantPropertyPanel(IModule module,
                                       java.lang.String name,
                                       java.lang.String label,
                                       java.lang.String icon)

Constructors of this property page.

Parameters:

module - module that is associated to the property page

name - the name of the property page.

label - the label of the property page.

icon - a relative path to the image to display for the property page.

Method Detail

createPanel

public java.lang.Object createPanel(Composite parent)

From interface IPanelProvider Create the GUI for the ModuleMultiVariantPropertyPanel. The GUI is mainly a Composite using a stack layout to switch between the different registered panels.

dispose

public void dispose()

From IPanelProvider

getHelpTopic

public java.lang.String getHelpTopic()

From interface IPanelProvider. Simply delegate to currently active panel.

getInput

public java.lang.Object getInput()

From interface IPanelProvider

getLabel

public java.lang.String getLabel()

from IModulePropertyPanel

Specified by:

getLabel in interface IModulePropertyPanel

Returns:

the text that will be displayed in the property page's label.

getModule

public IModule getModule()

from IModulePropertyPanel

Specified by:

getModule in interface IModulePropertyPanel

Returns:

the module displaying this property page.

getName

public java.lang.String getName()

from IModulePropertyPanel

Specified by:

getName in interface IModulePropertyPanel

Returns:

the name of the property page.

getPanel

public java.lang.Object getPanel()

From interface IPanelProvider

isRelevantFor

public boolean isRelevantFor(java.lang.Object proposedInput)

From interface IPanelProvider. The resolution of isRelevantFor() consists in:

1. get the proper IPanelProvider for the input
2. call this IPanelProvider isRelevantFor() method

The method does not switch the currently active panel.

register

public void register(IPanelProvider panelProvider,
                     ElementScope scope)

Register an IPanelProvider for the given scope.

Parameters:

panelProvider - the IPanelProvider to register. Cannot be null.

scope - the scope for which the panel provider is applicable. Cannot be null.

register

public void register(IPanelProvider panelProvider,
                     ElementScope scope,
                     IElementFilter filter)

Register an IPanelProvider for the given scope and under the additional filter condition.

Parameters:

panelProvider - the IPanelProvider to register. Cannot be null.

scope - the scope for which the panel provider is applicable. Cannot be null.

filter - the additional filter the element must pass once its scope has been approved. Cannot be null.

setInput

public void setInput(java.lang.Object input)

From interface IPanelProvider. Switch the currently activated panel to the proper panel for proposed input and pass the input to this new activated panel.

setLabel

public void setLabel(java.lang.String label)

from IModulePropertyPanel

Specified by:

setLabel in interface IModulePropertyPanel

Parameters:

label - the text that will be displayed in the property page's label.

setModule

public void setModule(IModule mdac)

from IModulePropertyPanel

Specified by:

setModule in interface IModulePropertyPanel

Parameters:

mdac - the module owning this property page.

setName

public void setName(java.lang.String name)

from IModulePropertyPanel

Specified by:

setName in interface IModulePropertyPanel

Parameters:

name - the name of the property page.

getIcon

public java.nio.file.Path getIcon()

Description copied from interface: IModulePropertyPanel

Get the icon path for this property page.

Modelio is in charge of loading/disposing this image along with the property page itself.

Specified by:

getIcon in interface IModulePropertyPanel

Returns:

a fully qualified path to an Image to display for this property page. Might be null.

getActivePanelProvider

protected final IPanelProvider getActivePanelProvider()