templates.model
Interface TemplateComponent

All Superinterfaces:

ides.api.core.Annotable, ides.api.plugin.model.DESElement

All Known Implementing Classes:

Component

public interface TemplateComponent
extends ides.api.plugin.model.DESElement

Describes a component in a template design, namely a module or a channel.

Author:

Lenko Grigorov

Field Summary

static int	TYPE_CHANNEL Specifies the type of components which are channels.
static int	TYPE_MODULE Specifies the type of components which are modules.

Fields inherited from interface ides.api.core.Annotable

COMPOSED_OF, COMPOSED_OF_NAMES, CONTROL_MAP, FILE, LAYOUT, TEXT_ANNOTATION

Method Summary

ides.api.model.fsa.FSAModel	getModel() Retrieve the FSAModel associated with the component.
int	getType() Retrieve the type of the component.
boolean	hasModel() Checks if there is an FSAModel associated with the component.
void	setModel(ides.api.model.fsa.FSAModel fsa) Assign the FSAModel to be associated with the component.
void	setType(int type) Sets the type of the component.

Methods inherited from interface ides.api.plugin.model.DESElement

getId, setId

Methods inherited from interface ides.api.core.Annotable

getAnnotation, hasAnnotation, removeAnnotation, setAnnotation

Field Detail

TYPE_MODULE

static final int TYPE_MODULE

Specifies the type of components which are modules.

See Also:

Constant Field Values

TYPE_CHANNEL

static final int TYPE_CHANNEL

Specifies the type of components which are channels.

See Also:

Constant Field Values

Method Detail

getType

int getType()

Retrieve the type of the component.

Returns:

TYPE_MODULE or TYPE_CHANNEL

setType

void setType(int type)

Sets the type of the component.

Parameters:

type - the type of the component (TYPE_MODULE or TYPE_CHANNEL)

getModel

ides.api.model.fsa.FSAModel getModel()

Retrieve the FSAModel associated with the component.

Returns:

the FSAModel associated with the component; null if no FSAModel is associated

setModel

void setModel(ides.api.model.fsa.FSAModel fsa)

Assign the FSAModel to be associated with the component.

Parameters:

fsa - the FSAModel to be associated with the component

hasModel

boolean hasModel()

Checks if there is an FSAModel associated with the component.

Returns:

true if the associated FSAModel is not null; false otherwise