Widget (hybris Commerce Suite 6.3.0.0-SNAPSHOT)

Type Parameters:

T - widget model type

U - widget controller type

All Superinterfaces:

FocusableComponent, WidgetModelListener

All Known Subinterfaces:

InputWidget<T,U>, ListboxWidget<T,U>

All Known Implementing Classes:

AbstractWidget, AutoFocusInputWidget, CaptionUpdateListboxWidget, CardPaymentWidget, DefaultInputListboxWidget, DefaultInputWidget, DefaultListboxWidget, DefaultWidget, HelpWidget
```
public interface Widget<T extends WidgetModel,U extends WidgetController>
extends WidgetModelListener, FocusableComponent
```
A Widget component is an independent view component providing a caption and a content area as well as focus handling.

See Also:

WidgetContainer, WidgetFactory, WidgetModel, WidgetController, WidgetConfig, CockpitEventAcceptor, CockpitEventProducer, FocusableComponent

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`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`	`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.
`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 enabled)` 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 controller)` Sets the widget's controller to `controller`.
`void`	`setWidgetModel(T model)` Sets the widget's (view) model.
`void`	`setWidgetRenderer(WidgetRenderer renderer)` Sets the widget renderer.
`void`	`setWidgetTitle(String title)` Sets the widget's title to `title`.

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

Methods inherited from interface de.hybris.platform.cockpit.components.FocusableComponent
handleFocus

- Method Detail
  - setWidgetCode
```
void setWidgetCode(String widgetCode)
```
    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.
    
    Parameters:
    
    widgetCode - widget code
  - getWidgetCode
```
String getWidgetCode()
```
    Returns the widget's code.
    
    Returns:
    
    this widget's code
    
    See Also:
    
    setWidgetCode(String)
  - setWidgetModel
```
void setWidgetModel(T model)
```
    Sets the widget's (view) model.
    
    Parameters:
    
    model - the model
  - getWidgetModel
```
T getWidgetModel()
```
    Returns the widget's (view) model.
    
    Returns:
    
    widget's model or null if no model is available
  - setWidgetContainer
```
void setWidgetContainer(WidgetContainer container)
```
    Sets the widget container to which this widget belongs.
    
    Parameters:
    
    container - widget container
  - getWidgetContainer
```
WidgetContainer getWidgetContainer()
```
    Returns the widget container to which this widget belongs.
    
    Returns:
    
    this widget's widget container
  - setFocusable
```
void setFocusable(boolean focusable)
```
    Sets whether this widget can be focused or not.
    
    Parameters:
    
    focusable - true means focusing is enabled, false means disabled
  - isFocusable
```
boolean isFocusable()
```
    Returns whether this widget can be focused or not.
    
    Returns:
    
    true if focusing is enabled, false otherwise
  - setWidgetTitle
```
void setWidgetTitle(String title)
```
    Sets the widget's title to title.
    
    Parameters:
    
    title - widget title as either i3-label key or direct value
  - getWidgetTitle
```
String getWidgetTitle()
```
    Returns the widget's title.
    Note: This method will return the raw title as set by previous call to setWidgetTitle(String) i.e. in the case of an i3-label key, no evaluation is done.
    
    Returns:
    
    widget's title
  - initialize
```
void initialize(Map<String,Object> params)
```
    Initializes this widget.
    
    Parameters:
    
    params - initialization parameters
  - isInitialized
```
boolean isInitialized()
```
    Returns whether this widget has been initialized or not.
    
    Returns:
    
    true if widget has been initialized, false otherwise
  - getCaption
```
HtmlBasedComponent getCaption()
```
    Returns this widget's caption component.
    
    Returns:
    
    the caption component
    
    See Also:
    
    WidgetRenderer.createCaption(Widget)
  - getContent
```
HtmlBasedComponent getContent()
```
    Returns this widget's content component
    
    Returns:
    
    the content component
    
    See Also:
    
    WidgetRenderer.createContent(Widget)
  - cleanup
```
void cleanup()
```
    Called whenever this widget is invalidated or when a cleanup is needed.
    Typically unregisters itself and releases any acquired resources.
  - setWidgetRenderer
```
void setWidgetRenderer(WidgetRenderer renderer)
```
    Sets the widget renderer.
    
    Parameters:
    
    renderer - widget renderer
  - getWidgetRenderer
```
WidgetRenderer getWidgetRenderer()
```
    Returns the widget renderer.
    
    Returns:
    
    widget renderer
  - setWidgetController
```
void setWidgetController(U controller)
```
    Sets the widget's controller to controller.
    
    Parameters:
    
    controller - widget controller
  - getWidgetController
```
U getWidgetController()
```
    Returns the widget's controller.
    
    Returns:
    
    widget controller
  - setControllerCtx
```
void setControllerCtx(String controllerCtx)
```
    Sets this widget's controller context i.e. the context for which this widget should use when dealing with its controller.
    
    Parameters:
    
    controllerCtx - controller context code
  - getControllerCtx
```
String getControllerCtx()
```
    Returns this widget's controller context.
    
    Returns:
    
    controller context code
  - setLazyLoadingEnabled
```
void setLazyLoadingEnabled(boolean enabled)
```
    Enables or disables content lazy loading.
    
    Parameters:
    
    enabled - lazy loading
  - isLazyLoadingEnabled
```
boolean isLazyLoadingEnabled()
```
    Returns whether content lazy loading is enabled or not.
    
    Returns:
    
    true if lazy loading is enabled, false otherwise

Interface Widget<T extends WidgetModel,U extends WidgetController>

Method Summary

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

Methods inherited from interface de.hybris.platform.cockpit.components.FocusableComponent

Method Detail

setWidgetCode

getWidgetCode

setWidgetModel

getWidgetModel

setWidgetContainer

getWidgetContainer

setFocusable

isFocusable

setWidgetTitle

getWidgetTitle

initialize

isInitialized

getCaption

getContent

cleanup

setWidgetRenderer

getWidgetRenderer

setWidgetController

getWidgetController

setControllerCtx

getControllerCtx

setLazyLoadingEnabled

isLazyLoadingEnabled