senselogic.sitevision.api.context

Interface PortletContextUtil

All Superinterfaces:

VelocityAccess.PortletContextUtilConstants

@Requireable(value="PortletContextUtil")
public interface PortletContextUtil
extends VelocityAccess.PortletContextUtilConstants

Portlet context utility interface.

Contains methods for retrieving information about present portlet execution context.

An instance of the Sitevision class implementing this interface can be obtained via Utils.getPortletContextUtil(). See Utils for how to obtain an instance of the Utils interface.

Author:

Magnus Lövgren

Field Summary

Fields

Modifier and Type	Field and Description
static int	OFFLINE_VERSION Deprecated. Use VersionUtil.OFFLINE_VERSION
static int	ONLINE_VERSION Deprecated. Use VersionUtil.ONLINE_VERSION

Method Summary

Modifier and Type	Method and Description
Node	getCurrentDashboard() Gets current dashboard node (applicable during render of a sv:widgetCustomModule).
Node	getCurrentDecoratedNode() Gets current decorated node (applicable during render of a sv:decorationTemplate).
Locale	getCurrentLocale() Gets current Locale.
Node	getCurrentModuleElement() Gets current module element (module element draft or module element).
Node	getCurrentPage() Gets current page (i.e. the page node for the currently executing portlet).
Node	getCurrentPortlet() Gets current portlet.
Node	getCurrentUser() Gets current user.
Node	getCurrentUserIdentity() Gets current user identity.
int	getCurrentVersion() Deprecated. Use VersionUtil.getCurrentVersion()
String	getNonce() Gets a unique nonce for this request.
String	getPortletNamespace(String aPrefix) Gets a unique namespace for the specific portlet that is rendering.

Methods inherited from interface senselogic.sitevision.api.render.velocity.VelocityAccess.PortletContextUtilConstants

getOFFLINE_VERSION, getONLINE_VERSION

Field Detail

OFFLINE_VERSION

@Deprecated
static final int OFFLINE_VERSION

Deprecated. Use VersionUtil.OFFLINE_VERSION

The offline version (i.e. the version used when editing in the Sitevision editor) marker

See Also:

Constant Field Values

ONLINE_VERSION

@Deprecated
static final int ONLINE_VERSION

Deprecated. Use VersionUtil.ONLINE_VERSION

The online version (i.e. the published version that visitors can access) marker

See Also:

Constant Field Values

Method Detail

getCurrentPage

Node getCurrentPage()

Gets current page (i.e. the page node for the currently executing portlet).

Returns:

current page Node, or null if indeterminable (i.e. this method is not called from within a portlet or current portlet is not bound to any page)

getCurrentPortlet

Node getCurrentPortlet()

Gets current portlet.

Returns:

current portlet as Node, or null if indeterminable (i.e. this method is not called from within a portlet)

getCurrentModuleElement

Node getCurrentModuleElement()

Gets current module element (module element draft or module element).

Returns:

current module element as Node, or null if indeterminable (i.e. this method is not called from within a module element)

Since:

Sitevision 4.2

getCurrentDashboard

Node getCurrentDashboard()

Gets current dashboard node (applicable during render of a sv:widgetCustomModule).

Returns:

current dashboard as Node, or null if indeterminable (i.e. this method is not called from within a sv:widgetCustomModule)

Since:

Sitevision 2024.02.1

getCurrentLocale

Locale getCurrentLocale()

Gets current Locale.

Returns:

current Locale, or default Locale if indeterminable

See Also:

NodeResolverUtil.getLocaleResolver()

getCurrentUser

Node getCurrentUser()

Gets current user.

Returns:

current user Node, or null if indeterminable

Since:

Sitevision 2.6

getCurrentUserIdentity

Node getCurrentUserIdentity()

Gets current user identity.

Returns:

current user identity Node, or null if indeterminable

Since:

Sitevision 3.5

getCurrentDecoratedNode

Node getCurrentDecoratedNode()

Gets current decorated node (applicable during render of a sv:decorationTemplate).

This method returns the "decorated" node (typically a sv:portlet or sv:layout) during render of a sv:decorationTemplate. In other words - it returns the node that is decorated with the template-based decoration that is now rendering.

Returns:

the decorated node or null if indeterminable (i.e. the caller is not a part of a decoration template that is being rendered right now)

Since:

Sitevision 5.1

getCurrentVersion

@Deprecated
int getCurrentVersion()

Deprecated. Use VersionUtil.getCurrentVersion()

Gets current version.

Returns:

VersionUtil.OFFLINE_VERSION, or VersionUtil.ONLINE_VERSION

Since:

Sitevision 2.6

getPortletNamespace

String getPortletNamespace(String aPrefix)

Gets a unique namespace for the specific portlet that is rendering.

The namespace is based on the prefix (aPrefix) and the current portlet's id. If you have two portlets of same type on the same page, the namespaces will differ. This can for instance be very useful when you connect a <label> with an <input>. Example in Velocity:

   #set ($portletContextUtil = $sitevisionUtils.portletContextUtil)
   ...
   #set ($ns = $portletContextUtil.getPortletNamespace('name'))
   <label for="$ns">Name: </label><input id="$ns" name="name" type="text" />

The namespace generated in the above example (i.e. $ns) could be something like: name12_2b9561c511855e0ab91800015

Parameters:

aPrefix - the prefix for the namespace (ensure it only contains chars that are valid in an id value if you use it as such)

Returns:

a unique prefixed namespace for current portlet, or aPrefix if indeterminable

getNonce

String getNonce()

Gets a unique nonce for this request.

The nonce should be used for all client-side inline javascript (e.g. <script nonce="..."> ... <script>). If not specified, the script might be blocked and ignored by the client/browser due to the content security policy settings of the page (i.e. typically when the CSP has no "unsafe-inline" specified).

Returns:

A unique identifier for this request.

Since:

Sitevision 2022.08.1