net.sf.mmm.client.ui.base

Class UiConfigurationDefault

java.lang.Object

net.sf.mmm.client.ui.base.AbstractUiConfiguration

net.sf.mmm.client.ui.base.UiConfigurationDefault

All Implemented Interfaces:

UiConfiguration

Direct Known Subclasses:

UiConfigurationBean

public class UiConfigurationDefault
extends AbstractUiConfiguration

This is the default implementation of UiConfiguration.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields inherited from interface net.sf.mmm.client.ui.api.UiConfiguration

DEFAULT_THEME

Constructor Summary

Constructors

Constructor and Description
UiConfigurationDefault() The constructor.

Method Summary

Modifier and Type	Method and Description
NlsMessageLookup	getLabelLookup() This method gets the instance of NlsMessageLookup used to lookup labels automatically by property titles via UiDataBinding.
String	getTheme() This method gets the path for the current theme.

Methods inherited from class java.lang.Object

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

Constructor Detail

UiConfigurationDefault

public UiConfigurationDefault()

The constructor.

Method Detail

getTheme

public String getTheme()

This method gets the path for the current theme. This is attached to all relative image URLs. You can use this to switch to a different theme in order to get a different appearance of the UI. Typically you decide for a theme at build-time. However, this allows to switch themes at runtime.

Returns:

the URL path for the current theme.

getLabelLookup

public NlsMessageLookup getLabelLookup()

This method gets the instance of NlsMessageLookup used to lookup labels automatically by property titles via UiDataBinding. So you can highly customize your labels for your custom defined properties and have full I18N/l10n support with little effort. For rapid development you can also ignore all this and just live with the property title that is used as fallback if lookup fails.
For full support you create an interface e.g. NlsBundleMyLabelsRoot that extends from NlsBundleWithLookup. For further details look at NlsBundle. For each property title such as lastName you define an according method in your bundle (NlsBundleMyLabelsRoot):

 public interface NlsBundleMyLabelsRoot extends NlsBundleWithLookup {
    @NlsBundleMessage("Last name")
   NlsMessage lastName();
   ...
 }
 

E.g. for German localization you define NlsBundleMyLabels_de.properties in the same package with this content:

 lastName = Nachname
 ...
 

Now we assume you have a business object like this:

 public interface Partner {

   TypedProperty <String> PROPERTY_LAST_NAME = new TypedProperty <>("lastName", String.class);

 }
 

you can use createAndBind(Partner.PROPERTY_LAST_NAME) to create an input field widget and the label will be set automatically to your localized label text ("Last Name", "Vorname", or whatever).
Now if you refactor your code so the property lastName gets renamed to surename and you want to keep your NLS/I18N properties stable, you can change your declaration to

 public interface Partner {

   TypedProperty <String> PROPERTY_LAST_NAME = new TypedProperty <>("surename", String.class, "lastName");

 }
 

And maybe also rename it to PROPERTY_SURENAME.
You could also use "Partner_surename" as property title if you want to have a different label for surename in a different business object e.g. Address. You only need to ensure that the property title matches the method name and therefore key in your NlsBundleWithLookup. You can also use "Partner.surename" with the following trick:

    @NlsBundleKey("Partner.surename")
    @NlsBundleMessage("Last name")
   NlsMessage PartnerSurename();
 

NOTE:
It is recommended to specify the property type in your TypedProperty constant. However, this is technically not required and you may also omit it. This might cause a little performance overhead as the property type has to be reflected then. Also you need to be careful not to pick the wrong constructor for this purpose such as TypedProperty.TypedProperty(String, String).

Returns:

the NlsMessageLookup instance for automatic label creation. You should typically use NlsMessageLookupProxy in your custom implementation of this method.

See Also:

UiDataBinding