com.hybris.cockpitng.engine.impl

Class AbstractComponentWidgetAdapterAware

java.lang.Object

com.hybris.cockpitng.engine.impl.AbstractComponentWidgetAdapterAware

All Implemented Interfaces:

ComponentWidgetAdapterAware

Direct Known Subclasses:

AbstractReferenceEditor, AbstractStatefulAction, ActionStubExample, CloneAction, CreateAction, DragAndDropConfigAction, EditAction, ExampleWidgetStubEditor, PrincipalPermissionAction, SearchByTypeAction, SplitLayoutChooserAction, TypePermissionAction

public abstract class AbstractComponentWidgetAdapterAware
extends Object
implements ComponentWidgetAdapterAware

Constructor Summary

Constructors

Constructor and Description
AbstractComponentWidgetAdapterAware()

Method Summary

Modifier and Type	Method and Description
void	addSocketInputEventListener(String socketId, org.zkoss.zk.ui.event.EventListener<SocketEvent> eventListener)
String	getComponentID() Gets associated component ID.
void	handleSocketInputEvent(SocketEvent event) Handles a socket input event sent to this ComponentWidgetAdapterAware instance from outside.
void	initialize(ComponentWidgetAdapter componentWidgetAdapter, String componentID) Widget adapter aware components requires ComponentWidgetAdapter for incorporate a framework wide features.
void	initializeDefaultEventListeners() Initializes default socket event listeners for the component.
void	registerStubInstance(AbstractCockpitComponentDefinition definition) Registers a particular stub widget instance for given 'non-widget' aware component
void	sendOutput(String socketId, Object data)
void	setComponentID(String componentID)
void	unregisterStubInstance() Unregisters a particular stub widget instance assocated with instance ComponentWidgetAdapterAware

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractComponentWidgetAdapterAware

public AbstractComponentWidgetAdapterAware()

Method Detail

initialize

public void initialize(ComponentWidgetAdapter componentWidgetAdapter,
                       String componentID)

Description copied from interface: ComponentWidgetAdapterAware

Widget adapter aware components requires ComponentWidgetAdapter for incorporate a framework wide features.

Specified by:

initialize in interface ComponentWidgetAdapterAware

Parameters:

componentWidgetAdapter - incorporate a framework wide features

componentID - associated componend ID

registerStubInstance

public void registerStubInstance(AbstractCockpitComponentDefinition definition)

Description copied from interface: ComponentWidgetAdapterAware

Registers a particular stub widget instance for given 'non-widget' aware component

Specified by:

registerStubInstance in interface ComponentWidgetAdapterAware

Parameters:

definition - given component definition e.g. editor definition, action definition

unregisterStubInstance

public void unregisterStubInstance()

Description copied from interface: ComponentWidgetAdapterAware

Unregisters a particular stub widget instance assocated with instance ComponentWidgetAdapterAware

Specified by:

unregisterStubInstance in interface ComponentWidgetAdapterAware

handleSocketInputEvent

public void handleSocketInputEvent(SocketEvent event)

Description copied from interface: ComponentWidgetAdapterAware

Handles a socket input event sent to this ComponentWidgetAdapterAware instance from outside.

Specified by:

handleSocketInputEvent in interface ComponentWidgetAdapterAware

Parameters:

event - a socket input event

sendOutput

public void sendOutput(String socketId,
                       Object data)

addSocketInputEventListener

public void addSocketInputEventListener(String socketId,
                                        org.zkoss.zk.ui.event.EventListener<SocketEvent> eventListener)

getComponentID

public String getComponentID()

Description copied from interface: ComponentWidgetAdapterAware

Gets associated component ID.

Specified by:

getComponentID in interface ComponentWidgetAdapterAware

setComponentID

public void setComponentID(String componentID)

initializeDefaultEventListeners

public void initializeDefaultEventListeners()

Description copied from interface: ComponentWidgetAdapterAware

Initializes default socket event listeners for the component.

Specified by:

initializeDefaultEventListeners in interface ComponentWidgetAdapterAware