org.nuxeo.ecm.platform.ui.web.util

Class SuggestionActionsBean

java.lang.Object

org.nuxeo.ecm.platform.ui.web.util.SuggestionActionsBean

All Implemented Interfaces:

Serializable

@Name(value="suggestionActions")
 @Scope(value=EVENT)
public class SuggestionActionsBean
extends Object
implements Serializable

Suggestion actions helpers

Since:

5.2M4

Author:

Anahide Tchertchian

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String	selectedValue
protected String	suggestionInputSelectorId Id of the input selector
protected String	suggestionSelectionDeleteId Id of the delete component displayed next to single selection
protected String	suggestionSelectionHiddenId Id if the hidden component where single selection id is put
protected String	suggestionSelectionListId Id of the editable list component where selection ids are put.
protected String	suggestionSelectionOutputId Id of the output component where single selection is displayed

Constructor Summary

Constructors

Constructor and Description
SuggestionActionsBean()

Method Summary

Modifier and Type	Method and Description
void	addBoundSelectionToList(javax.faces.event.ActionEvent event) Adds selection from selector as a list element
void	addSelectionToList(javax.faces.event.ActionEvent event) Deprecated. use addBoundSelectionToList(ActionEvent) which retrieves selected value from bound method instead of retrieving suggestion input.
void	addSingleBoundSelection(javax.faces.event.ActionEvent event) Adds selection from selector as single element
void	addSingleSelection(javax.faces.event.ActionEvent event) Deprecated. use addBoundSelectionToList(ActionEvent) which retrieves selected value from bound method instead of retrieving suggestion input.
void	clearSingleSelection(javax.faces.event.ActionEvent event) Clears single selection.
protected javax.faces.component.UIComponent	getBase(javax.faces.component.UIComponent anchor) Deprecated.
String	getSelectedValue()
void	setSelectedValue(String selectedValue)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

suggestionInputSelectorId

@RequestParameter
protected String suggestionInputSelectorId

Id of the input selector

Component must be an instance of ValueHolder

suggestionSelectionListId

@RequestParameter
protected String suggestionSelectionListId

Id of the editable list component where selection ids are put.

Component must be an instance of UIEditableList

suggestionSelectionOutputId

@RequestParameter
protected String suggestionSelectionOutputId

Id of the output component where single selection is displayed

Component must be an instance of ValueHolder

suggestionSelectionHiddenId

@RequestParameter
protected String suggestionSelectionHiddenId

Id if the hidden component where single selection id is put

Component must be an instance of EditableValueHolder

suggestionSelectionDeleteId

@RequestParameter
protected String suggestionSelectionDeleteId

Id of the delete component displayed next to single selection

Component must be an instance of UIComponent

selectedValue

protected String selectedValue

Constructor Detail

SuggestionActionsBean

public SuggestionActionsBean()

Method Detail

getSelectedValue

public String getSelectedValue()

setSelectedValue

public void setSelectedValue(String selectedValue)

getBase

@Deprecated
protected javax.faces.component.UIComponent getBase(javax.faces.component.UIComponent anchor)

Deprecated.

Gets the base naming container from anchor.

Gets out of suggestion box as it's a naming container and we can't get components out of it with a relative path => take above first found container.

addBoundSelectionToList

public void addBoundSelectionToList(javax.faces.event.ActionEvent event)

Adds selection from selector as a list element

Must pass request parameter "suggestionSelectionListId" holding the binding to model. Selection will be retrieved using the getSelectedValue() method.

addSelectionToList

@Deprecated
public void addSelectionToList(javax.faces.event.ActionEvent event)

Deprecated. use addBoundSelectionToList(ActionEvent) which retrieves selected value from bound method instead of retrieving suggestion input.

Adds selection from selector as a list element

Must pass request parameters "suggestionInputSelectorId" holding the value to pass to the binding component, "suggestionSelectionListId" holding the binding to model.

addSingleBoundSelection

public void addSingleBoundSelection(javax.faces.event.ActionEvent event)

Adds selection from selector as single element

Must pass request parameters "suggestionSelectionOutputId" holding the value to show, and "suggestionSelectionHiddenId" holding the binding to model. Selection will be retrieved using the getSelectedValue() method. Since 5.5, only one of these two parameters is required.

Additional optional request parameter "suggestionSelectionDeleteId" can be used to show an area where the "clear" button is shown.

addSingleSelection

@Deprecated
public void addSingleSelection(javax.faces.event.ActionEvent event)

Deprecated. use addBoundSelectionToList(ActionEvent) which retrieves selected value from bound method instead of retrieving suggestion input.

Adds selection from selector as single element

Must pass request parameters "suggestionInputSelectorId" holding the value to pass to the binding component, "suggestionSelectionOutputId" holding the value to show, and "suggestionSelectionHiddenId" holding the binding to model.

Additional optional request parameter "suggestionSelectionDeleteId" can be used to show an area where the "clear" button is shown. *

clearSingleSelection

public void clearSingleSelection(javax.faces.event.ActionEvent event)

Clears single selection.

Must pass request parameters "suggestionSelectionOutputId" holding the value to show, and "suggestionSelectionHiddenId" holding the binding to model. Since 5.5, only one of these two parameters is required.

Additional optional request parameter "suggestionSelectionDeleteId" can be used to hide an area where the "clear" button is shown.