AbstractUiContext (JavaDocs for mmm-all dev-SNAPSHOT)

java.lang.Object
- net.sf.mmm.util.component.base.AbstractComponent
- - net.sf.mmm.util.component.base.AbstractLoggableComponent
  - - net.sf.mmm.client.ui.base.AbstractUiContext

All Implemented Interfaces:

AttributeReadEventObserver, AttributeWriteEventObserver, UiContext

Direct Known Subclasses:

AbstractUiContextImpl
```
public abstract class AbstractUiContext
extends AbstractLoggableComponent
implements UiContext, AttributeWriteEventObserver
```
This is the abstract base implementation of UiContext.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields
Modifier and Type	Field and Description
`private UiAccessKeyBinding`	`accessKeyBinding`
`private UiConfiguration`	`configuration`
`private ComponentContainer`	`container`
`private UiDataBindingFactory`	`dataBindingFactory`
`private DatatypeDetector`	`datatypeDetector`
`private UiDispatcher`	`dispatcher`
`private UiDisplay`	`display`
`private UiEventObserver`	`eventObserver`
`private UiModeChanger`	`modeChanger`
`private UiPopupHelper`	`popupHelper`
`private RoleFactory`	`roleFactory`
`private UiWidgetFactory`	`widgetFactory`

Constructor Summary

Constructors
Constructor and Description

AbstractUiContext()
The constructor.

Constructors
Constructor and Description
`AbstractUiContext()` The constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`doInitialize()` This method performs the actual `initialization`.
`UiAccessKeyBinding`	`getAccessKeyBinding()`
`UiConfiguration`	`getConfiguration()` This method gets the `UiConfiguration` for this factory.
`ComponentContainer`	`getContainer()`
`UiDataBindingFactory`	`getDataBindingFactory()`
`DatatypeDetector`	`getDatatypeDetector()`
`UiDispatcher`	`getDispatcher()`
`UiDisplay`	`getDisplay()` This method gets the `UiDisplay` e.g.
`UiEventObserver`	`getEventObserver()` This method gets the `UiEventObserver`.
`org.slf4j.Logger`	`getLogger()` This method gets the `logger` for this component.
`UiModeChanger`	`getModeChanger()`
`UiPopupHelper`	`getPopupHelper()`
`RoleFactory`	`getRoleFactory()`
`UiWidgetFactory`	`getWidgetFactory()` This method gets the `UiWidgetFactory` that is used to create `UiWidget`s.
`void`	`setAccessKeyBinding(UiAccessKeyBinding accessKeyBinding)`
`void`	`setConfiguration(UiConfiguration configuration)`
`void`	`setContainer(ComponentContainer container)`
`void`	`setDataBindingFactory(UiDataBindingFactory dataBindingFactory)`
`void`	`setDatatypeDetector(DatatypeDetector datatypeDetector)`
`void`	`setDispatcher(UiDispatcher dispatcher)`
`void`	`setDisplay(UiDisplay display)`
`void`	`setEventObserver(UiEventObserver eventObserver)` This method gets the editable status.
`void`	`setModeChanger(UiModeChanger modeChanger)`
`void`	`setPopupHelper(UiPopupHelper popupHelper)`
`void`	`setRoleFactory(RoleFactory roleFactory)`
`void`	`setWidgetFactory(UiWidgetFactory widgetFactory)`

Methods inherited from class net.sf.mmm.util.component.base.AbstractLoggableComponent
createLogger

Methods inherited from class net.sf.mmm.util.component.base.AbstractComponent
doInitialized, getInitializationState, initialize

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - eventObserver
```
private UiEventObserver eventObserver
```
    See Also:
    
    getEventObserver()
  - modeChanger
```
private UiModeChanger modeChanger
```
    See Also:
    
    getModeChanger()
  - configuration
```
private UiConfiguration configuration
```
    See Also:
    
    getConfiguration()
  - dispatcher
```
private UiDispatcher dispatcher
```
    See Also:
    
    getDispatcher()
  - display
```
private UiDisplay display
```
    See Also:
    
    getDisplay()
  - roleFactory
```
private RoleFactory roleFactory
```
    See Also:
    
    getRoleFactory()
  - widgetFactory
```
private UiWidgetFactory widgetFactory
```
    See Also:
    
    getWidgetFactory()
  - popupHelper
```
private UiPopupHelper popupHelper
```
    See Also:
    
    getPopupHelper()
  - container
```
private ComponentContainer container
```
    See Also:
    
    getContainer()
  - dataBindingFactory
```
private UiDataBindingFactory dataBindingFactory
```
    See Also:
    
    getDataBindingFactory()
  - accessKeyBinding
```
private UiAccessKeyBinding accessKeyBinding
```
    See Also:
    
    getAccessKeyBinding()
  - datatypeDetector
```
private DatatypeDetector datatypeDetector
```
    See Also:
    
    getDatatypeDetector()
- Constructor Detail
  - AbstractUiContext
```
public AbstractUiContext()
```
    The constructor.
- Method Detail
  - doInitialize
```
protected void doInitialize()
```
    This method performs the actual initialization. It is called when AbstractComponent.initialize() is invoked for the first time.
    ATTENTION:
    When you override this method from a sub-class you need to do a super.AbstractComponent.doInitialize().
    
    Overrides:
    
    doInitialize in class AbstractLoggableComponent
  - getEventObserver
```
public UiEventObserver getEventObserver()
```
    This method gets the UiEventObserver.
    
    Specified by:
    
    getEventObserver in interface AttributeReadEventObserver
    
    Returns:
    
    the UiEventObserver.
  - setEventObserver
```
public void setEventObserver(UiEventObserver eventObserver)
```
    This method gets the editable status.
    
    Specified by:
    
    setEventObserver in interface AttributeWriteEventObserver
    
    Parameters:
    
    eventObserver - is the UiEventObserver.
  - getModeChanger
```
public UiModeChanger getModeChanger()
```
    Returns:
    
    the UiModeChanger instance to use.
  - setModeChanger
```
@Inject
public void setModeChanger(UiModeChanger modeChanger)
```
    Parameters:
    
    modeChanger - is the new UiModeChanger to use.
  - getConfiguration
```
public UiConfiguration getConfiguration()
```
    This method gets the UiConfiguration for this factory. It is intended to be read by UiWidget implementations to configure their look and feel.
    
    Specified by:
    
    getConfiguration in interface UiContext
    
    Returns:
    
    the UiConfiguration.
  - setConfiguration
```
@Inject
public void setConfiguration(UiConfiguration configuration)
```
    Parameters:
    
    configuration - is the configuration to set
  - getDispatcher
```
public UiDispatcher getDispatcher()
```
    Specified by:
    
    getDispatcher in interface UiContext
    
    Returns:
    
    the UiDispatcher.
  - setDispatcher
```
@Inject
public void setDispatcher(UiDispatcher dispatcher)
```
    Parameters:
    
    dispatcher - is the dispatcher to set
  - getDisplay
```
public UiDisplay getDisplay()
```
    This method gets the UiDisplay e.g. to read the current screen resolution.
    
    Specified by:
    
    getDisplay in interface UiContext
    
    Returns:
    
    the UiDisplay.
  - setDisplay
```
@Inject
public void setDisplay(UiDisplay display)
```
    Parameters:
    
    display - is the display to set
  - getRoleFactory
```
public RoleFactory getRoleFactory()
```
    Specified by:
    
    getRoleFactory in interface UiContext
    
    Returns:
    
    the instance of RoleFactory.
  - setRoleFactory
```
@Inject
public void setRoleFactory(RoleFactory roleFactory)
```
    Parameters:
    
    roleFactory - is the RoleFactory instance to set (to inject).
  - getWidgetFactory
```
public UiWidgetFactory getWidgetFactory()
```
    This method gets the UiWidgetFactory that is used to create UiWidgets.
    
    Specified by:
    
    getWidgetFactory in interface UiContext
    
    Returns:
    
    the UiWidgetFactory.
  - setWidgetFactory
```
@Inject
public void setWidgetFactory(UiWidgetFactory widgetFactory)
```
    Parameters:
    
    widgetFactory - is the UiWidgetFactory to Inject.
  - getPopupHelper
```
public UiPopupHelper getPopupHelper()
```
    Specified by:
    
    getPopupHelper in interface UiContext
    
    Returns:
    
    the instance of UiPopupHelper.
  - setPopupHelper
```
@Inject
public void setPopupHelper(UiPopupHelper popupHelper)
```
    Parameters:
    
    popupHelper - is the UiPopupHelper to Inject.
  - getContainer
```
public ComponentContainer getContainer()
```
    Specified by:
    
    getContainer in interface UiContext
    
    Returns:
    
    the instance of ComponentContainer.
  - setContainer
```
@Inject
public void setContainer(ComponentContainer container)
```
    Parameters:
    
    container - is the ComponentContainer to Inject.
  - getDataBindingFactory
```
public UiDataBindingFactory getDataBindingFactory()
```
    Returns:
    
    the instance of UiDataBindingFactory.
  - setDataBindingFactory
```
@Inject
public void setDataBindingFactory(UiDataBindingFactory dataBindingFactory)
```
    Parameters:
    
    dataBindingFactory - is the UiDataBindingFactory to Inject.
  - getAccessKeyBinding
```
public UiAccessKeyBinding getAccessKeyBinding()
```
    Returns:
    
    the instance of UiAccessKeyBinding.
  - setAccessKeyBinding
```
@Inject
public void setAccessKeyBinding(UiAccessKeyBinding accessKeyBinding)
```
    Parameters:
    
    accessKeyBinding - is the UiAccessKeyBinding to Inject.
  - getLogger
```
public org.slf4j.Logger getLogger()
```
    This method gets the logger for this component.
    This method is NOT public because the logger should only be used by the component itself and NOT externally.
    
    Overrides:
    
    getLogger in class AbstractLoggableComponent
    
    Returns:
    
    the Logger to be used by this component.
  - getDatatypeDetector
```
public DatatypeDetector getDatatypeDetector()
```
    Returns:
    
    the instance of DatatypeDetector.
  - setDatatypeDetector
```
@Inject
public void setDatatypeDetector(DatatypeDetector datatypeDetector)
```
    Parameters:
    
    datatypeDetector - is the datatypeDetector to set

Class AbstractUiContext

Field Summary

Constructor Summary

Method Summary

Methods inherited from class net.sf.mmm.util.component.base.AbstractLoggableComponent

Methods inherited from class net.sf.mmm.util.component.base.AbstractComponent

Methods inherited from class java.lang.Object

Field Detail

eventObserver

modeChanger

configuration

dispatcher

display

roleFactory

widgetFactory

popupHelper

container

dataBindingFactory

accessKeyBinding

datatypeDetector

Constructor Detail

AbstractUiContext

Method Detail

doInitialize

getEventObserver

setEventObserver

getModeChanger

setModeChanger

getConfiguration

setConfiguration

getDispatcher

setDispatcher

getDisplay

setDisplay

getRoleFactory

setRoleFactory

getWidgetFactory

setWidgetFactory

getPopupHelper

setPopupHelper

getContainer

setContainer

getDataBindingFactory

setDataBindingFactory

getAccessKeyBinding

setAccessKeyBinding

getLogger

getDatatypeDetector

setDatatypeDetector