org.modelio.api.module.propertiesPage

Interface IModulePropertyPanel

All Known Subinterfaces:

IModulePropertyCustomPanel, IModulePropertyPage

All Known Implementing Classes:

AbstractModulePropertyPage, ElementFormPropertyPanel, ModuleMultiVariantPropertyPanel

public interface IModulePropertyPanel

This interface defines the property page of a module.

Method Summary

Modifier and Type	Method and Description
java.nio.file.Path	getIcon() Get the icon path for this property page.
java.lang.String	getLabel() Get the label of this property page.
IModule	getModule() Get the module of this property page.
java.lang.String	getName() Get the name of the property page.
default java.lang.String	getRelevance() Return the relevance criterion used to reorder the contributed panels in the edition dialog.
void	setLabel(java.lang.String label) Set the labe of this property page.
void	setModule(IModule module) Set the module of this property page.
void	setName(java.lang.String name) Set the name of the property page.

Method Detail

getName

java.lang.String getName()

Get the name of the property page.

Returns:

the name of the property page.

getLabel

java.lang.String getLabel()

Get the label of this property page.

Returns:

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

getModule

IModule getModule()

Get the module of this property page.

Returns:

the module displaying this property page.

setName

void setName(java.lang.String name)

Set the name of the property page.

Parameters:

name - the name of the property page.

setLabel

void setLabel(java.lang.String label)

Set the labe of this property page.

Parameters:

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

setModule

void setModule(IModule module)

Set the module of this property page.

Parameters:

module - the module owning this property page.

getRelevance

default java.lang.String getRelevance()

Return the relevance criterion used to reorder the contributed panels in the edition dialog.

Returns:

a string matching the name of the module providing the panel or the MDA extensions managed by the panel (might be different of this module)

Since:

3.6

getIcon

java.nio.file.Path getIcon()

Get the icon path for this property page.

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

Returns:

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

Since:

4.1