de.hybris.platform.cockpit.widgets.impl

Class AbstractWidget<T extends WidgetModel,U extends WidgetController>

java.lang.Object

Div

de.hybris.platform.cockpit.widgets.impl.AbstractWidget<T,U>

All Implemented Interfaces:

FocusableComponent, WidgetModelListener, Widget<T,U>

Direct Known Subclasses:

DefaultWidget

public abstract class AbstractWidget<T extends WidgetModel,U extends WidgetController>
extends Div
implements Widget<T,U>

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	LAZY_LOAD_EVT_KEY

Constructor Summary

Constructors

Constructor and Description
AbstractWidget() Creates a new widget instance.

Method Summary

Modifier and Type	Method and Description
abstract void	cleanup() Called whenever this widget is invalidated or when a cleanup is needed.
HtmlBasedComponent	getCaption() Returns this widget's caption component.
HtmlBasedComponent	getContent() Returns this widget's content component
String	getControllerCtx() Returns this widget's controller context.
String	getWidgetCode() Returns the widget's code.
WidgetContainer	getWidgetContainer() Returns the widget container to which this widget belongs.
U	getWidgetController() Returns the widget's controller.
T	getWidgetModel() Returns the widget's (view) model.
WidgetRenderer	getWidgetRenderer() Returns the widget renderer.
String	getWidgetTitle() Returns the widget's title.
void	handleFocus(boolean focused) Called whenever the focus view state of this component should be changed.
void	initialize(Map<String,Object> params) Initializes this widget.
boolean	isFocusable() Returns whether this widget can be focused or not.
boolean	isInitialized() Returns whether this widget has been initialized or not.
boolean	isLazyLoadingEnabled() Returns whether content lazy loading is enabled or not.
protected void	setCaption(HtmlBasedComponent caption) Sets this widget's caption component to caption.
protected void	setContent(HtmlBasedComponent content) Sets this widget's content component to content.
void	setControllerCtx(String controllerCtx) Sets this widget's controller context i.e.
void	setFocusable(boolean focusable) Sets whether this widget can be focused or not.
void	setLazyLoadingEnabled(boolean lazyLoading) Enables or disables content lazy loading.
void	setWidgetCode(String widgetCode) Sets the widget's code.
void	setWidgetContainer(WidgetContainer container) Sets the widget container to which this widget belongs.
void	setWidgetController(U widgetController) Sets the widget's controller to controller.
void	setWidgetModel(T model) Sets the widget's (view) model.
void	setWidgetRenderer(WidgetRenderer widgetRenderer) Sets the widget renderer.
void	setWidgetTitle(String title) Sets the widget's title to title.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface de.hybris.platform.cockpit.widgets.events.WidgetModelListener

onModelEvent

Field Detail

LAZY_LOAD_EVT_KEY

protected static final String LAZY_LOAD_EVT_KEY

See Also:

Constant Field Values

Constructor Detail

AbstractWidget

public AbstractWidget()

Creates a new widget instance.

Method Detail

initialize

public void initialize(Map<String,Object> params)

Description copied from interface: Widget

Initializes this widget.

Specified by:

initialize in interface Widget<T extends WidgetModel,U extends WidgetController>

Parameters:

params - initialization parameters

isInitialized

public boolean isInitialized()

Description copied from interface: Widget

Returns whether this widget has been initialized or not.

Specified by:

isInitialized in interface Widget<T extends WidgetModel,U extends WidgetController>

Returns:

true if widget has been initialized, false otherwise

handleFocus

public void handleFocus(boolean focused)

Description copied from interface: FocusableComponent

Called whenever the focus view state of this component should be changed.

Specified by:

handleFocus in interface FocusableComponent

Parameters:

focused - true if the component should be rendered as focused, false otherwise

cleanup

public abstract void cleanup()

Description copied from interface: Widget

Called whenever this widget is invalidated or when a cleanup is needed.

Typically unregisters itself and releases any acquired resources.

Specified by:

cleanup in interface Widget<T extends WidgetModel,U extends WidgetController>

getContent

public HtmlBasedComponent getContent()

Description copied from interface: Widget

Returns this widget's content component

Specified by:

getContent in interface Widget<T extends WidgetModel,U extends WidgetController>

Returns:

the content component

See Also:

WidgetRenderer.createContent(Widget)

setContent

protected void setContent(HtmlBasedComponent content)

Sets this widget's content component to content.

Note: If a content component has already been set the old one will be removed.

Parameters:

content - content component

getCaption

public HtmlBasedComponent getCaption()

Description copied from interface: Widget

Returns this widget's caption component.

Specified by:

getCaption in interface Widget<T extends WidgetModel,U extends WidgetController>

Returns:

the caption component

See Also:

WidgetRenderer.createCaption(Widget)

setCaption

protected void setCaption(HtmlBasedComponent caption)

Sets this widget's caption component to caption.

Note: If a caption component has already been set the old one will be removed.

Parameters:

caption - caption component

setWidgetContainer

public void setWidgetContainer(WidgetContainer container)

Description copied from interface: Widget

Sets the widget container to which this widget belongs.

Specified by:

setWidgetContainer in interface Widget<T extends WidgetModel,U extends WidgetController>

Parameters:

container - widget container

getWidgetContainer

public WidgetContainer getWidgetContainer()

Description copied from interface: Widget

Returns the widget container to which this widget belongs.

Specified by:

getWidgetContainer in interface Widget<T extends WidgetModel,U extends WidgetController>

Returns:

this widget's widget container

setWidgetModel

public void setWidgetModel(T model)

Description copied from interface: Widget

Sets the widget's (view) model.

Specified by:

setWidgetModel in interface Widget<T extends WidgetModel,U extends WidgetController>

Parameters:

model - the model

getWidgetModel

public T getWidgetModel()

Description copied from interface: Widget

Returns the widget's (view) model.

Specified by:

getWidgetModel in interface Widget<T extends WidgetModel,U extends WidgetController>

Returns:

widget's model or null if no model is available

setWidgetCode

public void setWidgetCode(String widgetCode)

Description copied from interface: Widget

Sets the widget's code.

The code of a widget is used for focus handling and internal mapping, thus it is important that widgets' codes are unique within one WidgetContainer.

Specified by:

setWidgetCode in interface Widget<T extends WidgetModel,U extends WidgetController>

Parameters:

widgetCode - widget code

getWidgetCode

public String getWidgetCode()

Description copied from interface: Widget

Returns the widget's code.

Specified by:

getWidgetCode in interface Widget<T extends WidgetModel,U extends WidgetController>

Returns:

this widget's code

See Also:

Widget.setWidgetCode(String)

setWidgetRenderer

public void setWidgetRenderer(WidgetRenderer widgetRenderer)

Description copied from interface: Widget

Sets the widget renderer.

Specified by:

setWidgetRenderer in interface Widget<T extends WidgetModel,U extends WidgetController>

Parameters:

widgetRenderer - widget renderer

getWidgetRenderer

public WidgetRenderer getWidgetRenderer()

Description copied from interface: Widget

Returns the widget renderer.

Specified by:

getWidgetRenderer in interface Widget<T extends WidgetModel,U extends WidgetController>

Returns:

widget renderer

setFocusable

public void setFocusable(boolean focusable)

Description copied from interface: Widget

Sets whether this widget can be focused or not.

Specified by:

setFocusable in interface Widget<T extends WidgetModel,U extends WidgetController>

Parameters:

focusable - true means focusing is enabled, false means disabled

isFocusable

public boolean isFocusable()

Description copied from interface: Widget

Returns whether this widget can be focused or not.

Specified by:

isFocusable in interface Widget<T extends WidgetModel,U extends WidgetController>

Returns:

true if focusing is enabled, false otherwise

setWidgetController

public void setWidgetController(U widgetController)

Description copied from interface: Widget

Sets the widget's controller to controller.

Specified by:

setWidgetController in interface Widget<T extends WidgetModel,U extends WidgetController>

Parameters:

widgetController - widget controller

getWidgetController

public U getWidgetController()

Description copied from interface: Widget

Returns the widget's controller.

Specified by:

getWidgetController in interface Widget<T extends WidgetModel,U extends WidgetController>

Returns:

widget controller

setControllerCtx

public void setControllerCtx(String controllerCtx)

Description copied from interface: Widget

Sets this widget's controller context i.e. the context for which this widget should use when dealing with its controller.

Specified by:

setControllerCtx in interface Widget<T extends WidgetModel,U extends WidgetController>

Parameters:

controllerCtx - controller context code

getControllerCtx

public String getControllerCtx()

Description copied from interface: Widget

Returns this widget's controller context.

Specified by:

getControllerCtx in interface Widget<T extends WidgetModel,U extends WidgetController>

Returns:

controller context code

isLazyLoadingEnabled

public boolean isLazyLoadingEnabled()

Description copied from interface: Widget

Returns whether content lazy loading is enabled or not.

Specified by:

isLazyLoadingEnabled in interface Widget<T extends WidgetModel,U extends WidgetController>

Returns:

true if lazy loading is enabled, false otherwise

setLazyLoadingEnabled

public void setLazyLoadingEnabled(boolean lazyLoading)

Description copied from interface: Widget

Enables or disables content lazy loading.

Specified by:

setLazyLoadingEnabled in interface Widget<T extends WidgetModel,U extends WidgetController>

Parameters:

lazyLoading - lazy loading

setWidgetTitle

public void setWidgetTitle(String title)

Description copied from interface: Widget

Sets the widget's title to title.

Specified by:

setWidgetTitle in interface Widget<T extends WidgetModel,U extends WidgetController>

Parameters:

title - widget title as either i3-label key or direct value

getWidgetTitle

public String getWidgetTitle()

Description copied from interface: Widget

Returns the widget's title.

Note: This method will return the raw title as set by previous call to Widget.setWidgetTitle(String) i.e. in the case of an i3-label key, no evaluation is done.

Specified by:

getWidgetTitle in interface Widget<T extends WidgetModel,U extends WidgetController>

Returns:

widget's title