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, IterationTag, JspTag, Tag
```
public class DefineObjectsTag
extends DefineObjectsTag
```
Defines page context attributes useful for scripting.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field	Description
`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_CONTENT_POLICY_NAME`	Default name for the scripting variable referencing the `ContentPolicy` of the current cell (value is ""currentContentPolicy"").
`static String`	`DEFAULT_CURRENT_CONTENT_POLICY_PROPS_NAME`	Default name for the scripting variable referencing the properties of the current content policy (value is ""currentContentPolicyProperties"").
`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"").
`static String`	`DEFAULT_XSSAPI_NAME`	Default name for the scripting variable referencing the `xssAPI protection service` currently in use (value is ""xssAPI"").

Fields inherited from class org.apache.sling.scripting.jsp.taglib.DefineObjectsTag
DEFAULT_BINDINGS_NAME, 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 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

DefineObjectsTag()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`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`	`setCurrentPolicyName(String currentPolicyName)`
`void`	`setCurrentPolicyPropertiesName(String currentPolicyPropertiesName)`
`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)`
`void`	`setXssAPIName(String xssAPIName)`

Methods inherited from class org.apache.sling.scripting.jsp.taglib.DefineObjectsTag
release, setBindingsName, setLogName, setNodeName, setPageContext, setRequestName, setResourceName, setResourceResolverName, setResponseName, setSlingName

Methods inherited from class javax.servlet.jsp.tagext.TagSupport
doAfterBody, doStartTag, findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setId, setParent, setValue

Methods inherited from class java.lang.Object
equals, 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
  - DEFAULT_XSSAPI_NAME
```
public static final String DEFAULT_XSSAPI_NAME
```
    Default name for the scripting variable referencing the xssAPI protection service currently in use (value is ""xssAPI"").
    
    See Also:
    
    Constant Field Values
  - DEFAULT_CURRENT_CONTENT_POLICY_NAME
```
public static final String DEFAULT_CURRENT_CONTENT_POLICY_NAME
```
    Default name for the scripting variable referencing the ContentPolicy of the current cell (value is ""currentContentPolicy"").
    
    See Also:
    
    Constant Field Values
  - DEFAULT_CURRENT_CONTENT_POLICY_PROPS_NAME
```
public static final String DEFAULT_CURRENT_CONTENT_POLICY_PROPS_NAME
```
    Default name for the scripting variable referencing the properties of the current content policy (value is ""currentContentPolicyProperties"").
    
    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 Tag
    
    Overrides:
    
    doEndTag in class DefineObjectsTag
    
    Returns:
    
    always Tag.EVAL_PAGE.
    
    See Also:
    
    Tag.doEndTag()
  - 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)
```
  - setXssAPIName
```
public void setXssAPIName(String xssAPIName)
```
  - setCurrentPolicyName
```
public void setCurrentPolicyName(String currentPolicyName)
```
  - setCurrentPolicyPropertiesName
```
public void setCurrentPolicyPropertiesName(String currentPolicyPropertiesName)
```

Class DefineObjectsTag

Field Summary

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

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

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_COMPONENT_CONTEXT_NAME

DEFAULT_EDIT_CONTEXT_NAME

DEFAULT_PROPERTIES_NAME

DEFAULT_PAGE_MANAGER_NAME

DEFAULT_CURRENT_PAGE_NAME

DEFAULT_RESOURCE_PAGE_NAME

DEFAULT_PAGE_PROPERTIES_NAME

DEFAULT_COMPONENT_NAME

DEFAULT_DESIGNER_NAME

DEFAULT_CURRENT_DESIGN_NAME

DEFAULT_RESOURCE_DESIGN_NAME

DEFAULT_CURRENT_STYLE_NAME

DEFAULT_XSSAPI_NAME

DEFAULT_CURRENT_CONTENT_POLICY_NAME

DEFAULT_CURRENT_CONTENT_POLICY_PROPS_NAME

Constructor Detail

DefineObjectsTag

Method Detail

doEndTag

setComponentContextName

setEditContextName

setPropertiesName

setPageManagerName

setCurrentPageName

setResourcePageName

setResourceDesignName

setPagePropertiesName

setComponentName

setDesignerName

setCurrentDesignName

setCurrentStyleName

setXssAPIName

setCurrentPolicyName

setCurrentPolicyPropertiesName