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

Class SelectionActionsBean

java.lang.Object

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

All Implemented Interfaces:

Serializable

@Name(value="selectionActions")
 @Scope(value=EVENT)
public class SelectionActionsBean
extends Object
implements Serializable

Helper for selection actions, useful when performing ajax calls on a "liste shuttle" widget for instance, or to retrieve the selected value on a JSF component and set it on another.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SelectionActionsBean.ShiftType

Field Summary

Fields

Modifier and Type	Field and Description
protected String	leftItems
protected String	leftSelect
protected Integer	lookupLevel Lookup level request parameter (defaults to 1, means search is done in r first parent naming container)
protected String	lookupLevelValue Lookup level field (defaults to 1, means search is done in first parent naming container)
protected String	rightItems
protected String	rightSelect
protected String	selectedValue Value held temporarily by this bean to be set on JSF components.
protected String	selectedValueHolder Value component id held temporarily by this bean to be retrieved from the JSF component tree.
protected String	selectorId Id of the input selector
protected String	submittedList
protected String	valueHolderId Id of the value holder that will receive the selected value.

Constructor Summary

Constructors

Constructor and Description
SelectionActionsBean()

Method Summary

Modifier and Type	Method and Description
void	addAllToSelection(javax.faces.event.ActionEvent event)
void	addToSelection(javax.faces.event.ActionEvent event)
protected boolean	checkLeftComponents()
protected boolean	checkRightComponents()
protected boolean	checkSubmittedList()
protected int	computeLookupLevel()
javax.faces.model.SelectItem[]	getEmptySelection()
String	getLookupLevelValue()
String	getSelectedValue()
String	getSelectedValueHolder()
javax.faces.component.UISelectMany	getSourceSelectComponent(javax.faces.event.ActionEvent event)
javax.faces.component.UISelectItems	getSourceSelectItems(javax.faces.event.ActionEvent event)
protected String	getStringAttribute(javax.faces.component.UIComponent component, String name, boolean required)
void	onClick(javax.faces.event.ActionEvent event) Deprecated. since 6.0: use onClick(AjaxBehaviorEvent) instead.
void	onClick(javax.faces.event.AjaxBehaviorEvent event)
protected void	onClick(javax.faces.event.FacesEvent event)
void	onSelection(javax.faces.event.ActionEvent event) Deprecated. since 6.0: use onSelection(AjaxBehaviorEvent) instead.
void	onSelection(javax.faces.event.AjaxBehaviorEvent event)
protected void	onSelection(javax.faces.event.FacesEvent event)
void	removeAllFromSelection(javax.faces.event.ActionEvent event)
void	removeFromSelection(javax.faces.event.ActionEvent event)
protected javax.faces.component.UIComponent	retrieveBase(javax.faces.component.UIComponent anchor, int lookupLevel)
protected Object	retrieveSourceComponentValue(javax.faces.component.UIComponent base, String targetId)
void	setLookupLevelValue(String lookupLevelValue)
void	setSelectedValue(String selectedValue)
void	setSelectedValueHolder(String selectedValueHolder)
void	setStaticValue(javax.faces.event.ActionEvent event)
void	setStaticValue(javax.faces.event.AjaxBehaviorEvent event) Retrieves a value passed as an attribute with id "selectedValue" on the event component attributes and sets it on the target component.
protected void	setStaticValue(javax.faces.event.FacesEvent event)
protected void	setTargetComponentValue(javax.faces.component.ValueHolder target, Object value)
void	setValueFromComponent(javax.faces.event.ActionEvent event)
void	setValueFromComponent(javax.faces.event.AjaxBehaviorEvent event) Retrieves a value from another component and sets it on the target component.
protected void	setValueFromComponent(javax.faces.event.FacesEvent event)
void	shiftSelected(SelectionActionsBean.ShiftType stype, javax.faces.event.ActionEvent event)
void	shiftSelectedDown(javax.faces.event.ActionEvent event)
void	shiftSelectedFirst(javax.faces.event.ActionEvent event)
void	shiftSelectedLast(javax.faces.event.ActionEvent event)
void	shiftSelectedUp(javax.faces.event.ActionEvent event)

Methods inherited from class java.lang.Object

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

Field Detail

leftSelect

@RequestParameter
protected String leftSelect

leftItems

@RequestParameter
protected String leftItems

rightSelect

@RequestParameter
protected String rightSelect

rightItems

@RequestParameter
protected String rightItems

submittedList

@RequestParameter
protected String submittedList

selectorId

@RequestParameter
protected String selectorId

Id of the input selector

Component must be an instance of ValueHolder

valueHolderId

@RequestParameter
protected String valueHolderId

Id of the value holder that will receive the selected value.

Component must be an instance of ValueHolder

lookupLevel

@RequestParameter
protected Integer lookupLevel

Lookup level request parameter (defaults to 1, means search is done in r first parent naming container)

Since:

5.6

lookupLevelValue

protected String lookupLevelValue

Lookup level field (defaults to 1, means search is done in first parent naming container)

Useful as fallback when posting a button where request parameter lookupLevel cannot be set.

Since:

5.6

selectedValue

@RequestParameter
protected String selectedValue

Value held temporarily by this bean to be set on JSF components.

Since:

5.5

selectedValueHolder

protected String selectedValueHolder

Value component id held temporarily by this bean to be retrieved from the JSF component tree.

this is an alternative to valueHolderId request parameter usage, to make it possible to set this value easily from command buttons (as only command links do take request parameters into account).

Since:

5.6

Constructor Detail

SelectionActionsBean

public SelectionActionsBean()

Method Detail

getLookupLevelValue

public String getLookupLevelValue()

Since:

5.6

setLookupLevelValue

public void setLookupLevelValue(String lookupLevelValue)

Since:

5.6

computeLookupLevel

protected int computeLookupLevel()

Since:

5.6

getSelectedValue

public String getSelectedValue()

setSelectedValue

public void setSelectedValue(String selectedValue)

getSelectedValueHolder

public String getSelectedValueHolder()

setSelectedValueHolder

public void setSelectedValueHolder(String selectedValueHolder)

getEmptySelection

public javax.faces.model.SelectItem[] getEmptySelection()

checkRightComponents

protected boolean checkRightComponents()

checkLeftComponents

protected boolean checkLeftComponents()

checkSubmittedList

protected boolean checkSubmittedList()

shiftSelected

public void shiftSelected(SelectionActionsBean.ShiftType stype,
                          javax.faces.event.ActionEvent event)

shiftSelectedUp

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

shiftSelectedDown

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

shiftSelectedFirst

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

shiftSelectedLast

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

addToSelection

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

removeFromSelection

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

addAllToSelection

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

getSourceSelectComponent

public javax.faces.component.UISelectMany getSourceSelectComponent(javax.faces.event.ActionEvent event)

getSourceSelectItems

public javax.faces.component.UISelectItems getSourceSelectItems(javax.faces.event.ActionEvent event)

removeAllFromSelection

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

onSelection

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

Deprecated. since 6.0: use onSelection(AjaxBehaviorEvent) instead.

Adds selection retrieved from a selector to another component

Must pass request parameters "selectorId" holding the id of component holding the value to pass to the other component, and "valueHolderId" holding the other component id.

Parameters:

event -

Since:

5.5

onSelection

public void onSelection(javax.faces.event.AjaxBehaviorEvent event)

Since:

6.0

onSelection

protected void onSelection(javax.faces.event.FacesEvent event)

onClick

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

Deprecated. since 6.0: use onClick(AjaxBehaviorEvent) instead.

Adds value retrieved from getSelectedValue() to a component

Must pass request parameters "valueHolderId" holding the id of the bound component, and call setSelectedValue(String) prior to this call.

As an alternative, must call setSelectedValueHolder(String) with the id of the bound component, and call setSelectedValue(String) prior to this call (this makes it possible to use the same logic in command buttons that do not make it possible to pass request parameters).

Parameters:

event -

Since:

5.5

onClick

public void onClick(javax.faces.event.AjaxBehaviorEvent event)

onClick

protected void onClick(javax.faces.event.FacesEvent event)

retrieveBase

protected javax.faces.component.UIComponent retrieveBase(javax.faces.component.UIComponent anchor,
                                                         int lookupLevel)

setValueFromComponent

public void setValueFromComponent(javax.faces.event.AjaxBehaviorEvent event)

Retrieves a value from another component and sets it on the target component.

Source component id must be passed in the event component attributes with id "sourceComponentId".

Target component id must be passed in the event component attributes with id "targetComponentId". If target component is an EditableValueHolder, its submitted value is set. Otherwise, its local value is set.

Parameters:

event -

Since:

6.0

setValueFromComponent

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

Since:

6.0

See Also:

setValueFromComponent(ActionEvent)

setValueFromComponent

protected void setValueFromComponent(javax.faces.event.FacesEvent event)

setStaticValue

public void setStaticValue(javax.faces.event.AjaxBehaviorEvent event)

Retrieves a value passed as an attribute with id "selectedValue" on the event component attributes and sets it on the target component.

Target component id must be passed in the event component attributes with id "targetComponentId". If target component is an EditableValueHolder, its submitted value is set. Otherwise, its local value is set.

Parameters:

event -

Since:

6.0

setStaticValue

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

Since:

6.0

See Also:

setStaticValue(ActionEvent)

setStaticValue

protected void setStaticValue(javax.faces.event.FacesEvent event)

getStringAttribute

protected String getStringAttribute(javax.faces.component.UIComponent component,
                                    String name,
                                    boolean required)

retrieveSourceComponentValue

protected Object retrieveSourceComponentValue(javax.faces.component.UIComponent base,
                                              String targetId)

setTargetComponentValue

protected void setTargetComponentValue(javax.faces.component.ValueHolder target,
                                       Object value)