Package de.hybris.platform.cms2lib.cmstags

Class CMSComponentTag

java.lang.Object

javax.servlet.jsp.tagext.TagSupport

de.hybris.platform.cms2lib.cmstags.CMSComponentTag

All Implemented Interfaces:

java.io.Serializable, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag

public class CMSComponentTag
extends javax.servlet.jsp.tagext.TagSupport

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected static java.lang.String	DEFAULT_CONTROLLER
protected static java.lang.String	INIT_LE_JS

Fields inherited from class javax.servlet.jsp.tagext.TagSupport

id, pageContext

Fields inherited from interface javax.servlet.jsp.tagext.IterationTag

EVAL_BODY_AGAIN

Fields inherited from interface javax.servlet.jsp.tagext.Tag

EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE

Constructor Summary

Constructors

Constructor	Description
CMSComponentTag()

Method Summary

Modifier and Type	Method	Description
int	doEndTag()
int	doStartTag()
protected java.util.Collection<SimpleCMSComponentModel>	getComponents(org.springframework.web.context.WebApplicationContext appContext, javax.servlet.http.HttpServletRequest request)
protected javax.servlet.ServletContext	getServletContext()
protected void	init()
protected void	initLiveEditJS(javax.servlet.http.HttpServletRequest request)
protected boolean	isAllowed(AbstractCMSComponentModel component, RestrictionData restrictionData, CMSRestrictionService cmsRestrictionService, boolean previewEnabled)	Checks whether component should be displayed.
protected boolean	isLiveEdit()	Deprecated. since 1811, not used anymore
protected boolean	isPreviewEnabled()
protected RestrictionData	populate(javax.servlet.http.HttpServletRequest request, CMSDataFactory cmsDataFactory)	Wrapped all information fetched from current HTTP request
void	release()
void	setComponent(AbstractCMSComponentModel component)
void	setEvaluateRestriction(boolean evaluateRestriction)
void	setUid(java.lang.String uid)

Methods inherited from class javax.servlet.jsp.tagext.TagSupport

doAfterBody, findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setId, setPageContext, setParent, setValue

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 java.lang.String INIT_LE_JS

See Also:

Constant Field Values

DEFAULT_CONTROLLER

protected static final java.lang.String DEFAULT_CONTROLLER

See Also:

Constant Field Values

Constructor Detail

CMSComponentTag

public CMSComponentTag()

Method Detail

release

public void release()

Specified by:

release in interface javax.servlet.jsp.tagext.Tag

Overrides:

release in class javax.servlet.jsp.tagext.TagSupport

init

protected void init()

getServletContext

protected javax.servlet.ServletContext getServletContext()

getComponents

protected java.util.Collection<SimpleCMSComponentModel> getComponents(org.springframework.web.context.WebApplicationContext appContext,
                                                                      javax.servlet.http.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

@Deprecated
protected boolean isLiveEdit()

Deprecated.

since 1811, not used anymore

doStartTag

public int doStartTag()
               throws javax.servlet.jsp.JspException

Specified by:

doStartTag in interface javax.servlet.jsp.tagext.Tag

Overrides:

doStartTag in class javax.servlet.jsp.tagext.TagSupport

Throws:

javax.servlet.jsp.JspException

initLiveEditJS

protected void initLiveEditJS(javax.servlet.http.HttpServletRequest request)

doEndTag

public int doEndTag()
             throws javax.servlet.jsp.JspException

Specified by:

doEndTag in interface javax.servlet.jsp.tagext.Tag

Overrides:

doEndTag in class javax.servlet.jsp.tagext.TagSupport

Throws:

javax.servlet.jsp.JspException

setUid

public void setUid(java.lang.String uid)

setComponent

public void setComponent(AbstractCMSComponentModel component)

setEvaluateRestriction

public void setEvaluateRestriction(boolean evaluateRestriction)

populate

protected RestrictionData populate(javax.servlet.http.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