Package org.ametys.runtime.model

Interface ModelViewItem<T extends ModelItem>

Type Parameters:

T - type of the referenced model item

All Superinterfaces:

Labelable, ModifiableLabelable, ViewItem

All Known Subinterfaces:

SearchModelCriterionViewItem<T>, SearchUIColumn<T>

All Known Implementing Classes:

DefaultSearchModelCriterionViewItem, ModelViewItemGroup, RepeaterSearchUIColumn, RepeaterViewItem, ViewElement, ViewElementAccessor, ViewElementAccessorSearchUIColumn, ViewElementSearchUIColumn

public interface ModelViewItem<T extends ModelItem>
extends ViewItem

Interface for view references to model items

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	ModelViewItem.DisabledItemRendering	Determine the rendering of the item when it is disabled

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_ITEM_TAG_NAME	The default tag name to use while generating SAX events

Method Summary

Modifier and Type	Method	Description
T	getDefinition()	Retrieves the referenced model item definition
ModelViewItem.DisabledItemRendering	getDisabledItemRendering()	Retrieves the rendering of the view item when it is disabled
default String	getName()	Get the name.
void	setDefinition(T definition)	Sets the referenced model item definition
void	setDisabledItemRendering(ModelViewItem.DisabledItemRendering disabledItemRendering)	Sets the rendering of the view item when it is disabled
default void	setName(String name)	Set the name.

Methods inherited from interface org.ametys.runtime.util.Labelable

getDescription, getLabel

Methods inherited from interface org.ametys.runtime.util.ModifiableLabelable

setDescription, setLabel

Methods inherited from interface org.ametys.runtime.model.ViewItem

copyTo, copyTo, createInstance, equals, getParent, setParent, toJSON, toSAX

Field Details

DEFAULT_ITEM_TAG_NAME

static final String DEFAULT_ITEM_TAG_NAME

The default tag name to use while generating SAX events

See Also:

• Constant Field Values

Method Details

getDefinition

T getDefinition()

Retrieves the referenced model item definition

Returns:

the referenced definition

setDefinition

void setDefinition(T definition)

Sets the referenced model item definition

Parameters:

definition - the referenced definition

getDisabledItemRendering

ModelViewItem.DisabledItemRendering getDisabledItemRendering()

Retrieves the rendering of the view item when it is disabled

Returns:

the rendering of the view item when it is disabled

setDisabledItemRendering

void setDisabledItemRendering(ModelViewItem.DisabledItemRendering disabledItemRendering)

Sets the rendering of the view item when it is disabled

Parameters:

disabledItemRendering - the rendering to set

getName

default String getName()

Description copied from interface: Labelable

Get the name.

Specified by:

getName in interface Labelable

Returns:

the name.

setName

default void setName(String name)

Description copied from interface: ModifiableLabelable

Set the name.

Specified by:

setName in interface ModifiableLabelable

Parameters:

name - the name.