Subscription list portlet

The custom Velocity templates in the Subscription list portlet uses the JCR (Java Content Repository, JSR 283) programming model. The SiteVision API is available here. There are two templates available corresponding to the different views.
Elements available in the Velocity Context
NameType and Description
portletjavax.jcr.Node
 This portlet. See properties below
sitevisionUtilssenselogic.sitevision.api.Utilsopens in new window
 The main entry point to all utility classes
jcrSessionjavax.jcr.Session
 The JCR Session
requestjavax.portlet.PortletRequest
 The portlet request
Additional properties available for the portlet ($portlet) in both views
NameType and Description 
subscriptionRepositoryjavax.jcr.PropertyType.WEAKREFERENCE 
 Corresponds to 'Subscriptions' in the portlet configuration. A JCR-node with subnodes containing information about the active subscription. More information bellow 
useSubmitTextjavax.jcr.PropertyType.BOOLEAN 
 Corresponds to the selection 'Standard button' in the portlet configuration 
submitTextjavax.jcr.PropertyType.STRING 
 Corresponds to 'Button text' in the portlet configuration 
submitTextFontjavax.jcr.PropertyType.WEAKREFERENCE 
 Corresponds to 'Button text font' in the portlet configuration. A Node that has property selectorText (java.lang.String) - the css class name of the font . 
submitImagejavax.jcr.PropertyType.WEAKREFERENCE 
 Corresponds to 'Button image' in the portlet configuration. A JCR-Node that has property URI pointing at the image resource 
submitImageDescjavax.jcr.PropertyType.STRING 
 Corresponds to 'Button image description' in the portlet configuration 
listShowTitlejavax.jcr.PropertyType.BOOLEAN 
 Corresponds to 'Show title' in the portlet configuration 
listTitleFontjavax.jcr.PropertyType.WEAKREFERENCE 
 Corresponds to 'Title font' in the portlet configuration. A Node that has property selectorText (java.lang.String) - the css class name of the font . 
listShowDescriptionjavax.jcr.PropertyType.BOOLEAN 
 Corresponds to 'Show description' in the portlet configuration 
listDescriptionFontjavax.jcr.PropertyType.WEAKREFERENCE 
 Corresponds to 'Description font' in the portlet configuration. A Node that has property selectorText (java.lang.String) - the css class name of the font . 
showSentMessagejavax.jcr.PropertyType.BOOLEAN 
 Corresponds to the selection 'Show message after subscription' in the portlet configuration 
sentMessagejavax.jcr.PropertyType.STRING 
 Corresponds to the text 'Show message after subscription' in the portlet configuration 
sentMessageFontjavax.jcr.PropertyType.WEAKREFERENCE 
 Corresponds to 'Show message after subscription font' in the portlet configuration. A Node that has property selectorText (java.lang.String) - the css class name of the font . 
showSubscriptionsjavax.jcr.PropertyType.BOOLEAN 
 Corresponds to the selection 'Visa list' in the portlet configuration 
defaultInputjavax.jcr.PropertyType.STRING 
 Corresponds to 'Default value' in the portlet configuration 
inputWidthjavax.jcr.PropertyType.LONG 
 Corresponds to 'Width' in the portlet configuration 
inputFontjavax.jcr.PropertyType.WEAKREFERENCE 
 Corresponds to 'Text field font' in the portlet configuration. A Node that has property selectorText (java.lang.String) - the css class name of the font  
allowEmailjavax.jcr.PropertyType.BOOLEAN 
 Corresponds to 'Allow e-mail' in the portlet configuration 
allowPhonejavax.jcr.PropertyType.BOOLEAN 
 Corresponds to 'Allow phone number' in the portlet configuration 
errorFontjavax.jcr.PropertyType.WEAKREFERENCE 
 Corresponds to 'Font for error messages' in the portlet configuration. A Node that has property selectorText (java.lang.String) - the css class name of the font  
inputFieldValuejavax.jcr.PropertyType.STRING 
 Corresponds to the value of the input field 
currentEmailjavax.jcr.PropertyType.STRING 
 Corresponds to the e-mail for the current user (needs to be logged in) 
subscribeURLjavax.jcr.PropertyType.URI 
 The form action URL for the subscription action 
Additional properties available on the subscribe (i.e. the first) view
NameType and Description 
redirectURLjavax.jcr.PropertyType.URI 
 Corresponds to the 'Send user to an other page after subscription' in the portlet configuration 
subscriberInputNamejavax.jcr.PropertyType.STRING 
 The form text input name for the subscriber e-mail / phone 
subscriberSubmitNamejavax.jcr.PropertyType.STRING 
 The submit button name for the subscription action 
bundlejavax.jcr.PropertyType.WEAKREFERENCE 
 A JCR-node containing the language dependent strings. The actual node can be resolved by calling getNode() on this property. The strings are javax.jcr.PropertyType.STRING properties 
errorsjavax.jcr.PropertyType.WEAKREFERENCE 
 A JCR-node containing the input errors. The actual node can be resolved by calling getNode() on this property. The errors are javax.jcr.PropertyType.STRING properties with names prefixed with "error" 
The subscriptionRepository node has no properties. The sub nodes corresponds to the selected active subscriptions in the portlet configurations. They have the following properties:
NameType and Description 
pagejavax.jcr.PropertyType.WEAKREFERENCE 
 The page / article where the active subscription is configured. To get the JCR-node use the method getNode() 
subscribeElementNamejavax.jcr.PropertyType.STRING 
 The form element name used to indicate that the user want to be a subscriber 
isSubscriberjavax.jcr.PropertyType.BOOLEAN 
 Indicates that the current user is a subscriber (needs to be logged in) 

Denna sida publicerades: 2015-05-25

Skriv ut PDF-avsnitt

Hjälpte informationen på den här sidan dig?

Missa inga nya rön, tips och tricks! Prenumerera på insite!

Find us!

SiteVision AB (Headquarter)
Vasagatan 10
702 10 Orebro
Sweden

Info: +46 19-17 30 30
Support: +46 19-17 30 39

Latest Tweets