Package org.ametys.web.contenttype

Class SkinContentViewHelper

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.web.contenttype.SkinContentViewHelper

All Implemented Interfaces:

LogEnabled, Initializable, Component, Contextualizable, Serviceable, ThreadSafe

public class SkinContentViewHelper
extends AbstractLogEnabled
implements Component, Serviceable, ThreadSafe, Initializable, Contextualizable

Helper to get content type's views brought by the skin, linked to a model view

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	SkinContentViewHelper.SkinContentView	Rendering view of a content brought by a skin

Field Summary

Fields

Modifier and Type	Field	Description
static final String	REQUEST_PARAM_RENDERING_VIEW_NAME	The name of request parameter for skin content view
static final String	ROLE	The avalon role

Constructor Summary

Constructors

Constructor	Description
SkinContentViewHelper()

Method Summary

Modifier and Type	Method	Description
void	contextualize(Context context)
SkinContentViewHelper.SkinContentView	getContentViewFromSkin(String name, String contentTypeId)	Get the HTML content view brought by the current skin for a given content type
SkinContentViewHelper.SkinContentView	getContentViewFromSkin(String name, String contentTypeId, String format)	Get the content view brought by the current skin for a given content type
SkinContentViewHelper.SkinContentView	getContentViewFromSkin(String name, Content content)	Get the HTML content view brought by the current skin for the given content
SkinContentViewHelper.SkinContentView	getContentViewFromSkin(String name, Content content, String format)	Get the content view brought by the current skin for the given content
Set<SkinContentViewHelper.SkinContentView>	getContentViewsFromSkin(String contentTypeId)	Get the HTML content views brought by the current skin for a given content type
Set<SkinContentViewHelper.SkinContentView>	getContentViewsFromSkin(String contentTypeId, String format)	Get all the content views brought by the current skin for a given content type
Set<SkinContentViewHelper.SkinContentView>	getContentViewsFromSkin(String skinName, ContentType contentType)	Get the HTML content views brought by a given skin for a given content type
Set<SkinContentViewHelper.SkinContentView>	getContentViewsFromSkin(String skinName, ContentType contentType, String format)	Get the content views brought by the a skin for a given content type and output format
Set<SkinContentViewHelper.SkinContentView>	getContentViewsFromSkin(ContentType contentType)	Get the HTML content views brought by the current skin for a given content type
void	initialize()
void	service(ServiceManager smanager)

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Field Details

ROLE

public static final String ROLE

The avalon role

REQUEST_PARAM_RENDERING_VIEW_NAME

public static final String REQUEST_PARAM_RENDERING_VIEW_NAME

The name of request parameter for skin content view

See Also:

• Constant Field Values

Constructor Details

SkinContentViewHelper

public SkinContentViewHelper()

Method Details

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

initialize

public void initialize()
                throws Exception

Specified by:

initialize in interface Initializable

Throws:

Exception

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

getContentViewFromSkin

public SkinContentViewHelper.SkinContentView getContentViewFromSkin(String name,
 Content content)

Get the HTML content view brought by the current skin for the given content

Parameters:

name - the name of the view

content - the content

Returns:

the skin content view or null if view does not exists in skin

getContentViewFromSkin

public SkinContentViewHelper.SkinContentView getContentViewFromSkin(String name,
 Content content,
 String format)

Get the content view brought by the current skin for the given content

Parameters:

name - the name of the view

content - the content

format - the output format (html, pdf, doc, ...)

Returns:

the skin content view or null if view does not exists in skin

getContentViewFromSkin

public SkinContentViewHelper.SkinContentView getContentViewFromSkin(String name,
 String contentTypeId)

Get the HTML content view brought by the current skin for a given content type

Parameters:

name - the name of the view

contentTypeId - the content type id

Returns:

the skin content view or null if view does not exists in skin

getContentViewFromSkin

public SkinContentViewHelper.SkinContentView getContentViewFromSkin(String name,
 String contentTypeId,
 String format)

Get the content view brought by the current skin for a given content type

Parameters:

name - the name of the view

contentTypeId - the content type id

format - the output format (html, pdf, doc, ...)

Returns:

the skin content view or null if view does not exists in skin

getContentViewsFromSkin

public Set<SkinContentViewHelper.SkinContentView> getContentViewsFromSkin(String contentTypeId)

Get the HTML content views brought by the current skin for a given content type

Parameters:

contentTypeId - the content type id

Returns:

the skin content view

getContentViewsFromSkin

public Set<SkinContentViewHelper.SkinContentView> getContentViewsFromSkin(String contentTypeId,
 String format)

Get all the content views brought by the current skin for a given content type

Parameters:

contentTypeId - the content type id

format - the output format (html, pdf, doc, ...)

Returns:

the skin content view

getContentViewsFromSkin

public Set<SkinContentViewHelper.SkinContentView> getContentViewsFromSkin(ContentType contentType)

Get the HTML content views brought by the current skin for a given content type

Parameters:

contentType - the content type

Returns:

the skin content view

getContentViewsFromSkin

public Set<SkinContentViewHelper.SkinContentView> getContentViewsFromSkin(String skinName,
 ContentType contentType)

Get the HTML content views brought by a given skin for a given content type

Parameters:

skinName - the skin name

contentType - the content type

Returns:

the skin content view

getContentViewsFromSkin

public Set<SkinContentViewHelper.SkinContentView> getContentViewsFromSkin(String skinName,
 ContentType contentType,
 String format)

Get the content views brought by the a skin for a given content type and output format

Parameters:

skinName - the skin name

contentType - the content type

format - the output format (html, pdf, doc, ...)

Returns:

the skin content view