程序包 cn.taketoday.web.view

类 ViewReturnValueHandler

java.lang.Object

cn.taketoday.web.view.ViewReturnValueHandler

所有已实现的接口:

SmartReturnValueHandler, ReturnValueHandler

public class ViewReturnValueHandler
extends Object
implements SmartReturnValueHandler

view-name or View and ViewRef ReturnValueHandler

从以下版本开始:

4.0 2022/2/9 20:34

作者:

Harry Yang

另请参阅:

• View
• RedirectModel
• RedirectModelManager
• HandlerMethod

字段概要

字段

修饰符和类型	字段	说明
private LocaleResolver	localeResolver
private final ViewResolver	viewResolver

从接口继承的字段 cn.taketoday.web.ReturnValueHandler

NONE_RETURN_VALUE

构造器概要

构造器

构造器	说明
ViewReturnValueHandler(ViewResolver viewResolver)
ViewReturnValueHandler(ViewResolver viewResolver, LocaleResolver localeResolver)

方法概要

修饰符和类型	方法	说明
private Locale	getLocale(RequestContext request)	Retrieve the current locale from the given request, using the LocaleResolver bound to the request by the Ioc (if available), falling back to the request's accept-header Locale.
LocaleResolver	getLocaleResolver()	Returns LocaleResolver
ViewResolver	getViewResolver()	Returns ViewResolver
void	handleReturnValue(RequestContext context, Object handler, Object returnValue)	Handle result of the handler
void	renderView(RequestContext request, ModelAndView mv)	Resolve ModelAndView return type
void	renderView(RequestContext context, View view)	rendering a View
void	renderView(RequestContext context, ViewRef viewRef)	rendering a view from viewName
void	renderView(RequestContext context, ViewRef viewRef, Map<String,Object> model)	rendering a view from viewName
void	renderView(RequestContext context, View view, Map<String,Object> model)	rendering a View
void	renderView(RequestContext context, CharSequence viewName)	rendering a view from viewName
void	renderView(RequestContext context, String viewName)	rendering a view from viewName
void	renderView(RequestContext context, String viewName, Map<String,Object> model)	rendering a view from viewName
private View	resolveViewName(RequestContext context, String viewName, Locale locale)
private View	resolveViewName(Locale locale, String viewName)
void	setLocaleResolver(LocaleResolver localeResolver)	set localeResolver to determine the Locale in which to resolve the view.
boolean	supportsHandler(Object handler, Object returnValue)	handle handler and its return value
boolean	supportsReturnValue(Object returnValue)	If this ReturnValueHandler supports the target handler's result

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

从接口继承的方法 cn.taketoday.web.handler.result.SmartReturnValueHandler

supportsHandler

字段详细资料

viewResolver

private final ViewResolver viewResolver

localeResolver

@Nullable
private LocaleResolver localeResolver

构造器详细资料

ViewReturnValueHandler

public ViewReturnValueHandler(ViewResolver viewResolver)

ViewReturnValueHandler

public ViewReturnValueHandler(ViewResolver viewResolver,
 @Nullable
 LocaleResolver localeResolver)

方法详细资料

supportsHandler

public boolean supportsHandler(Object handler,
 @Nullable
 Object returnValue)

从接口复制的说明: SmartReturnValueHandler

handle handler and its return value

default is supportsHandler or supportsReturnValue returns true

指定者:

supportsHandler 在接口中 SmartReturnValueHandler

参数:

handler - target handler

returnValue - handler's return value

supportsReturnValue

public boolean supportsReturnValue(@Nullable
 Object returnValue)

从接口复制的说明: ReturnValueHandler

If this ReturnValueHandler supports the target handler's result

This method can test this ReturnValueHandler supports the target handler in application runtime

指定者:

supportsReturnValue 在接口中 ReturnValueHandler

参数:

returnValue - Target handler's return-value or result

返回:

If this ReturnValueHandler supports the target handler's result

handleReturnValue

public void handleReturnValue(RequestContext context,
 @Nullable
 Object handler,
 @Nullable
 Object returnValue)
                       throws ViewRenderingException

从接口复制的说明: ReturnValueHandler

Handle result of the handler

指定者:

handleReturnValue 在接口中 ReturnValueHandler

参数:

context - Current HTTP request context

handler - Target HTTP handler

returnValue - Handler execution result Or HandlerExceptionHandler return value

抛出:

ViewRenderingException - Could not resolve view with given name

renderView

public void renderView(RequestContext request,
 @Nullable
 ModelAndView mv)
                throws ViewRenderingException

Resolve ModelAndView return type

抛出:

ViewRenderingException

renderView

public void renderView(RequestContext context,
 CharSequence viewName)

rendering a view from viewName

参数:

context - current HTTP request context

viewName - View to render

抛出:

ViewRenderingException - If view rendering failed

renderView

public void renderView(RequestContext context,
 String viewName)

rendering a view from viewName

参数:

context - current HTTP request context

viewName - View to render

抛出:

ViewRenderingException - If view rendering failed

renderView

public void renderView(RequestContext context,
 String viewName,
 @Nullable
 Map<String,Object> model)

rendering a view from viewName

参数:

context - current HTTP request context

viewName - View to render

抛出:

ViewRenderingException - If view rendering failed

renderView

public void renderView(RequestContext context,
 ViewRef viewRef)

rendering a view from viewName

参数:

context - current HTTP request context

viewRef - ViewRef to render

抛出:

ViewRenderingException - If view rendering failed

renderView

public void renderView(RequestContext context,
 ViewRef viewRef,
 @Nullable
 Map<String,Object> model)

rendering a view from viewName

参数:

context - current HTTP request context

viewRef - ViewRef to render

抛出:

ViewRenderingException - If view rendering failed

getLocale

private Locale getLocale(RequestContext request)

Retrieve the current locale from the given request, using the LocaleResolver bound to the request by the Ioc (if available), falling back to the request's accept-header Locale.

This method serves as a straightforward alternative to the standard Servlet ServletRequest.getLocale() method, falling back to the latter if no more specific locale has been found.

Consider using LocaleContextHolder.getLocale() which will normally be populated with the same Locale.

参数:

request - current HTTP request

返回:

the current locale for the given request, either from the LocaleResolver or from the plain request itself

renderView

public void renderView(RequestContext context,
 View view)

rendering a View

参数:

context - current HTTP request context

view - View to render

抛出:

ViewRenderingException - If view rendering failed

renderView

public void renderView(RequestContext context,
 View view,
 @Nullable
 Map<String,Object> model)

rendering a View

参数:

context - current HTTP request context

view - View to render

抛出:

ViewRenderingException - If view rendering failed

setLocaleResolver

public void setLocaleResolver(@Nullable
 LocaleResolver localeResolver)

set localeResolver to determine the Locale in which to resolve the view. ViewResolvers that support internationalization should respect this.

If localeResolver is null use RequestContextUtils.getLocale(RequestContext) to find Locale

参数:

localeResolver - to determine the Locale in which to resolve the view

getLocaleResolver

@Nullable
public LocaleResolver getLocaleResolver()

Returns LocaleResolver

返回:

LocaleResolver

getViewResolver

public ViewResolver getViewResolver()

Returns ViewResolver

返回:

ViewResolver

resolveViewName

private View resolveViewName(RequestContext context,
 String viewName,
 @Nullable
 Locale locale)

resolveViewName

@Nullable
private View resolveViewName(Locale locale,
 String viewName)