| com.opensymphony.module.sitemesh.mapper |
|
| Java Source File Name | Type | Comment |
| AbstractDecoratorMapper.java | Class | Abstract DecoratorMapper implementation for easy creation of new DecoratorMappers. |
| AgentDecoratorMapper.java | Class | The AgentDecoratorMapper can determine the user-agent (i.e. |
| ConfigDecoratorMapper.java | Class | Default implementation of DecoratorMapper. |
| ConfigLoader.java | Class | The ConfigLoader reads a configuration XML file that contains Decorator definitions
(name, url, init-params) and path-mappings (pattern, name). |
| ConfigLoaderTest.java | Class | |
| CookieDecoratorMapper.java | Class | The CookieDecoratorMapper will map a suitable decorator based on a cookie value. |
| DefaultDecorator.java | Class | Default implementation of Decorator. |
| EnvEntryDecoratorMapper.java | Class | The EnvEntryDecoratorMapper allows the reference to a web-app environment entry for the
decorator name, and falls back to ConfigDecoratorMapper's behavior if no matching
environment entry is found.
In some cases, it's desirable to allow a deployer, as opposed to a developer,
to specify a decorator. |
| FileDecoratorMapper.java | Class | The FileDecoratorMapper will treat the name of the decorator as a file-name to use
(in the context of the web-app). |
| FrameSetDecoratorMapper.java | Class | The FrameSetDecoratorMapper will use the specified decorator when the Page
is an instance of
com.opensymphony.module.sitemesh.HTMLPage and
isFrameSet() returns true. |
| InlineDecoratorMapper.java | Class | The InlineDecoratorMapper is used to determine the correct Decorator when
using inline decorators.
It will check the request attribute value defined by the key
com.opensymphony.module.sitemesh.RequestConstants.DECORATOR and use the appropriate named
Decorator. |
| LanguageDecoratorMapper.java | Class | The LanguageDecoratorMapper can determine the preferred language set in the
browser requesting a page, and map to a suitable Decorator (using the
"Accept-Language" HTTP header).
This can be useful for supplying different versions of the same content
for different languages.
When LanguageDecoratorMapper is in the chain, it will request the appropriate Decorator
from its parent. |
| NullDecoratorMapper.java | Class | The NullDecoratorMapper represents the top-level DecoratorMapper that
is finally delegated to if no other DecoratorMapper has intervened. |
| OSDecoratorMapper.java | Class | The OSDecoratorMapper will map a suitable decorator based on the operating system
of the remote client.
OSDecoratorMapper works by checking to see if the "UA-OS" header
was sent with the HTTP request. |
| PageDecoratorMapper.java | Class | The PageDecoratorMapper allows the actual Page to determine the Decorator to be
used.
The 'meta.decorator' and 'decorator' properties of the page are accessed
and if any of them contain the name of a valid Decorator, that Decorator shall
be applied.
As an example, if HTML is being used, the Decorator could be chosen by using
a <html decorator="mydecorator"> root tag or by using a
<meta name="decorator" content="mydecorator"> tag in the header.
The actual properties to query are specified by passing properties to the mapper using the
property.? prefix. |
| ParameterDecoratorMapper.java | Class | The ParameterDecoratorMapper will map a suitable decorator based on request
parameters. |
| PathMapper.java | Class | The PathMapper is used to map file patterns to keys, and find an approriate
key for a given file path. |
| PathMapperTest.java | Class | |
| PrintableDecoratorMapper.java | Class | The PrintableDecoratorMapper is a sample DecoratorMapper that will
check to see whether 'printable=true' is supplied as a request parameter
and if so, use the specified decorator instead. |
| RobotDecoratorMapper.java | Class | The RobotDecoratorMapper will use the specified decorator when the requester
is identified as a robot (also known as spider, crawler, ferret) of a search engine. |
| SessionDecoratorMapper.java | Class | Will look at a session attribute to find the name of an appropriate decorator to use. |