Interface CTDisplayRenderer<T>
- All Known Implementing Classes:
BaseCTDisplayRenderer
public interface CTDisplayRenderer<T>
Display renderer used to describe and render models of a given type. If an
exception occurs during rendering, the default renderer is used instead.
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptiondefault TfetchLatestVersionedModel(T model) default String[]getAvailableLanguageIds(T model) default StringgetDefaultLanguageId(T model) default InputStreamgetDownloadInputStream(T model, String key) Returns the input stream for the model and key from when the URL was generated during rendering.getEditURL(javax.servlet.http.HttpServletRequest httpServletRequest, T model) Returns the edit URL for the model (optionallynull).Returns the model class for this display renderer.Returns the title for the model.getTypeName(Locale locale) Returns the translated type name for the model type.default StringgetVersionName(T model) default booleanisHideable(T model) Returns whether the model may be hidden by default.voidrender(DisplayContext<T> displayContext) Renders the model with the display context.default StringrenderPreview(DisplayContext<T> displayContext) default boolean
-
Method Details
-
fetchLatestVersionedModel
-
getAvailableLanguageIds
-
getDefaultLanguageId
-
getDownloadInputStream
default InputStream getDownloadInputStream(T model, String key) throws com.liferay.portal.kernel.exception.PortalException Returns the input stream for the model and key from when the URL was generated during rendering.- Parameters:
model- the model for the downloadkey- the key used when creating the download URL- Returns:
- the input stream
- Throws:
com.liferay.portal.kernel.exception.PortalException- See Also:
-
getEditURL
String getEditURL(javax.servlet.http.HttpServletRequest httpServletRequest, T model) throws Exception Returns the edit URL for the model (optionallynull).- Parameters:
httpServletRequest- the requestmodel- the model to be edited- Returns:
- the URL to use for editing the model
- Throws:
Exception- if an exception occurred
-
getModelClass
Returns the model class for this display renderer.- Returns:
- the model class for this display renderer
-
getTitle
Returns the title for the model.- Parameters:
locale- to use for translationmodel- the model for this display renderer- Returns:
- the title for the model
- Throws:
com.liferay.portal.kernel.exception.PortalException- if a portal exception occurred
-
getTypeName
Returns the translated type name for the model type.- Parameters:
locale- to use for translation- Returns:
- the type name for the model type
-
getVersionName
-
isHideable
Returns whether the model may be hidden by default. Hidden models may be filtered out in some views.- Parameters:
model- the model to be shown or hidden by default- Returns:
- whether the model may be hidden by default
-
render
Renders the model with the display context.- Parameters:
displayContext- the context for rendering the model- Throws:
Exception- if an exception occurred
-
renderPreview
- Throws:
Exception
-
showPreviewDiff
default boolean showPreviewDiff()
-