org.araneaframework.uilib
Interface ConfigurationContext

All Superinterfaces:
Serializable
All Known Implementing Classes:
StandardConfiguration

public interface ConfigurationContext
extends Serializable

Configuration context for Uilib widgets. Constants defined here are the keys under which some existing widgets search their configuration.

Author:
Jevgeni Kabanov (ekabanov at araneaframework dot org)

Field Summary
static String AUTO_COMPLETE_RESPONSE_BUILDER
          AutoCompleteTextControl.ResponseBuilder that configures how AutoCompleteTextControl sends back the suggested completions.
static String BACKGROUND_FORM_VALIDATION
          This java.lang.Boolean property should be set to true if application wants all forms to be validated on-the-fly.
static String CUSTOM_CONVERTER_PROVIDER
          The full class name of the implementation of ConverterProvider interface that will override the default.
static String CUSTOM_DATE_FORMAT
          String containing the patterns for Date date validation.
static String CUSTOM_TIME_FORMAT
          String containing the patterns for Date time validation.
static String DEFAULT_DATE_OUTPUT_FORMAT
          String containing the format for Date default date output.
static String DEFAULT_LIST_ITEMS_ON_PAGE
          Long that controls the default size of the list (eg how many rows are shown on one page).
static String DEFAULT_LIST_PAGES_ON_BLOCK
          Long that controls the default of how many list pages combine into one block for quick navigation.
static String DEFAULT_TIME_OUTPUT_FORMAT
          String containing the format for Date default time output.
static String FORMELEMENT_ERROR_RENDERER
          This property should be set to the class which stores the errors produced by failed FormElement validations.
static String FULL_LIST_ITEMS_ON_PAGE
          Long that controls the full size of the list (eg how many rows maximum may be shown at once).
static String LIKE_CONFIGURATION
          LikeConfiguration that configures Like filter in lists.
static String LIST_FILTER_CONFIGURATOR
          FilterFormBuilderVisitor.Configurator that configures the built filter form elements.
static String LIST_PRESERVE_STARTING_ROW
          Boolean that controls whether to preserve the list starting row when switching to showing full list and back.
static String LOCALIZE_FIXED_CONTROL_DATA
          This property is of type java.lang.Boolean and specifies whether data of controls, that have fixed values (i.e.
static String TAGS_EL_EVALUATE
          This property should be set as a Boolean to specify whether the tags should evaluate JSP EL.
 
Method Summary
 Object getEntry(String entryName)
          Returns a configuration entry with given name.
 

Field Detail

CUSTOM_DATE_FORMAT

static final String CUSTOM_DATE_FORMAT
String containing the patterns for Date date validation.

See Also:
Constant Field Values

CUSTOM_TIME_FORMAT

static final String CUSTOM_TIME_FORMAT
String containing the patterns for Date time validation.

See Also:
Constant Field Values

DEFAULT_DATE_OUTPUT_FORMAT

static final String DEFAULT_DATE_OUTPUT_FORMAT
String containing the format for Date default date output.

See Also:
Constant Field Values

DEFAULT_TIME_OUTPUT_FORMAT

static final String DEFAULT_TIME_OUTPUT_FORMAT
String containing the format for Date default time output.

See Also:
Constant Field Values

CUSTOM_CONVERTER_PROVIDER

static final String CUSTOM_CONVERTER_PROVIDER
The full class name of the implementation of ConverterProvider interface that will override the default.

See Also:
Constant Field Values

DEFAULT_LIST_ITEMS_ON_PAGE

static final String DEFAULT_LIST_ITEMS_ON_PAGE
Long that controls the default size of the list (eg how many rows are shown on one page).

See Also:
Constant Field Values

FULL_LIST_ITEMS_ON_PAGE

static final String FULL_LIST_ITEMS_ON_PAGE
Long that controls the full size of the list (eg how many rows maximum may be shown at once).

See Also:
Constant Field Values

DEFAULT_LIST_PAGES_ON_BLOCK

static final String DEFAULT_LIST_PAGES_ON_BLOCK
Long that controls the default of how many list pages combine into one block for quick navigation.

See Also:
Constant Field Values

LIST_PRESERVE_STARTING_ROW

static final String LIST_PRESERVE_STARTING_ROW
Boolean that controls whether to preserve the list starting row when switching to showing full list and back.

See Also:
Constant Field Values

LIST_FILTER_CONFIGURATOR

static final String LIST_FILTER_CONFIGURATOR
FilterFormBuilderVisitor.Configurator that configures the built filter form elements.

See Also:
Constant Field Values

AUTO_COMPLETE_RESPONSE_BUILDER

static final String AUTO_COMPLETE_RESPONSE_BUILDER
AutoCompleteTextControl.ResponseBuilder that configures how AutoCompleteTextControl sends back the suggested completions.

See Also:
Constant Field Values

LIKE_CONFIGURATION

static final String LIKE_CONFIGURATION
LikeConfiguration that configures Like filter in lists.

See Also:
Constant Field Values

BACKGROUND_FORM_VALIDATION

static final String BACKGROUND_FORM_VALIDATION
This java.lang.Boolean property should be set to true if application wants all forms to be validated on-the-fly. Validation is done by invoking server-side ActionListeners that perform the validation. When this is set to false, programmer can manually enable action validation for those FormWidget/FormElement which should be validated on-the-fly. When ConfigurationContext does not include entry corresponding to this property, it defaults to false.

Since:
1.1
See Also:
Constant Field Values

FORMELEMENT_ERROR_RENDERER

static final String FORMELEMENT_ERROR_RENDERER
This property should be set to the class which stores the errors produced by failed FormElement validations. When this property is not set, StandardFormElementValidationErrorRenderer is used.

See Also:
Constant Field Values

LOCALIZE_FIXED_CONTROL_DATA

static final String LOCALIZE_FIXED_CONTROL_DATA
This property is of type java.lang.Boolean and specifies whether data of controls, that have fixed values (i.e. SelectControl, MultiSelectControl), should be localized.

By default, it is not enabled (this may change in near future).

You can override this setting when you use a tag to render the control.

Since:
1.2
See Also:
Constant Field Values

TAGS_EL_EVALUATE

static final String TAGS_EL_EVALUATE
This property should be set as a Boolean to specify whether the tags should evaluate JSP EL. Default is true.

See Also:
Constant Field Values
Method Detail

getEntry

Object getEntry(String entryName)
Returns a configuration entry with given name.