com.adobe.cq.sightly

Class WCMUse

java.lang.Object

com.adobe.cq.sightly.WCMUse

All Implemented Interfaces:

Use

public abstract class WCMUse
extends Object
implements Use

Abstract implementation of Use interface. This could be extended to provide custom Use models.

Constructor Summary

Constructors

Constructor and Description
WCMUse()

Method Summary

Methods

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

Methods inherited from class java.lang.Object

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

Constructor Detail

WCMUse

public WCMUse()

Method Detail

init

public void init(javax.script.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 is called from the WCMUse#init

Throws:

Exception - in case of any error during activation

get

public <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 SightlyWCMMode getWcmMode()

Returns:

WCMBindings.WCM_MODE binding if available, otherwise null is returned

getPageManager

public PageManager getPageManager()

Returns:

WCMBindings.PAGE_MANAGER binding if available, otherwise null is returned

getCurrentPage

public Page getCurrentPage()

Returns:

WCMBindings.CURRENT_PAGE binding if available, otherwise null is returned

getResourcePage

public Page getResourcePage()

Returns:

WCMBindings.RESOURCE_PAGE binding if available, otherwise null is returned

getPageProperties

public ValueMap getPageProperties()

Returns:

WCMBindings.PAGE_PROPERTIES binding if available, otherwise null is returned

getProperties

public ValueMap getProperties()

Returns:

WCMBindings.PROPERTIES binding if available, otherwise null is returned

getDesigner

public Designer getDesigner()

Returns:

WCMBindings.DESIGNER binding if available, otherwise null is returned

getCurrentDesign

public Design getCurrentDesign()

Returns:

WCMBindings.CURRENT_DESIGN binding if available, otherwise null is returned

getCurrentStyle

public Style getCurrentStyle()

Returns:

WCMBindings.CURRENT_STYLE binding if available, otherwise null is returned

getComponent

public Component getComponent()

Returns:

WCMBindings.COMPONENT binding if available, otherwise null is returned

getInheritedProperties

public ValueMap getInheritedProperties()

Returns:

WCMBindings.INHERITED_PAGE_PROPERTIES binding if available, otherwise null is returned

getResource

public Resource getResource()

Returns:

Sling SlingBindings binding if available, otherwise null is returned

getResourceResolver

public ResourceResolver getResourceResolver()

Returns:

ResourceResolver associated with the current request

getRequest

public SlingHttpServletRequest getRequest()

Returns:

Sling SlingBindings binding if available, otherwise null is returned

getResponse

public SlingHttpServletResponse getResponse()

Returns:

Sling SlingBindings binding if available, otherwise null is returned

getSlingScriptHelper

public SlingScriptHelper getSlingScriptHelper()

Returns:

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