- SiteVision 2.6
- | SiteVision 2.6
- | Developer guide
- | Custom templates
- | Portlets
- | Comments
Comments portlet
The custom Velocity template in the Comments portlet uses the JCR (Java Content Repository, JSR 283) programming model. The SiteVision API is available here
| Name | Type and Description |
|---|---|
| portlet | javax.jcr.Node |
| This portlet. See properties below | |
| sitevisionUtils | senselogic.sitevision.api.Utils |
| The main entry point to all utility classes | |
| jcrSession | javax.jcr.Session |
| The JCR Session | |
| request | javax.portlet.PortletRequest |
| The portlet request |
| Name | Type and Description | |
|---|---|---|
| bundle | javax.jcr.PropertyType.STRING | |
| A Node that contains alla language bundle properties. The actual node can be resolved by calling getNode() on this property | ||
| icons | javax.jcr.PropertyType.STRING | |
| A Node that has all icon properties. The actual node can be resolved by calling getNode() on this property | ||
| errorMessages | MutliValue of javax.jcr.PropertyType.STRING | |
| The Collection of possible error messages for the posted data | ||
| informationMessages | MutliValue of javax.jcr.PropertyType.STRING | |
| Corresponds to the 'Show number of hits' in the tag cloud configuration | ||
| toggleDisabledURL | javax.jcr.PropertyType.URI | |
| URL to toggle hiden/disabled on the module. | ||
| toggleClosedURL | javax.jcr.PropertyType.URI | |
| URL to toggle the ability to add comments | ||
| comments | javax.jcr.PropertyType.STRING | |
| A Node that contains all comments and URL specific for each comment. The actual node can be resolved by calling getNode() on this property | ||
| createCommentURL | javax.jcr.PropertyType.URI | |
| A URL to post comments to. | ||
| rssLinkURL | javax.jcr.PropertyType.URI | |
| URL for the RSS feed for comments. | ||
| maxComments | javax.jcr.PropertyType.INTEGER | |
| Corresponds to max number of comments setting | ||
| limitComments | javax.jcr.PropertyType.BOOLEAN | |
| Corresponds to the setting to limit amount of comments | ||
| maxDays | javax.jcr.PropertyType.INTEGER | |
| Corresponds to max number of days setting. | ||
| limitDays | javax.jcr.PropertyType.BOOLEAN | |
| Corresponds to the setting to limit the number of days you can comment | ||
| enableCaptcha | javax.jcr.PropertyType.BOOLEAN | |
| Corresponds to captch antispam setting | ||
| commentFont | javax.jcr.PropertyType.WEAKREFERENCE | |
| A Node that has property selectorText (java.lang.String) - the css class name of the font . | ||
| dateFont | javax.jcr.PropertyType.WEAKREFERENCE | |
| A Node that has property selectorText (java.lang.String) - the css class name of the font . | ||
| headlineFont | javax.jcr.PropertyType.WEAKREFERENCE | |
| A Node that has property selectorText (java.lang.String) - the css class name of the font . | ||
| inputFont | javax.jcr.PropertyType.WEAKREFERENCE | |
| A Node that has property selectorText (java.lang.String) - the css class name of the font . | ||
| labelFont | javax.jcr.PropertyType.WEAKREFERENCE | |
| A Node that has property selectorText (java.lang.String) - the css class name of the font . | ||
| nameFont | javax.jcr.PropertyType.WEAKREFERENCE | |
| A Node that has property selectorText (java.lang.String) - the css class name of the font . | ||
| errorFont | javax.jcr.PropertyType.WEAKREFERENCE | |
| A Node that has property selectorText (java.lang.String) - the css class name of the font . | ||
| authorBackgroundColor | javax.jcr.PropertyType.WEAKREFERENCE | |
| A sv:color Node that has property htmlHexValue (java.lang.String) - the hexvalue of the color. | ||
| evenBackgroundColor | javax.jcr.PropertyType.WEAKREFERENCE | |
| A sv:color Node that has property htmlHexValue (java.lang.String) - the hexvalue of the color | ||
| oddBackgroundColor | javax.jcr.PropertyType.WEAKREFERENCE | |
| A Node that has property htmlHexValue (java.lang.String) - the hexvalue of the color | ||
| mandatoryFieldColor | javax.jcr.PropertyType.WEAKREFERENCE | |
| A sv:color Node that holds the color for the "mandatory input field asterisk" [@since 2.6.2_03] | ||
| rssEnabled | javax.jcr.PropertyType.BOOLEAN | |
| Corresponds to rss beeing enabled in the portlet configuration. | ||
| reverseOrder | javax.jcr.PropertyType.BOOLEAN | |
| Corresponds to setting to display comments in reverse order |
The Comments JCR node has a number of sub nodes. It has no properties.
Properties available for the comment nodes:
| Name | Type and Description | |
|---|---|---|
| deleteURL | javax.jcr.PropertyType.STRING | |
| The URL to delete a specific Comment | ||
| hideURL | javax.jcr.PropertyType.STRING | |
| The URL to hide a specific comment | ||
| showURL | javax.jcr.PropertyType.STRING | |
| The URL to show a specific comment | ||
| comment | javax.jcr.PropertyType.WEAKREFERENCE | |
| The SV.pageComment object |
The Bundle JCR node has no sub nodes. It has no properties.
Properties available for Bundle:
| Name | Type and Description | |
|---|---|---|
| authorComment | javax.jcr.PropertyType.STRING | |
| I18n bundle text for Author comment | ||
| by | javax.jcr.PropertyType.STRING | |
| I18n bundle text for by | ||
| commentsClosed | javax.jcr.PropertyType.STRING | |
| I18n bundle text for Comment are closed | ||
| commentsDisabled | javax.jcr.PropertyType.STRING | |
| I18n bundle text for comments are hidden/disabled | ||
| comments | javax.jcr.PropertyType.STRING | |
| I18n bundle text for Comments | ||
| createComment | javax.jcr.PropertyType.STRING | |
| I18n bundle text for Create comment | ||
| deleteComment | javax.jcr.PropertyType.STRING | |
| I18n bundle text for Delete comment | ||
| deleteCommentConfirm | javax.jcr.PropertyType.STRING | |
| I18n bundle text for Confirm deletion of comment | ||
| hiddenComment | javax.jcr.PropertyType.STRING | |
| I18n bundle text for Hidden comment | ||
| hideComment | javax.jcr.PropertyType.STRING | |
| I18n bundle text for Hide comment | ||
| mandatoryTooltip | javax.jcr.PropertyType.STRING | |
| I18n bundle text for Mandatory tooltip marker | ||
| submitComment | javax.jcr.PropertyType.STRING | |
| I18n bundle text for Submit comment | ||
| toggleClosed | javax.jcr.PropertyType.STRING | |
| I18n bundle text for Toggle closed, returns corresponding string according to current status | ||
| toggleDisabled | javax.jcr.PropertyType.STRING | |
| I18n bundle text for Toggle disabled, returns corresponding string according to current status | ||
| showComment | javax.jcr.PropertyType.STRING | |
| I18n bundle text for Show comment |
The Icons JCR node has no sub nodes. Each of the following properties can be resolved as a JCR node (the properties of of the resolved node is listed here). It has the following properties:
| Name | Type and Description | |
|---|---|---|
| deleteComment | javax.jcr.PropertyType.WEAKREFERENCE | |
| Image for Delete comment icon. | ||
| error | javax.jcr.PropertyType.WEAKREFERENCE | |
| Image for Error icon. | ||
| hideComment | javax.jcr.PropertyType.WEAKREFERENCE | |
| Image for the Hide comment icon. | ||
| information | javax.jcr.PropertyType.WEAKREFERENCE | |
| Image for the Information icon. | ||
| rss | javax.jcr.PropertyType.WEAKREFERENCE | |
| Image for the Rss icon. | ||
| showComment | javax.jcr.PropertyType.WEAKREFERENCE | |
| Image for the Show Comment icon. |
The image icon JCR node has no sub nodes. It has the following properties.
| Name | Type and Description | |
|---|---|---|
| alt | javax.jcr.PropertyType.STRING | |
| I18n alt text from icon image. | ||
| width | javax.jcr.PropertyType.STRING | |
| Width of image icon. | ||
| height | javax.jcr.PropertyType.STRING | |
| Height of image icon. | ||
| style | javax.jcr.PropertyType.STRING | |
| Specific style attributes for image icon. | ||
| URL | javax.jcr.PropertyType.URI | |
| The url for the image icon. |
help-cluster-3.sitevision.net