ComponentWidgetAdapterAware (cockpitng 20.05.0-RC3 API)

All Known Implementing Classes:

AbstractComponentWidgetAdapterAware, AbstractReferenceEditor, AbstractStatefulAction, AbstractToggleAction, ActionStubExample, CloneAction, CreateAction, DefaultEnumMultiReferenceEditor, DefaultExtendedMultiReferenceEditor, DefaultFixedReferenceEditor, DefaultMultiReferenceEditor, DefaultReferenceEditor, DragAndDropConfigAction, EditAction, ExampleWidgetStubEditor, FlexibleSidebarToggleAction, PrincipalPermissionAction, SearchByTypeAction, SplitLayoutChooserAction, ToggleAction, TypePermissionAction
```
public interface ComponentWidgetAdapterAware
```
Adapter aware marker that supports 'non-widget' components with useful framework features.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`java.lang.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, java.lang.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`	`unregisterStubInstance()`	Unregisters a particular stub widget instance assocated with instance `ComponentWidgetAdapterAware`

- Method Detail
  - initialize
```
void initialize(ComponentWidgetAdapter componentWidgetAdapter,
                java.lang.String componentID)
```
    Widget adapter aware components requires ComponentWidgetAdapter for incorporate a framework wide features.
    
    Parameters:
    
    componentWidgetAdapter - incorporate a framework wide features
    
    componentID - associated componend ID
  - registerStubInstance
```
void registerStubInstance(AbstractCockpitComponentDefinition definition)
```
    Registers a particular stub widget instance for given 'non-widget' aware component
    
    Parameters:
    
    definition - given component definition e.g. editor definition, action definition
  - unregisterStubInstance
```
void unregisterStubInstance()
```
    Unregisters a particular stub widget instance assocated with instance ComponentWidgetAdapterAware
  - handleSocketInputEvent
```
void handleSocketInputEvent(SocketEvent event)
```
    Handles a socket input event sent to this ComponentWidgetAdapterAware instance from outside.
    
    Parameters:
    
    event - a socket input event
  - initializeDefaultEventListeners
```
void initializeDefaultEventListeners()
```
    Initializes default socket event listeners for the component.
  - getComponentID
```
java.lang.String getComponentID()
```
    Gets associated component ID.