Package com.adobe.cq.sightly

Class WCMUsePojo

java.lang.Object

com.adobe.cq.sightly.WCMUsePojo

All Implemented Interfaces:

Use

Direct Known Subclasses:

AllowedComponentList, OffercardPropertiesProvider, OfferproxyPropertiesProvider, ResponsiveGrid, TemplatedContainer

@ConsumerType
public abstract class WCMUsePojo
extends Object
implements Use

Abstract implementation of Use interface. This could be extended to provide custom Java Use-API objects.

See Also:

• HTL Use-API Documentation

Constructor Summary

Constructors

Constructor	Description
WCMUsePojo()

Method Summary

Modifier and Type	Method	Description
abstract void	activate()	Implement this method to perform post initialization tasks.
final <T> T	get(String name, Class<T> type)	Get an object associated with the given name
final Component	getComponent()
final ComponentContext	getComponentContext()
final Design	getCurrentDesign()
final Page	getCurrentPage()
final Style	getCurrentStyle()
final Designer	getDesigner()
final EditContext	getEditContext()
final ValueMap	getInheritedPageProperties()
final ValueMap	getInheritedProperties()	Deprecated. since 3.1.0; please switch to getInheritedPageProperties()
final PageManager	getPageManager()
final ValueMap	getPageProperties()
final ValueMap	getProperties()
final SlingHttpServletRequest	getRequest()
final Resource	getResource()
final Design	getResourceDesign()
final Page	getResourcePage()
final ResourceResolver	getResourceResolver()
final SlingHttpServletResponse	getResponse()
final SlingScriptHelper	getSlingScriptHelper()
final SightlyWCMMode	getWcmMode()
final XSSAPI	getXSSAPI()
final void	init(Bindings scriptBindings)	Initialize bindings and calls #activate()

Methods inherited from class java.lang.Object

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

Constructor Details

WCMUsePojo

public WCMUsePojo()

Method Details

init

public final void init(Bindings scriptBindings)

Initialize bindings and calls #activate()

Specified by:

init in interface Use

Parameters:

scriptBindings - Bindings to be used, there is no guarantee of having any particular bindings available.

activate

public abstract void activate()
                       throws Exception

Implement this method to perform post initialization tasks. This method is called by init(Bindings).

Throws:

Exception - in case of any error during activation

get

public final <T> T get(String name,
 Class<T> type)

Get an object associated with the given name

Parameters:

name - Object property name

type - Expected object type

Returns:

Object or null if Object cannot be found or typed.

getWcmMode

public final SightlyWCMMode getWcmMode()

Returns:

WCMBindings.WCM_MODE binding if available, otherwise null is returned

getPageManager

public final PageManager getPageManager()

Returns:

WCMBindingsConstants.NAME_PAGE_MANAGER binding if available, otherwise null is returned

getCurrentPage

public final Page getCurrentPage()

Returns:

WCMBindingsConstants.NAME_CURRENT_PAGE binding if available, otherwise null is returned

getResourcePage

public final Page getResourcePage()

Returns:

WCMBindingsConstants.NAME_RESOURCE_PAGE binding if available, otherwise null is returned

getPageProperties

public final ValueMap getPageProperties()

Returns:

WCMBindingsConstants.NAME_PAGE_PROPERTIES binding if available, otherwise null is returned

getProperties

public final ValueMap getProperties()

Returns:

WCMBindingsConstants.NAME_PROPERTIES binding if available, otherwise null is returned

getDesigner

public final Designer getDesigner()

Returns:

WCMBindingsConstants.NAME_DESIGNER binding if available, otherwise null is returned

getCurrentDesign

public final Design getCurrentDesign()

Returns:

WCMBindingsConstants.NAME_CURRENT_DESIGN binding if available, otherwise null is returned

getCurrentStyle

public final Style getCurrentStyle()

Returns:

WCMBindingsConstants.NAME_CURRENT_STYLE binding if available, otherwise null is returned

getComponent

public final Component getComponent()

Returns:

WCMBindingsConstants.NAME_COMPONENT binding if available, otherwise null is returned

getInheritedProperties

@Deprecated
public final ValueMap getInheritedProperties()

Deprecated.

since 3.1.0; please switch to getInheritedPageProperties()

Returns:

WCMBindings.INHERITED_PAGE_PROPERTIES binding if available, otherwise null is returned

getInheritedPageProperties

public final ValueMap getInheritedPageProperties()

Returns:

WCMBindings.INHERITED_PAGE_PROPERTIES binding if available, otherwise null is returned

getResource

public final Resource getResource()

Returns:

Sling SlingBindings.RESOURCE binding if available, otherwise null is returned

getResourceResolver

public final ResourceResolver getResourceResolver()

Returns:

ResourceResolver associated with the current request

getRequest

public final SlingHttpServletRequest getRequest()

Returns:

Sling SlingBindings.REQUEST binding if available, otherwise null is returned

getResponse

public final SlingHttpServletResponse getResponse()

Returns:

Sling SlingBindings.RESPONSE binding if available, otherwise null is returned

getSlingScriptHelper

public final SlingScriptHelper getSlingScriptHelper()

Returns:

sling script helper binding SlingBindings.SLING if available, otherwise null is returned

getComponentContext

public final ComponentContext getComponentContext()

Returns:

WCMBindingsConstants.NAME_COMPONENT_CONTEXT binding if available, otherwise null is returned

getEditContext

public final EditContext getEditContext()

Returns:

WCMBindingsConstants.NAME_EDIT_CONTEXT binding if available, otherwise null is returned

getResourceDesign

public final Design getResourceDesign()

Returns:

WCMBindingsConstants.NAME_RESOURCE_DESIGN binding if available, otherwise null is returned

getXSSAPI

public final XSSAPI getXSSAPI()

Returns:

WCMBindingsConstants.NAME_XSSAPI binding if available, otherwise null is returned