Search field portlet
The custom Velocity template in this portlet uses the JCR (Java Content Repository, JSR 283) programming model. The SiteVision API is available here
| Name | Type and Description |
|---|---|
| request | javax.portlet.PortletRequest |
| The portlet request | |
| portlet | javax.jcr.Node |
| This portlet. See available properties in table below | |
| jcrSession | javax.jcr.Session |
| The JCR Session | |
| sitevisionUtils | senselogic.sitevision.api.Utils |
| The main entry point to all utility classes | |
| velocityEvaluator | senselogic.sitevision.api.render.velocity.VelocityEvaluator |
| A evaluator that can parse Velocity templates or Velocity expressions on the fly |
| Name | Type and Description | |
|---|---|---|
| Search form | ||
| searchFieldSize | javax.jcr.PropertyType.LONG | |
| The size of the search form input field | ||
| searchFieldFont | javax.jcr.PropertyType.WEAKREFERENCE | |
| The search field font Node (sv:font) | ||
| useTextSearchButton | javax.jcr.PropertyType.BOOLEAN | |
| Whether to use a text button or not (i.e. an image button) | ||
| searchButtonText | javax.jcr.PropertyType.STRING | |
| The i18n:ized search button text (en: "Search") | ||
| searchButtonFont | javax.jcr.PropertyType.WEAKREFERENCE | |
| The search button Node (sv:font) | ||
| searchButtonImage | javax.jcr.PropertyType.WEAKREFERENCE | |
| The search button image Node (sv:image) | ||
| Auto complete suggestions | ||
| useAutoSuggestions | javax.jcr.PropertyType.BOOLEAN | |
| Whether or not to use auto complete suggestions | ||
| maxAutoSuggestions | javax.jcr.PropertyType.LONG | |
| Max number of autocomplete suggestions | ||
| autoCompleteURL | javax.jcr.PropertyType.STRING | |
| The autocomplete suggestion URL to use in Ajax calls | ||
| autocompleteField | javax.jcr.PropertyType.STRING | |
| What index field to use when extracting auto complete suggestions ("nameField" or "titleField", se Index fields section below) | ||
| Querying | ||
| queryParameter | javax.jcr.PropertyType.STRING | |
| The name of the parameter to use when submitting a query | ||
| searchFormTargetPage | javax.jcr.PropertyType.WEAKREFERENCE | |
| The Node (typically a sv:page) rendering all templates for a search result | ||
| Type restrictions | ||
| includeFiles | javax.jcr.PropertyType.BOOLEAN | |
| Whether or not to include files in the search result | ||
| includeImages | javax.jcr.PropertyType.BOOLEAN | |
| Whether or not to include images in the search result | ||
| includePages | javax.jcr.PropertyType.BOOLEAN | |
| Whether or not to include pages in the search result | ||
| includeArticles | javax.jcr.PropertyType.BOOLEAN | |
| Whether or not to include articles in the search result | ||
| includeStructurePages | javax.jcr.PropertyType.BOOLEAN | |
| Whether or not to include structure pages in the search result | ||
| Index fields | ||
| summaryField | javax.jcr.PropertyType.STRING | |
| Name of the summary field | ||
| titleField | javax.jcr.PropertyType.STRING | |
| Name of the title field | ||
| nameField | javax.jcr.PropertyType.STRING | |
| Name of the name field | ||
| namepathField | javax.jcr.PropertyType.STRING | |
| Name of the name path field | ||
| urlField | javax.jcr.PropertyType.STRING | |
| Name of the absolute URL field | ||
| uriField | javax.jcr.PropertyType.STRING | |
| Name of the relative URL field | ||
| lastPublishedField | javax.jcr.PropertyType.STRING | |
| Name of the last published field | ||
| sizeField | javax.jcr.PropertyType.STRING | |
| Name of the size field | ||
| siteField | javax.jcr.PropertyType.STRING | |
| Name of the site field | ||
| mimetypeField | javax.jcr.PropertyType.STRING | |
| Name of the mime type field | ||
| Misc | ||
| useCustomIndex | javax.jcr.PropertyType.BOOLEAN | |
| Whether or not a custom index is used | ||
| Aggregated portlet preferences/settings: | ||
| templates | javax.jcr.PropertyType.WEAKREFERENCE | |
| A temporary Node holding all sub-templates used by the main template. See available properties in table below | ||
| bundle | javax.jcr.PropertyType.WEAKREFERENCE | |
| A temporary Node holding all i18n:ized texts used for output. See available properties in table below |
| Name | Type and Description | |
|---|---|---|
| searchFormScriptTemplate | javax.jcr.PropertyType.STRING | |
| The search form script Velocity template |
| Name | Type and Description | |
|---|---|---|
| searchHereText | javax.jcr.PropertyType.STRING | |
| The i18n:ized search here text (en: "Search here") |
Sidan uppdaterad:
Nästa generations publiceringsverktyg är här!
se-sto-ste-sv5-1
216.73.217.134
216.73.217.134