com.liferay.taglib.util

Class IncludeTag

java.lang.Object

com.liferay.portal.kernel.servlet.taglib.TagSupport

com.liferay.portal.kernel.servlet.taglib.BaseBodyTagSupport

com.liferay.taglib.util.ParamAndPropertyAncestorTagImpl

com.liferay.taglib.util.AttributesTagSupport

com.liferay.taglib.util.IncludeTag

All Implemented Interfaces:

ParamAncestorTag, PropertyAncestorTag, javax.servlet.jsp.tagext.DynamicAttributes, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag

Direct Known Subclasses:

AppViewDisplayStyleTag, AppViewEntryTag, AppViewNavigationEntryTag, AppViewSearchEntryTag, AssetCategoriesErrorTag, AssetCategoriesNavigationTag, AssetCategoriesSelectorTag, AssetCategoriesSummaryTag, AssetLinksTag, AssetTagsErrorTag, AssetTagsNavigationTag, AssetTagsSelectorTag, AssetTagsSummaryTag, BaseATag, BaseButtonItemTag, BaseButtonRowTag, BaseButtonTag, BaseColTag, BaseColumnTag, BaseComponentTag, BaseContainerTag, BaseFieldsetTag, BaseFieldWrapperTag, BaseFormTag, BaseHTMLFieldTag, BaseHTMLTag, BaseIconTag, BaseInputTag, BaseLayoutTag, BaseModelContextTag, BaseNavBarSearchTag, BaseNavBarTag, BaseNavItemTag, BaseNavTag, BaseOptionTag, BasePanelTag, BaseRowTag, BaseSelectTag, BaseTranslationManagerTag, BaseWorkflowStatusTag, BreadcrumbTag, CalendarTag, CaptchaTag, CategorizationFilterTag, CustomAttributeListTag, CustomAttributeTag, DDMTemplateSelectorTag, DiffHtmlTag, DiffTag, DiscussionTag, ErrorMarkerTag, FlagsTag, FlashTag, FormNavigatorTag, HeaderTag, IconTag, IncludeTag, InputCheckBoxTag, InputDateTag, InputEditorTag, InputFieldTag, InputLocalizedTag, InputMoveBoxesTag, InputPermissionsTag, InputRepeatTag, InputResourceTag, InputSchedulerTag, InputSearchTag, InputSelectTag, InputTextAreaTag, InputTimeTag, InputTimeZoneTag, JournalArticleTag, JournalContentSearchTag, LanguageTag, LayoutIconTag, LogoSelectorTag, MembershipPolicyErrorTag, MetaTagsTag, MySitesTag, NavigationTag, PageIteratorTag, PanelTag, PngImageTag, PreviewTag, ProgressTag, RatingsScoreTag, RatingsTag, RestoreEntryTag, RSSSettingsTag, RSSTag, SearchFormTag, SearchTag, SearchToggleTag, SectionTag, SitesDirectoryTag, SocialActivitiesTag, SocialBookmarksTag, SocialBookmarkTag, StagingTag, SuccessTag, TabsTag, ToggleAreaTag, ToggleTag, TrashEmptyTag, TrashUndoTag, UploadProgressTag, UserSearchTag, WebDAVTag, WriteTag

public class IncludeTag
extends AttributesTagSupport

Author:

Brian Wing Shun Chan, Shuyang Zhou, Eduardo Lundgren, Raymond Augé

Field Summary

Fields inherited from class com.liferay.taglib.util.ParamAndPropertyAncestorTagImpl

request, servletContext

Fields inherited from class com.liferay.portal.kernel.servlet.taglib.BaseBodyTagSupport

bodyContent

Fields inherited from class com.liferay.portal.kernel.servlet.taglib.TagSupport

pageContext

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

EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE

Constructor Summary

Constructors

Constructor and Description
IncludeTag()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	callSetAttributes()
protected void	cleanUp()
protected void	cleanUpSetAttributes()
int	doEndTag()
protected void	doInclude(java.lang.String page)
protected void	doIncludeTheme(java.lang.String page)
int	doStartTag()
protected java.lang.String	getCustomPage(javax.servlet.ServletContext servletContext, javax.servlet.http.HttpServletRequest request)
protected java.lang.String	getEndPage()
protected javax.servlet.http.HttpServletRequest	getOriginalServletRequest()
protected java.lang.String	getPage()
protected java.lang.String	getStartPage()
protected void	include(java.lang.String page)
protected boolean	isCleanUpSetAttributes()
protected boolean	isUseCustomPage()
protected int	processEndTag()
protected int	processStartTag()
void	runTag()
protected void	setAttributes(javax.servlet.http.HttpServletRequest request)
void	setPage(java.lang.String page)
void	setPortletId(java.lang.String portletId)
void	setStrict(boolean strict)
void	setUseCustomPage(boolean useCustomPage)
protected boolean	themeResourceExists(java.lang.String page)

Methods inherited from class com.liferay.taglib.util.AttributesTagSupport

clearDynamicAttributes, getAttributeNamespace, getDynamicAttributes, getScopedAttributes, release, setAttributeNamespace, setDynamicAttribute, setNamespacedAttribute, setScopedAttribute

Methods inherited from class com.liferay.taglib.util.ParamAndPropertyAncestorTagImpl

addParam, addProperty, clearParams, clearProperties, getParams, getProperties, getRemovedParameterNames, isAllowEmptyParam, setAllowEmptyParam, setPageContext, setServletContext

Methods inherited from class com.liferay.portal.kernel.servlet.taglib.BaseBodyTagSupport

doAfterBody, doInitBody, getBodyContent, getBodyContentAsStringBundler, setBodyContent, writeBodyContent

Methods inherited from class com.liferay.portal.kernel.servlet.taglib.TagSupport

findAncestorWithClass, getParent, setParent

Methods inherited from class java.lang.Object

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

Constructor Detail

IncludeTag

public IncludeTag()

Method Detail

doEndTag

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

Specified by:

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

Overrides:

doEndTag in class com.liferay.portal.kernel.servlet.taglib.TagSupport

Throws:

javax.servlet.jsp.JspException

doStartTag

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

Specified by:

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

Overrides:

doStartTag in class com.liferay.portal.kernel.servlet.taglib.BaseBodyTagSupport

Throws:

javax.servlet.jsp.JspException

runTag

public void runTag()
            throws javax.servlet.jsp.JspException

Throws:

javax.servlet.jsp.JspException

setPage

public void setPage(java.lang.String page)

setPortletId

public void setPortletId(java.lang.String portletId)

setStrict

public void setStrict(boolean strict)

setUseCustomPage

public void setUseCustomPage(boolean useCustomPage)

callSetAttributes

protected void callSetAttributes()

cleanUp

protected void cleanUp()

cleanUpSetAttributes

protected void cleanUpSetAttributes()

doInclude

protected void doInclude(java.lang.String page)
                  throws javax.servlet.jsp.JspException

Throws:

javax.servlet.jsp.JspException

doIncludeTheme

protected void doIncludeTheme(java.lang.String page)
                       throws java.lang.Exception

Throws:

java.lang.Exception

getCustomPage

protected java.lang.String getCustomPage(javax.servlet.ServletContext servletContext,
                             javax.servlet.http.HttpServletRequest request)

getEndPage

protected java.lang.String getEndPage()

getOriginalServletRequest

protected javax.servlet.http.HttpServletRequest getOriginalServletRequest()

getPage

protected java.lang.String getPage()

getStartPage

protected java.lang.String getStartPage()

include

protected void include(java.lang.String page)
                throws java.lang.Exception

Throws:

java.lang.Exception

isCleanUpSetAttributes

protected boolean isCleanUpSetAttributes()

isUseCustomPage

protected boolean isUseCustomPage()

processEndTag

protected int processEndTag()
                     throws java.lang.Exception

Throws:

java.lang.Exception

processStartTag

protected int processStartTag()
                       throws java.lang.Exception

Throws:

java.lang.Exception

setAttributes

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

themeResourceExists

protected boolean themeResourceExists(java.lang.String page)
                               throws java.lang.Exception

Throws:

java.lang.Exception