com.whitestein.lsps.vaadin.forms

Class Utils

java.lang.Object

com.whitestein.lsps.vaadin.forms.Utils

public class Utils
extends Object

"Native" methods for the new Forms framework.

Author:

mvy

Constructor Summary

Constructors

Constructor and Description
Utils()

Method Summary

Modifier and Type	Method and Description
void	addBrowserWindowResizeListener(ExecutionContext ctx, ClosureHolder listener) Adds a listener for the browser window resize events.
Object	call(ExecutionContext ctx, RecordHolder c, String method, ListHolder args) Calls a method on the underlying Java UI component.
Object	call(ExecutionContext ctx, RecordHolder c, String method, Object... args) Calls a method on the underlying Java UI component.
Object	callFormComponent(ExecutionContext ctx, String method, ListHolder args) Calls a method on a form component (this).
Object	callFormComponent(ExecutionContext ctx, String method, Object... args) Calls a method on a form component (this).
void	clearDataErrorMessages(ExecutionContext ctx, RecordHolder component) Clears error messages on the components and it's descendants.
Decimal	compare(ExecutionContext ctx, Object o1, Object o2) Compares two comparables (Strings, Dates, Integers, Decimals).
void	createNative(ExecutionContext ctx) Called in the forms::FormComponent constructor - registers the component to the Form and creates appropriate Vaadin component.
void	detectLocation(ExecutionContext ctx, RecordHolder optsHolder, ClosureHolder resultCallback) Requests a location detection.
Decimal	gc(ExecutionContext ctx) Runs a full garbage collection, both over the form and the model.
RecordHolder	getBrowserWindowSize(ExecutionContext ctx) Returns the browser window size.
RecordHolder	getRecordAndProperty(ExecutionContext ctx, ReferenceHolder ref) If given reference is a pointer to some record field, returns both the record and the property.
void	handleSubmitNavigation(ExecutionContext ctx, SetHolder todos, RecordHolder screenNavigation) Handles the navigation logic after a form has been submitted.
String	localize(ExecutionContext ctx, String message) Localized the provided message using the current component.
String	localize(ExecutionContext ctx, String message, RecordHolder component) Localizes the provided message.
boolean	matches(ExecutionContext ctx, String str, String regexp) Attempts to match the entire string against the pattern
void	navigate(ExecutionContext ctx, RecordHolder navigation) Navigates to given target.
RecordHolder	saveForm(ExecutionContext ctx) Saves the current Todo/Document.
void	showDataErrorMessages(ExecutionContext ctx, ListHolder constraintViolations, RecordHolder component) Shows the constraint violations on the components which are bound to the same record properties as the constraint violations.

Methods inherited from class java.lang.Object

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

Constructor Detail

Utils

public Utils()

Method Detail

call

public Object call(ExecutionContext ctx,
                   RecordHolder c,
                   String method,
                   Object... args)

Calls a method on the underlying Java UI component. Default implementation will first try to find given method reflectively on the FormComponent implementor; if there is no such method, the underlying Vaadin widget is searched. If there is no such method, this method fails with an exception.

Parameters:

ctx - current execution context

c - the component definition record, not null.

method - the method name, not null.

args - parameters

Returns:

optional method result, may be null.

Throws:

RuntimeException - if no such method exists.

call

public Object call(ExecutionContext ctx,
                   RecordHolder c,
                   String method,
                   ListHolder args)

Calls a method on the underlying Java UI component. Default implementation will first try to find given method reflectively on the FormComponent implementor; if there is no such method, the underlying Vaadin widget is searched. If there is no such method, this method fails with an exception.

Parameters:

ctx - current execution context

c - the component definition record, not null.

method - the method name, not null.

args - optional list of parameters, may be null.

Returns:

optional method result, may be null.

Throws:

RuntimeException - if no such method exists.

callFormComponent

public Object callFormComponent(ExecutionContext ctx,
                                String method,
                                Object... args)
                         throws ErrorException

Calls a method on a form component (this).

Parameters:

ctx -

method -

args -

Returns:

optional method result, may be null

Throws:

ErrorException

callFormComponent

public Object callFormComponent(ExecutionContext ctx,
                                String method,
                                ListHolder args)
                         throws ErrorException

Calls a method on a form component (this).

Parameters:

ctx -

method -

args -

Returns:

optional method result, may be null

Throws:

ErrorException

createNative

public void createNative(ExecutionContext ctx)

Called in the forms::FormComponent constructor - registers the component to the Form and creates appropriate Vaadin component.

Parameters:

ctx - current execution context

getRecordAndProperty

public RecordHolder getRecordAndProperty(ExecutionContext ctx,
                                         ReferenceHolder ref)
                                  throws ErrorException

If given reference is a pointer to some record field, returns both the record and the property.

Parameters:

ctx - current execution context

ref - the reference, not null.

Returns:

RecordAndProperty holding record and property. Returns null if the reference points to e.g. a variable.

Throws:

ErrorException

navigate

public void navigate(ExecutionContext ctx,
                     RecordHolder navigation)

Navigates to given target.

Parameters:

ctx - current execution context

navigation - the human::Navigation subclass, not null.

handleSubmitNavigation

public void handleSubmitNavigation(ExecutionContext ctx,
                                   SetHolder todos,
                                   RecordHolder screenNavigation)

Handles the navigation logic after a form has been submitted. It tries to evaluate the navigation rule defined on the document/todo. If there is no navigation defined or the navigation rule yields no human::Navigation record then the screenNavigation is taken into account.

Parameters:

ctx -

todos - newly created todos

screenNavigation - the user navigation

saveForm

public RecordHolder saveForm(ExecutionContext ctx)
                      throws ErrorException

Saves the current Todo/Document. If the save action fails for any reason the current transaction is marked as rollback only.

Parameters:

ctx -

Returns:

the saved Todo/Document

Throws:

ErrorException - if the save action fails.

compare

public Decimal compare(ExecutionContext ctx,
                       Object o1,
                       Object o2)

Compares two comparables (Strings, Dates, Integers, Decimals). Equivalent to the "spaceship" operator.

Parameters:

ctx -

o1 - first object to compare, not null.

o2 - second object to compare, not null.

Returns:

a negative integer if o1 is less than o2, a positive integer if o1 is greater than o2, or zero if two are equal.

matches

public boolean matches(ExecutionContext ctx,
                       String str,
                       String regexp)

Attempts to match the entire string against the pattern

Parameters:

ctx -

str - the string

regexp - the pattern

Returns:

true if, and only if, the entire string matches the regex pattern

gc

public Decimal gc(ExecutionContext ctx)

Runs a full garbage collection, both over the form and the model.

Parameters:

ctx -

Returns:

the number of garbage collected objects.

localize

public String localize(ExecutionContext ctx,
                       String message,
                       RecordHolder component)

Localizes the provided message.

Parameters:

ctx -

message - the message to localize

component -

Returns:

the localized message

localize

public String localize(ExecutionContext ctx,
                       String message)

Localized the provided message using the current component. This method should be called only from within a component records.

Parameters:

ctx -

message - the message to localize

Returns:

the localized message

detectLocation

public void detectLocation(ExecutionContext ctx,
                           RecordHolder optsHolder,
                           ClosureHolder resultCallback)

Requests a location detection.

Parameters:

ctx -

optsHolder - the position options forms::PositionOptions

resultCallback - the callback which is notified when the location has been detected

getBrowserWindowSize

public RecordHolder getBrowserWindowSize(ExecutionContext ctx)

Returns the browser window size.

Parameters:

ctx -

Returns:

forms::Dimension representing the browser window size.

addBrowserWindowResizeListener

public void addBrowserWindowResizeListener(ExecutionContext ctx,
                                           ClosureHolder listener)

Adds a listener for the browser window resize events.

Parameters:

ctx -

listener -

showDataErrorMessages

public void showDataErrorMessages(ExecutionContext ctx,
                                  ListHolder constraintViolations,
                                  RecordHolder component)

Shows the constraint violations on the components which are bound to the same record properties as the constraint violations. The components are descendants of the specified component or the component itself. If the component is not specified then all components in the form are considered.

Parameters:

ctx -

constraintViolations -

component - the component where to start; null means form's root component

clearDataErrorMessages

public void clearDataErrorMessages(ExecutionContext ctx,
                                   RecordHolder component)

Clears error messages on the components and it's descendants. If the component is not specified (it is null) then clears all error messages on the components in the form.

Parameters:

ctx -

component - the component (optional)