Polish Javadoc for FreeMarker support
This commit is contained in:
parent
b58f34d802
commit
ac28de0dc1
|
@ -44,10 +44,10 @@ import org.springframework.web.util.UriTemplate;
|
||||||
* use, current locale, binding errors, etc. Provides easy access to localized
|
* use, current locale, binding errors, etc. Provides easy access to localized
|
||||||
* messages and Errors instances.
|
* messages and Errors instances.
|
||||||
*
|
*
|
||||||
* <p>Suitable for exposition to views, and usage within FreeMarker templates,
|
* <p>Suitable for exposition to views, and usage within FreeMarker templates
|
||||||
* and tag libraries.
|
* and tag libraries.
|
||||||
*
|
*
|
||||||
* <p>Can be instantiated manually, or automatically exposed to views as model
|
* <p>Can be instantiated manually or automatically exposed to views as a model
|
||||||
* attribute via AbstractView's "requestContextAttribute" property.
|
* attribute via AbstractView's "requestContextAttribute" property.
|
||||||
*
|
*
|
||||||
* @author Rossen Stoyanchev
|
* @author Rossen Stoyanchev
|
||||||
|
|
|
@ -188,7 +188,7 @@ public class UrlBasedViewResolver extends ViewResolverSupport
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Return the name of the @link RequestContext} attribute for all views, if any.
|
* Return the name of the {@link RequestContext} attribute for all views, if any.
|
||||||
*/
|
*/
|
||||||
@Nullable
|
@Nullable
|
||||||
protected String getRequestContextAttribute() {
|
protected String getRequestContextAttribute() {
|
||||||
|
|
|
@ -40,7 +40,7 @@ import org.springframework.util.Assert;
|
||||||
* using {@link FreeMarkerView}. It exists purely to configure FreeMarker.
|
* using {@link FreeMarkerView}. It exists purely to configure FreeMarker.
|
||||||
* It is not meant to be referenced by application components but just internally
|
* It is not meant to be referenced by application components but just internally
|
||||||
* by {@code FreeMarkerView}. Implements {@link FreeMarkerConfig} to be found by
|
* by {@code FreeMarkerView}. Implements {@link FreeMarkerConfig} to be found by
|
||||||
* {@code FreeMarkerView} without depending on the bean name the configurer.
|
* {@code FreeMarkerView} without depending on the bean name of the configurer.
|
||||||
*
|
*
|
||||||
* <p>Note that you can also refer to a pre-configured FreeMarker Configuration
|
* <p>Note that you can also refer to a pre-configured FreeMarker Configuration
|
||||||
* instance via the "configuration" property. This allows to share a FreeMarker
|
* instance via the "configuration" property. This allows to share a FreeMarker
|
||||||
|
|
|
@ -54,7 +54,7 @@ import org.springframework.web.server.ServerWebExchange;
|
||||||
*
|
*
|
||||||
* <p>Depends on a single {@link FreeMarkerConfig} object such as
|
* <p>Depends on a single {@link FreeMarkerConfig} object such as
|
||||||
* {@link FreeMarkerConfigurer} being accessible in the application context.
|
* {@link FreeMarkerConfigurer} being accessible in the application context.
|
||||||
* Alternatively set the FreeMarker configuration can be set directly on this
|
* Alternatively the FreeMarker configuration can be set directly on this
|
||||||
* class via {@link #setConfiguration}.
|
* class via {@link #setConfiguration}.
|
||||||
*
|
*
|
||||||
* <p>The {@link #setUrl(String) url} property is the location of the FreeMarker
|
* <p>The {@link #setUrl(String) url} property is the location of the FreeMarker
|
||||||
|
|
|
@ -48,7 +48,7 @@ import org.springframework.web.context.ServletContextAware;
|
||||||
* using Spring's FreeMarkerView for web MVC. It exists purely to configure FreeMarker.
|
* using Spring's FreeMarkerView for web MVC. It exists purely to configure FreeMarker.
|
||||||
* It is not meant to be referenced by application components but just internally
|
* It is not meant to be referenced by application components but just internally
|
||||||
* by FreeMarkerView. Implements FreeMarkerConfig to be found by FreeMarkerView without
|
* by FreeMarkerView. Implements FreeMarkerConfig to be found by FreeMarkerView without
|
||||||
* depending on the bean name the configurer. Each DispatcherServlet can define its
|
* depending on the bean name of the configurer. Each DispatcherServlet can define its
|
||||||
* own FreeMarkerConfigurer if desired.
|
* own FreeMarkerConfigurer if desired.
|
||||||
*
|
*
|
||||||
* <p>Note that you can also refer to a preconfigured FreeMarker Configuration
|
* <p>Note that you can also refer to a preconfigured FreeMarker Configuration
|
||||||
|
@ -57,8 +57,7 @@ import org.springframework.web.context.ServletContextAware;
|
||||||
* for web and email usage, for example.
|
* for web and email usage, for example.
|
||||||
*
|
*
|
||||||
* <p>This configurer registers a template loader for this package, allowing to
|
* <p>This configurer registers a template loader for this package, allowing to
|
||||||
* reference the "spring.ftl" macro library (contained in this package and thus
|
* reference the "spring.ftl" macro library contained in this package:
|
||||||
* in spring.jar) like this:
|
|
||||||
*
|
*
|
||||||
* <pre class="code">
|
* <pre class="code">
|
||||||
* <#import "/spring.ftl" as spring/>
|
* <#import "/spring.ftl" as spring/>
|
||||||
|
|
|
@ -70,8 +70,9 @@ import org.springframework.web.servlet.view.AbstractTemplateView;
|
||||||
*
|
*
|
||||||
* <p>Depends on a single {@link FreeMarkerConfig} object such as {@link FreeMarkerConfigurer}
|
* <p>Depends on a single {@link FreeMarkerConfig} object such as {@link FreeMarkerConfigurer}
|
||||||
* being accessible in the current web application context, with any bean name.
|
* being accessible in the current web application context, with any bean name.
|
||||||
* Alternatively, you can set the FreeMarker {@link Configuration} object as bean property.
|
* Alternatively, you can set the FreeMarker {@link Configuration} object as a
|
||||||
* See {@link #setConfiguration} for more details on the impacts of this approach.
|
* bean property. See {@link #setConfiguration} for more details on the impacts
|
||||||
|
* of this approach.
|
||||||
*
|
*
|
||||||
* <p>Note: Spring's FreeMarker support requires FreeMarker 2.3 or higher.
|
* <p>Note: Spring's FreeMarker support requires FreeMarker 2.3 or higher.
|
||||||
*
|
*
|
||||||
|
|
|
@ -11,7 +11,7 @@
|
||||||
* FreeMarkerConfigurer.
|
* FreeMarkerConfigurer.
|
||||||
*
|
*
|
||||||
* To take advantage of these macros, the "exposeSpringMacroHelpers" property
|
* To take advantage of these macros, the "exposeSpringMacroHelpers" property
|
||||||
* of the FreeMarker class needs to be set to "true". This will expose a
|
* of the FreeMarkerView class needs to be set to "true". This will expose a
|
||||||
* RequestContext under the name "springMacroRequestContext", as needed by
|
* RequestContext under the name "springMacroRequestContext", as needed by
|
||||||
* the macros in this library.
|
* the macros in this library.
|
||||||
*
|
*
|
||||||
|
|
Loading…
Reference in New Issue