UIComponents (LSPS 3.2 SDK)

java.lang.Object
- com.whitestein.lsps.vaadin.util.UIComponents

```
public class UIComponents
extends Object
```
Util class with various methods related to lsps renderer components

Author:

mbj

Field Summary

Fields
Modifier and Type Field and Description

static String REQUIRED_STYLE_NAME
HTML Style class for required input components

Fields
Modifier and Type	Field and Description
`static String`	`REQUIRED_STYLE_NAME` HTML Style class for required input components

Method Summary

All Methods Static Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static void`	`addComponentError(UIComponent component, String errorMessage)` Adds error message to the component.
`static void`	`afterCreate(UIComponent component)` Deprecated. moved to UIComponentFactoryImpl. Do not call - UIComponentFactoryImpl.afterCreate will be called automatically after the UI component is constructed.
`static List<UIComponent>`	`appendChildren2(UIComponent parent, Variant.ListVariant<RecordHolder> children)` Populates given parent with child components based on definitions from the given list.
`static boolean`	`areVisible(Set<UIComponent> components)`
`static boolean`	`fillInSelectItems(com.vaadin.ui.AbstractSelect select, UIComponentData componentData)` Updates list of items for the given select based on value of the field `UIFieldNames.OPTIONS`
`static boolean`	`fillInSelectItems(UIComponent component)` Updates list of items for the given select based on value of the field `UIFieldNames.OPTIONS`
`static void`	`fireAndProcess(UIEvent event)` Fires given event and triggers event processing.
`static void`	`fireAndProcess(UIEvent event, boolean handleErrorInScreen)` Fires given event and triggers event processing.
`static List<Variant<RecordHolder>>`	`getChildren(Variant.RecordVariant def)` Lists child component definitions from given component definition.
`static List<UIComponent>`	`getChildrenAsUIComponent(com.vaadin.ui.Component c)` Deprecated. Do not use - not compatible with the new `UIComponent.getWidget()` system. All layout components must instead track their children manually.
`static void`	`initAndRefreshChildren(List<? extends UIComponent> components, boolean isFirstLoad)` Initializes all the given components recursively, by firing new `Events.INIT_EVENT_TYPE` event for each component, and marks the components to be refreshed once the init events are processed.
`static void`	`initChildren(List<? extends UIComponent> components, boolean isFirstLoad)` Initializes all the given components recursively, by firing new `Events.INIT_EVENT_TYPE` event for each component.
`static boolean`	`isShown(UIComponent component)` Checks if the component is displayed on the screen by iterating through all parents and checking their visibility.
`static boolean`	`isUIComponent(com.vaadin.ui.Component component, LspsScreen screen)`
`static Set<UIComponent>`	`refreshRecursively(Collection<? extends UIComponent> components, Set<UIComponent> refreshedComponents)` Refreshes recursively all of given components and returns set of all refreshed components.
`static void`	`register(Collection<? extends UIComponent> components)` Registers all the given components recursively.
`static void`	`setComponentRequired(UIComponent component, boolean required)` Adds required style class (`REQUIRED_STYLE_NAME`) and also calls Vaadin `Component.setReadOnly(boolean)`.
`static String`	`toString(Collection<?> components, int max)` Nice toString for collection of components.
`static String`	`toString(UIComponent component)` Provides standardized "log" format of a component description, in form of `[class UIOutputText] (Enter your name:) #_ayu9283r4jasdasdi7234`.
`static void`	`unregister(Collection<? extends UIComponent> components)` Unregisters all the given components recursively.
`static Object`	`unwrap(Serializable wrapper)` Unwraps an engine value from its serializable representation.
`static Serializable`	`wrap(Object value, LspsContextHolder contextHolder)` Makes sure that the passed engine value is serializable.

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

- Field Detail
  - REQUIRED_STYLE_NAME
```
public static final String REQUIRED_STYLE_NAME
```
    HTML Style class for required input components
    
    See Also:
    
    Constant Field Values
- Method Detail
  - fillInSelectItems
```
public static boolean fillInSelectItems(UIComponent component)
```
    Updates list of items for the given select based on value of the field UIFieldNames.OPTIONS
    
    Parameters:
    
    component - the UI component. Its UIComponent.getWidget() must return AbstractSelect.
    
    Returns:
    
    'hasNull': true if null is present amongst options, false if not.
    
    Throws:
    
    IllegalArgumentException - if the provided component doesn't implement UIComponent interface
  - fillInSelectItems
```
public static boolean fillInSelectItems(com.vaadin.ui.AbstractSelect select,
                                        UIComponentData componentData)
```
    Updates list of items for the given select based on value of the field UIFieldNames.OPTIONS
    
    Parameters:
    
    select - the Vaadin AbstractSelect component which will get its items filled in
    
    componentData - fill item according to the UIFieldNames.OPTIONS property.
    
    Returns:
    
    'hasNull': true if null is present amongst options, false if not.
    
    Throws:
    
    IllegalArgumentException - if the provided component doesn't implement UIComponent interface
  - setComponentRequired
```
public static void setComponentRequired(UIComponent component,
                                        boolean required)
```
    Adds required style class (REQUIRED_STYLE_NAME) and also calls Vaadin Component.setReadOnly(boolean).
    
    Parameters:
    
    component -
    
    required -
  - afterCreate
```
@Deprecated
public static void afterCreate(UIComponent component)
```
    Deprecated. moved to UIComponentFactoryImpl. Do not call - UIComponentFactoryImpl.afterCreate will be called automatically after the UI component is constructed.
    
    Perform standard set of behaviors when component is created. The method will apply application listeners.
    It is called automatically by UIComponentFactoryImpl. DO NOT call this method at the end of its constructor - otherwise, extending classes will be passed half-initialized here.
    If the component implements Field, it's switched to buffered mode so that conversion/validation of the field value is properly integrated with the LSPS UI lifecycle.
    
    Parameters:
    
    component -
  - register
```
public static void register(Collection<? extends UIComponent> components)
```
    Registers all the given components recursively.
    
    Parameters:
    
    components - list of components, not null, may be empty.
  - unregister
```
public static void unregister(Collection<? extends UIComponent> components)
```
    Unregisters all the given components recursively.
    
    Parameters:
    
    components - list of components, not null, may be empty.
  - refreshRecursively
```
public static Set<UIComponent> refreshRecursively(Collection<? extends UIComponent> components,
                                                  Set<UIComponent> refreshedComponents)
```
    Refreshes recursively all of given components and returns set of all refreshed components. Refresh of a single component consists of calling UIComponent.refresh() and ClientConnector.markAsDirty(). Note that all components should be in the same depth in the UI component tree.
    
    Parameters:
    
    components - refresh these components and their descendants (except components already present in the refreshedComponents set). All components must be initialized or initialization must be started.
    
    refreshedComponents - components which have already been refreshed. These components and their descendants will not be refreshed again. Gradually filled with components from components as they are refreshed.
    
    Returns:
    
    set of components that has been refreshed. The value of the refreshedComponents parameter.
    
    Throws:
    
    IllegalArgumentException - if UIComponentData.isInitializationStarted() returns false for any of the component.
  - initAndRefreshChildren
```
public static void initAndRefreshChildren(List<? extends UIComponent> components,
                                          boolean isFirstLoad)
```
    Initializes all the given components recursively, by firing new Events.INIT_EVENT_TYPE event for each component, and marks the components to be refreshed once the init events are processed.
    
    Parameters:
    
    components - a list of children that should be initiated
    
    isFirstLoad - value of field UIFieldNames.IS_FIRST_LOAD of the created init event
  - initChildren
```
public static void initChildren(List<? extends UIComponent> components,
                                boolean isFirstLoad)
```
    Initializes all the given components recursively, by firing new Events.INIT_EVENT_TYPE event for each component.
    
    Parameters:
    
    components - a list of child components that should be initiated
    
    isFirstLoad - value of field UIFieldNames.IS_FIRST_LOAD of the created init event
  - areVisible
```
public static boolean areVisible(Set<UIComponent> components)
```
    Parameters:
    
    components - components, not null, may be empty.
    
    Returns:
    
    true if all the provided components are visible ( i.e. they are not in hidden conditional item and they are not in tab which is not visible ). Returns true for empty set.
  - isShown
```
public static boolean isShown(UIComponent component)
```
    Checks if the component is displayed on the screen by iterating through all parents and checking their visibility.
    
    Parameters:
    
    component -
    
    Returns:
    
    true it the given component is displayed on the screen
  - appendChildren2
```
public static List<UIComponent> appendChildren2(UIComponent parent,
                                                Variant.ListVariant<RecordHolder> children)
```
    Populates given parent with child components based on definitions from the given list.
    
    Parameters:
    
    parent - parent to populate, not null. Must implement the ComponentContainer interface.
    
    children - list of child definitions, must not be null. Nothing is done if the variant is absent.
    
    Returns:
    
    list of created components
    
    Throws:
    
    IllegalArgumentException - if parent is not instance of AbstractComponentContainer
  - wrap
```
public static Serializable wrap(Object value,
                                LspsContextHolder contextHolder)
```
    Makes sure that the passed engine value is serializable. Value holders are wrapped in a Variant while basic values don't need to be wrapped.
    
    Parameters:
    
    value -
    
    contextHolder -
    
    Returns:
    
    serializable value
  - unwrap
```
public static Object unwrap(Serializable wrapper)
```
    Unwraps an engine value from its serializable representation.
    
    Parameters:
    
    wrapper -
    
    Returns:
    
    unwrapped value
  - getChildrenAsUIComponent
```
@Deprecated
public static List<UIComponent> getChildrenAsUIComponent(com.vaadin.ui.Component c)
```
    Deprecated. Do not use - not compatible with the new UIComponent.getWidget() system. All layout components must instead track their children manually.
    
    Returns all direct children of given Vaadin component as a list. Does not call UIComponentContainer.getChildUIComponents() even if given components implements the interface.
    
    Parameters:
    
    c - the component, not null.
    
    Returns:
    
    the list, never null. May be empty if the component has no children or does not implement the ComponentContainer interface.
    
    Throws:
    
    ClassCastException - if some child does not implement the UIComponent interface.
  - getChildren
```
public static List<Variant<RecordHolder>> getChildren(Variant.RecordVariant def)
```
    Lists child component definitions from given component definition.
    
    Parameters:
    
    def - the component definition, not null, must be present. The record type must extend ui::Component
    
    Returns:
    
    the list, never null, may be empty.
  - fireAndProcess
```
public static void fireAndProcess(UIEvent event)
```
    Fires given event and triggers event processing. If the event processing fails, the component is marked as errorneous and the LspsFormConnector.handleError(Throwable) is invoked. The exception is not propagated from this method.
    
    Parameters:
    
    event - the event, not null.
  - fireAndProcess
```
public static void fireAndProcess(UIEvent event,
                                  boolean handleErrorInScreen)
```
    Fires given event and triggers event processing. If the event processing fails,
    
    Parameters:
    
    event - the event, not null.
    
    handleErrorInScreen - if true and the event processing fails, the component is marked as errorneous and the LspsFormConnector.handleError(Throwable) is invoked; the exception is not propagated from this method. If false, the exception is propagated outside of this method.
  - addComponentError
```
public static void addComponentError(UIComponent component,
                                     String errorMessage)
```
    Adds error message to the component. If the component already has an error message, it is appended with the "<BR>" separator.
    
    Parameters:
    
    component - the component, not null.
    
    errorMessage - the error message, not null, html-formatted. The message must be localized properly beforehand.
  - toString
```
public static String toString(UIComponent component)
```
    Provides standardized "log" format of a component description, in form of [class UIOutputText] (Enter your name:) #_ayu9283r4jasdasdi7234.
    
    Parameters:
    
    component - the component, not null.
    
    Returns:
    
    the component description, never null.
  - toString
```
public static String toString(Collection<?> components,
                              int max)
```
    Nice toString for collection of components. First max components in collection are converted to string and added to result. The amount of remaining components is added to the end.
    
    Parameters:
    
    components -
    
    max -
    
    Returns:
    
    string
  - isUIComponent
```
public static boolean isUIComponent(com.vaadin.ui.Component component,
                                    LspsScreen screen)
```
    Parameters:
    
    component -
    
    screen -
    
    Returns:
    
    returns whether the component belongs to the screen or is instance of UIComponent

Class UIComponents

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

REQUIRED_STYLE_NAME

Method Detail

fillInSelectItems

fillInSelectItems

setComponentRequired

afterCreate

register

unregister

refreshRecursively

initAndRefreshChildren

initChildren

areVisible

isShown

appendChildren2

wrap

unwrap

getChildrenAsUIComponent

getChildren

fireAndProcess

fireAndProcess

addComponentError

toString

toString

isUIComponent