|
Eclipse Rich Ajax Platform | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ApplicationConfigurator
Note: This API is provisional. It is likely to change before the final release.
AnApplicationConfigurator
instance is used to provide an RWT
ApplicationConfiguration
to the RWT runtime system.
The latter is represented by an Application
instance.
Each Application
instance takes exactly one configurator.
The simplest implementation of an ApplicationConfigurator
looks like this:
public class ExampleApplicationConfigurator implements ApplicationConfigurator { public void configure( ApplicationConfiguration configuration ) { configuration.addEntryPoint( "example", ExampleEntryPoint.class ); } }The
configure
method serves as callback for the Application
instance. The application uses this
method to retrieve the configuration at runtime. The example above shows how to register an
IEntryPoint
that will be used by the application at runtime
to provide application specific UIs.
In general RWT developers do not have to interact with the Application
instance
directly. An ApplicationConfigurator
implementation generally gets picked up
by the declaration system of the surrounding container. In case of a servlet container for
example the configurator is registered as context-param
in the
web.xml
, with OSGi
you might register it as a service using DS and
in the RAP workbench you do not see it at all as configuration is supplied via
extension-points
.
Note that the configurator is called only once during application lifetime. Configuration of the application takes place before the system gets activated. Therefore manipulation of the configuration instance at a later point in time is not an intended use case and will likely have no effect to the system.
Application
,
ApplicationConfiguration
Field Summary | |
---|---|
static java.lang.String |
CONFIGURATOR_PARAM
Value for the param-name of an context-param declaration that
declares an ApplicationConfigurator in a web.xml . |
static java.lang.String |
RESOURCE_ROOT_LOCATION
|
Method Summary | |
---|---|
void |
configure(ApplicationConfiguration configuration)
Callback method that allows to configure the given application configuration. |
Field Detail |
---|
static final java.lang.String CONFIGURATOR_PARAM
param-name
of an context-param
declaration that
declares an ApplicationConfigurator
in a web.xml
. The value of
param-value
in such an declaration has to be the fully qualified class name
of the configuration implementation in question.
static final java.lang.String RESOURCE_ROOT_LOCATION
Method Detail |
---|
void configure(ApplicationConfiguration configuration)
ApplicationConfigurator
class documentation for more details.
configuration
- Object that allows to apply various configuration settings to
the RWT runtime system
|
Eclipse Rich Ajax Platform | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright (c) EclipseSource and others 2002, 2011. All rights reserved.