Package com.storedobject.vaadin

Interface ApplicationEnvironment

All Known Implementing Classes:

SOEnvironment

public interface ApplicationEnvironment

Application can set up an environment that controls certain behaviours of the application.

Author:

Syam

See Also:

• Application.createEnvironment()

Method Summary

Modifier and Type	Method	Description
default String	createLabel(Class<?> aClass)	Create a label for displaying a particular class name.
default String	createLabel(String attributeName)	Create a label for the attribute name passed.
default ApplicationMenuItem	createMenuItem(ExecutableView view, String menuLabel, Runnable menuAction)	Create a menu item for the View.
default ApplicationMenuItem	createMenuItem(String menuLabel, String icon, Runnable menuAction)	Create a menu item.
default ApplicationMenuItemGroup	createMenuItemGroup(String menuLabel)	Create a menu item.
static ApplicationEnvironment	get()	Create a default implementation.
default String	getActiveMenuIconName()	Get the menu icon to be used for active (running) Views.
default String	getIconName(String label)	This method is used to determine the name of the icon to be displayed on a Button from its label.
default ObjectColumnCreator<?>	getObjectColumnCreator()	Create a "column creator" for the application when an Object is viewed in a Grid.
default ObjectFieldCreator<?>	getObjectFieldCreator()	Create the "field creator" for the application when an Object is edited or viewed in a "data entry form".
default String	toDisplay(Object any)	Converts an object into a displayable form (String).
default String	toString(Object any)	Converts an object into a displayable form (String).

Method Details

getObjectFieldCreator

default ObjectFieldCreator<?> getObjectFieldCreator()

Create the "field creator" for the application when an Object is edited or viewed in a "data entry form".

Returns:

Field creator.

getObjectColumnCreator

default ObjectColumnCreator<?> getObjectColumnCreator()

Create a "column creator" for the application when an Object is viewed in a Grid.

Returns:

Column creator.

toString

default String toString(Object any)

Converts an object into a displayable form (String). The default implementation converts it by invoking Object.toString().

Parameters:

any - Object to convert

Returns:

Converted string.

toDisplay

default String toDisplay(Object any)

Converts an object into a displayable form (String). The default implementation converts Exception to its message and rest of the types to toString(Object).

Parameters:

any - Object to convert

Returns:

Converted string.

createLabel

default String createLabel(String attributeName)

Create a label for the attribute name passed. This is typically used for creating labels for field names. The default implementation converts the name to camel case words. For example, "firstName" will be converted to "First Name".

Parameters:

attributeName - Attribute name

Returns:

Label.

createLabel

default String createLabel(Class<?> aClass)

Create a label for displaying a particular class name. (A class's name may have to be displayed in some part of the application and this method is invoked for that). The default implementation strips of the "package" portion and invokes createLabel(String) with the rest of the class name.

Parameters:

aClass - Class to be displayed

Returns:

Label.

getIconName

default String getIconName(String label)

This method is used to determine the name of the icon to be displayed on a Button from its label. The default implementation returns certain basic names. For example, for labels like "save", "ok", "yes" etc., it returns "check".

Parameters:

label - Label on the button

Returns:

Name of the icon (Icons are created using Icon class).

createMenuItem

default ApplicationMenuItem createMenuItem(String menuLabel,
 String icon,
 Runnable menuAction)

Create a menu item.

Parameters:

menuLabel - Menu label

icon - Icon

menuAction - Action associated with the menu item

Returns:

Menu item created.

createMenuItem

default ApplicationMenuItem createMenuItem(ExecutableView view,
 String menuLabel,
 Runnable menuAction)

Create a menu item for the View.

Parameters:

view - View for which menu item needs to be created

menuLabel - Menu label

menuAction - Action associated with the menu item

Returns:

Menu item created.

createMenuItemGroup

default ApplicationMenuItemGroup createMenuItemGroup(String menuLabel)

Create a menu item.

Parameters:

menuLabel - Menu label

Returns:

Menu item created.

getActiveMenuIconName

default String getActiveMenuIconName()

Get the menu icon to be used for active (running) Views.

Returns:

Default implementation returns "vaadin:cogs".

get

static ApplicationEnvironment get()

Create a default implementation.

Returns:

A default implementation of the "application environment".