com.whitestein.lsps.vaadin.ui

Class UIComponentFactoryImpl.ScreenLevelRecord

java.lang.Object

com.whitestein.lsps.vaadin.ui.UIComponentFactoryImpl.ScreenLevelRecord

Enclosing class:

UIComponentFactoryImpl

public static class UIComponentFactoryImpl.ScreenLevelRecord
extends Object

Creates image of validation error in screen-level context, which is seen by all UIComponents. Original validation error may not be visible to all components, e.g. when it was created inside a ViewModel, etc.

Field Summary

Fields

Modifier and Type	Field and Description
Variant.RecordVariant	validationErrorOriginal Original ui::ValidationError as received from the VALIDATE closure.
Variant.RecordVariant	validationErrorScreenLevel Screen-level ui::ValidationError copy.

Constructor Summary

Constructors

Constructor and Description
ScreenLevelRecord(Variant.RecordVariant validationError, LspsScreen screen)

Method Summary

Modifier and Type	Method and Description
void	addToShownOn(UIComponent component) Call when the validation error was mapped on some component.
boolean	equals(Object o)
int	hashCode()
boolean	isExcluded(UIComponent component) Invokes the UIComponent "excludeValidationError" closure and checks whether given validation error is exluded or not.
boolean	isIncluded(UIComponent component) Invokes the UIComponent "includeValidationError" closure and checks whether given validation error is included or not.
boolean	isNotShown()
static boolean	isShownOn(RecordHolder validationError, UIComponent component) Deprecated.
boolean	isShownOn(UIComponent component)
static boolean	isShownOn(Variant.RecordVariant validationError, UIComponent component) Deprecated.

Methods inherited from class java.lang.Object

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

Field Detail

validationErrorScreenLevel

public final Variant.RecordVariant validationErrorScreenLevel

Screen-level ui::ValidationError copy. Not null, not absent.

validationErrorOriginal

public final Variant.RecordVariant validationErrorOriginal

Original ui::ValidationError as received from the VALIDATE closure. Not null, not absent.

Constructor Detail

ScreenLevelRecord

public ScreenLevelRecord(Variant.RecordVariant validationError,
                         LspsScreen screen)

Method Detail

isExcluded

public boolean isExcluded(UIComponent component)

Invokes the UIComponent "excludeValidationError" closure and checks whether given validation error is exluded or not.

Parameters:

component - the component on which the closure is invoked, not null.

Returns:

true if the validation error is excluded from the component, false if not or if the closure is null.

isIncluded

public boolean isIncluded(UIComponent component)

Invokes the UIComponent "includeValidationError" closure and checks whether given validation error is included or not.

Parameters:

component - the component on which the closure is invoked, not null.

Returns:

true if the validation error is included from the component, false otherwise

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

isShownOn

@Deprecated
public static boolean isShownOn(RecordHolder validationError,
                                            UIComponent component)

Deprecated.

This method should not be used. It uses "shownOn" property of ui::ValidationError record which is unreliable. Whether validation error is shown on that component.

Parameters:

validationError -

component -

Returns:

in most cases, returns whether validation error is shown on that component. Not reliable.

isShownOn

@Deprecated
public static boolean isShownOn(Variant.RecordVariant validationError,
                                            UIComponent component)

Deprecated.

This method should not be used. It uses "shownOn" property of ui::ValidationError record which is unreliable. Whether validation error is shown on that component.

Parameters:

validationError -

component -

Returns:

in most cases, returns whether validation error is shown on that component. Not reliable.

isShownOn

public boolean isShownOn(UIComponent component)

Parameters:

component -

Returns:

true if the validation error is shown on the component

isNotShown

public boolean isNotShown()

Returns:

true if the validation error is shown on some component

addToShownOn

public void addToShownOn(UIComponent component)

Call when the validation error was mapped on some component. Adds the information to all relevant data structures.

Parameters:

component -