| Home >> All >> org >> apache >> turbine >> services >> [ template Javadoc ] |
| • | org.apache.turbine.services.template.mapper.* (9) | • | org.apache.turbine.services.template.modules.* (9) |
• org.apache.turbine.services.template: Javadoc index of package org.apache.turbine.services.template.
Package Samples:
• org.apache.turbine.services.template.mapper: Template Service maps template references to a view service and a template name.
• org.apache.turbine.services.template.modules.layouts.existing.dflt
• org.apache.turbine.services.template.modules.layouts.existing
• org.apache.turbine.services.template.modules.layouts
• org.apache.turbine.services.template.modules.navigations.existing.dflt
• org.apache.turbine.services.template.modules.navigations.existing
• org.apache.turbine.services.template.modules.navigations
• org.apache.turbine.services.template.modules.screens.existing.dflt
• org.apache.turbine.services.template.modules.screens.existing
• org.apache.turbine.services.template.modules.screens
Classes:
• TurbineTemplateService: This service provides a method for mapping templates to their appropriate Screens or Navigations. It also allows templates to define a layout/navigations/screen modularization within the template structure. It also performs caching if turned on in the properties file. This service is not bound to a specific templating engine but we will use the Velocity templating engine for the examples. It is available by using the VelocityService. This assumes the following properties in the Turbine configuration: # Register the VelocityService for the "vm" extension. services.VelocityService.template.extension=vm ...
• ClassMapper: This mapper tries to map Template names to class names. If no direct match is found, it tries matches "upwards" in the package hierarchy until either a match is found or the root is hit. Then it returns the name of the default class from the TemplateEngineService. 1. about.directions.Driving <- direct matching the template to the class name 2. about.directions.Default <- matching the package, class name is Default 3. about.Default <- stepping up in the package hierarchy, looking for Default 4. Default <- Class called "Default" without package 5. VelocityScreen <- The class configured ...
• LayoutTemplateMapper: This mapper is responsible for the lookup of templates for the Layout It tries to look in various packages for a match: 1. about,directions,Driving.vm <- exact match 2. about,directions,Default.vm <- package match, Default name 3. about,Default.vm <- stepping up in the hierarchy 4. Default.vm <- The name configured as default.layout.template in the corresponding Templating Engine
• ScreenDefaultTemplateMapper: This is a pretty simple mapper which returns template pathes for a supplied template name. If the path does not exist, it looks for a templated called "Default" in the same package. This path can be used by the TemplateEngine to access a certain resource to actually render the template.
• TemplateService: This service provides a method for mapping templates to their appropriate Screens or Navigations. It also allows templates to define a layout/navigations/screen modularization within the template structure. It also performs caching if turned on in the properties file.
• BaseTemplateEngineService: The base implementation of Turbine TemplateEngineService .
• ScreenTemplateMapper: This is a pretty simple mapper which returns template pathes for a supplied template name. This path can be used by the TemplateEngine to access a certain resource to actually render the template.
• DirectTemplateMapper: The most primitive templating mapper. It is used for the navigation template objects. It never caches and simply returns what is given to it but keeps the template extension.
• BaseTemplateMapper: This is a mapper like the BaseMapper but it returns its results with the extension of the template names passed or (if no extension is passed), the default extension.
• TemplateEngineService: This is the interface that all template engine services must adhere to. This includes the Velocity, WebMacro, FreeMarker, and JSP services.
• DirectMapper: The most primitive mapper. It is used for the page objects in the Template service. It never caches and simply returns what is given to it.
• Mapper: To separate out the various map and search policies for class names and template names, we use classes that implement this interface.
• TurbineTemplate: This is a simple static accessor to common TemplateService tasks such as getting a Screen that is associated with a screen template.
• TemplateTest: Tests all the various template mappings for Screen and Layout templates of the template service.
• ClassTest: Tests the class mapping of the Template Service for screen, layout and navigation.
• InitTest: Tests startup of the Template Service and registration of the Velocity Service.
• BaseMapper: A base class for the various mappers which contains common code.
• DefaultsTest: Tests all the various defaults for the Template Service.
• ExistPageWithClass: This is a test class for the template service.
• PageWithClass: This is a test class for the template service.
• Default: This is a test class for the template service.
• ExistPageWithClass: This is a test class for the template service.
• PageWithClass: This is a test class for the template service.
• Default: This is a test class for the template service.
• ExistPageWithClass: This is a test class for the template service.
| Home | Contact Us | Privacy Policy | Terms of Service |