Skip navigation links
oracle.stellent.wcm.javaee.taglib
Class PlaceholderTag
java.lang.Object
javax.servlet.jsp.tagext.SimpleTagSupport
oracle.stellent.wcm.javaee.taglib.BaseTag<PlaceholderRequest>
oracle.stellent.wcm.javaee.taglib.PlaceholderTag
- All Implemented Interfaces:
- javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.SimpleTag
-
public class PlaceholderTag
- extends BaseTag<PlaceholderRequest>
This is the class which implements the WCM placeholder tag. This tag servers as a "placeholder" for content to be defined at a later date. By default, the placeholder is just a name that uses contextual information, specified by the web application, to locate the content that will be placed into the tag. This tag also is implemented as a "region" tag, which is a specific case when you know what data file and view are needed without the placeholder name indirection. We look up the specified data file and the view file for the region. The dataFile is parsed and stored in the servlet request object and the view file is included using the same request.
Fields inherited from class oracle.stellent.wcm.javaee.taglib.BaseTag |
m_log |
Methods inherited from class javax.servlet.jsp.tagext.SimpleTagSupport |
findAncestorWithClass, getJspBody, getJspContext, getParent, setJspBody, setJspContext, setParent |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
PlaceholderTag
public PlaceholderTag()
getName
public java.lang.String getName()
setName
public void setName(java.lang.String name)
getDataFile
public java.lang.String getDataFile()
-
- Returns:
- the datafile content ID
setDataFile
public void setDataFile(java.lang.String dataFile)
getDefinition
public java.lang.String getDefinition()
setDefinition
public void setDefinition(java.lang.String definition)
getRegionDefinition
public java.lang.String getRegionDefinition()
-
- Returns:
- (optional) the region definition to use
setRegionDefinition
public void setRegionDefinition(java.lang.String regionDefinition)
setTemplate
public void setTemplate(java.lang.String template)
- Set a template. This is used when the tag is statically referencing a template object; internally just sets the view property.
-
- Parameters:
template
- the template name
getTemplate
public java.lang.String getTemplate()
getActions
public java.lang.String getActions()
-
- Returns:
- a string containing a letter for each allowable action
- See Also:
PlaceholderRequest.setActions(String)
setActions
public void setActions(java.lang.String actions)
isInlineRefresh
public boolean isInlineRefresh()
setInlineRefresh
public void setInlineRefresh(boolean inlineRefresh)
getWidth
public java.lang.String getWidth()
setWidth
public void setWidth(java.lang.String width)
getHeight
public java.lang.String getHeight()
setHeight
public void setHeight(java.lang.String height)
createSiteRequestInvoker
protected SiteRequestInvoker<PlaceholderRequest> createSiteRequestInvoker()
throws ApplicationException
-
- Specified by:
createSiteRequestInvoker
in class BaseTag<PlaceholderRequest>
-
- Returns:
- the type of request
- Throws:
ApplicationException
populateSiteRequest
protected void populateSiteRequest()
throws ApplicationException
- Populate the site request object from the tag parameters
-
- Specified by:
populateSiteRequest
in class BaseTag<PlaceholderRequest>
-
- Throws:
ApplicationException
Skip navigation links
Copyright © 2010, 2011, Oracle and/or its affiliates. All rights reserved.