com.hybris.cockpitng.util

Class DefaultWidgetController

java.lang.Object

org.zkoss.zk.ui.event.GenericEventListener

org.zkoss.zk.ui.util.GenericComposer<T>

org.zkoss.zk.ui.util.GenericAutowireComposer<T>

org.zkoss.zk.ui.util.GenericForwardComposer<org.zkoss.zk.ui.Component>

com.hybris.cockpitng.util.ViewAnnotationAwareComposer

com.hybris.cockpitng.util.DefaultWidgetController

All Implemented Interfaces:

WidgetController, WidgetDragAndDropAware, WidgetInstanceManagerAware, Serializable, org.zkoss.zk.ui.event.EventListener, org.zkoss.zk.ui.event.SerializableEventListener, org.zkoss.zk.ui.util.ComponentActivationListener, org.zkoss.zk.ui.util.ComponentCloneListener, org.zkoss.zk.ui.util.Composer<org.zkoss.zk.ui.Component>, org.zkoss.zk.ui.util.ComposerExt<org.zkoss.zk.ui.Component>

Direct Known Subclasses:

AbstractBackofficeWidgetController, AbstractBackofficeWidgetController, AbstractInitAdvancedSearchAdapter, AuthorityGroupSelector, BackofficeMainLayoutController, BackofficeSpaceManagementController, BorderLayoutWidgetController, BreadboardController, ChatWidgetController, CollapsibleContainerController, CollectionBrowserController, CollectionEditorAreaController, CollectionPreviewController, CompareViewController, ConceptActionWidgetController, ConceptL10nWidgetController, ConceptWidgetController, ConditionEvaluatorWidgetController, ConfigurableFlowController, DashboardWidgetController, DataPassingWidgetController, DefaultEditorAreaController, DefaultFlowWidgetController, EditorExampleMVCController, EditorWidgetController, EventAcceptorWidgetController, EventProducerWidgetController, ExampleDefaultWidgetController, ExampleWysiwygWidgetController, ExplorerTreeController, ExtendedSplitLayoutWidgetController, FlexibleLayoutWidgetController, GlobalLinksController, HtmlBasedWidgetController, InputTestController, MapEditorsDemoController, MultiplexerController, NavigationHistoryController, NetworkChartController, NextItemSelectorController, NotGateController, NotificationController, OutputTestWidgetController, PermissionManagementController, PermissionManagementGroupController, PerspectiveChooserWidgetController, PreviousItemSelectorController, PropertyExtractorController, QuickListController, QuickToggleLocaleController, ReferenceAdvancedSearchController, RefineByController, SimpleCastController, SimpleListController, SplitterLayoutController, SummaryViewController, SystemBarController, TabWidgetController, TextSearchController, ToolbarWidgetController, TryitWidgetController, UserRoleChooserWidgetController, ValueChooserController, ViewSwitcherWidgetController

public class DefaultWidgetController
extends ViewAnnotationAwareComposer
implements WidgetController, WidgetInstanceManagerAware, WidgetDragAndDropAware

See Also:

Serialized Form

Field Summary

Fields inherited from class org.zkoss.zk.ui.util.GenericAutowireComposer

_separator, application, applicationScope, arg, componentScope, desktop, desktopScope, execution, page, pageScope, param, requestScope, self, session, sessionScope, spaceOwner, spaceScope

Fields inherited from class org.zkoss.zk.ui.util.GenericComposer

_applied

Constructor Summary

Constructors

Constructor and Description
DefaultWidgetController()

Method Summary

Modifier and Type	Method and Description
void	doAfterCompose(org.zkoss.zk.ui.Component comp) This method is final, use initialize(Component) instead.
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)
protected void	executeOperation(Operation operation, org.zkoss.zk.ui.event.EventListener<org.zkoss.zk.ui.event.Event> callbackEvent, String busyMessage) Executes an Operation in a separate thread.l
DragAndDropStrategy	getDragAndDropStrategy()
String	getLabel(String key) See WidgetInstanceManager.getLabel(String).
String	getLabel(String key, Object[] args) See WidgetInstanceManager.getLabel(String, Object[]).
WidgetModel	getModel()
<T> T	getValue(String key, Class<T> expectedClass)
protected WidgetDragAndDropStrategyRepository	getWidgetDragAndDropStrategyRepository()
WidgetInstanceManager	getWidgetInstanceManager()
String	getWidgetRoot() Returns root path prefix for the given widget.
TypedSettingsMap	getWidgetSettings()
Widgetslot	getWidgetslot()
String	getWidgetTitle() Gets the title of the current widget instance
WidgetUtils	getWidgetUtils()
protected void	initDragAndDropAwareness() Deprecated. since 6.6 we don't put beans to Widget Model
void	initialize(org.zkoss.zk.ui.Component comp) Override this method to do initialization stuff for your widget, like initialize widget settings, restore view state from viewmodel, etc.
protected void	initWidgetSetting(String key) Same as initWidgetSetting(key, "").
protected void	initWidgetSetting(String key, boolean initialValue) Same as initWidgetSetting(key, Boolean.valueOf(initialValue)).
protected void	initWidgetSetting(String key, double initialValue) Same as initWidgetSetting(key, Double.valueOf(initialValue)).
protected void	initWidgetSetting(String key, int initialValue) Same as initWidgetSetting(key, Integer.valueOf(initialValue)).
protected void	initWidgetSetting(String key, Object initialValue) Initializes a widget setting and sets an initial value if there is none, i.e.
protected void	invokeListenerMethod(Method method, org.zkoss.zk.ui.event.Event event, ViewEvent viewAnnotation) Override to intercept listener calls
void	onSocketInput(org.zkoss.zk.ui.event.Event event) Override this method to handle all input socket events.
void	preInitialize(org.zkoss.zk.ui.Component comp) Override this method to initialize widget settings.
void	sendOutput(String id, Object data) Sends an output event to the output socket with the given id.
protected void	sendOutputAfterOperation(String id, Operation operation) Same as sendOutputAfterOperation(id, operation, null, null).
protected void	sendOutputAfterOperation(String id, Operation operation, org.zkoss.zk.ui.event.EventListener<org.zkoss.zk.ui.event.Event> callbackEvent, String busyMessage) Executes an Operation in a separate thread and sends an output event to the output socket with the given id after the operation has been finished.
protected void	sendOutputAfterOperation(String id, Operation operation, String busyMessage) Same as sendOutputAfterOperation(id, operation, null, busyMessage).
void	setValue(String key, Object value)
void	setWidgetInstanceManager(WidgetInstanceManager widgetInstanceManager)
void	setWidgetTitle(String title) Sets the title of the current widget instance

Methods inherited from class com.hybris.cockpitng.util.ViewAnnotationAwareComposer

scanEventListeners

Methods inherited from class org.zkoss.zk.ui.util.GenericAutowireComposer

alert, didActivate, getPage, willClone, willPassivate

Methods inherited from class org.zkoss.zk.ui.util.GenericComposer

doCatch, doFinally

Methods inherited from class org.zkoss.zk.ui.event.GenericEventListener

bindComponent, getController, onEvent, unbindComponent

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultWidgetController

public DefaultWidgetController()

Method Detail

getWidgetInstanceManager

public WidgetInstanceManager getWidgetInstanceManager()

setWidgetInstanceManager

public void setWidgetInstanceManager(WidgetInstanceManager widgetInstanceManager)

Specified by:

setWidgetInstanceManager in interface WidgetInstanceManagerAware

preInitialize

public void preInitialize(org.zkoss.zk.ui.Component comp)

Override this method to initialize widget settings. Do not refer to view components since they may not have been wired yet.

initialize

public void initialize(org.zkoss.zk.ui.Component comp)

Override this method to do initialization stuff for your widget, like initialize widget settings, restore view state from viewmodel, etc. This method will be invoked by doAfterCompose(Component) everytime your widget view is created. See GenericForwardComposer.doAfterCompose(Component) for more details.

doBeforeComposeChildren

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

Specified by:

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

Overrides:

doBeforeComposeChildren in class org.zkoss.zk.ui.util.GenericComposer<org.zkoss.zk.ui.Component>

Throws:

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)

Specified by:

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

Overrides:

doBeforeCompose in class org.zkoss.zk.ui.util.GenericComposer<org.zkoss.zk.ui.Component>

doAfterCompose

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

This method is final, use initialize(Component) instead.

Specified by:

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

Overrides:

doAfterCompose in class ViewAnnotationAwareComposer

Throws:

Exception

getWidgetRoot

public String getWidgetRoot()

Returns root path prefix for the given widget. All resource paths within the widget must be preceded by this.

getWidgetslot

public Widgetslot getWidgetslot()

getModel

public WidgetModel getModel()

Specified by:

getModel in interface WidgetController

setValue

public void setValue(String key,
                     Object value)

getValue

public <T> T getValue(String key,
                      Class<T> expectedClass)

invokeListenerMethod

protected final void invokeListenerMethod(Method method,
                                          org.zkoss.zk.ui.event.Event event,
                                          ViewEvent viewAnnotation)
                                   throws IllegalAccessException,
                                          InvocationTargetException

Description copied from class: ViewAnnotationAwareComposer

Override to intercept listener calls

Overrides:

invokeListenerMethod in class ViewAnnotationAwareComposer

Throws:

IllegalAccessException

InvocationTargetException

initWidgetSetting

protected void initWidgetSetting(String key,
                                 Object initialValue)

Initializes a widget setting and sets an initial value if there is none, i.e. this method does nothing if there is already a value set for the given key. A common place to invoke this method is within initialize(Component).

initWidgetSetting

protected void initWidgetSetting(String key)

Same as initWidgetSetting(key, "").

initWidgetSetting

protected void initWidgetSetting(String key,
                                 int initialValue)

Same as initWidgetSetting(key, Integer.valueOf(initialValue)).

initWidgetSetting

protected void initWidgetSetting(String key,
                                 boolean initialValue)

Same as initWidgetSetting(key, Boolean.valueOf(initialValue)).

initWidgetSetting

protected void initWidgetSetting(String key,
                                 double initialValue)

Same as initWidgetSetting(key, Double.valueOf(initialValue)).

sendOutput

public final void sendOutput(String id,
                             Object data)

Sends an output event to the output socket with the given id.

Parameters:

id - The output socket id.

data - The data to send or null.

getLabel

public String getLabel(String key)

See WidgetInstanceManager.getLabel(String).

getLabel

public String getLabel(String key,
                       Object[] args)

See WidgetInstanceManager.getLabel(String, Object[]).

sendOutputAfterOperation

protected final void sendOutputAfterOperation(String id,
                                              Operation operation)

Same as sendOutputAfterOperation(id, operation, null, null).

sendOutputAfterOperation

protected final void sendOutputAfterOperation(String id,
                                              Operation operation,
                                              String busyMessage)

Same as sendOutputAfterOperation(id, operation, null, busyMessage).

sendOutputAfterOperation

protected final void sendOutputAfterOperation(String id,
                                              Operation operation,
                                              org.zkoss.zk.ui.event.EventListener<org.zkoss.zk.ui.event.Event> callbackEvent,
                                              String busyMessage)

Executes an Operation in a separate thread and sends an output event to the output socket with the given id after the operation has been finished.

Parameters:

id - The output socket id.

operation - The operation to execute.

callbackEvent - An optional callback event listener that is invoked after the output event has been sent.

busyMessage - A busy message that should be displayed while the operation is executed.

executeOperation

protected final void executeOperation(Operation operation,
                                      org.zkoss.zk.ui.event.EventListener<org.zkoss.zk.ui.event.Event> callbackEvent,
                                      String busyMessage)

Executes an Operation in a separate thread.l

Parameters:

operation - The operation to execute.

callbackEvent - An optional callback event listener that is invoked after the operation has been finished.

busyMessage - A busy message that should be displayed while the operation is executed.

onSocketInput

public void onSocketInput(org.zkoss.zk.ui.event.Event event)

Override this method to handle all input socket events.

Parameters:

event - Usually an instance of ForwardEvent. Use ForwardEvent.getOrigin() to get the original event.

getWidgetSettings

public TypedSettingsMap getWidgetSettings()

Specified by:

getWidgetSettings in interface WidgetController

getWidgetUtils

public WidgetUtils getWidgetUtils()

getWidgetTitle

public String getWidgetTitle()

Gets the title of the current widget instance

setWidgetTitle

public void setWidgetTitle(String title)

Sets the title of the current widget instance

initDragAndDropAwareness

@Deprecated
protected void initDragAndDropAwareness()

Deprecated. since 6.6 we don't put beans to Widget Model

getDragAndDropStrategy

public DragAndDropStrategy getDragAndDropStrategy()

Specified by:

getDragAndDropStrategy in interface WidgetDragAndDropAware

getWidgetDragAndDropStrategyRepository

protected WidgetDragAndDropStrategyRepository getWidgetDragAndDropStrategyRepository()