Birthday

The custom Velocity template in the birthday portlet uses the JCR (Java Content Repository, JSR 283) programming model. The SiteVision API is available here

Elements available in the Velocity Context
NameType and Description
portletjavax.jcr.Node
 This portlet. See properties below
sitevisionUtilssenselogic.sitevision.api.Utils
 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 element ($portlet)
NameType and Description 
headlineFontjavax.jcr.PropertyType.WEAKREFERENCE 
 The font used in the headline. Is by default set to 'portlet-section-header'. 
pastBirthdaysFontjavax.jcr.PropertyType.WEAKREFERENCE 
 The font used for all birthdays that has already occured this year. Is by default set to 'portlet-section-text'. 
todayBirthdaysFontjavax.jcr.PropertyType.WEAKREFERENCE 
 The font used for all birthdays that occurs today. Is by default set to 'portlet-section-body'. 
upcomingBirthdaysFontjavax.jcr.PropertyType.WEAKREFERENCE 
 The font used for all birthdays that has not yet occured this year. Is by default set to 'portlet-section-text'. 
useHeadlinejavax.jcr.PropertyType.BOOLEAN 
 Shows a headline on top of all birthdays (is only visibile as long as at least one birthday is rendered). 
headlinejavax.jcr.PropertyType.STRING 
 The headline to be shown. 
selectionjavax.jcr.PropertyType.STRING 
 Defines the selection of birthdays to be rendered (see documentation below for allowed selection values). Its default value is 'custom'. 
birthdaysTypejavax.jcr.PropertyType.STRING 
 Defines according to which critera birthdays should be rendered and is always used in a combination with the property 'numberOfBirthdays' (see documentation below for allowed 'birthdaysType' values). Its default value is 'quantity'. 
numberOfBirthdaysjavax.jcr.PropertyType.LONG 
 Number of birthdays to be rendered starting from today. The value from this property is always used in a combination with the property 'birthdaysType' to calculate the "real" number of birthdays to be rendered. Its default value is '5'. 
showNameBeforeDatejavax.jcr.PropertyType.BOOLEAN 
 Shows a persons name before its birthday date. 
showBirthdayAgejavax.jcr.PropertyType.BOOLEAN 
 Shows the number of years a person is turning. 
defaultBirthDatePatternjavax.jcr.PropertyType.STRING 
 The date pattern used at rendering of a persons birth day in the portlet configuration. Its default value is language dependent where Swedish is 'd MMMM' and English is 'MMMM d'. 
defaultBirthdayDatePatternjavax.jcr.PropertyType.STRING 
 The date pattern used at rendering of birthdays. Its default value is language dependent where Swedish is 'd MMMM' and English is 'MMMM d'. 
useCustomBirthdayDatePatternjavax.jcr.PropertyType.BOOLEAN 
 Overrides the usage of the default birthday date pattern at rendering of birthdays. 
customBirthdayDatePatternjavax.jcr.PropertyType.STRING 
 A custom date pattern that can be used at rendering of birthdays. Its default value is language dependent where Swedish is 'dd/MM' and English is 'MM/dd'. 
birthdaysjavax.jcr.PropertyType.STRING 
 A List of rendered birthdays where each birthday is represented by a Node that contains all birthday properties (see documentation of birthday properties below). 
bundlejavax.jcr.PropertyType.STRING 
 A Node that contains all language bundle properties. The actual node can be resolved by calling getNode() on this property (see documentation of bundle properties below). 
Additional properties available for a birthday
NameType and Description 
namejavax.jcr.PropertyType.STRING 
 The name of a person. 
birthDatejavax.jcr.PropertyType.DATE 
 The birth date of a person. 
birthdayDatejavax.jcr.PropertyType.DATE 
 The date when a persons next birthday is (if the birthday should occur on a leap day and it is not a leap year than the returned date will be 28 February. 
birthdayAgejavax.jcr.PropertyType.LONG 
 Number of years a person is turning. 
isTodayjavax.jcr.PropertyType.BOOLEAN 
 Defines if a persons birthday is today (if a birthday should occur on a leap day and it is not a leap year than today will return true on 28 February). 
Additional properties available for a bundle
NameType and Description 
captionjavax.jcr.PropertyType.STRING 
 I18n bundle text for caption in table. 
nameHeaderjavax.jcr.PropertyType.STRING 
 I18n bundle text for name header in table. 
birthdayDateHeaderjavax.jcr.PropertyType.STRING 
 I18n bundle text for birthday date header in table. 
birthdayAgeHeaderjavax.jcr.PropertyType.STRING 
 I18n bundle text for birthday age header in table. 
yearsjavax.jcr.PropertyType.STRING 
 I18n bundle text for years. Is used after the number of years a person is turning, e.g. 21 years. 
Allowed values for selection property
NameType and Description 
monthjavax.jcr.PropertyType.STRING 
 Defines that only birthdays that occurs this month is rendered. 
weekjavax.jcr.PropertyType.STRING 
 Defines that only birthdays that occurs this week is rendered. 
dayjavax.jcr.PropertyType.STRING 
 Defines that only birthdays that occurs today is rendered. 
customjavax.jcr.PropertyType.STRING 
 Defines that only birthdays matching the calcluated value from the properties 'numberOfBirthdays' and 'birthdaysType' are rendered. 
Allowed values for birthdaysType property
NameType and Description 
quantityjavax.jcr.PropertyType.STRING 
 Defines the maximum number of birthdays that are rendered as defined by the property 'numberOfBirthdays'. At rendering it starts from todays date and in alfabetical order, e.g. if the properties are set to '1' and 'quantity' and both Allan and Brook have their birthday today than only Allan is rendered. 
daysjavax.jcr.PropertyType.STRING 
 Defines that only the birthdays that occur between todays date and a number of days in the future are rendered. The number of days in the future is defined by the property 'numberOfBirthdays', e.g. if the properties are set to '1' and 'days' and both Allan and Brook have their birthday today than both are rendered.  
monthsjavax.jcr.PropertyType.STRING 
 Defines that only the birthdays that occur between todays date and the same date a specific number of months in the future are rendered. The number of months in the future is defined by the property 'numberOfBirthdays'. 

Denna sida publicerades: 2012-06-14

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