org.fujion.model

Interface ISupportsModel<T extends BaseComponent>

Type Parameters:

T - The type of component rendered from the model.

All Known Implementing Classes:

BasePickerComponent, ColorPicker, Columns, Combobox, ImagePicker, Listbox, Menu, Menupopup, Rows, Tabview, Treeview

public interface ISupportsModel<T extends BaseComponent>

Interface for components that support an associated model and view. Note that default implementations are provided for all but one method. Therefore, a component only needs to implement that one method.

Method Summary

Modifier and Type	Method and Description
default boolean	getDeferredRendering() Returns deferred rendering setting.
default IListModel<?>	getModel() Returns the list model, or null if none set.
default <M> IListModel<M>	getModel(Class<M> type) Returns the model for this component.
IModelAndView<T,?>	getModelAndView() Returns the model and view for this component.
default <M> IModelAndView<T,M>	getModelAndView(Class<M> type) Returns the model and view for this component.
default IPaginator	getPaginator() Returns the paging controller, if any.
default IComponentRenderer<T,?>	getRenderer() Returns the renderer, or null if none set.
default <M> IComponentRenderer<T,M>	getRenderer(Class<M> type) Returns the renderer for a specified model type.
default void	setDeferredRendering(boolean value) Sets the deferred rendering setting.
default <M> void	setModel(IListModel<M> model) Sets the list model.
default <M> void	setRenderer(IComponentRenderer<T,M> renderer) Sets the renderer.

Method Detail

getModelAndView

IModelAndView<T,?> getModelAndView()

Returns the model and view for this component.

Returns:

The model and view for this component.

getModelAndView

default <M> IModelAndView<T,M> getModelAndView(Class<M> type)

Returns the model and view for this component. The model is cast to the specified type.

Type Parameters:

M - The class of the model object.

Parameters:

type - The type of the model object.

Returns:

The model and view for this component.

getModel

@Component.PropertyGetter(value="model",
                          description="The model to be associated with the component.")
default IListModel<?> getModel()

Returns the list model, or null if none set.

Returns:

The list model, possibly null.

getModel

default <M> IListModel<M> getModel(Class<M> type)

Returns the model for this component. The model is cast to the specified type.

Type Parameters:

M - The class of the model object.

Parameters:

type - The type of the model object.

Returns:

The model this component.

setModel

@Component.PropertySetter(value="model",
                          description="The model to be associated with the component.")
default <M> void setModel(IListModel<M> model)

Sets the list model. If not null and a renderer has been set, the model will be re-rendered immediately. If null, any previous rendering will be removed.

Type Parameters:

M - The class of the model object.

Parameters:

model - The list model, or null to remove an existing one.

getRenderer

@Component.PropertyGetter(value="renderer",
                          description="The renderer to be associated with the model.")
default IComponentRenderer<T,?> getRenderer()

Returns the renderer, or null if none set.

Returns:

The renderer, possibly null.

getRenderer

default <M> IComponentRenderer<T,M> getRenderer(Class<M> type)

Returns the renderer for a specified model type.

Type Parameters:

M - The class of the model object.

Parameters:

type - The type of model object.

Returns:

The renderer, possibly null.

setRenderer

@Component.PropertySetter(value="renderer",
                          description="The renderer to be associated with the model.")
default <M> void setRenderer(IComponentRenderer<T,M> renderer)

Sets the renderer. If not null and a model has been set, the model will be re-rendered immediately. If null, any previous rendering will be removed.

Type Parameters:

M - The class of the model object.

Parameters:

renderer - The renderer, or null to remove an existing one.

getDeferredRendering

default boolean getDeferredRendering()

Returns deferred rendering setting. If true, rendering to the client is deferred until all model objects are rendered, then client updates are sent in bulk. This can be more efficient when rendering a large number of items.

Returns:

The deferred rendering setting.

setDeferredRendering

default void setDeferredRendering(boolean value)

Sets the deferred rendering setting. If true, rendering to the client is deferred until all model objects are rendered, then client updates are sent in bulk. This can be more efficient when rendering a large number of items.

Parameters:

value - The deferred rendering setting.

getPaginator

default IPaginator getPaginator()

Returns the paging controller, if any.

Returns:

The paging controller, possibly null.