de.hybris.platform.cms2lib.cmstags

Class CMSComponentTag

java.lang.Object

TagSupport

de.hybris.platform.cms2lib.cmstags.CMSComponentTag

public class CMSComponentTag
extends TagSupport

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	DEFAULT_CONTROLLER
protected static String	INIT_LE_JS

Constructor Summary

Constructors

Constructor and Description
CMSComponentTag()

Method Summary

Modifier and Type	Method and Description
int	doEndTag()
int	doStartTag()
protected Collection<SimpleCMSComponentModel>	getComponents(WebApplicationContext appContext, HttpServletRequest request)
protected ServletContext	getServletContext()
protected void	init()
protected void	initLiveEditJS(HttpServletRequest request)
protected boolean	isAllowed(AbstractCMSComponentModel component, RestrictionData restrictionData, CMSRestrictionService cmsRestrictionService, boolean previewEnabled) Checks whether component should be displayed. Note: Computation takes into account: Checks whether component is visible If component is restricted checks whether we should display it
protected boolean	isLiveEdit()
protected boolean	isPreviewEnabled()
protected RestrictionData	populate(HttpServletRequest request, CMSDataFactory cmsDataFactory) Wrapped all information fetched from current HTTP request
void	release()
void	setComponent(AbstractCMSComponentModel component)
void	setEvaluateRestriction(boolean evaluateRestriction)
void	setUid(String uid)

Methods inherited from class java.lang.Object

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

Field Detail

INIT_LE_JS

protected static final String INIT_LE_JS

See Also:

Constant Field Values

DEFAULT_CONTROLLER

protected static final String DEFAULT_CONTROLLER

See Also:

Constant Field Values

Constructor Detail

CMSComponentTag

public CMSComponentTag()

Method Detail

release

public void release()

init

protected void init()

getServletContext

protected ServletContext getServletContext()

getComponents

protected Collection<SimpleCMSComponentModel> getComponents(WebApplicationContext appContext,
                                                            HttpServletRequest request)
                                                     throws CMSItemNotFoundException

Throws:

CMSItemNotFoundException

isAllowed

protected boolean isAllowed(AbstractCMSComponentModel component,
                            RestrictionData restrictionData,
                            CMSRestrictionService cmsRestrictionService,
                            boolean previewEnabled)

Checks whether component should be displayed.

Note: Computation takes into account:

• Checks whether component is visible
• If component is restricted checks whether we should display it

isPreviewEnabled

protected boolean isPreviewEnabled()

isLiveEdit

protected boolean isLiveEdit()

doStartTag

public int doStartTag()
               throws JspException

Throws:

JspException

initLiveEditJS

protected void initLiveEditJS(HttpServletRequest request)

doEndTag

public int doEndTag()
             throws JspException

Throws:

JspException

setUid

public void setUid(String uid)

setComponent

public void setComponent(AbstractCMSComponentModel component)

setEvaluateRestriction

public void setEvaluateRestriction(boolean evaluateRestriction)

populate

protected RestrictionData populate(HttpServletRequest request,
                                   CMSDataFactory cmsDataFactory)

Wrapped all information fetched from current HTTP request

Parameters:

request - current HTTP request

Returns:

all gather information wrapped to RestrictionData object