de.hybris.platform.cockpit.widgets.adapters

Interface WidgetAdapter<T extends WidgetModel,U extends WidgetController>

Type Parameters:

T - widget model type

U - widget controller type

All Superinterfaces:

CockpitEventAcceptor

All Known Implementing Classes:

AbstractWidgetAdapter

public interface WidgetAdapter<T extends WidgetModel,U extends WidgetController>
extends CockpitEventAcceptor

A WidgetAdapter typically ties a WidgetController and a WidgetModel together.

Widget adapters are registered as event subscribers with a WidgetController. When a WidgetEvent is published, the adapter contains the logic to determine how a widget's model should be updated i.e. it "translates" the event into concrete model method calls.

See Also:

WidgetController, WidgetModel, WidgetConfig

Method Summary

Modifier and Type	Method and Description
java.lang.String	getControllerCtx() Returns the widget controller context code.
U	getWidgetController() Returns the widget controller.
T	getWidgetModel() Returns the widget model.
boolean	isAutoControllerEnabled() Returns whether this adapter allows WidgetController to be set automatically.
void	setAutoControllerEnabled(boolean autoController) Sets whether this adapter allows the WidgetController to be set automatically.
void	setControllerCtx(java.lang.String ctx) Sets the widget controller context code to ctx.
void	setWidgetController(U controller) Sets the widget controller to controller.
void	setWidgetModel(T model) Sets the widget model to model.

Methods inherited from interface de.hybris.platform.cockpit.events.CockpitEventAcceptor

onCockpitEvent

Method Detail

setWidgetModel

void setWidgetModel(T model)

Sets the widget model to model.

Parameters:

model - widget model

getWidgetModel

T getWidgetModel()

Returns the widget model.

Returns:

the widget model

setWidgetController

void setWidgetController(U controller)

Sets the widget controller to controller.

Parameters:

controller - the widget controller

getWidgetController

U getWidgetController()

Returns the widget controller.

Returns:

the widget controller

setControllerCtx

void setControllerCtx(java.lang.String ctx)

Sets the widget controller context code to ctx.

Parameters:

ctx - widget controller context code

getControllerCtx

java.lang.String getControllerCtx()

Returns the widget controller context code.

Returns:

widget controller context code

setAutoControllerEnabled

void setAutoControllerEnabled(boolean autoController)

Sets whether this adapter allows the WidgetController to be set automatically.

Parameters:

autoController - true means enabled, false disabled

isAutoControllerEnabled

boolean isAutoControllerEnabled()

Returns whether this adapter allows WidgetController to be set automatically.

Returns:

true if enabled, false otherwise