nl.gx.webmanager.cms.element
Interface SearchElement

All Superinterfaces:

DelegatedControllerAware, Element, Presentable, Wrapper

public interface SearchElement
extends Element

Representation of SearchElement.

Method Summary

java.lang.String	getExtraPrefix() Return the extra prefix.
int	getSearchFieldWidth() Return search field width in characters.
Page	getSearchResultsPage() Return search result page.
java.lang.String	getSearchUrl() Returns the relative location of the search filter
boolean	getShowableHigherPages() If true, the searchelement must display an option to search in children pages of the parent.
boolean	getShowableLowerPages() If true, the searchelement must display an option to search in children pages.
Website[]	getWebsites() Return Websites this element searches.
boolean	isShowableResultsSitewide() If true, the search results of the searchelement must be displayed on a sitewide searchresults page.

Methods inherited from interface nl.gx.webmanager.cms.element.Element

cleanup, copy, getEditElementHeader, getElementHolder, getHeader, getIcon, getMediaItemVersion, getPageModel, getPageModelElement, getPageVersion, getPersonalization, getWebsite, isAuthorized, setAuthorized, setDefaultPresentation, setEditElementHeader, setHeader, setIcon, setPersonalization

Methods inherited from interface nl.gx.webmanager.cms.core.Presentable

getPresentation, render, render, setPresentation

Methods inherited from interface nl.gx.webmanager.wrapper.Wrapper

getId, getUUID, setId, setUUID

Methods inherited from interface nl.gx.webmanager.springmvc.DelegatedControllerAware

getDelegatedController, setDelegatedController

Method Detail

getSearchFieldWidth

int getSearchFieldWidth()

Return search field width in characters.

Returns:

search field width in characters.

getShowableLowerPages

boolean getShowableLowerPages()

If true, the searchelement must display an option to search in children pages.

Returns:

True if the searchelement must display an option to search in children pages.

getShowableHigherPages

boolean getShowableHigherPages()

If true, the searchelement must display an option to search in children pages of the parent.

Returns:

True if the searchelement must display an option to search in children pages of the parent.

getWebsites

Website[] getWebsites()

Return Websites this element searches.

Returns:

Websites this element searches.

isShowableResultsSitewide

boolean isShowableResultsSitewide()

If true, the search results of the searchelement must be displayed on a sitewide searchresults page.

Returns:

True if the search results of the searchelement must be displayed on a sitewide searchresults page.

getSearchResultsPage

Page getSearchResultsPage()

Return search result page.

Returns:

search result page.

getExtraPrefix

java.lang.String getExtraPrefix()

Return the extra prefix.

Returns:

the extra prefix.

getSearchUrl

java.lang.String getSearchUrl()

Returns the relative location of the search filter

Returns:

the relative location of the search filter