Birthday
Name | Type and description |
---|---|
jcrSession | |
The JCR Session | |
portlet | |
This portlet. See properties below | |
request | javax.portlet.PortletRequest |
The portlet request | |
sitevisionUtils | |
The main entry point to all utility classes |
Name | Type and Description |
---|---|
birthdays | javax.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). | |
birthdaysType | javax.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'. | |
bundle | javax.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). | |
customBirthdayDatePattern | javax.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'. | |
defaultBirthDatePattern | javax.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'. | |
defaultBirthdayDatePattern | javax.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'. | |
headline | javax.jcr.PropertyType.STRING |
The headline to be shown. | |
headlineFont | javax.jcr.PropertyType.WEAKREFERENCE |
The font used in the headline. Is by default set to 'portlet-section-header'. | |
numberOfBirthdays | javax.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'. | |
nonce | javax.jcr.PropertyType.STRING |
The nonce attribute value for the current request | |
pastBirthdaysFont | javax.jcr.PropertyType.WEAKREFERENCE |
The font used for all birthdays that has already occured this year. Is by default set to 'portlet-section-text'. | |
selection | javax.jcr.PropertyType.STRING |
Defines the selection of birthdays to be rendered (see documentation below for allowed selection values). Its default value is 'custom'. | |
showBirthdayAge | javax.jcr.PropertyType.BOOLEAN |
Shows the number of years a person is turning. | |
showNameBeforeDate | javax.jcr.PropertyType.BOOLEAN |
Shows a persons name before its birthday date. | |
todayBirthdaysFont | javax.jcr.PropertyType.WEAKREFERENCE |
The font used for all birthdays that occurs today. Is by default set to 'portlet-section-body'. | |
upcomingBirthdaysFont | javax.jcr.PropertyType.WEAKREFERENCE |
The font used for all birthdays that has not yet occured this year. Is by default set to 'portlet-section-text'. | |
useCustomBirthdayDatePattern | javax.jcr.PropertyType.BOOLEAN |
Overrides the usage of the default birthday date pattern at rendering of birthdays. | |
useHeadline | javax.jcr.PropertyType.BOOLEAN |
Shows a headline on top of all birthdays (is only visibile as long as at least one birthday is rendered). |
Name | Type and Description |
---|---|
birthdayAge | javax.jcr.PropertyType.LONG |
Number of years a person is turning. | |
birthdayDate | javax.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. | |
birthDate | javax.jcr.PropertyType.DATE |
The birth date of a person. | |
isToday | javax.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). | |
name | javax.jcr.PropertyType.STRING |
The name of a person. |
Name | Type and Description |
---|---|
birthdayAgeHeader | javax.jcr.PropertyType.STRING |
I18n bundle text for birthday age header in table. | |
birthdayDateHeader | javax.jcr.PropertyType.STRING |
I18n bundle text for birthday date header in table. | |
caption | javax.jcr.PropertyType.STRING |
I18n bundle text for caption in table. | |
nameHeader | javax.jcr.PropertyType.STRING |
I18n bundle text for name header in table. | |
years | javax.jcr.PropertyType.STRING |
I18n bundle text for years. Is used after the number of years a person is turning, e.g. 21 years. |
Name | Type and Description |
---|---|
custom | javax.jcr.PropertyType.STRING |
Defines that only birthdays matching the calcluated value from the properties 'numberOfBirthdays' and 'birthdaysType' are rendered. | |
day | javax.jcr.PropertyType.STRING |
Defines that only birthdays that occurs today is rendered. | |
month | javax.jcr.PropertyType.STRING |
Defines that only birthdays that occurs this month is rendered. | |
week | javax.jcr.PropertyType.STRING |
Defines that only birthdays that occurs this week is rendered. |
Name | Type and Description |
---|---|
days | javax.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. | |
months | javax.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'. | |
quantity | javax.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. |