org.olat.search.ui
Class SearchInputController

java.lang.Object
  org.olat.core.gui.control.DefaultController
      org.olat.core.gui.control.controller.BasicController
          org.olat.core.gui.components.form.flexible.impl.FormBasicController
              org.olat.search.ui.SearchInputController

All Implemented Interfaces:

SearchController, Controller, ControllerEventListener, Disposable

Direct Known Subclasses:

ResultsSearchController

public class SearchInputController
extends FormBasicController
implements SearchController

Description:
Controller with a simple input for the full text search. The display option select how the input is shown: only a button, button with text, input field and button.

Initial Date: 3 dec. 2009

Author:

srosse, stephane.rosse@frentix.com

Nested Class Summary

class

SearchInputController.ContextTokens

Field Summary

Fields inherited from class org.olat.core.gui.components.form.flexible.impl.FormBasicController

LAYOUT_CUSTOM, LAYOUT_DEFAULT, LAYOUT_HORIZONTAL, LAYOUT_VERTICAL

Constructor Summary

SearchInputController(UserRequest ureq, WindowControl wControl, java.lang.String resourceUrl, SearchServiceUIFactory.DisplayOption displayOption)

SearchInputController(UserRequest ureq, WindowControl wControl, java.lang.String resourceUrl, SearchServiceUIFactory.DisplayOption displayOption, Form mainForm)

SearchInputController(UserRequest ureq, WindowControl wControl, java.lang.String resourceUrl, java.lang.String customPage)

Method Summary

void	closeSearchDialogBox()
java.util.Set<java.lang.String>	getDidYouMeanWords()
java.lang.String	getDocumentType()
FormItem	getFormItem()
java.lang.String	getParentContext()
java.lang.String	getResourceUrl()
java.lang.String	getSearchString()
void	gotoSearchResult(UserRequest ureq, ResultDocument document)
boolean	isResourceContextEnable()
void	setDidYouMeanWords(java.util.Set<java.lang.String> didYouMeansWords) Unregister existing did-you-mean-links from content and add new links.
void	setDocumentType(java.lang.String documentType)
void	setParentContext(java.lang.String parentContext)
void	setResourceContextEnable(boolean resourceContextEnable)
void	setSearchString(java.lang.String searchString)

Methods inherited from class org.olat.core.gui.components.form.flexible.impl.FormBasicController

dispose, event

Methods inherited from class org.olat.core.gui.control.DefaultController

addControllerListener, addLoggingResourceable, dispatchEvent, dispatchEvent, getControllerCount, getInitialComponent, getUserActivityLogger, getWindowControlForDebug, isDisposed, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.olat.core.gui.control.Controller

addControllerListener, dispatchEvent, dispose, getInitialComponent, getUserActivityLogger, getWindowControlForDebug, isDisposed

Constructor Detail

SearchInputController

public SearchInputController(UserRequest ureq,
                             WindowControl wControl,
                             java.lang.String resourceUrl,
                             SearchServiceUIFactory.DisplayOption displayOption)

SearchInputController

public SearchInputController(UserRequest ureq,
                             WindowControl wControl,
                             java.lang.String resourceUrl,
                             java.lang.String customPage)

SearchInputController

public SearchInputController(UserRequest ureq,
                             WindowControl wControl,
                             java.lang.String resourceUrl,
                             SearchServiceUIFactory.DisplayOption displayOption,
                             Form mainForm)

Method Detail

getParentContext

public java.lang.String getParentContext()

Specified by:

getParentContext in interface SearchController

setParentContext

public void setParentContext(java.lang.String parentContext)

Specified by:

setParentContext in interface SearchController

getDocumentType

public java.lang.String getDocumentType()

Specified by:

getDocumentType in interface SearchController

setDocumentType

public void setDocumentType(java.lang.String documentType)

Specified by:

setDocumentType in interface SearchController

getResourceUrl

public java.lang.String getResourceUrl()

Specified by:

getResourceUrl in interface SearchController

isResourceContextEnable

public boolean isResourceContextEnable()

Specified by:

isResourceContextEnable in interface SearchController

setResourceContextEnable

public void setResourceContextEnable(boolean resourceContextEnable)

Specified by:

setResourceContextEnable in interface SearchController

getSearchString

public java.lang.String getSearchString()

Specified by:

getSearchString in interface SearchController

setSearchString

public void setSearchString(java.lang.String searchString)

Specified by:

setSearchString in interface SearchController

closeSearchDialogBox

public void closeSearchDialogBox()

gotoSearchResult

public void gotoSearchResult(UserRequest ureq,
                             ResultDocument document)

Specified by:

gotoSearchResult in interface SearchController

Parameters:

ureq -

command -

getDidYouMeanWords

public java.util.Set<java.lang.String> getDidYouMeanWords()

setDidYouMeanWords

public void setDidYouMeanWords(java.util.Set<java.lang.String> didYouMeansWords)

Unregister existing did-you-mean-links from content and add new links.

Parameters:

didYouMeansWords - List of 'did you mean' words

getFormItem

public FormItem getFormItem()

Specified by:

getFormItem in interface SearchController