Search field

Elements available in the Velocity Context

Name

Type and description

jcrSession

javax.jcr.Session


The JCR Session

portlet

javax.jcr.Node


This portlet. See properties below

request

javax.portlet.PortletRequest


The portlet request

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

 

Additional properties available for the portlet element ($portlet)

Name

Type and Desciption

 

SEARCH FORM
searchButtonFont

javax.jcr.PropertyType.WEAKREFERENCE

 

The search button Node (sv:font)

searchButtonImage

javax.jcr.PropertyType.WEAKREFERENCE

 

The search button image Node (sv:image)

searchButtonText

javax.jcr.PropertyType.STRING

 

The i18n:ized search button text (en: "Search")

searchFieldFont

javax.jcr.PropertyType.WEAKREFERENCE

 

The search field font Node (sv:font)

searchFieldSize

javax.jcr.PropertyType.LONG

 

The size of the search form input field

useTextSearchButton

javax.jcr.PropertyType.BOOLEAN

 

Whether to use a text button or not (i.e. an image button)

 

 

 

AUTO COMPLETE SUGGESTIONS
autocompleteField

javax.jcr.PropertyType.STRING

 

What index field to use when extracting auto complete suggestions ("nameField" or "titleField", se Index fields section below)

autoCompleteURL

javax.jcr.PropertyType.STRING

 

The autocomplete suggestion URL to use in Ajax calls

maxAutoSuggestions

javax.jcr.PropertyType.LONG

 

Max number of autocomplete suggestions

useAutoSuggestions

javax.jcr.PropertyType.BOOLEAN

 

Whether or not to use auto complete suggestions



 

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

includeArticles

javax.jcr.PropertyType.BOOLEAN

 

Whether or not to include articles in the search result

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

includeStructurePages

javax.jcr.PropertyType.BOOLEAN

 

Whether or not to include structure pages in the search result

  
 

INDEX FIELDS

lastPublishedField

javax.jcr.PropertyType.STRING

 

Name of the last published field

mimetypeField

javax.jcr.PropertyType.STRING

 

Name of the mime type field

nameField

javax.jcr.PropertyType.STRING

 

Name of the name field

namepathField

javax.jcr.PropertyType.STRING

 

Name of the name path field

siteField

javax.jcr.PropertyType.STRING

 

Name of the site field

sizeField

javax.jcr.PropertyType.STRING

 

Name of the size field

summaryField

javax.jcr.PropertyType.STRING

 

Name of the summary field

titleField

javax.jcr.PropertyType.STRING

 

Name of the title field

uriField

javax.jcr.PropertyType.STRING

 

Name of the relative URL field

urlField

javax.jcr.PropertyType.STRING

 

Name of the absolute URL field



 

MISC

useCustomIndex

javax.jcr.PropertyType.BOOLEAN

 

Whether or not a custom index is used



 

AGGREGATED PORTLET PREFERENCES/SETTINGS:

bundle

javax.jcr.PropertyType.WEAKREFERENCE

 

A temporary Node holding all i18n:ized texts used for output. See available properties in table below

templates

javax.jcr.PropertyType.WEAKREFERENCE

 

A temporary Node with sub-nodes that holds properties about all letters. See available properties for letters sub-nodes in table below

  

 

Properties available for the templates Node

Name
Type and Description

searchFormScriptTemplate

javax.jcr.PropertyType.STRING

 

The search form script Velocity template



Properties available for the bundle Node

Name
Type and Description

searchHereText

javax.jcr.PropertyType.STRING

 

The i18n:ized search here text (en: "Search here")