net.sf.jzeno.echo
Class EchoSupport

java.lang.Object
  net.sf.jzeno.echo.EchoSupport

public class EchoSupport
extends java.lang.Object

The EchoSupport class is one of the main interfaces between the jZeno environment and you application code.

For developer convenience, the methods on this class are all static, and are therefore easy to call from any context in you application code.

This class contains a variety of operations, like:

• Optimized wrappers for doing java reflection calls (reading/writing javabean properties dynamically). Finding out the type of such a property path, etc.. These methods are optimized for speed, and avoid looking up the right read/write methods all the time, as they cache these lookups.
• Setting errors and messages on your application.
• Searching for a dynamic component in you component tree, based on various criteria.
• Navigating to a different screen in your application.
• Validating (parts) of the component tree, and triggering error marking.
• ...

Constructor Summary

EchoSupport()


Method Summary

static boolean	addActionListener(Component source, ActionListener listener) Convenience method for adding action listeners to a component.
static void	addError(Component c, java.lang.String key) Adds an application error to a specific component.
static void	addError(Component c, java.lang.String key, java.lang.Object[] args) Adds an application error to a specific component.
static void	addError(java.lang.String key) Adds an application error to the layout.
static void	addError(java.lang.String key, java.lang.Object[] args) Adds an application error to the layout.
static void	addMessage(Component c, java.lang.String key) Adds an application message to a specific component.
static void	addMessage(Component c, java.lang.String key, java.lang.Object[] args) Adds an application message to a specific component.
static void	addMessage(java.lang.String key) Adds an application message to the layout.
static void	addMessage(java.lang.String key, java.lang.Object[] args) Adds an application message to the layout.
static void	addScreenChangeListener(ScreenChangeListener listener) Add a screen change listener to the system.
static void	applyStyle(Component component, Style style) Generic implementation of applyStyle.
static void	back() Return to the previous screen (if any, otherwise do nothing).
static Screen	backToScreen(java.lang.Class screenClass) Find a screen in the history of the specified type.
static boolean	beanEquals(java.lang.Object first, java.lang.Object second) Generic java bean equals method that does an equals operation on all public properties of the bean to determine equality.
static void	checkValidationStyle(PropertyComponent pc)
static void	clearErrorsAndMessages() Clears all errors and messages.
static java.lang.Object	create(java.lang.Class clazz)
static Component	createComponent(java.lang.Class componentClass) Create an instance of a given class.
static Component	createComponent(java.lang.String fullyQualifiedClassName) Create an instance of a given class.
static Layout	createDefaultLayout()
static PropertyComponent	createEditor(java.lang.Class beanClass, java.lang.String property, java.lang.String constructionHints) Create a default editor for the given property in the domain model cluster. use the hints parameter to manipulate detailed properties of the newly created component.
static PropertyComponent	createPropertyComponent(java.lang.Class componentClass, java.lang.Class beanClass, java.lang.String propertyPath, java.lang.String constructionHints) Generic construction of property components.
static Screen	createScreen(java.lang.String className) This method will create an instance of the screen of the specified class.
static Screen	createScreen(java.lang.String className, boolean reload) This method will create an instance of the screen of the specified class.
static PropertyComponent	createViewer(java.lang.Class bean, java.lang.String property, java.lang.String constructionHints) Creates a matching default viewer (read-only component) for the supplied property(path) from the supplied bean.
static void	doPrerenderRebindRecursively()
static void	doPrerenderRebindRecursively(Component rootComponent, boolean forValidation)
static void	doValidationChildrenRecursively(Component startFromComponent) Does error marking on all child PropertyComponents of a given root component.
static void	doValidationRecursively(Component startFromComponent) Performs error marking on (a part of) the component tree.
static void	doValidationRecursively(Component startFromComponent, java.util.List excludedComponents) Performs error marking on (a part of) the component tree.
static void	executeHints(java.lang.Object target, java.lang.String constructionHints)
static void	executeJavaScript(java.lang.String javaScriptExecutedOnceOnWindowLoad) This operation allows you to add a one-off script to the on-load of the page that will be rendered out after your current code finishes.
static void	exit()
static void	exit(java.lang.String targetUrl)
static java.util.Map	extractKeyValuePairs(java.lang.String constructionHints)
static java.util.List	findAllComponentsByType(Component startFromComponent, java.lang.Class componentType) Retrieve all components of a specific type in the component tree that have startFromComponent as ancestor.
static java.util.List	findAllComponentsByTypeOrSubType(Component startFromComponent, java.lang.Class componentType) Retrieve all components of a specific type or subtype of componentType in the component tree that have startFromComponent as ancestor.
static void	findAllPropertyComponentsForRebindAndPreRender(Component startFrom, java.util.List components, java.util.Map extendedChildToParent) Recursively find all _visible_ property components in the component tree starting from a given startFrom component.
static void	findAllPropertyComponentsForRebindAndPreRender(Component startFrom, java.util.List components, java.util.Map extendedChildToParent, boolean forValidation)
static Component	findComponentByType(java.lang.Class componentType) Retrieve a component of a specified type in the screen.
static Component	findComponentByType(Component startFromComponent, java.lang.Class componentType) Retrieve a component of a specific type, that is a child for the startFromComponent.
static EventSink	findEventSinkAboveComponent(Component eventSource) Finds the nearest event sink for a given component.
static PropertyComponent	findPropertyComponent(Component startFromComponent, java.lang.Object beanOrNull, java.lang.String propertyNameOrNull) Recursively tries to find a property component in the component tree that binds to the specified property/bean combination.
static PropertyComponent	findPropertyComponent(Component startFromComponent, java.lang.String propertyName) Look for a component in a part of the component tree (starting from the indicated root) that is bound to a specific property.
static PropertyComponent	findPropertyComponent(java.lang.Object beanOrNull, java.lang.String propertyNameOrNull) Convenience method for looking up a component in the current screen, based on the bean it's bound to and/or the property it is bound to.
static PropertyComponent	findPropertyComponent(java.lang.String propertyName) Convenience method for looking up a component in the current screen, based on the property it is bound to.
static PropertyComponent	findPropertyComponentByPropertyValue(Component startFromComponent, java.lang.String propertyToSearch, java.lang.Object propertyValueToSearch) Recursively tries to find a property component in the component tree that has a specific property value.
static void	forceReload()
static java.util.List	getAllChildPropertyComponents(Component startFrom) Enumerates all child property components in (a part of) the component tree.
static java.util.List	getAllPropertyComponents() A convenience method to enumerate all property components in the component tree.
static java.util.List	getAllPropertyComponents(Component startFrom) Enumerates all property components in (a part of) the component tree.
static java.util.List	getAllPropertyComponents(Component startFrom, boolean recurseRecursionSealers) A convenience method to enumerate all property components in the component tree.
static void	getAllVisiblePropertyComponents(java.util.List list, Component current)
static void	getAllVisiblePropertyComponents(java.util.List list, Component current, boolean excludeDynaTables)
static AutoRebindManager	getAutoRebindManager() Retrieves the AutoRebindManager.
static java.text.DateFormat	getDateFormat() Retrieve the configured dateformat object.
static FastFactory	getFastFactory()
static Screen	getInitialScreen() Determines the initial screen the user is shown when he logs into the application.
static Color	getInvalidBackground() Retrieves the configured background color for invalid components.
static int	getInvalidBorderSize() Gets the border size for invalid components.
static java.lang.String	getInvalidCssClass() Gets the configured css class for invalid input fields.
static Color	getInvalidForeground() Retrieves the configured foreground color for invalid components.
static Layout	getLayout() Retrieve the default Layout instance.
static java.lang.Object[]	getObjectValues(PropertyComponent pc) Convenience operation for retrieving all values from the given propertyComponent's property path.
static java.lang.Object	getProperty(java.lang.Object bean, java.lang.String propertyPath) Read the value of a property path.
static java.lang.Class	getPropertyType(java.lang.Class rootClass, java.lang.String propertyPath) Convenience method to determine the type of a property path, without needing to have an actual instance.
static java.util.List	getReadMethodsForPropertyPath(java.lang.Class beanClass, java.lang.String propertyPath) This method returns a list of java.lang.reflect.Method instances that you can invoke to read the full property path that you specified, starting with a root bean of the given type.
static Color	getReadOnlyBackground() Retrieves the configured background color for read-only input fields.
static java.lang.String	getReadOnlyCssClass() Gets the configured css class for read-only input fields.
static Color	getReadOnlyForeground() Retrieves the configured foreground color for the read-only input fields.
static RenderManager	getRenderManager() Retrieves the RenderManager.
static Color	getRequiredBackground() Gets the configured background color for required input fields.
static java.lang.String	getRequiredCssClass() Gets the configured css class for required input fields.
static Color	getRequiredForeground() Retrieves the configured foreground color for required input fields.
static Screen	getScreen() Context-free operation to determine the current screen of the application.
static Style	getStyle(java.lang.String styleName) Retrieves a Style instance from the configured StyleManager.
static StyleManager	getStyleManager()
static java.text.DateFormat	getTimeFormat() Retrieve the configured timeformat object.
static boolean	getTransparency(Component c) Gets the transparency property on the given component, if supported, otherwise false is returned.
static java.lang.String	getWrapperClassName(java.lang.String className) This method translates a fully qualified java class name, and traslates that into a wrapper class name, if the specified class name was a java primitive type.
static java.util.List	getWriteMethodsForPropertyPathInternal(java.lang.Class beanClass, java.lang.String propertyPath) Internal helper operation to find the methods to execute when writing to a property-path.
static void	invokeEventHandler(ActionEvent event, EventSink target)
static boolean	isValidChildrenRecursively(Component startFrom) Checks that all children of the given root component are valid.
static boolean	isValidRecursively(Component startFromComponent) Checks all PropertyComponents, beneath a given root and returns false if at least one of them is not valid (isValid() == false).
static boolean	isValidRecursively(Component startFromComponent, java.util.List excludedComponents) Checks all PropertyComponents, beneath a given root and returns false if at least one of them is not valid (isValid() == false).
static boolean	isVisible(Component c) Check that this component is visible in the browser.
static void	markValidRecursively(Component startFrom) Marks a part of your component tree as valid.
static void	removeAllScreenChangeListeners() Remove all screen change listeners from the system.
static void	removeScreenChangeListener(ScreenChangeListener listener) Remove a screen change listener from the system.
static Component	replaceComponent(Component replaceMe, Component withMe) In order to manipulate the component tree, this convenience method is supplied to allow replacing an existing component in the component tree, with a new component.
static void	replaceFastFactory()
static void	resetCaches()
static void	resetScheduledDowntime() Reset display of scheduled downtime in supporting layouts.
static void	setLayout(Layout l)
static void	setProperty(java.lang.Object bean, java.lang.String propertyPath, java.lang.Object value) Write a new value into a property path.
static void	setReadOnlyRecursively(Component startFrom) This method allows you to mark (a part of) the component tree as read-only.
static void	setReadOnlyRecursively(Component startFrom, boolean value) This method allows you to mark (a part of) the component tree as read-only.
static void	setScheduledDowntime(java.lang.String msg, java.util.Date startTime, java.lang.Integer duration) Set scheduled downtime for display in supporting layouts.
static void	setScreen(Screen newContent) Sets a new screen to display.
static void	setScreen(Screen newContent, boolean addToNavigationHistory)
static void	setScreen(Screen newContent, Layout layout) Set a new screen, and specify a custom Layout instance to use.
static void	setScreen(Screen newContent, Layout layout, boolean addToNavigationHistory)
static void	setTransparency(Component c, boolean transparent) Turns transparency on/off if the component supports this.
static java.lang.String	translate(java.lang.String key)
static java.lang.String	translate(java.lang.String key, java.lang.Object[] parameters)

Methods inherited from class java.lang.Object

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

Constructor Detail

EchoSupport

public EchoSupport()

Method Detail

getReadMethodsForPropertyPath

public static java.util.List getReadMethodsForPropertyPath(java.lang.Class beanClass,
                                                           java.lang.String propertyPath)

This method returns a list of java.lang.reflect.Method instances that you can invoke to read the full property path that you specified, starting with a root bean of the given type.

getWriteMethodsForPropertyPathInternal

public static java.util.List getWriteMethodsForPropertyPathInternal(java.lang.Class beanClass,
                                                                    java.lang.String propertyPath)

Internal helper operation to find the methods to execute when writing to a property-path. It returns null if the path is invalid. Otherwise it returns a list of read methods, and 1 write method, that allows you to execute them if required.

setProperty

public static void setProperty(java.lang.Object bean,
                               java.lang.String propertyPath,
                               java.lang.Object value)

Write a new value into a property path. This method is optimized for speed. Use this inside you own application code as well, whenever you need to dynamically set a property or property path.

getProperty

public static java.lang.Object getProperty(java.lang.Object bean,
                                           java.lang.String propertyPath)

Read the value of a property path. This method is optimized for speed. Use this in your own application code if you need to write to a javabean property dynamically.

getPropertyType

public static java.lang.Class getPropertyType(java.lang.Class rootClass,
                                              java.lang.String propertyPath)

Convenience method to determine the type of a property path, without needing to have an actual instance. It simple traverses the property path by looking at the reflection metadata.

executeHints

public static void executeHints(java.lang.Object target,
                                java.lang.String constructionHints)

See Also:

ConstructionHintsInterpreter.executeHints(Object, String)

extractKeyValuePairs

public static java.util.Map extractKeyValuePairs(java.lang.String constructionHints)

See Also:

ConstructionHintsInterpreter.extractKeyValuePairs(String)

createComponent

public static Component createComponent(java.lang.String fullyQualifiedClassName)

Create an instance of a given class. The class is specified as a string. This string should be the fully qualified class name of the component to instantiate.

createComponent

public static Component createComponent(java.lang.Class componentClass)

Create an instance of a given class.

createEditor

public static PropertyComponent createEditor(java.lang.Class beanClass,
                                             java.lang.String property,
                                             java.lang.String constructionHints)

Create a default editor for the given property in the domain model cluster. use the hints parameter to manipulate detailed properties of the newly created component.

Returns:

the default editor for the property type, or null if nothing matched.

createViewer

public static PropertyComponent createViewer(java.lang.Class bean,
                                             java.lang.String property,
                                             java.lang.String constructionHints)

Creates a matching default viewer (read-only component) for the supplied property(path) from the supplied bean. It determines the default editor based on the type of the property you're refering. Use the constructionHints parameter to fine-tune properties on the new viewer component.

Returns:

the default viewer for the property type, or null if nothing matched.

getWrapperClassName

public static java.lang.String getWrapperClassName(java.lang.String className)

This method translates a fully qualified java class name, and traslates that into a wrapper class name, if the specified class name was a java primitive type.

createPropertyComponent

public static PropertyComponent createPropertyComponent(java.lang.Class componentClass,
                                                        java.lang.Class beanClass,
                                                        java.lang.String propertyPath,
                                                        java.lang.String constructionHints)

Generic construction of property components.

Returns:

the create property component.

findPropertyComponent

public static PropertyComponent findPropertyComponent(Component startFromComponent,
                                                      java.lang.Object beanOrNull,
                                                      java.lang.String propertyNameOrNull)

Recursively tries to find a property component in the component tree that binds to the specified property/bean combination.

Parameters:

startFromComponent - start looking in the component tree, beneath this given root

beanOrNull - look for a component bound to this bean (or any bean if null)

propertyNameOrNull - look for a component bound to this property (or any property if null).

Returns:

the PropertyComponent that matched your criteria

findPropertyComponentByPropertyValue

public static PropertyComponent findPropertyComponentByPropertyValue(Component startFromComponent,
                                                                     java.lang.String propertyToSearch,
                                                                     java.lang.Object propertyValueToSearch)

Recursively tries to find a property component in the component tree that has a specific property value.

Parameters:

startFromComponent - start looking from this component down in the component tree.

propertyToSearch - look for a component with this property.

propertyValueToSearch - look for a component with this property value.

Returns:

the PropertyComponent that matched your criteria

findPropertyComponent

public static PropertyComponent findPropertyComponent(Component startFromComponent,
                                                      java.lang.String propertyName)

Look for a component in a part of the component tree (starting from the indicated root) that is bound to a specific property.

findPropertyComponent

public static PropertyComponent findPropertyComponent(java.lang.String propertyName)

Convenience method for looking up a component in the current screen, based on the property it is bound to.

findPropertyComponent

public static PropertyComponent findPropertyComponent(java.lang.Object beanOrNull,
                                                      java.lang.String propertyNameOrNull)

Convenience method for looking up a component in the current screen, based on the bean it's bound to and/or the property it is bound to.

findComponentByType

public static Component findComponentByType(Component startFromComponent,
                                            java.lang.Class componentType)

Retrieve a component of a specific type, that is a child for the startFromComponent.

findAllComponentsByType

public static java.util.List findAllComponentsByType(Component startFromComponent,
                                                     java.lang.Class componentType)

Retrieve all components of a specific type in the component tree that have startFromComponent as ancestor.

findAllComponentsByTypeOrSubType

public static java.util.List findAllComponentsByTypeOrSubType(Component startFromComponent,
                                                              java.lang.Class componentType)

Retrieve all components of a specific type or subtype of componentType in the component tree that have startFromComponent as ancestor.

findComponentByType

public static Component findComponentByType(java.lang.Class componentType)

Retrieve a component of a specified type in the screen.

setScheduledDowntime

public static void setScheduledDowntime(java.lang.String msg,
                                        java.util.Date startTime,
                                        java.lang.Integer duration)

Set scheduled downtime for display in supporting layouts.

resetScheduledDowntime

public static void resetScheduledDowntime()

Reset display of scheduled downtime in supporting layouts.

getLayout

public static Layout getLayout()

Retrieve the default Layout instance.

setLayout

public static void setLayout(Layout l)

createDefaultLayout

public static Layout createDefaultLayout()

setScreen

public static void setScreen(Screen newContent)

Sets a new screen to display. Use this to navigate between screens. The default configured layout instance is used for the layout.

An advised way of passing parameters into your new screen would be to simply pass in constructor arguments when instantiating your new screen.

setScreen

public static void setScreen(Screen newContent,
                             boolean addToNavigationHistory)

setScreen

public static void setScreen(Screen newContent,
                             Layout layout)

Set a new screen, and specify a custom Layout instance to use.

setScreen

public static void setScreen(Screen newContent,
                             Layout layout,
                             boolean addToNavigationHistory)

back

public static void back()

Return to the previous screen (if any, otherwise do nothing).

backToScreen

public static Screen backToScreen(java.lang.Class screenClass)

Find a screen in the history of the specified type. Does NOT navigate to that screen, only returns it.

addScreenChangeListener

public static void addScreenChangeListener(ScreenChangeListener listener)

Add a screen change listener to the system. These listeners have the ability to veto the navigation to a new screen. Any operation that triggers a navigation to a new screen (like setScreen, back, etc...) will first query all registered listeners for permission to affect the change. Adding an individual listener instance twice will only result in a single registration.

Parameters:

listener -

removeScreenChangeListener

public static void removeScreenChangeListener(ScreenChangeListener listener)

Remove a screen change listener from the system.

Parameters:

listener -

removeAllScreenChangeListeners

public static void removeAllScreenChangeListeners()

Remove all screen change listeners from the system.

getScreen

public static Screen getScreen()

Context-free operation to determine the current screen of the application.

executeJavaScript

public static void executeJavaScript(java.lang.String javaScriptExecutedOnceOnWindowLoad)

This operation allows you to add a one-off script to the on-load of the page that will be rendered out after your current code finishes. Typical usage includes opening a popup with a URL that is outside of the application, etc...

Parameters:

javaScriptExecutedOnceOnWindowLoad - the javascript to execute.

findEventSinkAboveComponent

public static EventSink findEventSinkAboveComponent(Component eventSource)

Finds the nearest event sink for a given component.

isValidRecursively

public static boolean isValidRecursively(Component startFromComponent)

Checks all PropertyComponents, beneath a given root and returns false if at least one of them is not valid (isValid() == false). So if all PropertyComponents that are offspring of the root, and the root itself are valid, than this operation returns true. The purpose of this operation is clearly to check for pending user input errors.

isValidRecursively

public static boolean isValidRecursively(Component startFromComponent,
                                         java.util.List excludedComponents)

Checks all PropertyComponents, beneath a given root and returns false if at least one of them is not valid (isValid() == false). So if all PropertyComponents that are offspring of the root, and the root itself are valid, than this operation returns true. The purpose of this operation is clearly to check for pending user input errors.

A list of components that need to be excluded can be supplied.

isValidChildrenRecursively

public static boolean isValidChildrenRecursively(Component startFrom)

Checks that all children of the given root component are valid. Also see isValidRecursively(Component).

doValidationRecursively

public static void doValidationRecursively(Component startFromComponent)

Performs error marking on (a part of) the component tree. It basically takes all PropertyComponents a part of the component tree, starting from the specified root, and :

1. Marks all of the found components as valid, to clear any previous error marking.
2. Marks all components that are invalid (isValid returned false) as invalid.

doValidationRecursively

public static void doValidationRecursively(Component startFromComponent,
                                           java.util.List excludedComponents)

Performs error marking on (a part of) the component tree. It basically takes all PropertyComponents a part of the component tree, starting from the specified root, and :

1. Marks all of the found components as valid, to clear any previous error marking.
2. Marks all components that are invalid (isValid returned false) as invalid.

A list of exluded components can be supplied

doValidationChildrenRecursively

public static void doValidationChildrenRecursively(Component startFromComponent)

Does error marking on all child PropertyComponents of a given root component. Also see doValidationChildrenRecursively(Component).

checkValidationStyle

public static void checkValidationStyle(PropertyComponent pc)

isVisible

public static boolean isVisible(Component c)

Check that this component is visible in the browser. It will check that this, and all parent components of this component, are visible. If a component is a cell in a DynaTable, it will also take into account that the component is on the currently visible page.

getAllPropertyComponents

public static java.util.List getAllPropertyComponents()

A convenience method to enumerate all property components in the component tree.

getAllPropertyComponents

public static java.util.List getAllPropertyComponents(Component startFrom,
                                                      boolean recurseRecursionSealers)

A convenience method to enumerate all property components in the component tree.

You can specify wether or not you want to stop at autonomous components (implementing the RecursionSealer tagging interface).

Returns:

getAllChildPropertyComponents

public static java.util.List getAllChildPropertyComponents(Component startFrom)

Enumerates all child property components in (a part of) the component tree.

getAllPropertyComponents

public static java.util.List getAllPropertyComponents(Component startFrom)

Enumerates all property components in (a part of) the component tree. Inluding the specified root.

replaceComponent

public static Component replaceComponent(Component replaceMe,
                                         Component withMe)

In order to manipulate the component tree, this convenience method is supplied to allow replacing an existing component in the component tree, with a new component.

setTransparency

public static void setTransparency(Component c,
                                   boolean transparent)

Turns transparency on/off if the component supports this.

getTransparency

public static boolean getTransparency(Component c)

Gets the transparency property on the given component, if supported, otherwise false is returned.

getInitialScreen

public static Screen getInitialScreen()

Determines the initial screen the user is shown when he logs into the application.

resetCaches

public static void resetCaches()

invokeEventHandler

public static void invokeEventHandler(ActionEvent event,
                                      EventSink target)

addActionListener

public static boolean addActionListener(Component source,
                                        ActionListener listener)

Convenience method for adding action listeners to a component. If the component does not support action listeners, the method returns false (true if registration of the listener went ok)

getObjectValues

public static java.lang.Object[] getObjectValues(PropertyComponent pc)

Convenience operation for retrieving all values from the given propertyComponent's property path.

getAutoRebindManager

public static AutoRebindManager getAutoRebindManager()

Retrieves the AutoRebindManager.

getRenderManager

public static RenderManager getRenderManager()

Retrieves the RenderManager.

setReadOnlyRecursively

public static void setReadOnlyRecursively(Component startFrom)

This method allows you to mark (a part of) the component tree as read-only. All dynamic components support read-only, and as such this method provides an easy way to allow a user to view (a part of) a certain screen, but not to modify any information.

setReadOnlyRecursively

public static void setReadOnlyRecursively(Component startFrom,
                                          boolean value)

This method allows you to mark (a part of) the component tree as read-only. All dynamic components support read-only, and as such this method provides an easy way to allow a user to view (a part of) a certain screen, but not to modify any information.

findAllPropertyComponentsForRebindAndPreRender

public static void findAllPropertyComponentsForRebindAndPreRender(Component startFrom,
                                                                  java.util.List components,
                                                                  java.util.Map extendedChildToParent)

Recursively find all _visible_ property components in the component tree starting from a given startFrom component. This function also returns the DynaTables and the components contained within tables as if they were part of the component tree. The extededChildToParent map returns the reverse child parent relationship so the component tree can be traversed both ways.

findAllPropertyComponentsForRebindAndPreRender

public static void findAllPropertyComponentsForRebindAndPreRender(Component startFrom,
                                                                  java.util.List components,
                                                                  java.util.Map extendedChildToParent,
                                                                  boolean forValidation)

getAllVisiblePropertyComponents

public static void getAllVisiblePropertyComponents(java.util.List list,
                                                   Component current)

getAllVisiblePropertyComponents

public static void getAllVisiblePropertyComponents(java.util.List list,
                                                   Component current,
                                                   boolean excludeDynaTables)

getStyle

public static Style getStyle(java.lang.String styleName)

Retrieves a Style instance from the configured StyleManager.

getStyleManager

public static StyleManager getStyleManager()

getDateFormat

public static java.text.DateFormat getDateFormat()

Retrieve the configured dateformat object. This can be set in the configuration.properties, using the dateformat.class.name option.

getTimeFormat

public static java.text.DateFormat getTimeFormat()

Retrieve the configured timeformat object. This can be set in the configuration.properties, using the timeformat.class.name option.

clearErrorsAndMessages

public static void clearErrorsAndMessages()

Clears all errors and messages.

addMessage

public static void addMessage(java.lang.String key)

Adds an application message to the layout. You supply a resource key that is used to identify the real message (in i18n.properties).

addMessage

public static void addMessage(java.lang.String key,
                              java.lang.Object[] args)

Adds an application message to the layout. You supply a resource key that is used to identify the real message (in i18n.properties ). Arguments that appear in the resource file as {0},{1},.. are filled with the supplied arguments.

addError

public static void addError(java.lang.String key)

Adds an application error to the layout. You supply a resource key that is used to identify the real message (in i18n.properties ).

addError

public static void addError(java.lang.String key,
                            java.lang.Object[] args)

Adds an application error to the layout. You supply a resource key that is used to identify the real message (in i18n.properties ). Arguments that appear in the resource file as {0},{1},.. are filled with the supplied arguments.

addMessage

public static void addMessage(Component c,
                              java.lang.String key)

Adds an application message to a specific component. You supply a resource key that is used to identify the real message (in i18n.properties).

addMessage

public static void addMessage(Component c,
                              java.lang.String key,
                              java.lang.Object[] args)

Adds an application message to a specific component. You supply a resource key that is used to identify the real message (in i18n.properties ). Arguments that appear in the resource file as {0},{1},.. are filled with the supplied arguments.

addError

public static void addError(Component c,
                            java.lang.String key)

Adds an application error to a specific component. You supply a resource key that is used to identify the real message (in i18n.properties ).

addError

public static void addError(Component c,
                            java.lang.String key,
                            java.lang.Object[] args)

Adds an application error to a specific component. You supply a resource key that is used to identify the real message (in i18n.properties ). Arguments that appear in the resource file as {0},{1},.. are filled with the supplied arguments.

translate

public static java.lang.String translate(java.lang.String key)

translate

public static java.lang.String translate(java.lang.String key,
                                         java.lang.Object[] parameters)

getRequiredCssClass

public static java.lang.String getRequiredCssClass()

Gets the configured css class for required input fields.

getReadOnlyCssClass

public static java.lang.String getReadOnlyCssClass()

Gets the configured css class for read-only input fields.

getInvalidCssClass

public static java.lang.String getInvalidCssClass()

Gets the configured css class for invalid input fields.

getRequiredBackground

public static Color getRequiredBackground()

Gets the configured background color for required input fields.

getRequiredForeground

public static Color getRequiredForeground()

Retrieves the configured foreground color for required input fields.

getReadOnlyBackground

public static Color getReadOnlyBackground()

Retrieves the configured background color for read-only input fields.

getReadOnlyForeground

public static Color getReadOnlyForeground()

Retrieves the configured foreground color for the read-only input fields.

getInvalidBackground

public static Color getInvalidBackground()

Retrieves the configured background color for invalid components.

getInvalidForeground

public static Color getInvalidForeground()

Retrieves the configured foreground color for invalid components.

getInvalidBorderSize

public static int getInvalidBorderSize()

Gets the border size for invalid components.

beanEquals

public static boolean beanEquals(java.lang.Object first,
                                 java.lang.Object second)

Generic java bean equals method that does an equals operation on all public properties of the bean to determine equality.

markValidRecursively

public static void markValidRecursively(Component startFrom)

Marks a part of your component tree as valid. All error marking on invalid components are removed.

Parameters:

startFrom -

applyStyle

public static void applyStyle(Component component,
                              Style style)

Generic implementation of applyStyle. This method can be used in your own components to apply the style of a certain component unto itself. Any style that is specified is taken to be the name of a property with the same type as the style attribute, and applied to the component.

doPrerenderRebindRecursively

public static void doPrerenderRebindRecursively()

doPrerenderRebindRecursively

public static void doPrerenderRebindRecursively(Component rootComponent,
                                                boolean forValidation)

createScreen

public static Screen createScreen(java.lang.String className)

This method will create an instance of the screen of the specified class. classes.

createScreen

public static Screen createScreen(java.lang.String className,
                                  boolean reload)

This method will create an instance of the screen of the specified class. The purpose of this method is to allow dynamic reloading of modified UI classes.

create

public static java.lang.Object create(java.lang.Class clazz)

getFastFactory

public static FastFactory getFastFactory()

replaceFastFactory

public static void replaceFastFactory()

exit

public static void exit()

exit

public static void exit(java.lang.String targetUrl)

forceReload

public static void forceReload()