Package com.hybris.cockpitng.util

Class BindWidgetController

java.lang.Object

org.zkoss.bind.BindComposer<org.zkoss.zk.ui.Component>

com.hybris.cockpitng.util.BindWidgetController

All Implemented Interfaces:

WidgetController, WidgetInstanceManagerAware, java.io.Serializable, org.zkoss.zk.au.AuService, org.zkoss.zk.ui.util.ComponentActivationListener, org.zkoss.zk.ui.util.Composer<org.zkoss.zk.ui.Component>, org.zkoss.zk.ui.util.ComposerExt<org.zkoss.zk.ui.Component>

public class BindWidgetController
extends org.zkoss.bind.BindComposer<org.zkoss.zk.ui.Component>
implements WidgetController, WidgetInstanceManagerAware

A MVVM bind composer based widget controller. Used as a widget controller for widgets with a MVVM view model. It is not to be used directly. To access the widget framework functionality from your MVVM view model you need to make it WidgetInstanceManager-aware by implementing the interface WidgetInstanceManagerAware. The injected WidgetInstanceManager will allow you to send data to output sockets, access the widget settings and the widget model to store view related data in the session scope.

See Also:

Serialized Form

Field Summary

Fields inherited from class org.zkoss.bind.BindComposer

BINDER_ATTR, BINDER_ID, ID_ANNO, INIT_ANNO, QUEUE_NAME_ANNO_ATTR, QUEUE_SCOPE_ANNO_ATTR, VALIDATION_MESSAGES_ATTR, VALUE_ANNO_ATTR, VIEW_MODEL_ATTR, VM_ID

Constructor Summary

Constructors

Constructor	Description
BindWidgetController()

Method Summary

Modifier and Type	Method	Description
protected void	bindSockets(org.zkoss.zk.ui.Component comp, java.lang.Object viewModel, WidgetDefinition widgetDefinition)
void	doAfterCompose(org.zkoss.zk.ui.Component comp)
org.zkoss.zk.ui.metainfo.ComponentInfo	doBeforeCompose(org.zkoss.zk.ui.Page page, org.zkoss.zk.ui.Component parent, org.zkoss.zk.ui.metainfo.ComponentInfo compInfo)
void	doBeforeComposeChildren(org.zkoss.zk.ui.Component comp)
WidgetModel	getModel()
java.lang.String	getViewModelID()
TypedSettingsMap	getWidgetSettings()
void	sendOutput(java.lang.String socketId, java.lang.Object data)
void	setViewModelId(java.lang.String viewModelIDArg)
void	setWidgetDefinition(WidgetDefinition definitionArg)
void	setWidgetInstanceManager(WidgetInstanceManager widgetInstanceManager)
void	setWidgetslot(Widgetslot widgetslot)

Methods inherited from class org.zkoss.bind.BindComposer

addConverter, addValidator, didActivate, doCatch, doFinally, getBinder, getConverter, getValidator, getViewModel, notifyChange, service, setViewModel, willPassivate

Methods inherited from class java.lang.Object

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

Constructor Detail

BindWidgetController

public BindWidgetController()

Method Detail

doBeforeComposeChildren

public void doBeforeComposeChildren(org.zkoss.zk.ui.Component comp)
                             throws java.lang.Exception

Specified by:

doBeforeComposeChildren in interface org.zkoss.zk.ui.util.ComposerExt<org.zkoss.zk.ui.Component>

Overrides:

doBeforeComposeChildren in class org.zkoss.bind.BindComposer<org.zkoss.zk.ui.Component>

Throws:

java.lang.Exception

doBeforeCompose

public org.zkoss.zk.ui.metainfo.ComponentInfo doBeforeCompose(org.zkoss.zk.ui.Page page,
                                                              org.zkoss.zk.ui.Component parent,
                                                              org.zkoss.zk.ui.metainfo.ComponentInfo compInfo)
                                                       throws java.lang.Exception

Specified by:

doBeforeCompose in interface org.zkoss.zk.ui.util.ComposerExt<org.zkoss.zk.ui.Component>

Overrides:

doBeforeCompose in class org.zkoss.bind.BindComposer<org.zkoss.zk.ui.Component>

Throws:

java.lang.Exception

doAfterCompose

public void doAfterCompose(org.zkoss.zk.ui.Component comp)
                    throws java.lang.Exception

Specified by:

doAfterCompose in interface org.zkoss.zk.ui.util.Composer<org.zkoss.zk.ui.Component>

Overrides:

doAfterCompose in class org.zkoss.bind.BindComposer<org.zkoss.zk.ui.Component>

Throws:

java.lang.Exception

bindSockets

protected void bindSockets(org.zkoss.zk.ui.Component comp,
                           java.lang.Object viewModel,
                           WidgetDefinition widgetDefinition)

setWidgetslot

public void setWidgetslot(Widgetslot widgetslot)

sendOutput

public void sendOutput(java.lang.String socketId,
                       java.lang.Object data)

getWidgetSettings

public TypedSettingsMap getWidgetSettings()

Specified by:

getWidgetSettings in interface WidgetController

setViewModelId

public void setViewModelId(java.lang.String viewModelIDArg)

getViewModelID

public java.lang.String getViewModelID()

setWidgetDefinition

public void setWidgetDefinition(WidgetDefinition definitionArg)

getModel

public WidgetModel getModel()

Specified by:

getModel in interface WidgetController

setWidgetInstanceManager

public void setWidgetInstanceManager(WidgetInstanceManager widgetInstanceManager)

Specified by:

setWidgetInstanceManager in interface WidgetInstanceManagerAware