|Home >> All >> org >> apache >> struts >> [ tiles Javadoc ]|
|||org.apache.struts.tiles.actions.* (4)||||org.apache.struts.tiles.beans.* (2)|
|||org.apache.struts.tiles.definition.* (2)||||org.apache.struts.tiles.xmlDefinition.* (8)|
org.apache.struts.tiles: Javadoc index of package org.apache.struts.tiles.
org.apache.struts.tiles.xmlDefinition: The Tiles taglib and framework allows building web pages by assembling reusable pieces of pages, called Tiles.
TilesRequestProcessor: RequestProcessor contains the processing logic that the Struts controller servlet performs as it receives each servlet request from the container. This processor subclasses the Struts RequestProcessor in order to intercept calls to forward or include. When such calls are done, the Tiles processor checks if the specified URI is a definition name. If true, the definition is retrieved and included. If false, the original URI is included or a forward is performed. Actually, catching is done by overloading the following methods: processForwardConfig(HttpServletRequest,HttpServletResponse,ForwardConfig) ...
TilesPlugin: Tiles Plugin used to initialize Tiles. This plugin is to be used with Struts 1.1 in association with TilesRequestProcessor . This plugin creates one definition factory for each Struts-module. The definition factory configuration is read first from 'web.xml' (backward compatibility), then it is overloaded with values found in the plugin property values. The plugin changes the Struts configuration by specifying a TilesRequestProcessor as request processor. If you want to use your own RequestProcessor, it should subclass TilesRequestProcessor. This plugin can also be used to create one single factory ...
DefinitionDispatcherAction: An Action that dispatches to a Tiles Definition that is named by the request parameter whose name is specified by the parameter property of the corresponding ActionMapping. This action is useful in following situations: To associate an Url to a definition To use Struts <html:link> tag on a definition To configure the use of this action in your struts-config.xml file, create an entry like this: <action path="/saveSubscription" type="org.apache.struts.tiles.actions.DefinitionDispatcherAction" parameter="def"/> <forward name="success" path="anything" //> <forward name="error" ...
TilesUtil: Class containing utility methods for Tiles. Methods of this class are static and thereby accessible from anywhere. The underlying implementation can be changed with setTilesUtil(TilesUtilImpl) 55 . Real implementation classes should derive from the TilesUtilImpl class. Some methods are specified to throw the UnsupportedOperationException if the underlying implementation doesn't support the operation.
DefinitionsFactory: Tiles Definition factory. This interface replace old ComponentDefinitionsFactory. Main method getDefinition() is exactly the same. Initialization method change. This interface allows to retrieve a definition by its name, independently of the factory implementation. Object life cycle is as follow: Constructor: create object setConfig: set config and initialize factory. After first call to this method, factory is operational. destroy: factory is being shutdown. Implementation must be Serializable, in order to be compliant with web Container having this constraint (Weblogic 6.x).
I18nFactorySet: Definitions factory. This implementation allows to have a set of definition factories. There is a main factory and one factory for each file associated to a Locale. To retrieve a definition, we first search for the appropriate factory using the Locale found in session context. If no factory is found, use the default one. Then we ask the factory for the definition. A definition factory file is loaded using main filename extended with locale code (ex : templateDefinitions_fr.xml ). If no file is found under this name, use default file.
TilesUtilStrutsModulesImpl: Implementation of TilesUtil for Struts multi modules. Methods in this implementation are aware of the Struts module context. The method getFactory(...) returns the factory for the current Struts module. Methods doForward() and doInclude() use their counterparts in the current RequestProcessor (todo). The method createFactory(...) creates a factory for the current module and stores it under the appropriate property name.
TilesAction: Base class for Tiles Actions. This class has the same role as Struts Action. It provides a method execute(...) called when action is invoked. The difference is, that the execute() method takes an additional parameter : tile context. This class extends Struts Action. Subclasses should override execute(ComponentContext ...) method instead of Struts execute(ActionMapping ...) method.
TilesUtilStrutsImpl: TilesUtil implementation for Struts 1.1 with one single factory. This class contains default implementation of utilities. This implementation is intended to be used with Struts 1.1. This class is used as the base class for all Struts 1.1 implementations of TilesUtil.
ComponentDefinitionsFactory: Component repository interface. This interface allows to retrieve an definition by its name, independently of the factory implementation. Implementation must be Serializable, in order to be compliant with web Container having this constraint (Weblogic 6.x).
ReloadDefinitionsAction: A standard Action that calls the reload() method of our controller servlet to reload its configuration information from the configuration files (which have presumably been updated) dynamically.
XmlListAttribute: An attribute as a List . This attribute associates a name with a list. The list can be found by the property name. Elements in list are retrieved using List methods. This class is used to read configuration files.
FactorySet: Component Definitions factory. This factory contains several factories identified by a key. The getDefinition() method first looks for the factory key, retrieves or creates this factory and then calls its getDefinition().
ComponentDefinition: Definition of a template / component attributes. Attributes of a component can be defined with the help of this class. An instance of this class can be used as a bean, and passed to 'insert' tag.
ReloadableDefinitionsFactory: A reloadable factory. This factory is the main entrance to any factory implementation. It takes in charge real implementation instance, and allows reloading by creating a new instance.
Controller: A controller is a piece of code called before rendering a jsp page. A controller can be associated to a tile. See <insert> or <definition> for association syntax.
ControllerSupport: Basic implementation of Controller. Implementations can extend this class to insulate themselves from changes in the Controller interface.
TilesUtilImpl: Default implementation of TilesUtil. This class contains default implementation of utilities. This implementation is intended to be used without Struts.
ComponentDefinitionsFactoryWrapper: Wrapper from new definition factory interface to old interface. This class provides mapping from the old interface's life cycle to the new life cycle.
ViewDefinitionsAction: An Action that writes the definitions of the Tiles factory. Useful to check what is effectivly loaded in a Tiles factory
ActionController: Struts wrapper implementation of Controller. This implementation wraps an Action in a Controller .
DefinitionsUtil: Utilities class for definitions factory. Also define userDebugLevel property (TODO to be moved from this class ?).
DefinitionAttribute: Attribute representing a Component Definition. This attribute definition contains a Component definition.