org.modelio.api.module.propertiesPage

Class AbstractModulePropertyPage

java.lang.Object

org.modelio.api.module.propertiesPage.AbstractModulePropertyPage

All Implemented Interfaces:

IModulePropertyPage, IModulePropertyPanel

public abstract class AbstractModulePropertyPage
extends java.lang.Object
implements IModulePropertyPage

Abstract class of a module property page generated by the MDA Designer tool.

This class is used as a base class of the property page that is associated to a specific module.

Field Summary

Fields

Modifier and Type	Field and Description
protected IModule	module Module that is associated to the property page.

Constructor Summary

Constructors

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

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

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

changeProperty, update

Methods inherited from interface org.modelio.api.module.propertiesPage.IModulePropertyPanel

getRelevance

Field Detail

module

protected IModule module

Module that is associated to the property page.

Constructor Detail

AbstractModulePropertyPage

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

Constructors of this abstract 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

getModule

public final IModule getModule()

Description copied from interface: IModulePropertyPanel

Get the module of this property page.

Specified by:

getModule in interface IModulePropertyPanel

Returns:

the module displaying this property page.

getName

public java.lang.String getName()

Description copied from interface: IModulePropertyPanel

Get the name of the property page.

Specified by:

getName in interface IModulePropertyPanel

Returns:

the name of the property page.

getLabel

public java.lang.String getLabel()

Description copied from interface: IModulePropertyPanel

Get the label of this property page.

Specified by:

getLabel in interface IModulePropertyPanel

Returns:

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

setName

public void setName(java.lang.String name)

Description copied from interface: IModulePropertyPanel

Set the name of the property page.

Specified by:

setName in interface IModulePropertyPanel

Parameters:

name - the name of the property page.

setLabel

public void setLabel(java.lang.String label)

Description copied from interface: IModulePropertyPanel

Set the labe of this property page.

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 module)

Description copied from interface: IModulePropertyPanel

Set the module of this property page.

Specified by:

setModule in interface IModulePropertyPanel

Parameters:

module - the module owning this 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.