com.day.cq.wcm.tags
Class DefineObjectsTag

java.lang.Object
  javax.servlet.jsp.tagext.TagSupport
      org.apache.sling.scripting.jsp.taglib.DefineObjectsTag
          com.day.cq.wcm.tags.DefineObjectsTag

All Implemented Interfaces:

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

public class DefineObjectsTag
extends org.apache.sling.scripting.jsp.taglib.DefineObjectsTag

Defines page context attributes useful for scripting.

See Also:

Serialized Form

Field Summary

static String	DEFAULT_COMPONENT_CONTEXT_NAME Default name for the scripting variable referencing the ComponentContext object (value is ""componentContext"").
static String	DEFAULT_COMPONENT_NAME Default name for the scripting variable referencing the Component of the current resource (value is ""component"").
static String	DEFAULT_CURRENT_DESIGN_NAME Default name for the scripting variable referencing the design of the current page (value is ""currentDesign"").
static String	DEFAULT_CURRENT_PAGE_NAME Default name for the scripting variable referencing the current page object (value is ""currentPage"").
static String	DEFAULT_CURRENT_STYLE_NAME Default name for the scripting variable referencing the style of the current cell (value is ""currentStyle"").
static String	DEFAULT_DESIGNER_NAME Default name for the scripting variable referencing the Designer object (value is ""designer"").
static String	DEFAULT_EDIT_CONTEXT_NAME Default name for the scripting variable referencing the EditContext object (value is ""editContext"").
static String	DEFAULT_PAGE_MANAGER_NAME Default name for the scripting variable referencing the PageManager object (value is ""pageManager"").
static String	DEFAULT_PAGE_PROPERTIES_NAME Default name for the scripting variable referencing the page properties of the current page (value is ""pageProperties"").
static String	DEFAULT_PROPERTIES_NAME Default name for the scripting variable referencing the properties of the current resource (value is ""properties"").
static String	DEFAULT_RESOURCE_DESIGN_NAME Default name for the scripting variable referencing the design of the resource page (value is ""resourceDesign"").
static String	DEFAULT_RESOURCE_PAGE_NAME Default name for the scripting variable referencing the resource page object (value is ""resourcePage"").

Fields inherited from class org.apache.sling.scripting.jsp.taglib.DefineObjectsTag

DEFAULT_LOG_NAME, DEFAULT_NODE_NAME, DEFAULT_REQUEST_NAME, DEFAULT_RESOURCE_NAME, DEFAULT_RESOURCE_RESOLVER_NAME, DEFAULT_RESPONSE_NAME, DEFAULT_SLING_NAME

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

DefineObjectsTag()

Method Summary

int	doEndTag() Creates Scripting variables for: SlingHttpServletRequest SlingHttpServletResponse current Resource current Node (if resource is adaptable to a node) current Logger current SlingScriptHelper
void	setComponentContextName(String componentContextName)
void	setComponentName(String componentName)
void	setCurrentDesignName(String currentDesignName)
void	setCurrentPageName(String currentPageName)
void	setCurrentStyleName(String currentStyleName)
void	setDesignerName(String designerName)
void	setEditContextName(String editContextName)
void	setPageManagerName(String pageManagerName)
void	setPagePropertiesName(String pagePropertiesName)
void	setPropertiesName(String propertiesName)
void	setResourceDesignName(String resourceDesignName)
void	setResourcePageName(String resourcePageName)

Methods inherited from class org.apache.sling.scripting.jsp.taglib.DefineObjectsTag

setLogName, setNodeName, setRequestName, setResourceName, setResourceResolverName, setResponseName, setSlingName

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

doAfterBody, doStartTag, findAncestorWithClass, getId, getParent, getValue, getValues, release, 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

DEFAULT_COMPONENT_CONTEXT_NAME

public static final String DEFAULT_COMPONENT_CONTEXT_NAME

Default name for the scripting variable referencing the ComponentContext object (value is ""componentContext"").

See Also:

Constant Field Values

DEFAULT_EDIT_CONTEXT_NAME

public static final String DEFAULT_EDIT_CONTEXT_NAME

Default name for the scripting variable referencing the EditContext object (value is ""editContext"").

See Also:

Constant Field Values

DEFAULT_PROPERTIES_NAME

public static final String DEFAULT_PROPERTIES_NAME

Default name for the scripting variable referencing the properties of the current resource (value is ""properties"").

See Also:

Constant Field Values

DEFAULT_PAGE_MANAGER_NAME

public static final String DEFAULT_PAGE_MANAGER_NAME

Default name for the scripting variable referencing the PageManager object (value is ""pageManager"").

See Also:

Constant Field Values

DEFAULT_CURRENT_PAGE_NAME

public static final String DEFAULT_CURRENT_PAGE_NAME

Default name for the scripting variable referencing the current page object (value is ""currentPage"").

See Also:

Constant Field Values

DEFAULT_RESOURCE_PAGE_NAME

public static final String DEFAULT_RESOURCE_PAGE_NAME

Default name for the scripting variable referencing the resource page object (value is ""resourcePage"").

See Also:

Constant Field Values

DEFAULT_PAGE_PROPERTIES_NAME

public static final String DEFAULT_PAGE_PROPERTIES_NAME

Default name for the scripting variable referencing the page properties of the current page (value is ""pageProperties"").

See Also:

Constant Field Values

DEFAULT_COMPONENT_NAME

public static final String DEFAULT_COMPONENT_NAME

Default name for the scripting variable referencing the Component of the current resource (value is ""component"").

See Also:

Constant Field Values

DEFAULT_DESIGNER_NAME

public static final String DEFAULT_DESIGNER_NAME

Default name for the scripting variable referencing the Designer object (value is ""designer"").

See Also:

Constant Field Values

DEFAULT_CURRENT_DESIGN_NAME

public static final String DEFAULT_CURRENT_DESIGN_NAME

Default name for the scripting variable referencing the design of the current page (value is ""currentDesign"").

See Also:

Constant Field Values

DEFAULT_RESOURCE_DESIGN_NAME

public static final String DEFAULT_RESOURCE_DESIGN_NAME

Default name for the scripting variable referencing the design of the resource page (value is ""resourceDesign"").

See Also:

Constant Field Values

DEFAULT_CURRENT_STYLE_NAME

public static final String DEFAULT_CURRENT_STYLE_NAME

Default name for the scripting variable referencing the style of the current cell (value is ""currentStyle"").

See Also:

Constant Field Values

Constructor Detail

DefineObjectsTag

public DefineObjectsTag()

Method Detail

doEndTag

public int doEndTag()

Creates Scripting variables for:

• SlingHttpServletRequest
• SlingHttpServletResponse
• current Resource
• current Node (if resource is adaptable to a node)
• current Logger
• current SlingScriptHelper

Specified by:

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

Overrides:

doEndTag in class org.apache.sling.scripting.jsp.taglib.DefineObjectsTag

Returns:

always Tag.EVAL_PAGE.

setComponentContextName

public void setComponentContextName(String componentContextName)

setEditContextName

public void setEditContextName(String editContextName)

setPropertiesName

public void setPropertiesName(String propertiesName)

setPageManagerName

public void setPageManagerName(String pageManagerName)

setCurrentPageName

public void setCurrentPageName(String currentPageName)

setResourcePageName

public void setResourcePageName(String resourcePageName)

setResourceDesignName

public void setResourceDesignName(String resourceDesignName)

setPagePropertiesName

public void setPagePropertiesName(String pagePropertiesName)

setComponentName

public void setComponentName(String componentName)

setDesignerName

public void setDesignerName(String designerName)

setCurrentDesignName

public void setCurrentDesignName(String currentDesignName)

setCurrentStyleName

public void setCurrentStyleName(String currentStyleName)