com.hybris.cockpitng.util

Interface WidgetUtils

All Known Implementing Classes:

DefaultWidgetUtils

public interface WidgetUtils

Utility methods for cockpitng framework engine. For internal use only.

Field Summary

Fields

Modifier and Type	Field and Description
static String	NOTIFIER_STACK

Method Summary

Modifier and Type	Method and Description
void	addGlobalEventListener(String eventName, Widgetslot widget, org.zkoss.zk.ui.event.EventListener<org.zkoss.zk.ui.event.Event> eventListener, String scope) Adds an event listener to the global event queue.
org.zkoss.zk.ui.Component	addNotifierToStack(org.zkoss.zk.ui.Component content)
org.zkoss.zk.ui.Component	addNotifierToStack(org.zkoss.zk.ui.Component content, org.zkoss.zk.ui.Component notifierStack)
default void	clearWidgetLibrary()
void	dispatchGlobalEvents() Gets all unprocessed events from the global event queue and notifies subscribers.
org.zkoss.zk.ui.Component	getCockpitRoot() Gets the root of the current desktop.
Widgetslot	getRegisteredWidgetslot(String widgetInstanceId) Gets the Widgetslot component for the given widgetInstanceId, if it has been registered for the current Desktop.
Widgetslot	getRegisteredWidgetslot(WidgetInstance widgetInstance) Gets the Widgetslot component for the given WidgetInstance, if it has been registered for the current Desktop.
org.zkoss.zk.ui.Component	getRoot() Same as getCockpitRoot().
boolean	isPartOfComposedWidget(Widget widget) Checks, if the given widget is has a group widget as ancestor.
void	refreshWidgetLibrary()
void	registerWidgetslot(Widgetslot widgetslot) Registers a Widgetslot at the current Desktop.

Field Detail

NOTIFIER_STACK

static final String NOTIFIER_STACK

See Also:

Constant Field Values

Method Detail

refreshWidgetLibrary

void refreshWidgetLibrary()

clearWidgetLibrary

default void clearWidgetLibrary()

addNotifierToStack

org.zkoss.zk.ui.Component addNotifierToStack(org.zkoss.zk.ui.Component content)

Parameters:

content - content component of the notify entry.

Returns:

returns a component that represents a notifier entry which will be created in the root notifier component. This component should be detached if not used anymore.

addNotifierToStack

org.zkoss.zk.ui.Component addNotifierToStack(org.zkoss.zk.ui.Component content,
                                             org.zkoss.zk.ui.Component notifierStack)

Parameters:

content - content component of the notify entry

notifierStack - All notifiers will be displayed in this component. If null, no notifier entries will be created at all.

Returns:

returns a component that represents a notifier entry. This component should be detached if not used anymore.

getCockpitRoot

org.zkoss.zk.ui.Component getCockpitRoot()

Gets the root of the current desktop.

isPartOfComposedWidget

boolean isPartOfComposedWidget(Widget widget)

Checks, if the given widget is has a group widget as ancestor.

addGlobalEventListener

void addGlobalEventListener(String eventName,
                            Widgetslot widget,
                            org.zkoss.zk.ui.event.EventListener<org.zkoss.zk.ui.event.Event> eventListener,
                            String scope)

Adds an event listener to the global event queue.

dispatchGlobalEvents

void dispatchGlobalEvents()
                   throws Exception

Gets all unprocessed events from the global event queue and notifies subscribers.

Throws:

Exception

getRoot

org.zkoss.zk.ui.Component getRoot()

Same as getCockpitRoot().

getRegisteredWidgetslot

Widgetslot getRegisteredWidgetslot(WidgetInstance widgetInstance)

Gets the Widgetslot component for the given WidgetInstance, if it has been registered for the current Desktop.

getRegisteredWidgetslot

Widgetslot getRegisteredWidgetslot(String widgetInstanceId)

Gets the Widgetslot component for the given widgetInstanceId, if it has been registered for the current Desktop.

registerWidgetslot

void registerWidgetslot(Widgetslot widgetslot)

Registers a Widgetslot at the current Desktop.