org.modelio.api.module.propertiesPage

Class ElementFormPropertyPanel

java.lang.Object

org.modelio.api.module.propertiesPage.ElementFormPropertyPanel

All Implemented Interfaces:

IModulePropertyCustomPanel, IModulePropertyPanel

public abstract class ElementFormPropertyPanel
extends java.lang.Object
implements IModulePropertyCustomPanel

An IModulePropertyCustomPanel implementation displaying a form for the selected element.

SubClasses should redefine #isRelevantFor(Object) and initFactory() only.

The IPanelProvider aspect is delegated to an ElementFormPanel relying on a IFieldFactory.

Constructor Summary

Constructors

Constructor and Description
ElementFormPropertyPanel(IModule module, java.lang.String name, java.lang.String label, java.lang.String icon) Constructor invoked by Modelio when building the module's property page.

Method Summary

Modifier and Type	Method and Description
Composite	createPanel(Composite parent)
void	dispose()
java.lang.String	getHelpTopic()
java.nio.file.Path	getIcon() Get the icon path for this property page.
java.lang.Object	getInput()
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.
Composite	getPanel()
protected abstract IFieldFactory	initFactory() Initialize an instance of IFieldFactory to build the property page's form.
void	setInput(java.lang.Object input)
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.IModulePropertyPanel

getRelevance

Constructor Detail

ElementFormPropertyPanel

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

Constructor invoked by Modelio when building the module's property page.

Signature is mandatory and shouldn't be changed on the module's side.

Parameters:

module - the module this property page is build for.

name - the internal name of this property page.

label - the label displayed in Modelio for this property page.

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

Method Detail

createPanel

public final Composite createPanel(Composite parent)

dispose

public final void dispose()

getHelpTopic

public java.lang.String getHelpTopic()

getInput

public final java.lang.Object getInput()

getLabel

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

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

getPanel

public final Composite getPanel()

setInput

public final void setInput(java.lang.Object input)

setLabel

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

setName

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

initFactory

protected abstract IFieldFactory initFactory()

Initialize an instance of IFieldFactory to build the property page's form.

Called only once in the constructor.

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.