Package com.storedobject.ui.util

Class SOEnvironment

java.lang.Object

com.storedobject.ui.util.SOEnvironment

All Implemented Interfaces:

ApplicationEnvironment

public class SOEnvironment
extends Object
implements ApplicationEnvironment

Constructor Summary

Constructors

Constructor	Description
SOEnvironment()

Method Summary

Modifier and Type	Method	Description
String	createLabel(Class<?> aClass)	Create a label for displaying a particular class name.
String	createLabel(String attributeName)	Create a label for the attribute name passed.
String	getIconName(String label)	This method is used to determine the name of the icon to be displayed on a Button from its label.
ObjectColumnCreator<?>	getObjectColumnCreator()	Create a "column creator" for the application when an Object is viewed in a Grid.
ObjectFieldCreator<?>	getObjectFieldCreator()	Create the "field creator" for the application when an Object is edited or viewed in a "data entry form".
String	toDisplay(Object message)	Converts an object into a displayable form (String).
String	toString(Object any)	Converts an object into a displayable form (String).

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.storedobject.vaadin.ApplicationEnvironment

createMenuItem, createMenuItem, createMenuItemGroup, getActiveMenuIconName

Constructor Details

SOEnvironment

public SOEnvironment()

Method Details

getObjectFieldCreator

public ObjectFieldCreator<?> getObjectFieldCreator()

Description copied from interface: ApplicationEnvironment

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

Specified by:

getObjectFieldCreator in interface ApplicationEnvironment

Returns:

Field creator.

getObjectColumnCreator

public ObjectColumnCreator<?> getObjectColumnCreator()

Description copied from interface: ApplicationEnvironment

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

Specified by:

getObjectColumnCreator in interface ApplicationEnvironment

Returns:

Column creator.

toString

public String toString(Object any)

Description copied from interface: ApplicationEnvironment

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

Specified by:

toString in interface ApplicationEnvironment

Parameters:

any - Object to convert

Returns:

Converted string.

toDisplay

public String toDisplay(Object message)

Description copied from interface: ApplicationEnvironment

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

Specified by:

toDisplay in interface ApplicationEnvironment

Parameters:

message - Object to convert

Returns:

Converted string.

createLabel

public String createLabel(String attributeName)

Description copied from interface: ApplicationEnvironment

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".

Specified by:

createLabel in interface ApplicationEnvironment

Parameters:

attributeName - Attribute name

Returns:

Label.

createLabel

public String createLabel(Class<?> aClass)

Description copied from interface: ApplicationEnvironment

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 ApplicationEnvironment.createLabel(String) with the rest of the class name.

Specified by:

createLabel in interface ApplicationEnvironment

Parameters:

aClass - Class to be displayed

Returns:

Label.

getIconName

public String getIconName(String label)

Description copied from interface: ApplicationEnvironment

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".

Specified by:

getIconName in interface ApplicationEnvironment

Parameters:

label - Label on the button

Returns:

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