UIComponentData (LSPS 3.2 SDK)

java.lang.Object
- com.whitestein.lsps.vaadin.ui.UIComponentData

All Implemented Interfaces:

Serializable
```
public class UIComponentData
extends Object
implements Serializable
```
The component definition. Holds various data needed by the lsps vaadin renderer.

Author:

mbj

See Also:

Serialized Form

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addJavaAppEventListener(JavaAppEventListener listener)` Adds a listener to handle application events.
`void`	`addListener(UIListener listener)`
`protected static StringBuilder`	`appendTo(RecordHolder def, StringBuilder sb)`
`static UIComponentData`	`create(UIComponent parent, RecordHolder definition)` Creates component data for a UIComponent.
`static UIComponentData`	`create(UIComponent parent, RecordHolder definition, UIComponentScope scope)` Creates component data for a UIComponent.
`static UIComponentData`	`createRoot(LspsScreen screen, RecordHolder definition, UIComponentScope scope)` Creates component data for a root UIComponent - the root of the UI component hierarchy.
`boolean`	`equals(Object obj)`
`void`	`fireUIEvent(UIEvent event)` This method provides LSPS with possibility to fire `UIEvent` directly on component itself.
`ContextWrapper`	`getComponentContext()` Returns the execution context in which values of this component should be evaluated and updated.
`RecordHolder`	`getComponentDefinition()`
`int`	`getComponentDepth()` A distance of this component from the root component.
`UIComponentFactory`	`getComponentFactory()` Equivalent to `getScreen().getContextHolder().getAppConnector().getComponentFactory()`
`LspsConverterFactory`	`getConverterFactory()` Equivalent to `getScreen().getContextHolder().getAppConnector().getConverterFactory()`.
`Variant.RecordVariant`	`getDefinition()`
`Variant.MapVariant<String,Object>`	`getHints()` Returns the presentation hints from the last component refresh.
`Variant.MapVariant<String,Object>`	`getHintsNonnull()` Returns the presentation hints from the last component refresh.
`SetVariant<RecordHolder>`	`getListenerDefinitions()` Returns the value of `UIFieldNames.LISTENERS`.
`String`	`getLocalizedString(String original, com.vaadin.ui.Component component)` Returns localized engine string based on the application locale.
`String`	`getModelingId()` Returns the value of the `UIFieldNames.MODELING_ID` property.
`UIComponent`	`getParent()`
`String`	`getPath()` Returns a path from the root component to this component, in the form of root / child / child / ...
`UIComponentScope`	`getScope()`
`LspsScreen`	`getScreen()`
`int`	`hashCode()`
`boolean`	`hasListenersOfType(String listenerType)` Checks if this component has listeners of given type listed, in the property.
`boolean`	`isInitializationStarted()`
`boolean`	`isInitialized()`
`boolean`	`isInitializing()`
`boolean`	`isRegistered()`
`boolean`	`markAfterCreateCalled()` Marks the component as `UIComponentFactoryImpl.afterCreate(UIComponent)`-called.
`void`	`removeJavaAppEventListener(JavaAppEventListener listener)` Removes a listener of application events.
`void`	`setComponentContext(ContextWrapper context)` Updates the execution context in which values should be evaluated and updated.
`void`	`setHints(Variant.MapVariant<String,Object> hints)` Sets the presentation hints from the last component refresh.
`void`	`setInitialized()` Sets the component to initialized state.
`void`	`setInitializing(boolean initializing)` Updates the initializing flag.
`void`	`setRegistered(boolean registered)` Updates the registered flag.
`String`	`toString()`
`void`	`updateContext()` Updates context dependent variables for this component.

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

- Method Detail
  - markAfterCreateCalled
```
public boolean markAfterCreateCalled()
```
    Marks the component as UIComponentFactoryImpl.afterCreate(UIComponent)-called.
    
    Returns:
    
    true if this method is called for the first time, false if not.
  - create
```
public static UIComponentData create(UIComponent parent,
                                     RecordHolder definition)
```
    Creates component data for a UIComponent. The component depth, context and scope are inferred from the parent component data.
    
    Parameters:
    
    parent - the parent, not null.
    
    definition - this component definition, not null.
    
    Returns:
    
    created component data
  - createRoot
```
public static UIComponentData createRoot(LspsScreen screen,
                                         RecordHolder definition,
                                         UIComponentScope scope)
```
    Creates component data for a root UIComponent - the root of the UI component hierarchy.
    
    Parameters:
    
    screen - the screen, not null.
    
    definition - the definition, not null.
    
    scope - the scope, not null.
    
    Returns:
    
    created component data
  - create
```
public static UIComponentData create(UIComponent parent,
                                     RecordHolder definition,
                                     UIComponentScope scope)
```
    Creates component data for a UIComponent.
    
    Parameters:
    
    parent - parent component, must not be null. Use createRoot(com.whitestein.lsps.vaadin.LspsScreen, com.whitestein.lsps.lang.exec.RecordHolder, UIComponentScope) to create definition for the root component.
    
    definition - the definition, not null.
    
    scope - the scope. If null, the scope is inferred from the parent.
    
    Returns:
    
    created component data
  - getComponentDefinition
```
public RecordHolder getComponentDefinition()
```
    Returns:
    
    the componentDefinition, never null. Warning: the definition record may not be present in 0:1. Do not modify this record!
  - getDefinition
```
public Variant.RecordVariant getDefinition()
```
    Returns:
    
    the componentDefinition, never null. Warning: the definition record may not be present in 0:1. Do not modify this record!
  - getScreen
```
public LspsScreen getScreen()
```
    Returns:
    
    the screen, never null.
  - getComponentDepth
```
public int getComponentDepth()
```
    A distance of this component from the root component. Measured in model's component hierarchy, not Vaadin's component hierarchy.
    
    Returns:
    
    the componentDepth the component depth. If zero, this component is the root component and has no parent (getParent() is null). Root's children have depth of 1, etc.
  - getComponentContext
```
public ContextWrapper getComponentContext()
```
    Returns the execution context in which values of this component should be evaluated and updated. This may differ to LspsScreen.getScreenContext() e.g. for view model and its children.
    
    Returns:
    
    the componentContext, never null.
  - getScope
```
public UIComponentScope getScope()
```
    Returns:
    
    the scope, never null.
  - getParent
```
public UIComponent getParent()
```
    Returns:
    
    the parent or null if this is the topmost component.
  - isRegistered
```
public boolean isRegistered()
```
    Returns:
    
    true if the component is registered in the screen
  - setRegistered
```
public void setRegistered(boolean registered)
```
    Updates the registered flag.
    
    Parameters:
    
    registered - if true, the component is registered in the screen.
  - isInitializing
```
public boolean isInitializing()
```
    Returns:
    
    true if the component is currently being initialized.
  - isInitialized
```
public boolean isInitialized()
```
    Returns:
    
    if the component is initialized, false if the initialization is ongoing or it has not yet even been started.
  - setInitialized
```
public void setInitialized()
```
    Sets the component to initialized state. Once initialized, this flag cannot be cleared. Setting this to true also clears the isInitializing() flag.
  - isInitializationStarted
```
public boolean isInitializationStarted()
```
  - setInitializing
```
public void setInitializing(boolean initializing)
```
    Updates the initializing flag.
    
    Parameters:
    
    initializing - true if the component is currently being initialized.
  - getHints
```
public Variant.MapVariant<String,Object> getHints()
```
    Returns the presentation hints from the last component refresh. If called from UIComponent.refresh(), it may provide null value only if this is some custom component which does not extend ui::UIComponent.
    
    Returns:
    
    presentation hints, null only if not yet set or if the component does not extend ui::UIComponent (has no hints field). If not null, the variant value is present.
  - getHintsNonnull
```
public Variant.MapVariant<String,Object> getHintsNonnull()
```
    Returns the presentation hints from the last component refresh. If called from UIComponent.refresh(), it may provide null value only if this is some custom component which does not extend ui::UIComponent.
    
    Returns:
    
    presentation hints, null only if not yet set or if the component does not extend ui::UIComponent (has no hints field). If not null, the variant value is present.
  - setHints
```
public void setHints(Variant.MapVariant<String,Object> hints)
```
    Sets the presentation hints from the last component refresh.
    
    Parameters:
    
    hints - hints, not null, must be present.
  - getComponentFactory
```
public UIComponentFactory getComponentFactory()
```
    Equivalent to getScreen().getContextHolder().getAppConnector().getComponentFactory()
    
    Returns:
    
    component factory, never null.
  - getConverterFactory
```
public LspsConverterFactory getConverterFactory()
```
    Equivalent to getScreen().getContextHolder().getAppConnector().getConverterFactory().
    
    Returns:
    
    converter factory, never null.
  - getLocalizedString
```
public String getLocalizedString(String original,
                                 com.vaadin.ui.Component component)
```
    Returns localized engine string based on the application locale. Shortcut for getAppConnector().getLocalizer().getLocalizedString(original).
    
    Parameters:
    
    original - may be null.
    
    component - used in com.whitestein.lsps.vaadin.ui.LspsLocalizer#getLocalizedString(String, com.whitestein.lsps.vaadin.ui.components.UIComponent)
    
    Returns:
    
    localized string
  - setComponentContext
```
public void setComponentContext(ContextWrapper context)
```
    Updates the execution context in which values should be evaluated and updated.
    
    Parameters:
    
    context - the new context, not null.
  - getListenerDefinitions
```
public SetVariant<RecordHolder> getListenerDefinitions()
```
    Returns the value of UIFieldNames.LISTENERS. Returns an empty set if there are no listeners.
    
    Returns:
    
    listener definition, never null, never absent.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - appendTo
```
protected static StringBuilder appendTo(RecordHolder def,
                                        StringBuilder sb)
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - updateContext
```
public final void updateContext()
```
    Updates context dependent variables for this component.
    
    See Also:
    
    UIComponentScope.updateContext()
  - getPath
```
public String getPath()
```
    Returns a path from the root component to this component, in the form of root / child / child / ... / this
    
    Returns:
    
    string path, never null
  - getModelingId
```
public String getModelingId()
```
    Returns the value of the UIFieldNames.MODELING_ID property.
    
    Returns:
    
    the modeling id, may be null if for some reason the component has no modeling id.
  - hasListenersOfType
```
public boolean hasListenersOfType(String listenerType)
```
    Checks if this component has listeners of given type listed, in the property.
    
    Parameters:
    
    listenerType - the type of the listener, not null.
    
    Returns:
    
    true if such listener is present in the set of listeners, false if not (or the listener set is empty).
  - addListener
```
public void addListener(UIListener listener)
```
  - addJavaAppEventListener
```
public void addJavaAppEventListener(JavaAppEventListener listener)
```
    Adds a listener to handle application events.
    
    Parameters:
    
    listener -
  - removeJavaAppEventListener
```
public void removeJavaAppEventListener(JavaAppEventListener listener)
```
    Removes a listener of application events.
    
    Parameters:
    
    listener -
  - fireUIEvent
```
public void fireUIEvent(UIEvent event)
```
    This method provides LSPS with possibility to fire UIEvent directly on component itself.
    
    Parameters:
    
    event - the event, not null.

Class UIComponentData

Method Summary

Methods inherited from class java.lang.Object

Method Detail

markAfterCreateCalled

create

createRoot

create

getComponentDefinition

getDefinition

getScreen

getComponentDepth

getComponentContext

getScope

getParent

isRegistered

setRegistered

isInitializing

isInitialized

setInitialized

isInitializationStarted

setInitializing

getHints

getHintsNonnull

setHints

getComponentFactory

getConverterFactory

getLocalizedString

setComponentContext

getListenerDefinitions

toString

appendTo

hashCode

equals

updateContext

getPath

getModelingId

hasListenersOfType

addListener

addJavaAppEventListener

removeJavaAppEventListener

fireUIEvent